torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
torc::architecture::xilinx::CompactSegmentCount Struct Reference

Encapsulation of a compact segment count in an unsigned 32-bit integer. More...

#include <XilinxDatabaseTypes.hpp>

+ Inheritance diagram for torc::architecture::xilinx::CompactSegmentCount:
+ Collaboration diagram for torc::architecture::xilinx::CompactSegmentCount:

Public Types

typedef EncapsulatedInteger
< boost::uint32_t > 
type
 Alias for the instantiated class type. More...
 
typedef boost::uint32_t pod
 Alias for the encapsulated Plain-Old-Data type. More...
 

Public Member Functions

 CompactSegmentCount (void)
 Null constructor. More...
 
 CompactSegmentCount (const pod &rhs)
 Data type constructor. More...
 
 CompactSegmentCount (const type &rhs)
 Copy constructor. More...
 
bool operator== (const type &rhs) const
 Equality operator (against encapsulated type). More...
 
bool operator== (const boost::uint32_t &rhs) const
 Equality operator. More...
 
 operator const boost::uint32_t & (void) const
 Constant cast operator. More...
 
 operator boost::uint32_t & (void)
 Non-constant cast operator. More...
 
bool isUndefined (void) const
 

Static Public Member Functions

static pod undefined (void)
 

Protected Attributes

boost::uint32_t m
 Encapsulated integer. More...
 

Detailed Description

Encapsulation of a compact segment count in an unsigned 32-bit integer.

This type supports compact segment counts between 0 and 4,294,967,295 inclusive.

Definition at line 128 of file XilinxDatabaseTypes.hpp.

Member Typedef Documentation

typedef boost::uint32_t torc::common::EncapsulatedInteger< boost::uint32_t >::pod
inherited

Alias for the encapsulated Plain-Old-Data type.

Definition at line 35 of file EncapsulatedInteger.hpp.

typedef EncapsulatedInteger<boost::uint32_t > torc::common::EncapsulatedInteger< boost::uint32_t >::type
inherited

Alias for the instantiated class type.

Definition at line 34 of file EncapsulatedInteger.hpp.

Constructor & Destructor Documentation

torc::architecture::xilinx::CompactSegmentCount::CompactSegmentCount ( void  )
inlineexplicit

Null constructor.

Definition at line 129 of file XilinxDatabaseTypes.hpp.

torc::architecture::xilinx::CompactSegmentCount::CompactSegmentCount ( const pod rhs)
inlineexplicit

Data type constructor.

Definition at line 131 of file XilinxDatabaseTypes.hpp.

torc::architecture::xilinx::CompactSegmentCount::CompactSegmentCount ( const type rhs)
inlineexplicit

Copy constructor.

Definition at line 133 of file XilinxDatabaseTypes.hpp.

Member Function Documentation

bool torc::common::EncapsulatedInteger< boost::uint32_t >::isUndefined ( void  ) const
inlineinherited

Definition at line 61 of file EncapsulatedInteger.hpp.

61 { return m == static_cast<pod>(-1); }
boost::uint32_t pod
Alias for the encapsulated Plain-Old-Data type.
torc::common::EncapsulatedInteger< boost::uint32_t >::operator boost::uint32_t & ( void  )
inlineinherited

Non-constant cast operator.

Definition at line 55 of file EncapsulatedInteger.hpp.

55 { return m; }
torc::common::EncapsulatedInteger< boost::uint32_t >::operator const boost::uint32_t & ( void  ) const
inlineinherited

Constant cast operator.

Definition at line 53 of file EncapsulatedInteger.hpp.

53 { return m; }
bool torc::common::EncapsulatedInteger< boost::uint32_t >::operator== ( const type rhs) const
inlineinherited

Equality operator (against encapsulated type).

Definition at line 49 of file EncapsulatedInteger.hpp.

49 { return m == rhs.m; }
bool torc::common::EncapsulatedInteger< boost::uint32_t >::operator== ( const boost::uint32_t &  rhs) const
inlineinherited

Equality operator.

Definition at line 51 of file EncapsulatedInteger.hpp.

51 { return m == rhs; }
static pod torc::common::EncapsulatedInteger< boost::uint32_t >::undefined ( void  )
inlinestaticinherited

Definition at line 60 of file EncapsulatedInteger.hpp.

60 { return static_cast<pod>(-1); }
boost::uint32_t pod
Alias for the encapsulated Plain-Old-Data type.

+ Here is the caller graph for this function:

Field Documentation

boost::uint32_t torc::common::EncapsulatedInteger< boost::uint32_t >::m
protectedinherited

Encapsulated integer.

Definition at line 31 of file EncapsulatedInteger.hpp.


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