f.r.e.e. - Flexible Registration and Evaluation Engine: FREE::IDPath Class Reference

`[in]`	index	Index of the component whose tag and type should be retrieved.
`[out]`	sTag	The specified component name of the IDPath, excluding a following slash.

Returns:: Type of the first path element. If the index is out of bound the return will be PTNULL.

Definition at line 81 of file freIDPath.cxx.

References m_ElementTags, m_ElementTypes, PTNULL, and Size().

Referenced by AssembleIDPath(), ChildOf(), Concat(), FREE::DispatchParameterIDPath(), GetFirstComponent(), and operator=().

Here is the call graph for this function:

IDPath::PathElementType FREE::IDPath::GetFirstComponent ( std::string & sTag ) const

Function returns the path element type of the first component within the IDPath and also passes the tag of the path element.

Parameters:

[out] sTag The first component of the IDPath, excluding a following slash.

Returns:: Type of the first path element. If the IDPath is empty the return will be PTNULL.

Definition at line 96 of file freIDPath.cxx.

References GetComponent().

Referenced by FREE::ComponentSetupBrowser::CrawlComponentByIDPath(), FREE::ComponentSetup::GetComponentByIDPath(), FREE::SessionComponentCache::GetConstCacheByIDPath(), IDPathesMatch(), and operator+().

Here is the call graph for this function:

IDPath FREE::IDPath::GetSubIDPath ( ) const

Function returns the IDPath without the first component and the seperating slash.

Returns:: the new IDPath

Definition at line 104 of file freIDPath.cxx.

References AssembleIDPath(), and Size().

Referenced by FREE::ComponentSetupBrowser::CrawlComponentByIDPath(), FREE::ComponentSetup::GetComponentByIDPath(), FREE::SessionComponentCache::GetConstCacheByIDPath(), IDPathesMatch(), and operator+().

Here is the call graph for this function:

IDPath FREE::IDPath::GetParentIDPath ( ) const

Function returns the IDPath of the preceeding element, so without the last path element.

Returns:: The parent IDPath

Definition at line 112 of file freIDPath.cxx.

References AssembleIDPath(), SetAbsolute(), and Size().

Referenced by GetParentComponentIDPath(), and operator+().

Here is the call graph for this function:

IDPath FREE::IDPath::GetParentComponentIDPath ( ) const

Function returns the IDPath of the the first preceeding element that is a component, neither a parameter nor a media component.

Returns:: The parent IDPath

Definition at line 121 of file freIDPath.cxx.

References GetParentIDPath(), IsComponentSelection(), and IsEmpty().

Referenced by FREE::SessionAccessor::GetMedia(), FREE::SetupTransform::GetParameterValueType(), and FREE::SessionAccessor::SetMedia().

Here is the call graph for this function:

IDPath FREE::IDPath::GetParameterIDPath ( ) const

Function returns the IDPath of the parameter, so the parameter element will be the relative root of the parameter path.
e.g.: /item1/subitem//1 -> /1
If no parameter is selected in this path, the returned path will be empty.

Returns:: The parameterent IDPath

Definition at line 135 of file freIDPath.cxx.

References AssembleIDPath(), m_ElementTypes, PTParameter, and Size().

Referenced by FREE::DispatchParameterIDPath().

Here is the call graph for this function:

std::string FREE::IDPath::GetParameterName ( ) const

Function returns the parameter name, if one is specified by the path.

Returns:: The parameter name. If no parameter has been specified by the path the return is an empty string

Definition at line 157 of file freIDPath.cxx.

References m_ElementTags, m_ElementTypes, and PTParameter.

Referenced by FREE::SetupTransform::GetParameterValueType(), FREE::SessionAccessor::GetValidityTag(), and FREE::SessionAccessor::GetValidityTagRequirement().

std::string FREE::IDPath::GetMediaID ( ) const

Function returns the media id, if one is specified by the path.

Returns:: The media id. If no media has been specified by the path the return is an empty string

Definition at line 171 of file freIDPath.cxx.

References m_ElementTags, m_ElementTypes, and PTMedia.

Referenced by FREE::SessionAccessor::GetMedia(), FREE::SessionAccessor::GetMediaControllerID(), FREE::SessionAccessor::GetValidityTag(), FREE::SessionAccessor::GetValidityTagRequirement(), and FREE::SessionAccessor::SetMedia().

std::string FREE::IDPath::GetComponentID ( ) const

