torc::generic::ParameterArray Class Reference

Represents a parameter array. More...

#include <ParameterArray.hpp>

Inheritance diagram for torc::generic::ParameterArray:

Collaboration diagram for torc::generic::ParameterArray:

Data Structures
class	Factory

Public Types
typedef Vector< Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false >	BaseVectorType
typedef VisitorType < ParameterArray >	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 >	BaseType
typedef BaseType::Type	Type
typedef BaseType::List	List
typedef BaseType::Pointer	Pointer
typedef BaseType::SizeType	SizeType
typedef ParameterArrayElement	ChildType
typedef boost::shared_ptr < ChildType >	ChildPointer
typedef ParameterArrayElement::Factory	ChildFactory
typedef boost::shared_ptr < ParameterArrayElement::Factory >	ChildFactorySharedPtr

Public Member Functions
virtual	~ParameterArray () 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 > &inIndices) const throw (Error)
virtual void	getChildren (List &outChildren) const throw (Error)
void	applyOnAllChildren (const _Action &action) throw (Error)
virtual void	forceAutoBlast (void) throw (Error)
virtual void	getCreatedChildren (List &outChildren) const throw (Error)
void	constructChildren (const boost::shared_ptr< ChildFactory > &inFactory, const std::vector< SizeType > &inLimits) throw (Error)
void	getLimits (std::vector< SizeType > &outLimits) const
bool	getIsPreserved () const

Protected Member Functions
virtual void	onChildCreate (const boost::shared_ptr< BaseVectorType::ChildType > &inCreatedChild) const throw (Error)
	ParameterArray ()
void	setChildren (const List &inSource) throw (Error)
virtual void	onAutoBlast () const throw (Error)
virtual void	onChildCreate (const boost::shared_ptr< ChildType > &inCreatedChild) const throw (Error)
void	setLimits (const std::vector< SizeType > &inSource)
const boost::shared_ptr < ChildFactory >	getFactory () const
void	setFactory (const boost::shared_ptr< ChildFactory > &inSource)

Friends
class	FactoryType< ParameterArray >

Detailed Description

Represents a parameter array.

The ParameterArray class represents an array of parameters.

Definition at line 42 of file ParameterArray.hpp.

Member Typedef Documentation

typedef Composite<Parameter > torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::BaseType

inherited

Definition at line 55 of file Vector.hpp.

typedef Vector<Parameter, ParameterArrayElement, ParameterArrayElement::Factory, false> torc::generic::ParameterArray::BaseVectorType

Definition at line 51 of file ParameterArray.hpp.

typedef ParameterArrayElement::Factory torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::ChildFactory

inherited

Definition at line 62 of file Vector.hpp.

typedef boost::shared_ptr<ParameterArrayElement::Factory > torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::ChildFactorySharedPtr

inherited

Definition at line 63 of file Vector.hpp.

typedef boost::shared_ptr<ChildType> torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::ChildPointer

inherited

Definition at line 61 of file Vector.hpp.

typedef ParameterArrayElement torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::ChildType

inherited

Definition at line 60 of file Vector.hpp.

typedef BaseType::List torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::List

inherited

Definition at line 57 of file Vector.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 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 BaseType::Pointer torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::Pointer

inherited

Definition at line 58 of file Vector.hpp.

typedef BaseType::SizeType torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::SizeType

inherited

Definition at line 59 of file Vector.hpp.

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

inherited

Definition at line 62 of file Composite.hpp.

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

inherited

Definition at line 50 of file Composite.hpp.

typedef BaseType::Type torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::Type

inherited

Definition at line 56 of file Vector.hpp.

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

Definition at line 52 of file ParameterArray.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::ParameterArray::~ParameterArray ( ) throw ( )

virtual

Definition at line 43 of file ParameterArray.cpp.

{}

torc::generic::ParameterArray::ParameterArray ( )

protected

Definition at line 40 of file ParameterArray.cpp.

                               : Parameter(), Vector<Parameter, ParameterArrayElement,
    ParameterArrayElement::Factory, false>() {}

Member Function Documentation

void torc::generic::ParameterArray::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 96 of file ParameterArray.cpp.

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

