torc::common::EncapsulatedInteger< T > Class Template Reference

Template base for encapsulated integers, to enforce strong typing. More...

#include <EncapsulatedInteger.hpp>

Collaboration diagram for torc::common::EncapsulatedInteger< T >:

Public Types
typedef EncapsulatedInteger< T >	type
	Alias for the instantiated class type. More...
typedef T	pod
	Alias for the encapsulated Plain-Old-Data type. More...

Public Member Functions
	EncapsulatedInteger (void)
	Null constructor. More...
	EncapsulatedInteger (const type &rhs)
	Copy constructor. More...
	EncapsulatedInteger (const T &rhs)
	Copy constructor. More...
type &	operator= (const type &rhs)
	Assignment operator (from encapsulated type). More...
type &	operator= (const T &rhs)
	Assignment operator. More...
bool	operator== (const type &rhs) const
	Equality operator (against encapsulated type). More...
bool	operator== (const T &rhs) const
	Equality operator. More...
	operator const T & (void) const
	Constant cast operator. More...
	operator T & (void)
	Non-constant cast operator. More...
bool	isUndefined (void) const

Static Public Member Functions
static pod	undefined (void)

Protected Attributes
T	m
	Encapsulated integer. More...

Friends
std::size_t	hash_value (const type &rhs)
	Return a hash value for the specified encapsulated integer. More...

Detailed Description

template<typename T>
class torc::common::EncapsulatedInteger< T >

Template base for encapsulated integers, to enforce strong typing.

Definition at line 28 of file EncapsulatedInteger.hpp.

Member Typedef Documentation

template<typename T>

typedef T torc::common::EncapsulatedInteger< T >::pod

Alias for the encapsulated Plain-Old-Data type.

Definition at line 35 of file EncapsulatedInteger.hpp.

template<typename T>

typedef EncapsulatedInteger<T> torc::common::EncapsulatedInteger< T >::type

Alias for the instantiated class type.

Definition at line 34 of file EncapsulatedInteger.hpp.

Constructor & Destructor Documentation

template<typename T>

torc::common::EncapsulatedInteger< T >::EncapsulatedInteger ( void  )

inline

Null constructor.

Definition at line 38 of file EncapsulatedInteger.hpp.

{ m = 0; }

template<typename T>

torc::common::EncapsulatedInteger< T >::EncapsulatedInteger ( const type &  rhs )

inline

Copy constructor.

Definition at line 40 of file EncapsulatedInteger.hpp.

{ m = rhs.m; }

template<typename T>

torc::common::EncapsulatedInteger< T >::EncapsulatedInteger ( const T &  rhs )

inline

Copy constructor.

Definition at line 42 of file EncapsulatedInteger.hpp.

{ m = rhs; }

Member Function Documentation

template<typename T>

bool torc::common::EncapsulatedInteger< T >::isUndefined ( void  ) const

inline

Definition at line 61 of file EncapsulatedInteger.hpp.

{ return m == static_cast<pod>(-1); }

Here is the caller graph for this function:

template<typename T>

torc::common::EncapsulatedInteger< T >::operator const T & ( void  ) const

inline

Constant cast operator.

Definition at line 53 of file EncapsulatedInteger.hpp.

{ return m; }

template<typename T>

torc::common::EncapsulatedInteger< T >::operator T & ( void  )

inline

Non-constant cast operator.

Definition at line 55 of file EncapsulatedInteger.hpp.

{ return m; }

template<typename T>

type& torc::common::EncapsulatedInteger< T >::operator= ( const type &  rhs )

inline

Assignment operator (from encapsulated type).

Definition at line 45 of file EncapsulatedInteger.hpp.

{ m = rhs.m; return *this; }

template<typename T>

type& torc::common::EncapsulatedInteger< T >::operator= ( const T &  rhs )

inline

Assignment operator.

Definition at line 47 of file EncapsulatedInteger.hpp.

{ m = rhs; return *this; }

template<typename T>

bool torc::common::EncapsulatedInteger< T >::operator== ( const type &  rhs ) const

inline

Equality operator (against encapsulated type).

Definition at line 49 of file EncapsulatedInteger.hpp.

{ return m == rhs.m; }

template<typename T>

bool torc::common::EncapsulatedInteger< T >::operator== ( const T &  rhs ) const

inline

Equality operator.

Definition at line 51 of file EncapsulatedInteger.hpp.

{ return m == rhs; }

template<typename T>

static pod torc::common::EncapsulatedInteger< T >::undefined ( void  )

inlinestatic

Definition at line 60 of file EncapsulatedInteger.hpp.

{ return static_cast<pod>(-1); }

Friends And Related Function Documentation

template<typename T>

std::size_t hash_value ( const type &  rhs )

friend

Return a hash value for the specified encapsulated integer.

Definition at line 58 of file EncapsulatedInteger.hpp.

{ return boost::hash_value(rhs.m); }

Field Documentation

template<typename T>

T torc::common::EncapsulatedInteger< T >::m

protected

Encapsulated integer.

Definition at line 31 of file EncapsulatedInteger.hpp.

---

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

• EncapsulatedInteger.hpp