freComponentSetup.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: freComponentSetup.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 __freComponentSetup_h
#define __freComponentSetup_h

#include "freXMLStreamObject.h"
#include "freComponentID.h"
#include "freIDPath.h"
#include "freParameterCollection.h"
#include "freComponentMediaLinks.h"

#include "itkLightObject.h"

namespace FREE
{

class ComponentSetupCollection; //forwarding because also used in SetupSections

class ComponentSetup : public XMLStreamObject, public itk::LightObject
{
public:
  typedef ComponentSetup  Self;
  typedef itk::LightObject Superclass;
  typedef itk::SmartPointer<Self>        Pointer;
  typedef itk::SmartPointer<const Self>  ConstPointer;

        itkTypeMacro(ComponentSetup, XMLStreamObject);
  itkNewMacro(ComponentSetup);
  static Pointer New(ComponentSetup* pParentComponent, const ComponentID& compID = cComp_NotDefined);

  inline bool ControllerIsAssigned() const { return GetControllerID()!=csUndefinedController; };

  void SetControllerID(const std::string& sControllerID);
  std::string GetControllerID() const { return m_sControllerID; };

  void SetComment(const std::string& sComment) { m_sComment = sComment; };
  std::string GetComment() const { return m_sComment; };

  void SetComponentID( const ComponentID& componentID );
  const ComponentID& GetComponentID() const { return m_ComponentID; };
  ComponentID& GetComponentID() { return m_ComponentID; };

  void SetTemplateID(const std::string& sTemplateID) {m_sTemplateID = sTemplateID; };
  const std::string& GetTemplateID() const { return m_sTemplateID; };
  bool IsTemplateBased() const {return m_sTemplateID.size()>0;};

  ParameterCollection& Parameters() { return m_Parameters; };
  const ParameterCollection& Parameters() const { return m_Parameters; };

  ComponentMediaLinks& MediaLinks() { return m_Links; };
  const ComponentMediaLinks& MediaLinks() const { return m_Links; };

  ComponentSetupCollection& Components() { return *m_Components; };
  const ComponentSetupCollection& Components() const { return *m_Components; };

  bool HasParentComponent() const;
  const ComponentSetup* GetParentComponent() const;
  ComponentSetup* GetParentComponent();

  const ComponentSetup* GetRootComponent() const;
  ComponentSetup* GetRootComponent();

  ComponentSetup* GetComponentByIDPath(const IDPath& idPath);

  IDPath GetIDPath() const;

  bool operator == (const std::string& sControllerID) const;

  virtual ComponentSetup& operator = (const ComponentSetup& rComponentSetup);

  virtual void ResetParameters ();

  virtual void Reset();

protected:
  ComponentSetup( );

  ComponentSetup(ComponentSetup* pParentComponent, const ComponentID& compID = cComp_NotDefined);

  virtual ~ComponentSetup();

  virtual void SubElementLoadProcessing(const std::string& rsXMLSubTag, const std::string& rsXMLSubElement, const std::string& rsXMLSubData);

  virtual std::string SaveData(const unsigned int& iDepth, bool& bHasSubElements) const;

  virtual void AttributesLoadProcessing(const AttributesType& rAttributes);

  virtual void SaveAttributes(AttributesSaveListType& rAttributes) const;

  std::string m_sControllerID;

  std::string m_sComment;

  ComponentID m_ComponentID;

  std::string m_sTemplateID;

  ParameterCollection m_Parameters;

  ComponentMediaLinks m_Links;

  ComponentSetupCollection* m_Components;

  ComponentSetup* m_pParent;

private:
    ComponentSetup( const ComponentSetup& rComponentSetup); //suppressing default generation
};

}//end of namespace FREE

#endif

---