Here is the call graph for this function:

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::applyOnAllChildren ( const _Action &  action ) throw ( Error )

inherited

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::constructChildren ( const boost::shared_ptr< ChildFactory > &  inFactory, const std::vector< SizeType > &  inLimits  ) throw ( Error )

inlineinherited

Create list of children using the provided factory and limits

Parameters

[in]	inFactory	ChildFactory to use for construcing children
[in]	inLimits	Array dimensions

Exceptions

Error

Children could not be created

Note

setName() must have already been called before calling this method. For preserved arrays this does not actually do anything other than storing the factory and limits inside itself for later use.

Create list of children using the provided factory and limits

Parameters

[in]	inFactory	ChildFactory to use for construcing children
[in]	inLimits	Array dimensions

Exceptions

Error

Children could not be created

Note

For preserved arrays this does not actually do anything other than storing the factory and limits inside itself for later use.

virtual void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::forceAutoBlast ( void  ) throw ( Error )

virtualinherited

Force creation of VectorBit children, even if this is a preserved Vector.

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 const Pointer torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::get ( const std::vector< SizeType > &  inIndices ) const throw ( Error )

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 Id : eMessageIdErrorArrayIndexSizeMismatch Context Data Array Index Size - size_t Array Dimension Size - size_t
Error	Array index out of bounds Id : eMessageIdErrorArrayIndexOutOfBounds Context Data Array Index - size_t Array Dimension - size_t
Error	Empty Array Id : eMessageIdErrorEmptyArray Context Data Array Dimension - size_t

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

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 void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getChildren ( List &  outChildren ) const throw ( Error )

virtualinherited

Get children of this composition.

Parameters

[out]

outChildren

A list of all children for this composition

Exceptions

Error

If factory is not set and preserve is true and the vector has not been blasted, an exception is generated.

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 >.

virtual CompositionType torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns

The CompositionType inSource eCompositionTypeVector is returned

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

virtual void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getCreatedChildren ( List &  outChildren ) const throw ( Error )

virtualinherited

const boost::shared_ptr<ChildFactory> torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getFactory ( ) const

inlineprotectedinherited

Get current factory

Returns

Return ChildFactory object

Exceptions

Error

Null Child Factory Id : eMessageIdErrorNullChildfactory Context Data Child factory - ChildFactory Get current factory

Returns

Return ChildFactory object

bool torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getIsPreserved ( ) const

inlineinherited

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getLimits ( std::vector< SizeType > &  outLimits ) const

inlineinherited

Get dimensions of the array.

Parameters

[in]

outLimits

Dimensions of the vector

Get dimensions of the array.

Returns

Dimensions of the vector

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 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 >.

virtual SizeType torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::getSize ( void  ) const

virtualinherited

Get the total number of bits of the composition

Returns

Number of bits

Implements torc::generic::Composite< 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;
}

virtual void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::onAutoBlast ( ) const throw ( Error )

protectedvirtualinherited

void torc::generic::ParameterArray::onChildCreate ( const boost::shared_ptr< BaseVectorType::ChildType > &  inCreatedChild ) const throw ( Error )

protectedvirtual

Definition at line 35 of file ParameterArray.cpp.

                                                                                        {
    inCreatedChild->setName(getName());
}

virtual void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::onChildCreate ( const boost::shared_ptr< ChildType > &  inCreatedChild ) const throw ( Error )

protectedvirtualinherited

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::setChildren ( const List &  inSource ) throw ( Error )

protectedinherited

Set list of children for unpreserved vector.

Parameters

[in]

inSource

List of children

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::setFactory ( const boost::shared_ptr< ChildFactory > &  inSource )

protectedinherited

Set current factory

Parameters

[in]

inSource

ChildFactory object

void torc::generic::Vector< Parameter , ParameterArrayElement , ParameterArrayElement::Factory , cPreserve >::setLimits ( const std::vector< SizeType > &  inSource )

protectedinherited

Set dimensions of the array.

Parameters

[in]

inSource

Dimensions of the vector

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< ParameterArray >

friend

Definition at line 47 of file ParameterArray.hpp.

---

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

• ParameterArray.hpp
• ParameterArray.cpp