torc::generic::PropertyContainer Class Reference

Represents objects that have properties. More...

#include <PropertyContainer.hpp>

Inheritance diagram for torc::generic::PropertyContainer:

Collaboration diagram for torc::generic::PropertyContainer:

Public Member Functions
PropertySharedPtr	getProperty (const std::string &inName)
bool	setProperty (const std::string &inName, const PropertySharedPtr &inProperty)
void	getProperties (std::map< std::string, PropertySharedPtr > &outProperties) const
void	setProperties (const std::map< std::string, PropertySharedPtr > &inSource)
template<typename _Action >
void	applyOnAllProperties (const _Action &action) throw (Error)
	~PropertyContainer () throw ()

Protected Member Functions
	PropertyContainer ()

Private Member Functions
	PropertyContainer (const PropertyContainer &source)
PropertyContainer &	operator= (const PropertyContainer &source)

Private Attributes
SymTab< std::string, PropertySharedPtr >	mProperties

Detailed Description

Represents objects that have properties.

The PropertyContainer interface is generalized by classes tat need to hold one or more properties. A property is identified by name in the container.

Definition at line 39 of file PropertyContainer.hpp.

Constructor & Destructor Documentation

torc::generic::PropertyContainer::PropertyContainer ( )

protected

Definition at line 73 of file PropertyContainer.cpp.

: mProperties() {}

torc::generic::PropertyContainer::~PropertyContainer	(		)
throw	(
	)

Definition at line 75 of file PropertyContainer.cpp.

{}

torc::generic::PropertyContainer::PropertyContainer ( const PropertyContainer &  source )

private

Member Function Documentation

template<typename _Action >

void torc::generic::PropertyContainer::applyOnAllProperties ( const _Action &  action ) throw ( Error )

inline

Apply action on all properties.

Parameters

[in]

action

Action to be applied

Definition at line 113 of file PropertyContainer.hpp.

                                         {
    try {
        mProperties.applyOnAll(action);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

void torc::generic::PropertyContainer::getProperties ( std::map< std::string, PropertySharedPtr > &  outProperties ) const

inline

Get the map of all properties

Parameters

[out]

outProperties

The map of properties

Get the map of all properties

Returns

The map of properties

Definition at line 107 of file PropertyContainer.hpp.

                                                               {
    mProperties.getValueMap(outProperties);
    return;
}

Here is the call graph for this function:

PropertySharedPtr torc::generic::PropertyContainer::getProperty

(

const std::string &

inName

)

Get a property

Parameters

[in]

inName

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Get a property

Parameters

[in]

name

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Definition at line 37 of file PropertyContainer.cpp.

                                                                        {
    PropertySharedPtr property;
    if(!inName.empty()) {
        mProperties.get(inName, property);
    }
    return property;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PropertyContainer& torc::generic::PropertyContainer::operator= ( const PropertyContainer &  source )

private

void torc::generic::PropertyContainer::setProperties

(

const std::map< std::string, PropertySharedPtr > &

inSource

)

Set the map of properties

Parameters

[in]

inSource

The map of properties

Definition at line 66 of file PropertyContainer.cpp.

                                                                                          {
    std::map<std::string, PropertySharedPtr>::const_iterator it = inSource.begin();
    for(; it != inSource.end(); it++) {
        setProperty((*it).first, (*it).second);
    }
}

Here is the call graph for this function:

bool torc::generic::PropertyContainer::setProperty	(	const std::string &	inName,
		const PropertySharedPtr &	inProperty
	)

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inProperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inPoperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Definition at line 53 of file PropertyContainer.cpp.

                                         {
    if(!inName.empty()) {
        return mProperties.set(inName, inProperty);
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

SymTab<std::string, PropertySharedPtr> torc::generic::PropertyContainer::mProperties

private

Definition at line 99 of file PropertyContainer.hpp.

---

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

• PropertyContainer.hpp
• PropertyContainer.cpp