FREE::ParameterListIO Class Reference

An IO interface that allows to extract parameters from a setup. More...

#include <freParameterListIO.h>

Collaboration diagram for FREE::ParameterListIO:

[legend]

List of all members.

Public Types
typedef std::map < std::string, IDPath >	ParameterLinkMapType
typedef ParameterListIO	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	SetComponentCache (SessionComponentCache *pCache)
SessionComponentCache *	GetComponentCache ()
void	AddParameterLink (const std::string &sName, const IDPath &idPath)
void	DeleteParameterLink (const std::string &sName)
IDPath	GetParameterLink (const std::string &sName)
void	ResetParameterLinks ()
void	SaveListToFile (const std::string &sFileName)
void	LoadListFromFile (const std::string &sFileName)
virtual	~ParameterListIO ()
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	ParameterListIO ()
Protected Attributes
SessionComponentCache *	m_pCache
ParameterLinkMapType	m_Links

---

Detailed Description

An IO interface that allows to extract parameters from a setup.

ParameterListIO allwos to extract parameters from a setup and save them in an xml file or to read these xml files and set the parameters in the setup.

Remarks:

ParameterListIO is only abel to set parameters which are present in ComponentSetup structur. But it can get every parameter via the component cache.

Definition at line 43 of file freParameterListIO.h.

---

Member Typedef Documentation

typedef std::map<std::string, IDPath> FREE::ParameterListIO::ParameterLinkMapType

Definition at line 46 of file freParameterListIO.h.

typedef ParameterListIO FREE::ParameterListIO::Self

Standard typedefs

Definition at line 49 of file freParameterListIO.h.

typedef itk::LightObject FREE::ParameterListIO::Superclass

Definition at line 50 of file freParameterListIO.h.

typedef itk::SmartPointer<Self> FREE::ParameterListIO::Pointer

Definition at line 51 of file freParameterListIO.h.

typedef itk::SmartPointer<const Self> FREE::ParameterListIO::ConstPointer

Definition at line 52 of file freParameterListIO.h.

---

Constructor & Destructor Documentation

FREE::ParameterListIO::~ParameterListIO

(

)

[virtual]

Definition at line 43 of file freParameterListIO.cxx.

FREE::ParameterListIO::ParameterListIO

(

)

[protected]

Definition at line 48 of file freParameterListIO.cxx.

References m_pCache.

---

Member Function Documentation

virtual const char* FREE::ParameterListIO::GetNameOfClass

(

)

const [inline, virtual]

Run-time type information (and related methods).

Definition at line 55 of file freParameterListIO.h.

static Pointer FREE::ParameterListIO::New

(

void

)

[inline, static]

Definition at line 56 of file freParameterListIO.h.

virtual ::itk::LightObject::Pointer FREE::ParameterListIO::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 56 of file freParameterListIO.h.

void FREE::ParameterListIO::SetComponentCache

(

SessionComponentCache *

pCache

)

Definition at line 31 of file freParameterListIO.cxx.

References m_pCache.

SessionComponentCache * FREE::ParameterListIO::GetComponentCache

(

)

Definition at line 38 of file freParameterListIO.cxx.

References m_pCache.

void FREE::ParameterListIO::AddParameterLink	(	const std::string &	sName,
		const IDPath &	idPath
	)

Definition at line 55 of file freParameterListIO.cxx.

References m_Links.

void FREE::ParameterListIO::DeleteParameterLink

(

const std::string &

sName

)

Definition at line 62 of file freParameterListIO.cxx.

References m_Links.

IDPath FREE::ParameterListIO::GetParameterLink

(

const std::string &

sName

)

Returns the IDPath associated with the name. If the name was not found, an empty path will be returned.

Definition at line 69 of file freParameterListIO.cxx.

References m_Links.

void FREE::ParameterListIO::ResetParameterLinks

(

)

Definition at line 76 of file freParameterListIO.cxx.

References m_Links.

void FREE::ParameterListIO::SaveListToFile

(

const std::string &

sFileName

)

Gets the parameters via the specified links and save them in a file specified by passed file name.

Definition at line 83 of file freParameterListIO.cxx.

References FREE::ParameterCollection::AddParameter(), catchAllNPassMacro, FREE::SessionAccessor::GetParameterByIDPath(), m_Links, m_pCache, FREE::XMLStreamObject::SaveToFile(), FREE::Parameter::SetParameterName(), and throwExceptionMacro.

Here is the call graph for this function:

void FREE::ParameterListIO::LoadListFromFile

(

const std::string &

sFileName

)

Loads the specified file and gets the stored parameter values and set the paramters specified by IDPath to these values.

Definition at line 107 of file freParameterListIO.cxx.

References catchAllNPassMacro, FREE::ComponentSetup::GetComponentByIDPath(), FREE::ParameterCollection::GetParameter(), FREE::XMLStreamObject::LoadFromFile(), m_Links, m_pCache, FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), and throwExceptionMacro.

Here is the call graph for this function:

---

Member Data Documentation

SessionComponentCache* FREE::ParameterListIO::m_pCache [protected]

Pointer to a cache of the session, where the parameters are located in

Definition at line 82 of file freParameterListIO.h.

Referenced by GetComponentCache(), LoadListFromFile(), ParameterListIO(), SaveListToFile(), and SetComponentCache().

ParameterLinkMapType FREE::ParameterListIO::m_Links [protected]

Definition at line 83 of file freParameterListIO.h.

Referenced by AddParameterLink(), DeleteParameterLink(), GetParameterLink(), LoadListFromFile(), ResetParameterLinks(), and SaveListToFile().

---

The documentation for this class was generated from the following files:

• freParameterListIO.h
• freParameterListIO.cxx

---