FixDictionary2::Field Class Reference

Represents Field interface. More...

#include <B2BITS_Field.h>

Inheritance diagram for FixDictionary2::Field:

Collaboration diagram for FixDictionary2::Field:

Public Member Functions
FieldT::Ptr	clone () const
	Make copy of object.
std::string const &	description () const throw ()
	Returns description of the field.
	Field (Field const &field)
	Copy Constructor.
	Field (std::string const &typeName, int tag, std::string const &name, std::string const &fixmlName)
	Constructor.
std::string const &	fixmlName () const throw ()
	Returns fixmlName of Field.
void	fixmlName (std::string const &fixmlName)
	Assigns FIXML field name.
std::string const &	getDescription () const throw ()
	Returns description of the field.
std::string const &	getFixmlName () const throw ()
	Returns fixmlName of Field.
bool	getIsTransport () const throw ()
	Returns true if field is part of transport protocol.
int	getLenField () const throw ()
	Returns tag of the associated length field.
std::string const &	getName () const throw ()
	Returns name of Field.
int	getTag () const throw ()
	Returns tag of Field.
std::string const &	getTypeName () const throw ()
	Returns type of Field.
ValBlockT::CPtr	getValBlock () const throw ()
	Returns list of valid values.
std::string const &	getValBlockRef () const throw ()
	Returns name of the external ValBlock.
bool	isTransport () const throw ()
	Returns true if field is part of transport protocol.
virtual ItemName	itemName () const throw ()
	Returns the ItemName of object.
int	lenField () const throw ()
	Returns tag of the associated length field.
void	lenField (int tag) throw ()
	Assigns tag of the associated length field.
std::string const &	name () const throw ()
	Returns name of Field.
void	setDescription (std::string const &value)
	Assigns description of the field.
void	setFixmlName (std::string const &fixmlName)
	Assigns FIXML field name.
void	setIsTransport (bool value)
	Assigns description of the field.
void	setLenField (int tag) throw ()
	Assigns tag of the associated length field.
void	setName (std::string const &name)
	Assigns field name.
void	setTag (int tag) throw ()
	Assigns field tag.
void	setTypeName (std::string const &typeName)
	Assigns field type.
void	setValBlock (ValBlockT::Ptr valBlockPtr) throw ()
	Assigns list of valid values.
void	setValBlockRef (std::string const &blockId)
	Assigns reference to the external named ValBlock.
int	tag () const throw ()
	Returns tag of Field.
virtual FieldT::Ptr	toField ()
	Try downcast to Field class.
virtual FieldT::CPtr	toField () const
	Try downcast to Field class.
std::string const &	typeName () const throw ()
	Returns type of Field.
Public Member Functions inherited from FixDictionary2::Item
ItemName	getItemName () const throw ()
	Returns the ItemName of object.
	Item ()
	Default constructor.
	Item (Item const &obj)
	Copy constructor.
Item &	operator= (Item const &obj)
	Assign operator.
virtual BlockT::Ptr	toBlock ()
	Try downcast to Block class.
virtual BlockT::CPtr	toBlock () const
	Try downcast to Block class.
virtual BlockRefT::Ptr	toBlockRef ()
	Try downcast to BlockRef class.
virtual BlockRefT::CPtr	toBlockRef () const
	Try downcast to BlockRef class.
virtual FieldRefT::Ptr	toFieldRef ()
	Try downcast to FieldRef class.
virtual FieldRefT::CPtr	toFieldRef () const
	Try downcast to FieldRef class.
virtual FieldTypeT::Ptr	toFieldType ()
	Try downcast to FieldType class.
virtual FieldTypeT::CPtr	toFieldType () const
	Try downcast to FieldType class.
virtual MessageT::Ptr	toMessage ()
	Try downcast to Message class.
virtual MessageT::CPtr	toMessage () const
	Try downcast to Message class.
virtual MessageItemT::Ptr	toMessageItem ()
	Try downcast to MessageItem class.
virtual MessageItemT::CPtr	toMessageItem () const
	Try downcast to MessageItem class.
virtual ProtocolT::Ptr	toProtocol ()
	Try downcast to Protocol class.
virtual ProtocolT::CPtr	toProtocol () const
	Try downcast to Protocol class.
virtual RepeatingGroupT::Ptr	toRepeatingGroup ()
	Try downcast to RepeatingGroup class.
virtual RepeatingGroupT::CPtr	toRepeatingGroup () const
	Try downcast to RepeatingGroup class.
Public Member Functions inherited from Utils::ReferenceCounter
virtual bool	addRef () const throw ()
	Increments reference counter.
virtual long	getNRef () const throw ()
	Returns the current value of the reference counter.
	ReferenceCounter () throw ()
	Constructor.
virtual long	release () const throw ()
	Decrements reference counter.

Protected Member Functions
virtual	~Field () throw ()
	Destructor.
Protected Member Functions inherited from Utils::ReferenceCounter
long	decrement () const throw ()
	Decrements counter and returns new counter value.
long	increment () const throw ()
	Increments counter and returns new counter value.
virtual	~ReferenceCounter ()
	Destructor.

Additional Inherited Members
Public Types inherited from FixDictionary2::Item
enum	ItemName {   ITEM_FIELD , ITEM_FIELDTYPE , ITEM_FIELDREF , ITEM_REPEATINGGROUP ,   ITEM_BLOCK , ITEM_BLOCKREF , ITEM_VALBLOCK , ITEM_MESSAGE ,   ITEM_PROTOCOL , ITEM_DICTIONARY }
	Dictionary Item Names. More...

