#include <Property.hpp>

Inheritance diagram for torc::generic::Property:

Collaboration diagram for torc::generic::Property:

Data Structures
class	Factory

Public Types
typedef VisitorType< Property >	Visitor

typedef std::string	Name

typedef Property	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

virtual	~Property () throw ()

const Value	getValue () const

void	setValue (const Value &inSource)

const Unit	getUnit () const

void	setUnit (const Unit &inSource)

const std::string	getOwner () const

void	setOwner (const std::string &inSource)

void	getChildren (std::map< std::string, PropertySharedPtr > &outValues) const

template<typename _Action >
void	applyOnAllChildren (const _Action &action) throw (Error)

void	setChildren (const std::map< std::string, PropertySharedPtr > &inSource)

bool	addChildProperty (const std::string &inName, const PropertySharedPtr &inProperty)

void	addComment (const std::string &comment)

const std::vector< std::string > &	getComments () const

void	setComments (const std::vector< std::string > &inSource)

virtual const std::string	getName () const

void	setName (const std::string &inSource) throw (Error)

virtual Name	getOriginalName () const

virtual void	setOriginalName (const Name &inSource)

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

Protected Member Functions
	Property ()

Private Attributes
std::string	mOwner

Unit	mUnit

Value	mValue

SymTab< std::string, PropertySharedPtr >	mChildren

Friends
class	FactoryType< Property >

Detailed Description

Represents an EDIF property. EDIF supports placing of simple and nested properties on different objects.

Definition at line 48 of file Property.hpp.

Member Typedef Documentation

typedef std::string torc::generic::Renamable::Name

inherited

Definition at line 40 of file generic/Renamable.hpp.

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< Property >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef Property torc::generic::SelfReferencing< Property >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<Property> torc::generic::Property::Visitor

Definition at line 58 of file Property.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< Property >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Property::~Property	(	)
throw	(
	)

virtual

Definition at line 43 of file Property.cpp.

43 {}

torc::generic::Property::Property ( )

protected

Definition at line 41 of file Property.cpp.

41 : Commentable(), Renamable(), SelfReferencing<Property>(), Visitable() {}

torc::generic::Commentable::Commentable

Commentable()

Definition: Commentable.cpp:49

torc::generic::Renamable::Renamable

Renamable()

Definition: generic/Renamable.cpp:39

torc::generic::Visitable::Visitable

Visitable()

Definition: Visitable.cpp:30

Member Function Documentation

void torc::generic::Property::accept	(	BaseVisitor &	inoutVisitor	)
throw	(	Error
	)

virtual

Implements torc::generic::Visitable.

