torc::common::EncapsulatedInteger< T > Class Template Reference
Template base for encapsulated integers, to enforce strong typing. More...
#include <EncapsulatedInteger.hpp>
Inheritance diagram for torc::common::EncapsulatedInteger< T >:
Collaboration diagram for torc::common::EncapsulatedInteger< T >:
Public Types | |
| typedef EncapsulatedInteger< T > | type |
| Alias for the instantiated class type. | |
| typedef T | pod |
| Alias for the encapsulated Plain-Old-Data type. | |
Public Member Functions | |
| EncapsulatedInteger (void) | |
| Null constructor. | |
| EncapsulatedInteger (const type &rhs) | |
| Copy constructor. | |
| EncapsulatedInteger (const T &rhs) | |
| Copy constructor. | |
| type & | operator= (const type &rhs) |
| Assignment operator (from encapsulated type). | |
| type & | operator= (const T &rhs) |
| Assignment operator. | |
| bool | operator== (const type &rhs) const |
| Equality operator (against encapsulated type). | |
| bool | operator== (const T &rhs) const |
| Equality operator. | |
| operator const T & (void) const | |
| Constant cast operator. | |
| operator T & (void) | |
| Non-constant cast operator. | |
| bool | isUndefined (void) const |
Static Public Member Functions | |
| static pod | undefined (void) |
Protected Attributes | |
| T | m |
| Encapsulated integer. | |
Detailed Description
template<typename T>
class torc::common::EncapsulatedInteger< T >
Template base for encapsulated integers, to enforce strong typing.
Definition at line 26 of file EncapsulatedInteger.hpp.
Member Typedef Documentation
template<typename T>
| typedef EncapsulatedInteger<T> torc::common::EncapsulatedInteger< T >::type |
template<typename T>
| typedef T torc::common::EncapsulatedInteger< T >::pod |
Alias for the encapsulated Plain-Old-Data type.
Definition at line 33 of file EncapsulatedInteger.hpp.
Constructor & Destructor Documentation
template<typename T>
| torc::common::EncapsulatedInteger< T >::EncapsulatedInteger | ( | void | ) | [inline] |
template<typename T>
| torc::common::EncapsulatedInteger< T >::EncapsulatedInteger | ( | const type & | rhs | ) | [inline] |
template<typename T>
| torc::common::EncapsulatedInteger< T >::EncapsulatedInteger | ( | const T & | rhs | ) | [inline] |
Member Function Documentation
template<typename T>
| type& torc::common::EncapsulatedInteger< T >::operator= | ( | const type & | rhs | ) | [inline] |
Assignment operator (from encapsulated type).
Definition at line 43 of file EncapsulatedInteger.hpp.
template<typename T>
| type& torc::common::EncapsulatedInteger< T >::operator= | ( | const T & | rhs | ) | [inline] |
template<typename T>
| bool torc::common::EncapsulatedInteger< T >::operator== | ( | const type & | rhs | ) | const [inline] |
Equality operator (against encapsulated type).
Definition at line 47 of file EncapsulatedInteger.hpp.
template<typename T>
| bool torc::common::EncapsulatedInteger< T >::operator== | ( | const T & | rhs | ) | const [inline] |
template<typename T>
| torc::common::EncapsulatedInteger< T >::operator const T & | ( | void | ) | const [inline] |
template<typename T>
| torc::common::EncapsulatedInteger< T >::operator T & | ( | void | ) | [inline] |
Member Data Documentation
template<typename T>
T torc::common::EncapsulatedInteger< T >::m [protected] |
The documentation for this class was generated from the following file:
- torc/common/EncapsulatedInteger.hpp