Function returns the component ID of the last component of the path, if one is specified by the path.

Returns:: The component id. If no component has been specified by the path the return is an empty string

Definition at line 185 of file freIDPath.cxx.

References m_ElementTags, m_ElementTypes, and PTComponent.

Referenced by FREE::Adaptation::AdaptationComponent::AttributesLoadProcessing(), and FREE::Adaptation::AdaptationComponent::operator=().

IDPath FREE::IDPath::TransformIDPath ( const IDPath & origin ) const

This function transforms the ID path relative to the passed origin. If this is a relative path it will be attached to origin and all . and .. tokens at the beginning will be processed. If this is an absolute path the return is independent from the origin and will be the value of this.
Example:
this: ../Item2/Child3
origin: /Main/Item1
Result: /Main/Item2/Child3

Parameters:

[in] origin the actual path for relative path transformations.

Definition at line 328 of file freIDPath.cxx.

FREE::IDPath::operator std::string ( ) const [inline]

Definition at line 146 of file freIDPath.h.

References ToStr().

Here is the call graph for this function:

std::string FREE::IDPath::ToStr ( ) const

Definition at line 199 of file freIDPath.cxx.

References m_ElementTags, m_ElementTypes, PTAnyChild, PTAnyDescendant, PTComponent, PTMedia, PTParameter, PTParent, PTSelf, and Size().

Here is the call graph for this function:

bool FREE::IDPath::operator== ( const IDPath & path ) const

Checks if to IDPathes are specify the same element. Hence all wildcards will be processed.
E.G.: "item1/child1/grandChild2" == ".//item1//grandChild2" is true

Definition at line 231 of file freIDPath.cxx.

References IDPathesMatch().

Referenced by ChildOf().

Here is the call graph for this function:

bool FREE::IDPath::Equals ( const IDPath & path ) const

Compares to IDPathes for real equality. So its a string compare of their string conversion

Definition at line 238 of file freIDPath.cxx.

References ToStr().

Here is the call graph for this function:

bool FREE::IDPath::ChildOf ( const IDPath & path ) const

Compares if this is a child of the passed IDPath.

Definition at line 245 of file freIDPath.cxx.

References GetComponent(), operator==(), PTAnyChild, PTMedia, PTNULL, and PTParameter.

Here is the call graph for this function:

IDPath & FREE::IDPath::operator= ( const IDPath & path )

Definition at line 263 of file freIDPath.cxx.

References AddComponent(), GetComponent(), IsAbsolute(), m_bAbsolute, Reset(), and Size().

Here is the call graph for this function:

IDPath & FREE::IDPath::operator= ( const std::string & path )

Definition at line 283 of file freIDPath.cxx.

References AddComponent(), GetComponentType(), GetFirstToken(), Reset(), SetAbsolute(), TTComponent, and TTSlash.

Here is the call graph for this function:

IDPath & FREE::IDPath::operator= ( const char * path )

Definition at line 319 of file freIDPath.cxx.

IDPath FREE::IDPath::operator+ ( const IDPath & modPath ) const

This funcion concates to ID pathes together.
The passed path will be handled as selction modifier for the actual path. Hence the type of the IDPath will influence the way of concatination:

modPath is absolut: The result will be modPath, because it skips the actual selection.
modPath is relativ: modPath will be added at the end, but all preceeding "." or ".." will be processed (eg.: "item1/child2/grand3" + "./../grand5" will result in "item1/child2/grand5").

Parameters:

[in] path The IDPath to be added.

Returns:: the new IDPath

Definition at line 335 of file freIDPath.cxx.

References Concat(), GetFirstComponent(), GetParentIDPath(), GetSubIDPath(), IsAbsolute(), PTParent, and PTSelf.

Here is the call graph for this function:

IDPath FREE::IDPath::Concat	(	const IDPath &	path1,
		const IDPath &	path2
	)			`[static]`

Concanates two pathes without path processing.

Definition at line 358 of file freIDPath.cxx.

References AddComponent(), GetComponent(), and Size().

Referenced by operator+().

Here is the call graph for this function:

void FREE::IDPath::Reset ( ) [virtual]

Resets the object to default/initial state

Reimplemented from FREE::XMLStreamObject.

Definition at line 399 of file freIDPath.cxx.

References m_bAbsolute, m_ElementTags, and m_ElementTypes.

