OnixS C++ FIX Engine  4.1.0
API Documentation
Group Class Reference

#include <OnixS/FIXEngine/FIX/Group.h>

Classes

class  Iterator
 

Public Member Functions

 Group ()
 
 Group (const Group &other)
 
 operator bool () const
 
size_t size () const
 
GroupInstance at (size_t index)
 
const GroupInstance at (size_t index) const
 
GroupInstance operator[] (size_t index)
 
const GroupInstance operator[] (size_t index) const
 
Groupoperator= (const Group &other)
 
void swap (Group &other)
 
std::string toString (char delimiter=0x1) const
 
void toString (std::string &str, char delimiter=0x1) const
 
Iterator begin ()
 
Iterator end ()
 

Friends

class MessageOperator
 

Detailed Description

Repeating group represents array of repeating group instances, So, class exposes corresponding services to manipulate array of repeating group instances. Similar to the OnixS::FIX::GroupInstance it behaves like a pointer/reference to the underlying data. It's a light-weight object which just wraps internal data.

Group remains valid until corresponding field (which defines size/length of repeating group) from field-set (message or outer repeating group instance) is updated.

Definition at line 107 of file Group.h.

Constructor & Destructor Documentation

Group ( )

Group which refers to nothing.

Group ( const Group other)

Initializes instance as reference to given repeating group.

Member Function Documentation

GroupInstance at ( size_t  index)

Accesses to repeating group instance.

Exceptions
std::exceptionif If index exceeds allowed bounds.
Warning
Due to performance considerations, instance is not checked for validness. Member must be used only when instance is in valid state.
const GroupInstance at ( size_t  index) const

Accesses to repeating group instance.

Exceptions
std::exceptionif If index exceeds allowed bounds.
Warning
Due to performance considerations, instance is not checked for validness. Member must be used only when instance is in valid state.
Iterator begin ( )

Returns the iterator to the first group instance in the group.

Iterator end ( )

Returns the iterator to the group instance after the last one in the group.

operator bool ( ) const

Indicated whether group refers to a valid instance.

Group& operator= ( const Group other)

Reinitializes instance as reference to other one.

GroupInstance operator[] ( size_t  index)

Accesses to repeating group instance.

Does NOT check index validness.

Warning
Due to performance considerations, instance is not checked for validness. Member must be used only when instance is in valid state.
const GroupInstance operator[] ( size_t  index) const

Accesses to repeating group instance.

Does NOT check index validness.

Warning
Due to performance considerations, instance is not checked for validness. Member must be used only when instance is in valid state.
size_t size ( ) const

Return number of instances in repeating group.

Warning
Due to performance considerations, instance is not checked for validness. Member must be used only when instance is in valid state.
void swap ( Group other)

Swaps two instances.

std::string toString ( char  delimiter = 0x1) const
inline

Returns the string representation of the group using the given delimiter.

Parameters
delimiterDefines field delimiter to be used.

Definition at line 230 of file Group.h.

void toString ( std::string &  str,
char  delimiter = 0x1 
) const

Appends string representation of the message using the given delimiter.

Parameters
strString to which presentation is appended.
delimiterDefines field delimiter to be used.

Friends And Related Function Documentation

friend class MessageOperator
friend

Definition at line 220 of file Group.h.


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