evio  6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
evio::CompositeData::Data Class Reference

This class is used to provide all data when constructing a CompositeData object. More...

#include <CompositeData.h>

Public Member Functions

 Data ()
 Constructor. More...
 
void setFormatTag (uint16_t tag)
 This method sets the tag in the segment containing the format string. More...
 
void setDataTag (uint16_t tag)
 This method sets the tag in the bank containing the data. More...
 
void setDataNum (uint8_t num)
 This method sets the num in the bank containing the data. More...
 
uint16_t getFormatTag () const
 This method gets the tag in the segment containing the format string. More...
 
uint16_t getDataTag () const
 This method gets the tag in the bank containing the data. More...
 
uint8_t getDataNum () const
 This method gets the num in the bank containing the data. More...
 
uint32_t getDataSize () const
 This method gets the raw data size in bytes. More...
 
uint32_t getPadding () const
 This method gets the padding (in bytes). More...
 
void addN (uint32_t N)
 This method adds an "N" or multiplier value to the data. More...
 
void addn (uint16_t n)
 This method adds an "n" or multiplier value to the data. More...
 
void addm (uint8_t m)
 This method adds an "m" or multiplier value to the data. More...
 
void addInt (int32_t i)
 Add a signed 32 bit integer to the data. More...
 
void addInt (std::vector< int32_t > const &i)
 Add an vector of signed 32 bit integers to the data. More...
 
void addUint (uint32_t i)
 Add an unsigned 32 bit integer to the data. More...
 
void addUint (std::vector< uint32_t > const &i)
 Add an vector of unsigned 32 bit integers to the data. More...
 
void addShort (int16_t s)
 Add a 16 bit short to the data. More...
 
void addShort (std::vector< int16_t > const &s)
 Add an vector of 16 bit shorts to the data. More...
 
void addUShort (uint16_t s)
 Add an unsigned 16 bit short to the data. More...
 
void addUShort (std::vector< uint16_t > const &s)
 Add an vector of unsigned 16 bit shorts to the data. More...
 
void addLong (int64_t l)
 Add a 64 bit long to the data. More...
 
void addLong (std::vector< int64_t > const &l)
 Add an vector of 64 bit longs to the data. More...
 
void addULong (uint64_t l)
 Add an unsigned 64 bit long to the data. More...
 
void addULong (std::vector< uint64_t > const &l)
 Add an vector of unsigned 64 bit longs to the data. More...
 
void addChar (int8_t b)
 Add an 8 bit byte (char) to the data. More...
 
void addChar (std::vector< int8_t > const &b)
 Add an vector of 8 bit bytes (chars) to the data. More...
 
void addUChar (uint8_t b)
 Add an unsigned 8 bit byte (uchar) to the data. More...
 
void addUChar (std::vector< uint8_t > const &b)
 Add an vector of unsigned 8 bit bytes (uchars) to the data. More...
 
void addFloat (float f)
 Add a 32 bit float to the data. More...
 
void addFloat (std::vector< float > const &f)
 Add an vector of 32 bit floats to the data. More...
 
void addDouble (double d)
 Add a 64 bit double to the data. More...
 
void addDouble (std::vector< double > const &d)
 Add an vector of 64 bit doubles to the data. More...
 
void addString (std::string const &s)
 Add a single string to the data. More...
 
void addString (std::vector< std::string > const &s)
 Add an vector of strings to the data. More...
 

Friends

class CompositeData
 Encapsulating class needs access. More...
 

Detailed Description

This class is used to provide all data when constructing a CompositeData object.

Doing things this way keeps all internal data members self-consistent.

Constructor & Destructor Documentation

evio::CompositeData::Data::Data ( )
inline

Constructor.

Member Function Documentation

void evio::CompositeData::Data::addChar ( int8_t  b)
inline

Add an 8 bit byte (char) to the data.

Parameters
bbyte to add.

References evio::CompositeData::SingleMember::b8, evio::DataType::CHAR8, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addChar ( std::vector< int8_t > const &  b)
inline

Add an vector of 8 bit bytes (chars) to the data.

Parameters
bvector of bytes to add.

References evio::CompositeData::SingleMember::b8, evio::DataType::CHAR8, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addDouble ( double  d)
inline

Add a 64 bit double to the data.

Parameters
ddouble to add.

References evio::CompositeData::SingleMember::dbl, evio::DataType::DOUBLE64, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addDouble ( std::vector< double > const &  d)
inline

Add an vector of 64 bit doubles to the data.

Parameters
dvector of doubles to add.

References evio::CompositeData::SingleMember::dbl, evio::DataType::DOUBLE64, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addFloat ( float  f)
inline

Add a 32 bit float to the data.

Parameters
ffloat to add.

References evio::DataType::FLOAT32, evio::CompositeData::SingleMember::flt, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addFloat ( std::vector< float > const &  f)
inline

Add an vector of 32 bit floats to the data.

Parameters
fvector of floats to add.

References evio::DataType::FLOAT32, evio::CompositeData::SingleMember::flt, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addInt ( int32_t  i)
inline

Add a signed 32 bit integer to the data.

Parameters
iinteger to add.

References evio::CompositeData::SingleMember::i32, evio::DataType::INT32, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addInt ( std::vector< int32_t > const &  i)
inline

