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

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

Classes

class  Iterator
 

Public Member Functions

 Group ()
 
 Group (const Group &other)
 
bool valid () 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

The repeating group represents an array of repeating group instances, So, the class exposes corresponding services to manipulate an 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.

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

Definition at line 107 of file Group.h.

Constructor & Destructor Documentation

Group ( )

The group which refers to nothing.

Group ( const Group other)

Initializes an instance as a reference to the given repeating group.

Member Function Documentation

GroupInstance at ( size_t  index)

Accesses to the repeating group instance.

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

Accesses to the repeating group instance.

Exceptions
std::exceptionIf the index exceeds allowed bounds.
Warning
Due to performance considerations, instance is not checked for validness. The member must be used only when an instance is in the 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.

Group& operator= ( const Group other)

Reinitializes the instance as a reference to other one.

GroupInstance operator[] ( size_t  index)

Accesses to the repeating group instance.

Does NOT check the index validness.

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

Accesses to the repeating group instance.

Does NOT check the index validness.

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

Return the number of instances in the repeating group.

Warning
Due to performance considerations, instance is not checked for validness. The member must be used only when an instance is in the 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 the field delimiter to be used.

Definition at line 236 of file Group.h.

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

Appends the string representation of the message using the given delimiter.

Parameters
strThe string to which the presentation is appended.
delimiterDefines the field delimiter to be used.
bool valid ( ) const

Indicated whether the group refers to a valid instance.

Friends And Related Function Documentation

friend class MessageOperator
friend

Definition at line 226 of file Group.h.


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