torc::generic::Scalar< _Type > Class Template Reference
A single object with no child objects. More...
#include <Scalar.hpp>
Inheritance diagram for torc::generic::Scalar< _Type >:
Collaboration diagram for torc::generic::Scalar< _Type >:
Public Types | |
| typedef Composite< _Type >::Type | Type |
| typedef Composite< _Type >::Pointer | Pointer |
| typedef Composite< _Type >::List | List |
|
typedef Composite< _Type > ::SizeType | SizeType |
Public Member Functions | |
| virtual CompositionType | getCompositionType () const throw () |
| virtual SizeType | getSize () const throw () |
| virtual const Pointer | get (const std::vector< SizeType > &indices) const throw (Error) |
| virtual void | getChildren (List &outChildren) const throw (Error) |
Private Member Functions | |
| Scalar (const Scalar< _Type > &source) throw () | |
| Scalar< _Type > & | operator= (const Scalar< _Type > &source) throw () |
Detailed Description
template<typename _Type>
class torc::generic::Scalar< _Type >
A single object with no child objects.
Definition at line 39 of file Scalar.hpp.
Member Typedef Documentation
template<typename _Type>
| typedef Composite<_Type>::Pointer torc::generic::Scalar< _Type >::Pointer |
Shared Pointer to object of type Type
Reimplemented from torc::generic::Composite< _Type >.
Definition at line 47 of file Scalar.hpp.
template<typename _Type>
| typedef Composite<_Type>::List torc::generic::Scalar< _Type >::List |
List of Shared Pointers to objects of type Type
Reimplemented from torc::generic::Composite< _Type >.
Definition at line 48 of file Scalar.hpp.
Member Function Documentation
template<typename _Type>
| CompositionType torc::generic::Scalar< _Type >::getCompositionType | ( | ) | const throw () [inline, virtual] |
Get composition type for this object
- Returns:
- The CompositionType inSource eCompositionTypeScalar is returned
Implements torc::generic::Composite< _Type >.
Definition at line 113 of file Scalar.hpp.
template<typename _Type>
| Scalar< _Type >::SizeType torc::generic::Scalar< _Type >::getSize | ( | void | ) | const throw () [inline, virtual] |
Get the total number of bits of the composition
- Returns:
- Number of bits
Implements torc::generic::Composite< _Type >.
Definition at line 123 of file Scalar.hpp.
template<typename _Type>
| virtual const Pointer torc::generic::Scalar< _Type >::get | ( | const std::vector< SizeType > & | indices | ) | const throw (Error) [virtual] |
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
template<typename _Type>
| virtual void torc::generic::Scalar< _Type >::getChildren | ( | List & | outChildren | ) | const throw (Error) [virtual] |
Get children of this composition.
- Parameters:
-
[out] outChildren A list of all children for this composition
- Note:
- This wil return empty list for scalar
The documentation for this class was generated from the following file:
- torc/generic/om/Scalar.hpp
