IceProperties::InheritanceSolver Class Reference

#include <ArmarXCore/core/application/properties/IceProperties.h>

Inheritance diagram for IceProperties::InheritanceSolver:

Public Types
using	NamespaceMap = std::map<std::string, bool>

Public Member Functions
void	extractNamespaces (const Ice::PropertiesPtr &properties, NamespaceMap &namespaces)
	Extracts all existing namespace within the passed property container.
std::string	getParent (const std::string &childNamespace, const Ice::PropertiesPtr &properties)
	Returns the parent namespace of a child namespace.
bool	hasParent (const std::string &childNamespace, const Ice::PropertiesPtr &properties)
	Checks whether the specified namespace has a parent which it inherits from.
void	inherit (const std::string &childNamespace, const std::string &parentNamespace, Ice::PropertiesPtr &properties, std::vector< std::string > heritageLine)
	Performs the inheritance of properties from parentNamespace to childNamespace.
bool	isInHeritageLine (const std::vector< std::string > &heritageLine, const std::string &namespace_)
	Checks whether the specified namespace exists already in the heritageLine.
void	resolveInheritance (Ice::PropertiesPtr &properties)
	Resolves all inheritance specifications made using the config notation "<namespace>.inheritFrom = <namespace>" while <namespace> is <domain>.
void	resolveNamespaceInheritance (const std::string &childNamespace, Ice::PropertiesPtr &properties)
	Resolves namespace inheritance for a specific namespace.
std::string	stripNamespace (const std::string &propertyName, const std::string &namespace_)
	Removes the namespace of the property name.
	~InheritanceSolver () override

Member Typedef Documentation

NamespaceMap

using NamespaceMap = std::map<std::string, bool>

Constructor & Destructor Documentation

~InheritanceSolver()

~InheritanceSolver ( )

override

Member Function Documentation

extractNamespaces()

void extractNamespaces	(	const Ice::PropertiesPtr &	properties,
		NamespaceMap &	namespaces )

Extracts all existing namespace within the passed property container.

More simply it extracts all existing prefixes.

Parameters

[in]	properties	Input property container
[out]	namespaces	Extracted properties

getParent()

std::string getParent	(	const std::string &	childNamespace,
		const Ice::PropertiesPtr &	properties )

Returns the parent namespace of a child namespace.

Parameters

[in]	childNamespace	Child namespace.
[in]	properties	Input properties containing inheritance specifications.

Returns

parent namespace, otherwise an empty string

hasParent()

bool hasParent	(	const std::string &	childNamespace,
		const Ice::PropertiesPtr &	properties )

Checks whether the specified namespace has a parent which it inherits from.

The inheritance is specified via a property as follows: <childNamespace>.inheritFrom = <parentNamespace>.

<childNamespace> can be anything. Usually it consists of the <domain> and <object-name>.

Parameters

[in]	childNamespace	Child namespace.
[in]	properties	Input properties containing inheritance specifications.

inherit()

void inherit	(	const std::string &	childNamespace,
		const std::string &	parentNamespace,
		Ice::PropertiesPtr &	properties,
		std::vector< std::string >	heritageLine )

Performs the inheritance of properties from parentNamespace to childNamespace.

Parameters

[in]	childNamespace	Namespace requiring inheritance
[in]	parentNamespace	Parent namespace to inherit from.
	properties	Input and output properties
	heritageLine	Heritage line vector. This is used to detect inheritance cycles.

isInHeritageLine()

bool isInHeritageLine	(	const std::vector< std::string > &	heritageLine,
		const std::string &	namespace_ )

Checks whether the specified namespace exists already in the heritageLine.

Parameters

[in]	heritageLine	Heritage line vector
[in]	namespace	The namespace to look for

Returns

true if namespace is in heritageLine, otherwise false

resolveInheritance()

void resolveInheritance

(

Ice::PropertiesPtr &

properties

)

Resolves all inheritance specifications made using the config notation "<namespace>.inheritFrom = <namespace>" while <namespace> is <domain>.

<object-name>.

Parameters

properties

The properties with inheritance specifications. The resolved inheritance is done within this property contain as well.

resolveNamespaceInheritance()

void resolveNamespaceInheritance	(	const std::string &	childNamespace,
		Ice::PropertiesPtr &	properties )

Resolves namespace inheritance for a specific namespace.

This will resolve all inheritance specifications of it's parent namespace.

Parameters

[in]	childNamespace	Namespace requiring inheritance
	properties	Input and output properties

stripNamespace()

std::string stripNamespace	(	const std::string &	propertyName,
		const std::string &	namespace_ )

Removes the namespace of the property name.

"<namespace>.<property-name> = <propertyValue>" becomes "<property-name> = <property-value>".

Returns

property name without the namespace.

---

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

• ArmarXCore/core/application/properties/IceProperties.h
• ArmarXCore/core/application/properties/IceProperties.cpp