Detailed Description

Represents Field interface.

Constructor & Destructor Documentation

Field() [1/2]

FixDictionary2::Field::Field

(

Field const &

field

)

Copy Constructor.

Field() [2/2]

FixDictionary2::Field::Field	(	std::string const &	typeName,
		int	tag,
		std::string const &	name,
		std::string const &	fixmlName )

Constructor.

~Field()

virtual FixDictionary2::Field::~Field ( ) throw (  )

protectedvirtual

Destructor.

Member Function Documentation

clone()

FieldT::Ptr FixDictionary2::Field::clone ( ) const

inlinevirtual

Make copy of object.

Implements FixDictionary2::Item.

description()

std::string const & FixDictionary2::Field::description ( ) const throw (  )

inline

Returns description of the field.

fixmlName() [1/2]

std::string const & FixDictionary2::Field::fixmlName	(		)	const
throw	(	)

Returns fixmlName of Field.

Returns

fixmlName of Field

fixmlName() [2/2]

void FixDictionary2::Field::fixmlName ( std::string const & fixmlName )

inline

Assigns FIXML field name.

getDescription()

std::string const & FixDictionary2::Field::getDescription	(		)	const
throw	(	)

Returns description of the field.

getFixmlName()

std::string const & FixDictionary2::Field::getFixmlName ( ) const throw (  )

inline

Returns fixmlName of Field.

Returns

fixmlName of Field

getIsTransport()

bool FixDictionary2::Field::getIsTransport	(		)	const
throw	(	)

Returns true if field is part of transport protocol.

getLenField()

int FixDictionary2::Field::getLenField ( ) const throw (  )

inline

Returns tag of the associated length field.

Applicable only for data fields.

getName()

std::string const & FixDictionary2::Field::getName ( ) const throw (  )

inline

Returns name of Field.

Returns

name of Field

getTag()

int FixDictionary2::Field::getTag ( ) const throw (  )

inline

Returns tag of Field.

Returns

tag of Field

getTypeName()

std::string const & FixDictionary2::Field::getTypeName ( ) const throw (  )

inline

Returns type of Field.

Returns

type of Field

getValBlock()

ValBlockT::CPtr FixDictionary2::Field::getValBlock	(		)	const
throw	(	)

Returns list of valid values.

Can be NULL

getValBlockRef()

std::string const & FixDictionary2::Field::getValBlockRef	(		)	const
throw	(	)

Returns name of the external ValBlock.

isTransport()

bool FixDictionary2::Field::isTransport ( ) const throw (  )

inline

Returns true if field is part of transport protocol.

itemName()

virtual ItemName FixDictionary2::Field::itemName ( ) const throw (  )

virtual

Returns the ItemName of object.

Returns

ItemName of Object

Implements FixDictionary2::Item.

lenField() [1/2]

int FixDictionary2::Field::lenField	(		)	const
throw	(	)

Returns tag of the associated length field.

If no field is associated, function returns -1. Applicable only for data fields.

lenField() [2/2]

void FixDictionary2::Field::lenField ( int tag ) throw (  )

inline

Assigns tag of the associated length field.

Applicable only for data fields.

name()

std::string const & FixDictionary2::Field::name	(		)	const
throw	(	)

Returns name of Field.

Returns

name of Field

setDescription()

void FixDictionary2::Field::setDescription

(

std::string const &

value

)

Assigns description of the field.

setFixmlName()

void FixDictionary2::Field::setFixmlName

(

std::string const &

fixmlName

)

Assigns FIXML field name.

setIsTransport()

void FixDictionary2::Field::setIsTransport

(

bool

value

)

Assigns description of the field.

setLenField()

void FixDictionary2::Field::setLenField	(	int	tag	)
throw	(	)

Assigns tag of the associated length field.

Applicable only for data fields.

setName()

void FixDictionary2::Field::setName

(

std::string const &

name

)

Assigns field name.

setTag()

void FixDictionary2::Field::setTag	(	int	tag	)
throw	(	)

Assigns field tag.

setTypeName()

void FixDictionary2::Field::setTypeName

(

std::string const &

typeName

)

Assigns field type.

setValBlock()

void FixDictionary2::Field::setValBlock	(	ValBlockT::Ptr	valBlockPtr	)
throw	(	)

Assigns list of valid values.

Methods aqures one reference to the ValBlock

setValBlockRef()

void FixDictionary2::Field::setValBlockRef

(

std::string const &

blockId

)

Assigns reference to the external named ValBlock.

tag()

int FixDictionary2::Field::tag	(		)	const
throw	(	)

Returns tag of Field.

Returns

tag of Field

toField() [1/2]

virtual FieldT::Ptr FixDictionary2::Field::toField ( )

virtual

Try downcast to Field class.

Returns

downcast to Field class

Reimplemented from FixDictionary2::Item.

toField() [2/2]

virtual FieldT::CPtr FixDictionary2::Field::toField ( ) const

virtual

Try downcast to Field class.

Returns

downcast to Field class

Reimplemented from FixDictionary2::Item.

typeName()

std::string const & FixDictionary2::Field::typeName	(		)	const
throw	(	)

Returns type of Field.

Returns

type of Field