FixDictionary2::ValBlock Class Reference

Represents ValBlock interface. More...

#include <B2BITS_ValBlock.h>

Inheritance diagram for FixDictionary2::ValBlock:

Collaboration diagram for FixDictionary2::ValBlock:

Classes
struct	ValueDescription
	ValBlock value. More...

Public Types
typedef std::map< std::string, ValueDescription >	Values
	Values container.
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...

Public Member Functions
void	addValue (std::string const &value, bool &duplicate)
void	addValue (std::string const &value, std::string const &description, std::string const &id)
	Adds new value of the value block.
void	addValue (std::string const &value, std::string const &description, std::string const &id, bool &duplicate)
virtual ValBlockT::Ptr	clone () const
	Make copy of object.
std::string const &	description () const throw ()
	Returns description of the valblock.
std::string const &	getDescription () const throw ()
	Returns description of the valblock.
std::string const &	getId () const throw ()
	Returns ID of the value block.
std::string const &	getMaxRangeValue () const throw ()
	Returns maximum value range.
std::string const &	getMinRangeValue () const throw ()
	Returns minimal value range.
std::string const &	getName () const throw ()
	Returns name of the value block.
std::string const &	getRangeDescription () const throw ()
	Returns description.
std::string const &	getRangeType () const throw ()
	Returns range values type (int, float, etc.)
Values const &	getValues () const throw ()
	Returns values.
std::string const &	id () const throw ()
	Returns ID of the value block.
bool	isEmpty () const throw ()
	Returns true if value block is empty; false otherwise.
bool	isMulti () const throw ()
bool	isRangePresent () const throw ()
	Returns true if range is defined; false otherwise.
virtual ItemName	itemName () const throw ()
	Returns the ItemName of object.
std::string const &	name () const throw ()
	Returns name of the value block.
void	setDescription (std::string const &value)
	Assigns description of the valblock.
void	setIsMulti (bool value) throw ()
void	setMaxRangeValue (std::string const &strMaxRangeVal)
	Sets maxumum value range.
void	setMinRangeValue (std::string const &strMinRangeVal)
	Sets minimal value range.
void	setName (std::string const &name)
	Assigns value block name .
void	setRangeDescription (std::string const &value)
	Assigns description to range.
void	setRangeType (std::string const &strRangeType)
	Sets range value type (int, float, etc.)
	ValBlock (std::string const &id)
	Constructor.
	ValBlock (ValBlock const &src)
	Copy Constructor.
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 FieldT::Ptr	toField ()
	Try downcast to Field class.
virtual FieldT::CPtr	toField () const
	Try downcast to Field 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
	~ValBlock () 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.

Detailed Description

Represents ValBlock interface.

Member Typedef Documentation

Values

typedef std::map<std::string, ValueDescription> FixDictionary2::ValBlock::Values

Values container.

Key is name of the value. Value is description of the value.

Constructor & Destructor Documentation

ValBlock() [1/2]

FixDictionary2::ValBlock::ValBlock

(

std::string const &

id

)

Constructor.

ValBlock() [2/2]

FixDictionary2::ValBlock::ValBlock

(

ValBlock const &

src

)

Copy Constructor.

~ValBlock()

FixDictionary2::ValBlock::~ValBlock ( ) throw (  )

protected

Destructor.

Member Function Documentation

addValue() [1/3]

void FixDictionary2::ValBlock::addValue	(	std::string const &	value,
		bool &	duplicate )

addValue() [2/3]

void FixDictionary2::ValBlock::addValue	(	std::string const &	value,
		std::string const &	description,
		std::string const &	id )

Adds new value of the value block.

addValue() [3/3]

void FixDictionary2::ValBlock::addValue	(	std::string const &	value,
		std::string const &	description,
		std::string const &	id,
		bool &	duplicate )

clone()

virtual ValBlockT::Ptr FixDictionary2::ValBlock::clone ( ) const

virtual

Make copy of object.

Implements FixDictionary2::Item.

description()

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

inline

Returns description of the valblock.

getDescription()

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

Returns description of the valblock.

getId()

std::string const & FixDictionary2::ValBlock::getId ( ) const throw (  )

inline

Returns ID of the value block.

getMaxRangeValue()

std::string const & FixDictionary2::ValBlock::getMaxRangeValue	(		)	const
throw	(	)

Returns maximum value range.

getMinRangeValue()

std::string const & FixDictionary2::ValBlock::getMinRangeValue	(		)	const
throw	(	)

Returns minimal value range.

getName()

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

inline

Returns name of the value block.

Optional.

getRangeDescription()

std::string const & FixDictionary2::ValBlock::getRangeDescription	(		)	const
throw	(	)

Returns description.

getRangeType()

std::string const & FixDictionary2::ValBlock::getRangeType	(		)	const
throw	(	)

Returns range values type (int, float, etc.)

getValues()

Values const & FixDictionary2::ValBlock::getValues	(		)	const
throw	(	)

Returns values.

id()

std::string const & FixDictionary2::ValBlock::id	(		)	const
throw	(	)

Returns ID of the value block.

isEmpty()

bool FixDictionary2::ValBlock::isEmpty	(		)	const
throw	(	)

Returns true if value block is empty; false otherwise.

isMulti()

bool FixDictionary2::ValBlock::isMulti	(		)	const
throw	(	)

isRangePresent()

bool FixDictionary2::ValBlock::isRangePresent	(		)	const
throw	(	)

Returns true if range is defined; false otherwise.

itemName()

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

virtual

Returns the ItemName of object.

Returns

ItemName of Object

Implements FixDictionary2::Item.

name()

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

Returns name of the value block.

Optional.

setDescription()

void FixDictionary2::ValBlock::setDescription

(

std::string const &

value

)

Assigns description of the valblock.

setIsMulti()

void FixDictionary2::ValBlock::setIsMulti	(	bool	value	)
throw	(	)

setMaxRangeValue()

void FixDictionary2::ValBlock::setMaxRangeValue

(

std::string const &

strMaxRangeVal

)

Sets maxumum value range.

setMinRangeValue()

void FixDictionary2::ValBlock::setMinRangeValue

(

std::string const &

strMinRangeVal

)

Sets minimal value range.

setName()

void FixDictionary2::ValBlock::setName

(

std::string const &

name

)

Assigns value block name .

setRangeDescription()

void FixDictionary2::ValBlock::setRangeDescription

(

std::string const &

value

)

Assigns description to range.

setRangeType()

void FixDictionary2::ValBlock::setRangeType

(

std::string const &

strRangeType

)

Sets range value type (int, float, etc.)