Referenced by FREE::AccuracySOMetric< VImageDimension >::AccuracySOMetric(), FREE::AccuracySOMetricThread< VImageDimension >::AccuracySOMetricThread(), IDPath(), FREE::ImageClassificationSOMetric< VImageDimension >::ImageClassificationSOMetric(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ImageClassificationSOMetricThread(), FREE::ImageDifferenceSOMetric< VImageDimension >::ImageDifferenceSOMetric(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ImageDifferenceSOMetricThread(), operator=(), and FREE::ComponentMediaLink::Reset().

IDPath FREE::IDPath::Parameter	(	const std::string &	sParameterName,
		unsigned long	lValueID = `0`,
		unsigned long	lLayerID = `0`
	)			`[static]`

Static function that generates a relative IDPath of the specified parameter.
E.g.: Parameter("Param1",0,1) will result in the path "@Param1/0/1".

Parameters:

`[in]`	sParameterName	Name of the parameter
`[in]`	lValueID	ID/position of the value (Default is 0)
`[in]`	lLayerID	Layer of the value (Default is 0)

Returns:: Corresponding relative IDPath

Definition at line 562 of file freIDPath.cxx.

References AddComponent(), PTComponent, PTParameter, SetAbsolute(), and FREE::Convert::ToStr().

Referenced by FREE::EvolutionaryStrategySOOptimizerController::ActualizeMainComponent().

Here is the call graph for this function:

IDPath FREE::IDPath::Media ( const std::string & sMediaName ) [static]

Static function that generates a relative IDPath of the specified media

Parameters:

[in] sMediaName Name of the media

Returns:: Corresponding relative IDPath

Definition at line 583 of file freIDPath.cxx.

References AddComponent(), PTMedia, and SetAbsolute().

Here is the call graph for this function:

void FREE::IDPath::SubElementLoadProcessing	(	const std::string &	rsXMLSubTag,
		const std::string &	rsXMLSubElement,
		const std::string &	rsXMLSubData
	)			`[protected, virtual]`

Reimplemented from FREE::XMLStreamObject.

Definition at line 408 of file freIDPath.cxx.

std::string FREE::IDPath::SaveData	(	const unsigned int &	iDepth,
		bool &	bHasSubElements
	)			const `[protected, virtual]`

Reimplemented from FREE::XMLStreamObject.

Definition at line 415 of file freIDPath.cxx.

References ToStr().

Here is the call graph for this function:

IDPath FREE::IDPath::AssembleIDPath	(	const unsigned int &	iFirstID,
		const unsigned int &	iLastID
	)			const `[protected]`

Function assambles an IDPath out of the actual IDPath, by starting with the element specified by firstID and concatenates all components untill the lastId is reached.

Parameters:

`[in]`	iFirstID	ID of the first component in the new IDPath.
`[in]`	iLastID	ID of the last component that should be encluded in the new IDPath.

Returns:: the newly assempled IDPath.

Definition at line 423 of file freIDPath.cxx.

References AddComponent(), GetComponent(), SetAbsolute(), and Size().

Referenced by GetParameterIDPath(), GetParentIDPath(), and GetSubIDPath().

Here is the call graph for this function:

bool FREE::IDPath::IDPathesMatch	(	const IDPath &	left,
		const IDPath &	right
	)			`[static, protected]`

Definition at line 446 of file freIDPath.cxx.

References GetFirstComponent(), GetSubIDPath(), IsEmpty(), PTAnyChild, and PTAnyDescendant.

Referenced by operator==().

Here is the call graph for this function:

bool FREE::IDPath::GetFirstToken	(	const std::string &	sIDPath,
		TokenType &	token,
		std::string &	sFirstTag,
		std::string &	sSubPath
	)			`[static, protected]`

Function returns the token type of the first component within the IDPath and also passes the string by sFirstComponent.

Parameters:

`[in]`	sIDPath	The IDPath which should be parsed.
`[out]`	sFirstTag	The first component tag of the IDPath, excluding a following slash.
`[out]`	sSubPath	Rest of the parsed path.
`[out]`	token	Token type of the first token.

Returns:: Indicates of there is any token. Only false if sIDPath is an empty string.

Remarks:: If the token type is a slash sFirstTag == "". If the token type is double slash the sFirstTag == "/".

Definition at line 491 of file freIDPath.cxx.

References TTComponent, TTDDot, TTDot, TTDSlash, TTSlash, and TTWildcard.

Referenced by operator=().

IDPath::PathElementType FREE::IDPath::GetComponentType	(	const std::string &	sTokenTag,
		std::string &	sComponentID
	)			`[static, protected]`

Checkes if the passed component token is a component, an attribute or a media definition. returns the corresponding path element type and the plain ID of the component (without the axes declarators @ or #)

Parameters:

`[in]`	sTokenFlag	the whole string tag of the token.
`[out]`	sComponentID	the ID of t

Definition at line 520 of file freIDPath.cxx.

References PTComponent, PTMedia, PTParameter, and throwStaticExceptionMacro.

Referenced by operator=().

PathElementTypeVector FREE::IDPath::m_ElementTypes [protected]

Definition at line 249 of file freIDPath.h.

Referenced by AddComponent(), GetComponent(), GetComponentID(), GetMediaID(), GetParameterIDPath(), GetParameterName(), IsEmpty(), IsMediaSelection(), IsParameterSelection(), Reset(), Size(), and ToStr().

STLStringVector FREE::IDPath::m_ElementTags [protected]

Definition at line 250 of file freIDPath.h.

Referenced by AddComponent(), GetComponent(), GetComponentID(), GetMediaID(), GetParameterName(), Reset(), and ToStr().

bool FREE::IDPath::m_bAbsolute [protected]

Indicates if the IDPath is absolute or relative.

Definition at line 253 of file freIDPath.h.

Referenced by IsAbsolute(), operator=(), Reset(), and SetAbsolute().


Public Types
enum	PathElementType { PTNULL = 0, PTSelf = 1, PTParent = 2, PTAnyChild = 3, PTAnyDescendant = 4, PTComponent = 5, PTParameter = 6, PTMedia = 7 }
Public Member Functions
bool	IsEmpty () const
bool	IsAbsolute () const
bool	IsRoot () const
void	SetAbsolute (const bool &bAbsolute)
bool	IsParameterSelection () const
bool	IsMediaSelection () const
bool	IsComponentSelection () const
unsigned int	Size () const
unsigned int	AddComponent (const PathElementType &elementType, const std::string &sTag)
PathElementType	GetComponent (const unsigned int &index, std::string &sTag) const
PathElementType	GetFirstComponent (std::string &sTag) const
IDPath	GetSubIDPath () const
IDPath	GetParentIDPath () const
IDPath	GetParentComponentIDPath () const
IDPath	GetParameterIDPath () const
std::string	GetParameterName () const
std::string	GetMediaID () const
std::string	GetComponentID () const
IDPath	TransformIDPath (const IDPath &origin) const
	operator std::string () const
std::string	ToStr () const
bool	operator== (const IDPath &path) const
bool	Equals (const IDPath &path) const
bool	ChildOf (const IDPath &path) const
IDPath &	operator= (const IDPath &path)
IDPath &	operator= (const std::string &path)
IDPath &	operator= (const char *path)
IDPath	operator+ (const IDPath &modPath) const
	IDPath ()
	IDPath (const IDPath &path)
	IDPath (const std::string &path)
	IDPath (const char *path)
	~IDPath ()
virtual void	Reset ()
Static Public Member Functions
static IDPath	Concat (const IDPath &path1, const IDPath &path2)
static IDPath	Parameter (const std::string &sParameterName, unsigned long lValueID=0, unsigned long lLayerID=0)
static IDPath	Media (const std::string &sMediaName)
Protected Types
enum	TokenType { TTSlash = 0, TTDot = 1, TTDDot = 2, TTWildcard = 3, TTDSlash = 4, TTComponent = 5 }
typedef std::vector < PathElementType >	PathElementTypeVector
Protected Member Functions
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
IDPath	AssembleIDPath (const unsigned int &iFirstID, const unsigned int &iLastID) const
Static Protected Member Functions
static bool	IDPathesMatch (const IDPath &left, const IDPath &right)
static bool	GetFirstToken (const std::string &sIDPath, TokenType &token, std::string &sFirstTag, std::string &sSubPath)
static PathElementType	GetComponentType (const std::string &sTokenTag, std::string &sComponentID)
Protected Attributes
PathElementTypeVector	m_ElementTypes
STLStringVector	m_ElementTags
bool	m_bAbsolute

FREE::IDPath Class Reference
[Setup, Controller profile]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

FREE::IDPath Class Reference [Setup, Controller profile]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

FREE::IDPath Class Reference
[Setup, Controller profile]