freComponentSetup.cxx

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.cxx,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 "freComponentSetup.h"

#include "freConvert.h"
#include "freComponentSetupCollection.h"

namespace FREE
{


void
ComponentSetup::
SetControllerID(const std::string& sControllerID)
{
  m_sControllerID = sControllerID;
};
 
void
ComponentSetup::
SetComponentID( const ComponentID& componentID )
{
  m_ComponentID = componentID;
};

bool
ComponentSetup::
operator == (const std::string& sControllerID) const
{
  return sControllerID == m_sControllerID;
};

ComponentSetup&
ComponentSetup::
operator = (const ComponentSetup& rComponentSetup)
{
  if (this == &rComponentSetup) return *this;

  Reset();

  m_sControllerID = rComponentSetup.GetControllerID();
  m_sTemplateID = rComponentSetup.GetTemplateID();
  m_sComment = rComponentSetup.GetComment();
        m_ComponentID = rComponentSetup.GetComponentID();
  m_Parameters = rComponentSetup.Parameters();
        m_Links = rComponentSetup.MediaLinks();

  delete m_Components;
  m_Components = new ComponentSetupCollection(this);
  *m_Components = rComponentSetup.Components();

  return *this;
};


bool
ComponentSetup::
HasParentComponent() const
{
  return m_pParent!=NULL;
};

const ComponentSetup*
ComponentSetup::
GetParentComponent() const
{ return m_pParent; };

ComponentSetup*
ComponentSetup::
GetParentComponent()
{ return m_pParent; };

const ComponentSetup*
ComponentSetup::
GetRootComponent() const
{ 
  if (m_pParent) return m_pParent->GetRootComponent();
  return this;
};

ComponentSetup*
ComponentSetup::
GetRootComponent()
{ 
  if (m_pParent) return m_pParent->GetRootComponent();
  return this;
};

ComponentSetup*
ComponentSetup::
GetComponentByIDPath(const IDPath& idPath)
{
  if (idPath.IsEmpty()) return this;

  //if not dispatch passed path
  std::string sTag;
  IDPath::PathElementType token = idPath.GetFirstComponent(sTag);

  //This is like self reference by default, hence it won't be checked in the switch statement
  IDPath nextPath = idPath.GetSubIDPath();
  ComponentSetup* pNext = this;

  if (idPath.IsAbsolute())
  {
    pNext = GetRootComponent();
    nextPath = idPath;
    nextPath.SetAbsolute(false);
  }
  else
  {
    switch(token)
    {
    case IDPath::PTAnyDescendant: //not allowed
      throwExceptionMacro("IDPath must be well defined. No Wildcards of any kind (*, //) are allowed. IDPath: " << idPath.ToStr());
    case IDPath::PTParent: //addresses parent
      pNext = GetParentComponent(); break;
    case IDPath::PTAnyChild: //not allowed
      throwExceptionMacro("IDPath must be well defined. No Wildcards of any kind (*, //) are allowed. IDPath: " << idPath.ToStr());
    case IDPath::PTComponent: //not allowed
      pNext = Components().GetElement(sTag); break;
    case IDPath::PTNULL:
      throwExceptionMacro("IDPath is invalid, contains undefined path element . IDPath: " << idPath.ToStr());
    }
  }

        if (!pNext) return NULL; //IDPAth is not empty, but no match in components found -> path location does not exist.
  return pNext->GetComponentByIDPath(nextPath);
};

IDPath
ComponentSetup::
GetIDPath() const
{
  IDPath path;
  if (HasParentComponent()) path = m_pParent->GetIDPath();

  path = path + IDPath(m_ComponentID);
  return path;
};

ComponentSetup::
ComponentSetup( ):XMLStreamObject(cXML_Component)
{
  m_Components = new ComponentSetupCollection(this);

  Reset();

  m_ComponentID = cComp_NotDefined;
  m_pParent = 0;
};

ComponentSetup::
ComponentSetup(ComponentSetup* pParentComponent,
               const ComponentID& compID):XMLStreamObject(cXML_Component)
{
  m_Components = new ComponentSetupCollection(this);

  Reset();

  SetComponentID(compID);
  
  m_pParent = pParentComponent;
};

ComponentSetup::Pointer
ComponentSetup::
New(ComponentSetup* pParentComponent,
               const ComponentID& compID)
{
  Pointer smartPtr;
  ComponentSetup *rawPtr = ::itk::ObjectFactory<ComponentSetup>::Create();
  if(rawPtr == NULL)
  {
    rawPtr = new ComponentSetup(pParentComponent, compID);
  }
  smartPtr = rawPtr;
  rawPtr->UnRegister();

  return smartPtr;
};

ComponentSetup::
~ComponentSetup()
{
  Reset();
  delete m_Components;
};

void ComponentSetup::Reset()
{
  XMLStreamObject::Reset();
  m_ComponentID = "";
  m_sControllerID = "";
  m_sTemplateID = "";
  m_sComment = "";

  ResetParameters();
        m_Links.Reset();
  m_Components->Reset();
};

void ComponentSetup::ResetParameters()
{
  m_Parameters.Reset();
};

void
ComponentSetup::
SubElementLoadProcessing(const std::string& rsXMLSubTag, const std::string& rsXMLSubElement, const std::string& rsXMLSubData)
{
  if (rsXMLSubTag==cXML_Components)
  {
    m_Components->LoadFromString(rsXMLSubElement);
  }
  else if (rsXMLSubTag==cXML_ComponentComment)
  {
    m_sComment = rsXMLSubData;
  }
  else if (rsXMLSubTag==cXML_ComponentParameters)
  {
    m_Parameters.LoadFromString(rsXMLSubElement);
  }
  else if (rsXMLSubTag==cXML_MediaLinks)
  {
    m_Links.LoadFromString(rsXMLSubElement);
  }
  else if (rsXMLSubTag!=cXML_Text) throwExceptionMacro("Unknown xml tag, unable to load value. Incorrect Tag: "<< rsXMLSubTag);
};

std::string
ComponentSetup::
SaveData(const unsigned int& iDepth, bool& bHasSubElements) const
{
  std::string sResult;
  if (m_sComment.size()!=0) AddSubElement(sResult,cXML_ComponentComment,m_sComment,iDepth);
        if (m_Parameters.Size()!=0) AddSubElement(sResult,&m_Parameters,iDepth);
        if (m_Links.Size()!=0) AddSubElement(sResult,&m_Links,iDepth);
  if (m_Components->Size()!=0) AddSubElement(sResult,m_Components,iDepth);

  return sResult;
};

void
ComponentSetup::
AttributesLoadProcessing(const AttributesType& rAttributes)
{
  for (AttributesType::const_iterator pos = rAttributes.begin(); pos!= rAttributes.end(); pos++)
  {
    if (pos->first==cXML_ComponentControllerID) m_sControllerID = pos->second;
    else if (pos->first==cXML_ComponentID) m_ComponentID = pos->second;
    else if (pos->first==cXML_TemplateID) m_sTemplateID = pos->second;
  };
};

void
ComponentSetup::
SaveAttributes(AttributesSaveListType& rAttributes) const
{
  rAttributes.push_back(AttributesType::value_type(cXML_ComponentID,m_ComponentID));
        if (m_sControllerID!=csUndefinedController) rAttributes.push_back(AttributesType::value_type(cXML_ComponentControllerID,m_sControllerID));
  if (IsTemplateBased()) rAttributes.push_back(AttributesType::value_type(cXML_TemplateID,m_sTemplateID));
}; 

}//end of namespace FREE

---