FieldSet Class Reference

Public Member Functions
	operator bool () const
FieldValueRef	get (Tag tag) const
Int32	getInt32 (Tag tag) const
UInt32	getUInt32 (Tag tag) const
Int64	getInt64 (Tag tag) const
UInt64	getUInt64 (Tag tag) const
Decimal	getDecimal (Tag tag) const
StringRef	getStringRef (Tag tag) const
Timestamp	getTimestamp (Tag tag, TimestampFormat::Enum=TimestampFormat::YYYYMMDDHHMMSSNsec) const
Group	getGroup (Tag numberOfInstancesTag) const
Group	getOptionalGroup (Tag numberOfInstancesTag) const
bool	hasFlag (Tag tag) const
size_t	fields (Fields &fields) const
void	swap (FieldSet &) throw ()

Protected Member Functions
	FieldSet ()
	FieldSet (const Message *, void *)
	FieldSet (const FieldSet &)
	~FieldSet ()
FieldSet &	operator= (const FieldSet &)

Protected Attributes
const Message *	container_
void *	impl_

Friends
class	Message
class	GroupInstance
class	MessageOperator

Detailed Description

Encapsulates primary operations over collection of FIX fields like FIX message and repeating group instance are.

Definition at line 66 of file FieldSet.h.

Constructor & Destructor Documentation

FieldSet() [1/3]

FieldSet ( )

protected

FieldSet() [2/3]

FieldSet ( const Message * , void *  )

protected

FieldSet() [3/3]

FieldSet ( const FieldSet & )

protected

~FieldSet()

~FieldSet ( )

protected

Member Function Documentation

fields()

size_t fields

(

Fields &

fields

)

const

Retrieve tags and values of all non-empty fields belonged to the given FieldSet instance.

Parameters

fields

Object to receive the FieldSet content.

Returns

Number of fields placed to the fields vector.

get()

FieldValueRef get

(

Tag

tag

)

const

Returns reference to a given field value.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getDecimal()

Decimal getDecimal

(

Tag

tag

)

const

Returns the field value as a decimal number.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getGroup()

Group getGroup

(

Tag

numberOfInstancesTag

)

const

Returns reference to a repeating group if underlying field defines length of repeating group.

Parameters

numberOfInstancesTag

Tag number of the field that defines the number of instances in this repeating group (the NoXXX field).

Exceptions

std::exception

if no repeating group is associated with given field (tag).

Warning

Returned instance remains valid until field is modified via any of OnixS::FIX::FieldSet::set members.

getInt32()

Int32 getInt32

(

Tag

tag

)

const

Returns field value as an OnixS::FIX::Int32 value.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getInt64()

Int64 getInt64

(

Tag

tag

)

const

Returns field value as an OnixS::FIX::Int64 value.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getOptionalGroup()

Group getOptionalGroup

(

Tag

numberOfInstancesTag

)

const

Returns reference to a repeating group if underlying field defines length of repeating group.

Parameters

numberOfInstancesTag

Tag number of the field that defines the number of instances in this repeating group (the NoXXX field).

Warning

Returned instance remains valid until field is modified via any of OnixS::FIX::FieldSet::set members.

getStringRef()

StringRef getStringRef

(

Tag

tag

)

const

Returns reference to a read-only text chain.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getTimestamp()

Timestamp getTimestamp	(	Tag	tag,
		TimestampFormat::Enum	= TimestampFormat::YYYYMMDDHHMMSSNsec ) const

Returns the field value as timestamp of requested format.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getUInt32()

UInt32 getUInt32

(

Tag

tag

)

const

Returns field value as an OnixS::FIX::UInt32 value.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

getUInt64()

UInt64 getUInt64

(

Tag

tag

)

const

Returns field value as an OnixS::FIX::UInt64 value.

Exceptions

std::exception

if conversion is impossible.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

hasFlag()

bool hasFlag

(

Tag

tag

)

const

Returns true if the given flag is present and it equals to "Y", otherwise false.

Warning

Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

operator bool()

operator bool

(

)

const

Indicates whether instance refers to a valid set of fields.

If given instance doesn't refer to a valid fields set, none of other members must be used.

operator=()

FieldSet & operator= ( const FieldSet & )

protected

swap()

void swap	(	FieldSet &		)
throw	(	)

Friends And Related Symbol Documentation

GroupInstance

friend class GroupInstance

friend

Definition at line 222 of file FieldSet.h.

Message

friend class Message

friend

Definition at line 221 of file FieldSet.h.

MessageOperator

friend class MessageOperator

friend

Definition at line 223 of file FieldSet.h.

Member Data Documentation

container_

const Message* container_

protected

Definition at line 201 of file FieldSet.h.

impl_

void* impl_

protected

Definition at line 204 of file FieldSet.h.