Definition at line 32 of file Property.cpp.

                                                              {
     try {
         runVisitor(*this, inoutVisitor);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

bool torc::generic::Property::addChildProperty	(	const std::string &	inName,
		const PropertySharedPtr &	inProperty
	)

Add a nested property to this property

Parameters

[in]	inName	Nested property name
[in]	inProperty	Nested property

Definition at line 91 of file Property.cpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::Commentable::addComment ( const std::string & comment )

inherited

Add a comment to the object

Parameters

[in] comment The comment to add to an existing list of comments

Definition at line 36 of file Commentable.cpp.

                                                      {
     mComments.push_back(comment);
 }

template<typename _Action >

void torc::generic::Property::applyOnAllChildren	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all children.

Parameters

[in] action Action to be applied

Definition at line 207 of file Property.hpp.

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

Here is the call graph for this function:

void torc::generic::Property::getChildren ( std::map< std::string, PropertySharedPtr > & outValues ) const

inline

Get the nested properties.

Returns: map Containing properties

Get the nested properties.

Parameters

[out] outValues map Containing properties

Definition at line 203 of file Property.hpp.

                                                                                        {
     mChildren.getValueMap(outValues);
 }

Here is the call graph for this function:

const std::vector< std::string > & torc::generic::Commentable::getComments ( ) const

inlineinherited

Get the list of all comments

Returns: A list of all comments on this object

Definition at line 85 of file Commentable.hpp.

                                                                   {
     return mComments;
 }

const std::string torc::generic::Nameable::getName ( void ) const

inlinevirtualinherited

Get the object name

Returns: Name of the object

Definition at line 89 of file Nameable.hpp.

                                                {
     return mName;
 }

Here is the caller graph for this function:

Renamable::Name torc::generic::Renamable::getOriginalName ( ) const

inlinevirtualinherited

Get the new name provided for the object.

Returns: Name of the object

Definition at line 78 of file generic/Renamable.hpp.

                                                       {
     return mOriginalName;
 }

Here is the caller graph for this function:

const std::string torc::generic::Property::getOwner ( ) const

inline

Get the owner/source of this property.

Returns: string Owner of this property

Definition at line 194 of file Property.hpp.

                                                 {
     return mOwner;
 }

Pointer torc::generic::SelfReferencing< Property >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns: A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out] ptr Set to a shared pointer to this object

const Unit torc::generic::Property::getUnit ( ) const

inline

Get the Unit inSource.

Returns: Unit of property.

Definition at line 185 of file Property.hpp.

                                           {
     return mUnit;
 }

const Value torc::generic::Property::getValue ( ) const

inline

Get the Property inSource.

Returns: Value of property.

Definition at line 176 of file Property.hpp.

                                             {
     return mValue;
 }

void torc::generic::Property::setChildren ( const std::map< std::string, PropertySharedPtr > & inSource )

Set the nested properties.

Parameters

[in] inSource Map containing properties

Definition at line 77 of file Property.cpp.

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

Here is the call graph for this function:

void torc::generic::Commentable::setComments ( const std::vector< std::string > & inSource )

inherited

Get the list of all comments

Parameters

[in] inSource A list of all comments to be set on this object

Definition at line 45 of file Commentable.cpp.

                                                                   {
     mComments.insert(mComments.end(), inSource.begin(), inSource.end());
 }

void torc::generic::Nameable::setName	(	const std::string &	inSource	)
throw	(	Error
	)

inherited

Set a name for this object

Parameters

[in] inSource Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members)

Id : eMessageIdErrorEmptyItemName
Context Data
- Nameable - String

Set a name for this object

Parameters

[in] inSource Name of the object

Exceptions

Error Could not set name, because name is empty (Will be used by array members)

Definition at line 41 of file Nameable.cpp.

                                                               {
     if(inSource.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Nameable", inSource);
         throw e;
     }
     mName = inSource;
 }

Here is the call graph for this function:

void torc::generic::Renamable::setOriginalName ( const Name & inSource )

virtualinherited

Set the new name provided for the object.

Parameters

[in] inSource Name of the object

Definition at line 35 of file generic/Renamable.cpp.

                                                              {
     mOriginalName = inSource;
 }

void torc::generic::Property::setOwner ( const std::string & inSource )

Set the owner/source of this property.

Parameters

[in] inSource Owner of this property

Definition at line 68 of file Property.cpp.

                                                  {
     mOwner = inSource;
 }

void torc::generic::Property::setUnit ( const Unit & inSource )

Set the Property inSource unit.

Parameters

[in] inSource Unit of property.

Definition at line 59 of file Property.cpp.

                                            {
     mUnit = inSource;
 }

void torc::generic::Property::setValue ( const Value & inSource )

Set the Property inSource.

Parameters

[in] inSource Value of property.

Definition at line 50 of file Property.cpp.

                                              {
     mValue = inSource;
 }

void torc::generic::SelfReferencing< Property >::setWeakThis ( const WeakPointer & inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in] weakThis A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< Property >

friend

Definition at line 54 of file Property.hpp.

Field Documentation

SymTab<std::string, PropertySharedPtr> torc::generic::Property::mChildren

private

Definition at line 168 of file Property.hpp.

std::string torc::generic::Property::mOwner

private

Definition at line 165 of file Property.hpp.

Unit torc::generic::Property::mUnit

private

Definition at line 166 of file Property.hpp.

Value torc::generic::Property::mValue

private

Definition at line 167 of file Property.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation