Engine::FIXGroup Class Reference

FIX Repeating Group interface. More...

#include <B2BITS_FIXGroup.h>

List of all members.

Public Member Functions
	FIXGroup ()
	Default constructor.
virtual const std::string *	get (int tag, int index) const =0
	Returns field value by tag number and entry's index.
virtual bool	get (int tag, FIXFieldValue *value, int index) const =0
	Retrives field value by tag number and entry's index and stores it into instance of FIXFieldValue class.
virtual bool	getAsBoolean (int tag, int index) const =0
	Returns value as byte array.
virtual char	getAsChar (int tag, int index) const =0
	Returns value as double.
virtual Engine::UTCDateOnly	getAsDateOnly (int tag, int index) const =0
virtual Decimal	getAsDecimal (int tag, int index) const =0
virtual double	getAsDouble (int tag, int index) const =0
	Returns value as double.
virtual int	getAsInt (int tag, int index) const =0
virtual System::i32	getAsInt32 (int tag, int index) const =0
virtual System::i64	getAsInt64 (int tag, int index) const =0
virtual Engine::LocalMktDate	getAsLocalMktDate (int tag, int index) const =0
virtual Engine::MonthYear	getAsMonthYear (int tag, int index) const =0
virtual ByteArray	getAsRaw (int tag, int index) const =0
	Returns value as byte array.
virtual AsciiString	getAsString (int tag, int index) const =0
	Returns value as string.
virtual Engine::UTCTimeOnly	getAsTimeOnly (int tag, int index) const =0
virtual Engine::UTCTimestamp	getAsTimestamp (int tag, int index) const =0
virtual unsigned int	getAsUInt (int tag, int index) const =0
virtual System::u32	getAsUInt32 (int tag, int index) const =0
virtual System::u64	getAsUInt64 (int tag, int index) const =0
virtual TagValue const *	getEntry (int index) const =0
	Returns group entry by index.
virtual TagValue *	getEntry (int index)=0
	Returns group entry by index.
virtual FixFieldsContainer *	getFields () const =0
	Returns list of the message fields and their values.
virtual FIXGroup *	getGroup (int tag, int index)=0
	Returns nested repeating group.
virtual FIXGroup const *	getGroup (int tag, int index) const =0
virtual bool	hasFlag (int tag, int index) const =0
virtual bool	isEmpty (int tag, int index) const =0
virtual bool	isEqual (int tag, int index, TagValue const *rv, int rvTag) const =0
virtual bool	isSupported (int tag) const
	Verifies is field acceptable inside this group.
virtual int	leadingField () const =0
	Returns the leading field tag of the repeating group.
virtual bool	remove (int tag, int index)=0
	Removes field, defined by input tag, from the given entry.
virtual bool	set (int tag, bool value, int index)=0
virtual bool	set (int tag, ByteArray value, int index)=0
virtual bool	set (int tag, AsciiString value, int index)=0
virtual bool	set (int tag, Decimal value, int index)=0
virtual bool	set (int tag, double value, int index)=0
virtual bool	set (int tag, Engine::MonthYear value, int index)=0
	Assignes value to the field, defined by tag and entry index.
virtual bool	set (int tag, System::u64 value, int index)=0
virtual bool	set (int tag, Engine::UTCTimeOnly value, int index)=0
virtual bool	set (int tag, System::i64 value, int index)=0
virtual bool	set (int tag, System::i32 value, int index)=0
bool	set (int tag, char const *value, int index)
virtual bool	set (int tag, Engine::LocalMktDate value, int index)=0
virtual bool	set (int tag, const std::string &value, int index)=0
	Assignes value to the field, defined by tag and entry index.
virtual bool	set (int tag, System::u32 value, int index)=0
virtual bool	set (int tag, Engine::UTCTimestamp value, int index)=0
virtual bool	set (int tag, Engine::UTCDateOnly value, int index)=0
virtual bool	set (int tag, const FIXFieldValue &value, int index)=0
	Assignes value to the field, defined by tag and entry index.
virtual bool	set (int tag, char value, int index)=0
virtual int	size () const =0
	Returns the number of entries in this repeating group.
virtual void	write (int tag, std::ostream &out, int index) const =0
Static Public Member Functions
static void	release (FIXGroup *pGroup)
	Releases resources used by the given group instance.
static void	release (FIXGroup const *pGroup)
	Releases resources used by the given group instance.
Protected Member Functions
virtual	~FIXGroup ()
	Destructor.

---

Detailed Description

FIX Repeating Group interface.

Definition at line 63 of file B2BITS_FIXGroup.h.

---

Constructor & Destructor Documentation

Engine::FIXGroup::FIXGroup

(

)

Default constructor.

virtual Engine::FIXGroup::~FIXGroup

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

virtual const std::string* Engine::FIXGroup::get	(	int	tag,
		int	index
	)		const [pure virtual]

Returns field value by tag number and entry's index.

Parameters:

index	group's entry index (starts at 0).
tag	FIX field tag to get data from.

Returns:

Returned value may be NULL, if the given tag defined 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.

Warning:

The returned buffer is shared for all calls. This means stored content is valid untill the next call of the get(). Can return NULL.

Exceptions:

Utils::Exception

if tag not defined for the group or entry index is invalid.

Deprecated:

Use get( int, FIXFieldValue *, int) const instead.

See also:

get( int, FIXFieldValue *, int) const

virtual bool Engine::FIXGroup::get	(	int	tag,
		FIXFieldValue *	value,
		int	index
	)		const [pure virtual]

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

Parameters:

	index	group's entry index (starts at 0).
	tag	FIX field tag to get data from.
[out]	value	pointer to the FIXFieldValue object to store data. Can't 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:

Utils::Exception

if tag not defined by FIX protocol for the group or entry index is invalid.

virtual bool Engine::FIXGroup::getAsBoolean	(	int	tag,
		int	index
	)		const [pure virtual]

Returns value as byte array.

Returns:

value of the field

virtual char Engine::FIXGroup::getAsChar	(	int	tag,
		int	index
	)		const [pure virtual]

Returns value as double.

Returns:

value of the field

virtual Engine::UTCDateOnly Engine::FIXGroup::getAsDateOnly	(	int	tag,
		int	index
	)		const [pure virtual]

virtual Decimal Engine::FIXGroup::getAsDecimal	(	int	tag,
		int	index
	)		const [pure virtual]

virtual double Engine::FIXGroup::getAsDouble	(	int	tag,
		int	index
	)		const [pure virtual]

Returns value as double.

Returns:

value of the field

virtual int Engine::FIXGroup::getAsInt	(	int	tag,
		int	index
	)		const [pure virtual]

virtual System::i32 Engine::FIXGroup::getAsInt32	(	int	tag,
		int	index
	)		const [pure virtual]

virtual System::i64 Engine::FIXGroup::getAsInt64	(	int	tag,
		int	index
	)		const [pure virtual]

virtual Engine::LocalMktDate Engine::FIXGroup::getAsLocalMktDate	(	int	tag,
		int	index
	)		const [pure virtual]

virtual Engine::MonthYear Engine::FIXGroup::getAsMonthYear	(	int	tag,
		int	index
	)		const [pure virtual]

virtual ByteArray Engine::FIXGroup::getAsRaw	(	int	tag,
		int	index
	)		const [pure virtual]

Returns value as byte array.

Returns:

value of the field

virtual AsciiString Engine::FIXGroup::getAsString	(	int	tag,
		int	index
	)		const [pure virtual]

Returns value as string.

Returns:

value of the field

virtual Engine::UTCTimeOnly Engine::FIXGroup::getAsTimeOnly	(	int	tag,
		int	index
	)		const [pure virtual]

virtual Engine::UTCTimestamp Engine::FIXGroup::getAsTimestamp	(	int	tag,
		int	index
	)		const [pure virtual]

virtual unsigned int Engine::FIXGroup::getAsUInt	(	int	tag,
		int	index
	)		const [pure virtual]

virtual System::u32 Engine::FIXGroup::getAsUInt32	(	int	tag,
		int	index
	)		const [pure virtual]

virtual System::u64 Engine::FIXGroup::getAsUInt64	(	int	tag,
		int	index
	)		const [pure virtual]

virtual TagValue* Engine::FIXGroup::getEntry

(

int

index )

[pure virtual]

Returns group entry by index.

Returns:

group entry by index

virtual TagValue const* Engine::FIXGroup::getEntry

(

int

index )

const [pure virtual]

Returns group entry by index.

Returns:

group entry by index

virtual FixFieldsContainer* Engine::FIXGroup::getFields

(

)

const [pure virtual]

Returns list of the message fields and their values.

Parameters:

[out]

list

list of the message fields and values

virtual FIXGroup* Engine::FIXGroup::getGroup	(	int	tag,
		int	index
	)		[pure virtual]

Returns nested repeating group.

Parameters:

index	group's entry index (starts at 0).
tag	Tag 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:

Utils::Exception

if tag not defined for the group or entry index is invalid.

virtual FIXGroup const* Engine::FIXGroup::getGroup	(	int	tag,
		int	index
	)		const [pure virtual]

virtual bool Engine::FIXGroup::hasFlag	(	int	tag,
		int	index
	)		const [pure virtual]

virtual bool Engine::FIXGroup::isEmpty	(	int	tag,
		int	index
	)		const [pure virtual]

virtual bool Engine::FIXGroup::isEqual	(	int	tag,
		int	index,
		TagValue const *	rv,
		int	rvTag
	)		const [pure virtual]

virtual bool Engine::FIXGroup::isSupported

(

int

tag )

const [virtual]

Verifies is field acceptable inside this group.

Parameters:

tag	Tag number of the field to verify.

Returns:

"true" if field supported by this group, otherwise returns false.

virtual int Engine::FIXGroup::leadingField

(

)

const [pure virtual]

Returns the leading field tag of the repeating group.

Returns:

Leading field tag of the repeating group .

static void Engine::FIXGroup::release

(

FIXGroup *

pGroup )

[static]

Releases resources used by the given group instance.

Parameters:

pGroup

Pointer to FIXGroup

Warning:

must be called before group's holder is released. Group's holder may be FIXMessage or other repeating group's entry. FIXMessage is released by calling FIXMessage::release(). Repeating group's entry become invalid when it's removed from the group by shrinking or entier outer group releasing.

See also:

FIXMessage::release

static void Engine::FIXGroup::release

(

FIXGroup const *

pGroup )

[static]

Releases resources used by the given group instance.

Parameters:

pGroup

Pointer to FIXGroup

Warning:

must be called before group's holder is released. Group's holder may be FIXMessage or other repeating group's entry. FIXMessage is released by calling FIXMessage::release(). Repeating group's entry become invalid when it's removed from the group by shrinking or entier outer group releasing.

See also:

FIXMessage::release

virtual bool Engine::FIXGroup::remove	(	int	tag,
		int	index
	)		[pure virtual]

Removes field, defined by input tag, from the given entry.

Parameters:

index	group's entry index (starts at 0).
tag	Tag of field to remove.

Returns:

"true" if the field defined by tag was initialized previously (i.e. had non-empty value), otherwise "false".

Exceptions:

Utils::Exception

if tag not defined for the group or entry index is invalid.

virtual bool Engine::FIXGroup::set	(	int	tag,
		ByteArray	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		const FIXFieldValue &	value,
		int	index
	)		[pure virtual]

Assignes value to the field, defined by tag and entry index.

Parameters:

index	group's entry index (starts at 0).
tag	FIX field tag to set data to.
value	New value for field.

Exceptions:

Utils::Exception

if tag not defined by FIX protocol for the group or entry index is invalid.

virtual bool Engine::FIXGroup::set	(	int	tag,
		AsciiString	value,
		int	index
	)		[pure virtual]

bool Engine::FIXGroup::set	(	int	tag,
		char const *	value,
		int	index
	)		[inline]

Definition at line 292 of file B2BITS_FIXGroup.h.

virtual bool Engine::FIXGroup::set	(	int	tag,
		Engine::UTCTimestamp	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		Engine::MonthYear	value,
		int	index
	)		[pure virtual]

Assignes value to the field, defined by tag and entry index.

Parameters:

index	group's entry index (starts at 0).
tag	Tag number of field to set data.
value	New value for field.

Returns:

"true" if the field defined by input tag was initialized previously, If field is just inserted, returned value is "false".

Exceptions:

Utils::Exception

if tag not defined for the group or entry index is invalid.

virtual bool Engine::FIXGroup::set	(	int	tag,
		System::u64	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		System::i32	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		Decimal	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		Engine::UTCDateOnly	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		System::i64	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		Engine::UTCTimeOnly	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		Engine::LocalMktDate	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		double	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		System::u32	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		bool	value,
		int	index
	)		[pure virtual]

virtual bool Engine::FIXGroup::set	(	int	tag,
		const std::string &	value,
		int	index
	)		[pure virtual]

Assignes value to the field, defined by tag and entry index.

Parameters:

index	group's entry index (starts at 0).
tag	FIX field tag to set data to.
value	New value for field.

Returns:

"true" if the field defined by input tag was initialized previously, If field is just inserted, returned value is "false".

Exceptions:

Utils::Exception

if tag not defined for the group or entry index is invalid.

virtual bool Engine::FIXGroup::set	(	int	tag,
		char	value,
		int	index
	)		[pure virtual]

virtual int Engine::FIXGroup::size

(

)

const [pure virtual]

Returns the number of entries in this repeating group.

Returns:

Number of entries in this repeating group.

virtual void Engine::FIXGroup::write	(	int	tag,
		std::ostream &	out,
		int	index
	)		const [pure virtual]