EPAM B2BITS C++ Bovespa MarketData handler  1.28.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
B2bits::MD::FIXGroup Class Reference

#include <b2bits/fix/FIXGroup.h>

Public Member Functions

bool isNull () const
 
bool get (int tag, FIXFieldValue *value, int index) const
 
int size () const
 
int leadingField () const
 
bool isSupported (int tag) const
 
const FIXGroup getGroup (int tag, int index) const
 
bool hasFlag (int tag, int index) const
 
i64 getAsInt64 (int tag, int index) const
 
u64 getAsUInt64 (int tag, int index) const
 
i32 getAsInt32 (int tag, int index) const
 
u32 getAsUInt32 (int tag, int index) const
 
int getAsInt (int tag, int index) const
 
unsigned int getAsUInt (int tag, int index) const
 
double getAsDouble (int tag, int index) const
 
Decimal getAsDecimal (int tag, int index) const
 
char getAsChar (int tag, int index) const
 
AsciiString getAsString (int tag, int index) const
 
ByteArray getAsRaw (int tag, int index) const
 
bool getAsBoolean (int tag, int index) const
 
MonthYear getAsMonthYear (int tag, int index) const
 
LocalMktDate getAsLocalMktDate (int tag, int index) const
 
UTCDateOnly getAsDateOnly (int tag, int index) const
 
UTCTimeOnly getAsTimeOnly (int tag, int index) const
 
UTCTimestamp getAsTimestamp (int tag, int index) const
 
bool isEqual (int tag, int index, TagValue const &rv, int rvTag) const
 
bool isEmpty (int tag, int index) const
 
bool hasValue (int tag, int index) const
 
const TagValue getEntry (int index) const
 

Friends

struct FIXFactory
 

Detailed Description

FIX Repeating Group interface.

Member Function Documentation

bool B2bits::MD::FIXGroup::get ( int  tag,
FIXFieldValue value,
int  index 
) const

Retrieves field value by tag number and entry's index and stores it into instance of FIXFieldValue class.

Parameters
indexgroup's entry index (starts at 0).
tagFIX field tag to get data from.
[out]valuepointer to the FIXFieldValue object to store data. Cannot be NULL.
Returns
"false", if the given tag defined for the group (according to the FIX protocol), but not present in requested group's entry. "true", if the given tag present in requested group's entry.
Exceptions
std:exceptionif tag not defined by FIX protocol for the group or entry index is invalid.
bool B2bits::MD::FIXGroup::getAsBoolean ( int  tag,
int  index 
) const

Returns value as bool

Returns
value of the field
char B2bits::MD::FIXGroup::getAsChar ( int  tag,
int  index 
) const

Returns value as double

Returns
value of the field
UTCDateOnly B2bits::MD::FIXGroup::getAsDateOnly ( int  tag,
int  index 
) const
Decimal B2bits::MD::FIXGroup::getAsDecimal ( int  tag,
int  index 
) const
double B2bits::MD::FIXGroup::getAsDouble ( int  tag,
int  index 
) const

Returns value as double

Returns
value of the field
int B2bits::MD::FIXGroup::getAsInt ( int  tag,
int  index 
) const
i32 B2bits::MD::FIXGroup::getAsInt32 ( int  tag,
int  index 
) const
i64 B2bits::MD::FIXGroup::getAsInt64 ( int  tag,
int  index 
) const
LocalMktDate B2bits::MD::FIXGroup::getAsLocalMktDate ( int  tag,
int  index 
) const
MonthYear B2bits::MD::FIXGroup::getAsMonthYear ( int  tag,
int  index 
) const
ByteArray B2bits::MD::FIXGroup::getAsRaw ( int  tag,
int  index 
) const

Returns value as byte array

Returns
value of the field
AsciiString B2bits::MD::FIXGroup::getAsString ( int  tag,
int  index 
) const

Returns value as string

Returns
value of the field
UTCTimeOnly B2bits::MD::FIXGroup::getAsTimeOnly ( int  tag,
int  index 
) const
UTCTimestamp B2bits::MD::FIXGroup::getAsTimestamp ( int  tag,
int  index 
) const
unsigned int B2bits::MD::FIXGroup::getAsUInt ( int  tag,
int  index 
) const
u32 B2bits::MD::FIXGroup::getAsUInt32 ( int  tag,
int  index 
) const
u64 B2bits::MD::FIXGroup::getAsUInt64 ( int  tag,
int  index 
) const
const TagValue B2bits::MD::FIXGroup::getEntry ( int  index) const

Returns group entry by index

Returns
group entry by index
const FIXGroup B2bits::MD::FIXGroup::getGroup ( int  tag,
int  index 
) const

Returns nested repeating group. The nested FIXGroup instance's memory is managed by FIX Engine. FIXGroup instance is guaranteed to exist within it's parent FIXMessage's lifetime or until trimming to zero length.

Parameters
indexgroup's entry index (starts at 0).
tagTag number of the leading field value.
Returns
Returned value may be NULL, if the given tag exists for the group (according to the FIX protocol), but not present in requested group's entry. If the tag not defined for the group then the method throws an exception. When you don't need returned value call release() to cleanup resources.
Exceptions
std:exceptionif tag not defined for the group or entry index is invalid.
bool B2bits::MD::FIXGroup::hasFlag ( int  tag,
int  index 
) const
bool B2bits::MD::FIXGroup::hasValue ( int  tag,
int  index 
) const

Returns true if value value is defined; false otherwise.

bool B2bits::MD::FIXGroup::isEmpty ( int  tag,
int  index 
) const

Returns true if value of the field is empty; false otherwise.

bool B2bits::MD::FIXGroup::isEqual ( int  tag,
int  index,
TagValue const &  rv,
int  rvTag 
) const
bool B2bits::MD::FIXGroup::isNull ( ) const
inline

Returns true if underlying is null

Returns
true if underlying is null
bool B2bits::MD::FIXGroup::isSupported ( int  tag) const

Verifies is field acceptable inside this group

Parameters
tagTag number of the field to verify.
Returns
"true" if field supported by this group, otherwise returns false.
int B2bits::MD::FIXGroup::leadingField ( ) const

Returns the leading field tag of the repeating group

Returns
Leading field tag of the repeating group .
int B2bits::MD::FIXGroup::size ( ) const

Returns the number of entries in this repeating group

Returns
Number of entries in this repeating group.

Friends And Related Function Documentation

friend struct FIXFactory
friend