#include <SingleParameter.hpp>

Inheritance diagram for torc::generic::SingleParameter:

Collaboration diagram for torc::generic::SingleParameter:

Data Structures
class	Factory

Public Types
typedef VisitorType < SingleParameter >	Visitor

typedef Parameter	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

typedef std::vector< Pointer >	List

typedef size_t	SizeType

typedef std::string	Name

typedef Composite< Parameter > ::Type	Type

typedef Composite< Parameter > ::Pointer	Pointer

typedef Composite< Parameter > ::List	List

typedef Composite< Parameter > ::SizeType	SizeType

Public Member Functions
virtual	~SingleParameter () throw ()

virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

const Value	getValue () const

void	setValue (const Value &inSource)

virtual const Unit	getUnit () const

virtual void	setUnit (const Unit &inSource)

virtual CompositionType	getCompositionType () const =0

virtual size_t	getSize () const =0

virtual void	getChildren (List &outChildren) const =0 throw (Error)

virtual const Pointer	get (const std::vector< SizeType > &inIndices) const =0 throw (Error)

virtual void	setParentCollection (const Pointer &inParentCollection)

virtual Pointer	getParentCollection () const

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

virtual const std::string	getName () const

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

virtual Name	getOriginalName () const

virtual void	setOriginalName (const Name &inSource)

virtual CompositionType	getCompositionType () const

virtual SizeType	getSize () const

virtual const Pointer	get (const std::vector< SizeType > &indices) const throw (Error)

virtual void	getChildren (List &outChildren) const throw (Error)

Protected Member Functions
	SingleParameter ()

Friends
class	FactoryType< SingleParameter >

Detailed Description

Represents a single parameter inSource.

Definition at line 39 of file SingleParameter.hpp.

Member Typedef Documentation

typedef Composite<Parameter >::List torc::generic::Scalar< Parameter >::List

inherited

Definition at line 41 of file Scalar.hpp.

typedef std::vector<Pointer> torc::generic::Composite< Parameter >::List

inherited

List of Shared Pointers to objects of type Type

Definition at line 61 of file Composite.hpp.

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

inherited

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

typedef Composite<Parameter >::Pointer torc::generic::Scalar< Parameter >::Pointer

inherited

Definition at line 40 of file Scalar.hpp.

typedef boost::shared_ptr<Type> torc::generic::Composite< Parameter >::Pointer

inherited

Shared Pointer to object of type Type

Definition at line 55 of file Composite.hpp.

typedef Composite<Parameter >::SizeType torc::generic::Scalar< Parameter >::SizeType

inherited

Definition at line 42 of file Scalar.hpp.

typedef size_t torc::generic::Composite< Parameter >::SizeType

inherited

Definition at line 62 of file Composite.hpp.

typedef Composite<Parameter >::Type torc::generic::Scalar< Parameter >::Type

inherited

Definition at line 39 of file Scalar.hpp.

typedef Parameter torc::generic::Composite< Parameter >::Type

inherited

Definition at line 50 of file Composite.hpp.

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

Definition at line 46 of file SingleParameter.hpp.

typedef boost::weak_ptr<Type> torc::generic::Composite< Parameter >::WeakPointer

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

torc::generic::SingleParameter::~SingleParameter	(	)
throw	(
	)

virtual

Definition at line 68 of file SingleParameter.cpp.

68 {}

torc::generic::SingleParameter::SingleParameter ( )

protected

Definition at line 66 of file SingleParameter.cpp.

66 : Parameter(), Scalar<Parameter>() {}

torc::generic::Parameter::Parameter

Parameter()

Definition: Parameter.cpp:35

Member Function Documentation

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

virtual

Receive an inoutVisitor to this class. The visit method of the inoutVisitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This situation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.

Parameters

[in,out] inoutVisitor A reference to the inoutVisitor object

Exceptions

Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Implements torc::generic::Visitable.

Definition at line 57 of file SingleParameter.cpp.

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

Here is the call graph for this function:

virtual const Pointer torc::generic::Scalar< Parameter >::get	(	const std::vector< SizeType > &	indices	)	const
throw	(	Error
	)

virtualinherited

Get a specific member of this composition.

Parameters

[in] indices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: An empty pointer is returned

Implements torc::generic::Composite< Parameter >.

virtual const Pointer torc::generic::Composite< Parameter >::get	(	const std::vector< SizeType > &	inIndices	)	const
throw	(	Error
	)

pure virtualinherited

Get a specific member of this composition.

Note: This is relevant for Vector composition only. Other compositions return a NULL pointer

Parameters

[in] inIndices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: A pointer to the child situated at the specified indices. For non-relevant types a NULL pointer is returned

Exceptions

Error Index dimensions mismatch

Implemented in torc::generic::Vector< Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false >, torc::generic::VectorBit< Parameter >, and torc::generic::Scalar< Parameter >.

virtual void torc::generic::Scalar< Parameter >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtualinherited

Get children of this composition.

Parameters

[out] outChildren A list of all children for this composition

Note: This wil return empty list for scalar

Get children of this composition.

Parameters

[out] outChildren A list of all children for this composition

Implements torc::generic::Composite< Parameter >.

virtual void torc::generic::Composite< Parameter >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

pure virtualinherited

Get children of this composition.

Note: This is relevant for Vector and Bundle compositions only. Other compositions return a NULL pointer

Parameters

[out] outChildren A list of all children for this composition

Implemented in torc::generic::Vector< Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false >, torc::generic::Scalar< Parameter >, and torc::generic::VectorBit< Parameter >.

virtual CompositionType torc::generic::Scalar< Parameter >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns: The CompositionType inSource eCompositionTypeScalar is returned

Implements torc::generic::Composite< Parameter >.

virtual CompositionType torc::generic::Composite< Parameter >::getCompositionType ( ) const

pure virtualinherited

Get the type of this composition.

Returns: Composition type for this object

Implemented in torc::generic::Vector< Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false >, torc::generic::VectorBit< Parameter >, and torc::generic::Scalar< Parameter >.

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:

virtual Pointer torc::generic::Composite< Parameter >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

Returns: A pointer to the parent collection if present, empty pointer otherwise

Pointer torc::generic::SelfReferencing< Parameter >::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

virtual SizeType torc::generic::Scalar< Parameter >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implements torc::generic::Composite< Parameter >.

virtual size_t torc::generic::Composite< Parameter >::getSize ( void ) const

pure virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implemented in torc::generic::Vector< Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false >, torc::generic::VectorBit< Parameter >, and torc::generic::Scalar< Parameter >.

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

virtualinherited

Definition at line 44 of file Parameter.cpp.

                                     {
     return mUnit;
 }

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

inlineinherited

Definition at line 71 of file Parameter.hpp.

                                              {
     return mValue;
 }

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;
 }

virtual void torc::generic::Composite< Parameter >::setParentCollection ( const Pointer & inParentCollection )

inlinevirtualinherited

Set a pointer to a parnt composition.

Parameters

[in] inParentCollection pointer to the parent collection (Vector/Bundle)

Set a pointer to a parnt composition.

Parameters

[in] parentCollection pointer to the parent collection (Vector/Bundle)

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

virtualinherited

Definition at line 48 of file Parameter.cpp.

                                             {
     mUnit = inSource;
 }

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

inherited

Definition at line 40 of file Parameter.cpp.

                                               {
     mValue = inSource;
 }

void torc::generic::SelfReferencing< Parameter >::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< SingleParameter >

friend

Definition at line 43 of file SingleParameter.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation