AFI
Advanced Forwarding Interface
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
AftDataInt Class Reference

Data class for all integers. More...

#include <AftData.h>

Inheritance diagram for AftDataInt:
AftData

Public Types

typedef std::shared_ptr
< AftDataInt
Ptr
 Pointer type for all AftData integers.
 

Public Member Functions

 AftDataInt (uint64_t newValue, uint32_t newBitLength)
 Constructor for general scalar value. More...
 
const uint64_t value () const
 
const uint32_t value32 () const
 
const uint16_t value16 () const
 
const uint8_t value8 () const
 
virtual uint32_t append (AftDataBytes &aData)
 Append contents of data object to AftDataBytes vector. More...
 
virtual const std::string dataClass () const
 
virtual std::ostream & description (std::ostream &os) const
 Append a description of the data to an output stream. More...
 
virtual int compare (const AftData &aData) const
 Compare data. More...
 
- Public Member Functions inherited from AftData
 AftData (uint32_t newBitLength)
 Base constructor for data objects. More...
 
const uint32_t bitLength () const
 
const uint32_t byteLength () const
 
bool operator== (const AftData &aData) const
 Comparator for data. More...
 

Static Public Member Functions

static AftDataInt::Ptr create (const uint8_t &newValue)
 Factory generator for general 8 bit scalar value. More...
 
static AftDataInt::Ptr create (const uint16_t &newValue)
 Factory generator for general 16 bit scalar value. More...
 
static AftDataInt::Ptr create (const uint32_t &newValue)
 Factory generator for general 32 bit scalar value. More...
 
static AftDataInt::Ptr create (const uint64_t &newValue)
 Factory generator for general 64 bit scalar value. More...
 
static AftDataInt::Ptr create (const uint64_t &newValue, uint32_t newBitLength)
 Factory generator for general scalar value. More...
 

Protected Attributes

uint64_t _value
 Scalar value of integer data.
 
- Protected Attributes inherited from AftData
uint32_t _bitLength
 Size of encapsulated data in bits.
 

Additional Inherited Members

- Protected Member Functions inherited from AftData
void setBitLength (uint32_t newBitLength)
 Set the bitlength of the data. More...
 

Detailed Description

Data class for all integers.

Constructor & Destructor Documentation

AftDataInt::AftDataInt ( uint64_t  newValue,
uint32_t  newBitLength 
)
inline

Constructor for general scalar value.

Parameters
[in]newValueScalar value to represent as data
[in]newBitLengthBitlength of the data

Member Function Documentation

virtual uint32_t AftDataInt::append ( AftDataBytes newData)
inlinevirtual

Append contents of data object to AftDataBytes vector.

Parameters
[in]dataReference to AftDataBytes vector to append to

Reimplemented from AftData.

virtual int AftDataInt::compare ( const AftData aData) const
inlinevirtual

Compare data.

Parameters
[in]aDataReference to data to compare against
Returns
Zero if data is the same

Reimplemented from AftData.

static AftDataInt::Ptr AftDataInt::create ( const uint8_t &  newValue)
inlinestatic

Factory generator for general 8 bit scalar value.

Parameters
[in]newValueScalar value to represent as data
static AftDataInt::Ptr AftDataInt::create ( const uint16_t &  newValue)
inlinestatic

Factory generator for general 16 bit scalar value.

Parameters
[in]newValueScalar value to represent as data
static AftDataInt::Ptr AftDataInt::create ( const uint32_t &  newValue)
inlinestatic

Factory generator for general 32 bit scalar value.

Parameters
[in]newValueScalar value to represent as data
static AftDataInt::Ptr AftDataInt::create ( const uint64_t &  newValue)
inlinestatic

Factory generator for general 64 bit scalar value.

Parameters
[in]newValueScalar value to represent as data
static AftDataInt::Ptr AftDataInt::create ( const uint64_t &  newValue,
uint32_t  newBitLength 
)
inlinestatic

Factory generator for general scalar value.

Parameters
[in]newValueScalar value to represent as data
virtual const std::string AftDataInt::dataClass ( ) const
inlinevirtual
Returns
String description of data type

Reimplemented from AftData.

virtual std::ostream& AftDataInt::description ( std::ostream &  os) const
inlinevirtual

Append a description of the data to an output stream.

Parameters
[in]osReference to output stream to append description to
Returns
Reference to output stream with text description of data appended

Reimplemented from AftData.

const uint64_t AftDataInt::value ( ) const
inline
Returns
Index value of data
const uint16_t AftDataInt::value16 ( ) const
inline
Returns
Index value of data as a 16 bit value
const uint32_t AftDataInt::value32 ( ) const
inline
Returns
Index value of data as a 32 bit value
const uint8_t AftDataInt::value8 ( ) const
inline
Returns
Index value of data as a 8 bit value

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