Add an vector of signed 32 bit integers to the data.

Parameters
ivector of integers to add.

References evio::CompositeData::SingleMember::i32, evio::DataType::INT32, and evio::CompositeData::DataItem::item.

void evio::CompositeData::Data::addLong ( int64_t  l)
inline

Add a 64 bit long to the data.

Parameters
llong to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::l64, and evio::DataType::LONG64.

void evio::CompositeData::Data::addLong ( std::vector< int64_t > const &  l)
inline

Add an vector of 64 bit longs to the data.

Parameters
lvector of longs to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::l64, and evio::DataType::LONG64.

void evio::CompositeData::Data::addm ( uint8_t  m)
inline

This method adds an "m" or multiplier value to the data.

It needs to be added in sequence with other data.

Parameters
mm or multiplier value

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ub8, and evio::DataType::UCHAR8.

void evio::CompositeData::Data::addN ( uint32_t  N)
inline

This method adds an "N" or multiplier value to the data.

It needs to be added in sequence with other data.

Parameters
NN or multiplier value

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ui32, and evio::DataType::UINT32.

void evio::CompositeData::Data::addn ( uint16_t  n)
inline

This method adds an "n" or multiplier value to the data.

It needs to be added in sequence with other data.

Parameters
nn or multiplier value

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::us16, and evio::DataType::USHORT16.

void evio::CompositeData::Data::addShort ( int16_t  s)
inline

Add a 16 bit short to the data.

Parameters
sshort to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::s16, and evio::DataType::SHORT16.

void evio::CompositeData::Data::addShort ( std::vector< int16_t > const &  s)
inline

Add an vector of 16 bit shorts to the data.

Parameters
svector of shorts to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::s16, and evio::DataType::SHORT16.

void evio::CompositeData::Data::addString ( std::string const &  s)
inline
void evio::CompositeData::Data::addString ( std::vector< std::string > const &  s)
inline
void evio::CompositeData::Data::addUChar ( uint8_t  b)
inline

Add an unsigned 8 bit byte (uchar) to the data.

Parameters
bunsigned byte to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ub8, and evio::DataType::UCHAR8.

void evio::CompositeData::Data::addUChar ( std::vector< uint8_t > const &  b)
inline

Add an vector of unsigned 8 bit bytes (uchars) to the data.

Parameters
bvector of unsigned bytes to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ub8, and evio::DataType::UCHAR8.

void evio::CompositeData::Data::addUint ( uint32_t  i)
inline

Add an unsigned 32 bit integer to the data.

Parameters
iunsigned integer to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ui32, and evio::DataType::UINT32.

void evio::CompositeData::Data::addUint ( std::vector< uint32_t > const &  i)
inline

Add an vector of unsigned 32 bit integers to the data.

Parameters
ivector of unsigned integers to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ui32, and evio::DataType::UINT32.

void evio::CompositeData::Data::addULong ( uint64_t  l)
inline

Add an unsigned 64 bit long to the data.

Parameters
lunsigned long to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ul64, and evio::DataType::ULONG64.

void evio::CompositeData::Data::addULong ( std::vector< uint64_t > const &  l)
inline

Add an vector of unsigned 64 bit longs to the data.

Parameters
lvector of unsigned longs to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::ul64, and evio::DataType::ULONG64.

void evio::CompositeData::Data::addUShort ( uint16_t  s)
inline

Add an unsigned 16 bit short to the data.

Parameters
sunsigned short to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::us16, and evio::DataType::USHORT16.

void evio::CompositeData::Data::addUShort ( std::vector< uint16_t > const &  s)
inline

Add an vector of unsigned 16 bit shorts to the data.

Parameters
svector of unsigned shorts to add.

References evio::CompositeData::DataItem::item, evio::CompositeData::SingleMember::us16, and evio::DataType::USHORT16.

uint8_t evio::CompositeData::Data::getDataNum ( ) const
inline

This method gets the num in the bank containing the data.

Returns
num in bank containing the data.
uint32_t evio::CompositeData::Data::getDataSize ( ) const
inline

This method gets the raw data size in bytes.

Returns
raw data size in bytes.
uint16_t evio::CompositeData::Data::getDataTag ( ) const
inline

This method gets the tag in the bank containing the data.

Returns
tag in bank containing the data.
uint16_t evio::CompositeData::Data::getFormatTag ( ) const
inline

This method gets the tag in the segment containing the format string.

Returns
tag in segment containing the format string.
uint32_t evio::CompositeData::Data::getPadding ( ) const
inline

This method gets the padding (in bytes).

Returns
padding (in bytes).
void evio::CompositeData::Data::setDataNum ( uint8_t  num)
inline

This method sets the num in the bank containing the data.

Parameters
numnum in bank containing the data.
void evio::CompositeData::Data::setDataTag ( uint16_t  tag)
inline

This method sets the tag in the bank containing the data.

Parameters
tagtag in bank containing the data.
void evio::CompositeData::Data::setFormatTag ( uint16_t  tag)
inline

This method sets the tag in the segment containing the format string.

Parameters
tagtag in segment containing the format string.

Friends And Related Function Documentation

friend class CompositeData
friend

Encapsulating class needs access.


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