freControllerInterface.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freComponentControllerInterface.h,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.

=========================================================================*/
#ifndef __freComponentControllerInterface_h
#define __freComponentControllerInterface_h

#include "freElementals.h"
#include "freExceptions.h"
#include "freControllerEvents.h"
#include "freComponentSetup.h"
#include "freControllerProfile.h"
#include "freSessionComponentCache.h"
#include "freSessionInfo.h"
#include "freValidityTag.h"

#include "itkLightObject.h"

namespace FREE
{

class ComponentControllerInterface
{
public:
  typedef itk::LightObject GenericComponentType;
  typedef GenericComponentType::Pointer GenericComponentPointer;

  typedef ::FREE::GenericMediaType GenericMediaType;
  typedef GenericMediaType::Pointer GenericMediaPointer;

  virtual const char *GetNameOfClass() const {return "ComponentControllerInterface";};

  const std::string& ControllerID() const {return this->m_ControllerID;};
  const std::string& Description() const {return this->m_Description;};
  const CtrlProfile::ProfileInheritance& ProfileInheritance() const {return this->m_Inheritance;};

  bool IsRelatedTo(const std::string& sControllerID) const;

  virtual CtrlProfile::ControllerProfile::Pointer GetProfile(const SessionComponentCache* pComponentCache) const = 0;

  typedef std::vector<IDPath> AffectedElementListType;

  virtual AffectedElementListType GetAffectedProfileElements(const IDPath& affectorID,
                                                             SessionComponentCache* pComponentCache,
                                                             const ComponentSetup* pNewAffectorSetup = 0) const = 0;

  virtual bool ControllerIsResponsible(const GenericComponentType* pComponent) const = 0;

  virtual void InitializeSetup(ComponentSetup* pComponentSetup, SessionComponentCache* pComponentCache) const = 0;

  virtual SessionComponentCache::Pointer BuildSetup(ComponentSetup* pComponentSetup,
                                                    SessionComponentCache* pParentComponentCache) const = 0;

   virtual const bool CheckComponentActualizationNecessity(const SessionComponentCache* pComponentCache) const = 0;

  virtual void ActualizeComponent(SessionComponentCache* pComponentCache,
                                  SessionInfo* pSessionInfo,
                                  const unsigned int& iActiveLayer = 0) const = 0;

  virtual void ResetComponent(SessionComponentCache* pComponentCache,
                              SessionInfo* pSessionInfo) const = 0;

  virtual void SetStatisticEntry(StatisticEntry& rStatisticEntry,
                                 SessionComponentCache* pComponentCache,
                                 SessionInfo* pSessionInfo) const = 0;

  virtual GenericComponentPointer GetGenericComponent(const SessionComponentCache* pComponentCache) const = 0; 

  virtual void SetGenericComponent(GenericComponentType* pGenericComponent, SessionComponentCache* pComponentCache) const = 0; 

  virtual GenericComponentType* GetSubComponent(SessionComponentCache* pMainComponentCache, const ComponentID compID) const = 0; 

  virtual void SetSubComponent(SessionComponentCache* pMainComponentCache, GenericComponentType* pSubComponent, 
                       const ComponentID compID) const = 0; 

  virtual GenericMediaPointer GetMedia(const MediaID& mediaID,
                                   SessionComponentCache* pComponentCache,
                                   SessionInfo* pSessionInfo) const = 0; 

  virtual void SetMedia(const MediaID& mediaID, GenericMediaType* pMedia,
                SessionComponentCache* pComponentCache,
                SessionInfo* pSessionInfo) const = 0; 
        
  virtual ValidityTag::Pointer GetMediaValidityTag(const MediaID& mediaID,
                                                   SessionComponentCache* pComponentCache) const = 0; 

  virtual ValidityTag::Pointer GetMediaValidityTagRequirement(const MediaID& mediaID,
                                                              SessionComponentCache* pComponentCache) const = 0; 

  virtual std::string GetMediaControllerID(const MediaID& mediaID,
                                           SessionComponentCache* pComponentCache) const = 0; 

  virtual Parameter::Pointer GetParameter(const SessionComponentCache* pComponentCache,
                                          const std::string& sParameterName) const = 0;

  virtual std::string GetParameterValue(const SessionComponentCache* pComponentCache,
                                        const std::string& sParameterName,
                                        const Parameter::ValueCountType iItemPos = 0,
                                        const Parameter::LayerCountType iLayer = 0) const = 0; 

  virtual void SetParameterValue(SessionComponentCache* pComponentCache,
                                 const std::string& sParameterName,
                                 const std::string& sValue,
                                 const Parameter::ValueCountType iItemPos = 0,
                                 const Parameter::LayerCountType iLayer = 0) const = 0; 

  virtual ValidityTag::Pointer GetParameterValidityTag(const std::string& sParameterName,
                                                       SessionComponentCache* pComponentCache) const = 0; 

  virtual ValidityTag::Pointer GetParameterValidityTagRequirement(const std::string& sParameterName,
                                                                  SessionComponentCache* pComponentCache) const = 0; 

  virtual ~ComponentControllerInterface();

protected:
  ComponentControllerInterface();

  void UpdateControllerID(const std::string& sControllerID);

  std::string m_ControllerID; 

  CtrlProfile::ProfileInheritance m_Inheritance;

  std::string m_Description;
};

typedef ComponentControllerInterface GenericComponentController;
typedef GenericComponentController::GenericComponentType GenericComponentType;

} //end of namespace FREE

#endif

---