torc::generic::ParameterArray::Factory Class Reference

#include <ParameterArray.hpp>

Inheritance diagram for torc::generic::ParameterArray::Factory:

Collaboration diagram for torc::generic::ParameterArray::Factory:

List of all members.

Public Member Functions

virtual ParameterArraySharedPtr newParameterArrayPtr (const std::string &inName, const size_t &inSize, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)

virtual ParameterArraySharedPtr newParameterArrayPtr (const std::string &inName, const std::vector< size_t > &inLimits, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)

Detailed Description

Convenience class to create a parameter array.

Definition at line 65 of file ParameterArray.hpp.

Member Function Documentation

ParameterArraySharedPtr torc::generic::ParameterArray::Factory::newParameterArrayPtr	(	const std::string &	inName,
		const size_t &	inSize,
		const ChildFactorySharedPtr &	inFactory = `BaseVectorType::ChildFactorySharedPtr( new BaseVectorType::ChildFactory() )`,
		const std::string &	inOriginalName = `std::string()`
	)			throw (Error) `[virtual]`

Create a parameter array.

Parameters:

`[in]`	inName	Name of the parameter array to be created.
`[in]`	inSize	Size of the instance array.
`[in]`	inFactory	Factory for the child.
`[in]`	inOriginalName	Original name of the parameter array [optional].

Returns:: Pointer to created parameter array.

Create a parameter array.

Parameters:

`[in]`	inName	Name of the parameter array to be created.
`[in]`	inUnit	Unit of the parameter array.
`[in]`	inFactory	Factory for the child.
`[in]`	inOriginalName	Original name of the parameter array [optional].

Returns:: Pointer to created parameter array.

Definition at line 68 of file ParameterArray.cpp.

ParameterArraySharedPtr torc::generic::ParameterArray::Factory::newParameterArrayPtr	(	const std::string &	inName,
		const std::vector< size_t > &	inLimits,
		const ChildFactorySharedPtr &	inFactory = `BaseVectorType::ChildFactorySharedPtr( new BaseVectorType::ChildFactory() )`,
		const std::string &	inOriginalName = `std::string()`
	)			throw (Error) `[virtual]`

Create a parameter array.

Parameters:

`[in]`	inName	Name of the parameter array to be created.
`[in]`	inLimits	Dimensions of the vector.
`[in]`	inFactory	Factory for the child.
`[in]`	inOriginalName	Original name of the parameter array [optional].

Returns:: Pointer to created parameter array.

Create a parameter array.

Parameters:

`[in]`	inName	Name of the parameter array to be created.
`[in]`	inLimits	Dimensions of the vector.
`[in]`	inValue	Value of the parameter array.
`[in]`	inUnit	Unit of the parameter array.
`[in]`	inFactory	Factory for the child.
`[in]`	inOriginalName	Original name of the parameter array [optional].

Returns:: Pointer to created parameter array.

Definition at line 99 of file ParameterArray.cpp.

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

torc/generic/om/ParameterArray.hpp
torc/generic/om/ParameterArray.cpp


Public Member Functions
virtual ParameterArraySharedPtr	newParameterArrayPtr (const std::string &inName, const size_t &inSize, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual ParameterArraySharedPtr	newParameterArrayPtr (const std::string &inName, const std::vector< size_t > &inLimits, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)