freParameterListMediaController.cxx

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2007/04/12 12:00:00 $
  Module:    $RCSfile: freParameterListMediaController.txx,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#include "freParameterListMediaController.h"
#include "freExceptions.h"

namespace FREE
{

  DefineParameterMacro(ParameterListMediaController,ReadMode,"ReadMode","Indicates if this component should be used in read (true) or write mode (false).");
  DefineParameterMacro(ParameterListMediaController,ParameterLink,"ParameterLink","Link specifing a parameter in the setup that should be read or written.");

  ParameterListMediaController::
    ParameterListMediaController()
  {
    //Profile settings
    this->UpdateControllerID(ControllerID::ParameterListMediaController);
    this->m_Description = "Controller for a parameter list.";
  };

  ParameterListMediaController::
    ~ParameterListMediaController()
  {}
  ;

  ParameterListMediaController::GenericMediaPointer
    ParameterListMediaController::
    ComputeActualizedMedia(GenericMediaType* pGenericMedia,
    GenericMediaType* pGenericTransformationField) const
  {
    //parameter list has nothing to actualize
    return GenericMediaPointer(pGenericMedia);
  };

  ParameterListMediaController::GenericMediaPointer
    ParameterListMediaController::
    ComputeActualizedMediaByFunction(GenericMediaType* pGenericMedia,
    GenericMediaType* pGenericTransformationFunction) const
  {
    //parameter list has nothing to actualize
    return GenericMediaPointer(pGenericMedia);
  };

  bool
    ParameterListMediaController::
    SaveMedia(std::string sMediaPath, GenericMediaType* pMedia) const
  {
    //parameter list cannot save directly allways need a session

    return false;
  };

  bool
    ParameterListMediaController::
    SaveMedia(SessionComponentCache* pCache) const
  {
    if (!pCache) throwCtrlExceptionMacro("", "Cannot save media. Passed session cache is NULL.");
    if (!pCache->SetupIsAssigned())
      throwCtrlExceptionMacro("","Error. Setup is missing in cache.");
    if (!pCache->ComponentIsAssigned())
      throwCtrlExceptionMacro("","Error. Component is missing in cache.");

    ComponentPointer smpIO = dynamic_cast<ComponentType*>(pCache->Component().GetPointer());

    std::string sMediaFile;
    if (!pCache->Setup()->Parameters().GetParameterValue(cParam_MediaFile,sMediaFile))
      throwCtrlExceptionMacro("", "Missing parameter" << cParam_MediaFile);

    for (ParameterCollection::ParameterCountType index=0; index<pCache->Setup()->Parameters().Size(); index++)
    { //search for all paramter link specifications
      Parameter* pParam = pCache->Setup()->Parameters().GetParameter(index);
      if ((pParam->GetParameterName()!=cParam_MediaFile) &&
        (pParam->GetParameterName()!=cParam_ReadMode))
      { //assume that it is a parameter link and add it
        std::string sLink = "";
        pParam->GetParameterValue(sLink);
        smpIO->AddParameterLink(pParam->GetParameterName(),sLink);
      }
    }

    smpIO->SetComponentCache(pCache);
    smpIO->SaveListToFile(sMediaFile);

    return true; //point set is saved to setup
  };

  bool
    ParameterListMediaController::
    LoadMedia(SessionComponentCache* pCache) const
  {
    if (!pCache) throwCtrlExceptionMacro("", "Cannot load media. Passed session cache is NULL.");
    if (!pCache->SetupIsAssigned())
      throwCtrlExceptionMacro("","Error. Setup is missing in cache.");
    if (!pCache->ComponentIsAssigned())
      throwCtrlExceptionMacro("","Error. Component is missing in cache.");

    ComponentPointer smpIO = dynamic_cast<ComponentType*>(pCache->Component().GetPointer());

    std::string sMediaFile;
    if (!pCache->Setup()->Parameters().GetParameterValue(cParam_MediaFile,sMediaFile))
      throwCtrlExceptionMacro("", "Missing parameter" << cParam_MediaFile);

    for (ParameterCollection::ParameterCountType index=0; index<pCache->Setup()->Parameters().Size(); index++)
    { //search for all paramter link specifications
      Parameter* pParam = pCache->Setup()->Parameters().GetParameter(index);
      if ((pParam->GetParameterName()!=cParam_MediaFile) &&
        (pParam->GetParameterName()!=cParam_ReadMode))
      { //assume that it is a parameter link and add it
        std::string sLink = "";
        pParam->GetParameterValue(sLink);
        smpIO->AddParameterLink(pParam->GetParameterName(),sLink);
      }
    }

    smpIO->SetComponentCache(pCache);
    smpIO->LoadListFromFile(sMediaFile);

    this->NotifyProgress(1,"Loading finished",pCache);

    return true;
  };

  unsigned long
    ParameterListMediaController::
    GetMediaDimension() const
  {
    return 0;
  };

  void
    ParameterListMediaController::
    GenerateProfile(CtrlProfile::ControllerProfile& profile,
    const SessionComponentCache* pComponentCache,
    bool bRegardOldSetup) const
  {
    Superclass::GenerateProfile(profile, pComponentCache, bRegardOldSetup);

    //Parameters
    profile.Parameters().AddParameter(cParam_ReadMode,Parameter::PVTBool,cParamDsc_ReadMode,1,"false");
    //TODO eigentlich als Template nötig
    profile.Parameters().AddParameter(cParam_ParameterLink,Parameter::PVTIDPath,cParamDsc_ParameterLink,1,"");
  };

  ParameterListMediaController::
    ComponentPointer
    ParameterListMediaController::
    BuildMainComponent(ComponentSetup* pComponentSetup, SessionComponentCache* pComponentCache) const
  {
    ComponentPointer smpComp = Superclass::BuildMainComponent(pComponentSetup, pComponentCache);

    bool bRead;
    if (!pComponentCache->Setup()->Parameters().GetParameterValue(cParam_ReadMode,bRead))
      throwCtrlExceptionMacro("", "Missing parameter" << cParam_ReadMode);

    if (bRead)
    {
      if (!LoadMedia(pComponentCache)) throwCtrlExceptionMacro("", "Unable to parameter list.");
    }

    return smpComp;
  };

ValidityTag::Pointer
ParameterListMediaController::
GetMediaValidityTagRequirement(const MediaID& mediaID, SessionComponentCache* pComponentCache) const
{
  if (mediaID == "media")
  {
    ValidityTag::Pointer tag = ValidityTag::New();
    tag->Actualize();
    return tag;
  }

  return Superclass::GetMediaValidityTagRequirement(mediaID, pComponentCache);
};

} //end of namespace free

---