Represents Protocol interface. More...

#include <B2BITS_Protocol.h>

Inheritance diagram for FixDictionary2::Protocol:

Collaboration diagram for FixDictionary2::Protocol:

Public Types
typedef std::map< std::string, MessageT::Ref >	MessagesByTypeMap

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	addBlock (BlockT::Ptr block)

void	addField (FieldT::Ptr field)

void	addFieldType (FieldTypeT::Ptr type)

void	addFieldTypes (std::list< FieldTypeT::Ref > *types)

void	addFieldTypes (FieldTypeT::RefArray types, std::size_t size)

void	addMessage (MessageT::Ptr msg)

void	addValBlock (ValBlockT::Ptr valBlock)

ProtocolT::Ptr	clone () const
	Make copy of object. More...

BlockT::CPtr	getBlock (std::string const &id) const
	Find block in protocol by id. More...

std::map< std::string, BlockT::Ref > const *	getBlocks () const throw ()
	Returns block's set used in protocol. More...

FieldT::CPtr	getField (int tag) const
	Find field in protocol by tag. More...

FieldT::CPtr	getField (std::string const &name) const
	Find field in protocol by name. More...

std::size_t	getFields (FieldT::CRefArray *fields) const throw ()
	Returns fields registered in protocol. More...

FieldTypeT::CPtr	getFieldType (std::string const &name) const
	Finds FieldType in protocol by name. More...

FieldTypeT::Ptr	getFieldType (std::string const &name)

std::map< std::string, FieldTypeT::Ref > const *	getFieldTypes () const throw ()
	Returns field's types registered in protocol. More...

MessageT::CPtr	getMessage (std::string const &msgType) const
	Find message in protocol by message type. More...

MessagesByTypeMap const *	getMessages () const throw ()
	Returns messages registered in protocol. More...

ValBlockT::CPtr	getValBlock (std::string const &id) const
	Finds ValBlock in protocol by id. More...

std::map< std::string, ValBlockT::Ref > const *	getValBocks () const throw ()
	Returns messages registered in protocol. More...

std::string const &	id () const throw ()
	Returns name of the Protocol, unique identifier. More...

virtual ItemName	itemName () const throw ()
	Returns the ItemName of object. More...

std::string const &	name () const throw ()
	Returns name of the Protocol, unique identifier. More...

	Protocol (std::string const &name, std::string const &version, std::string const &title)
	Constructor. More...

void	removeField (int tag)

void	removeMessage (std::string const &msgType)
	Removes given message. More...

ProtocolT::Ptr	shallowClone (std::string const &name, std::string const &title) const
	Makes shallow copy of object. More...

std::string const &	title () const throw ()
	Returns name of Protocol. More...

virtual ProtocolT::Ptr	toProtocol ()
	Try downcast to Protocol class. More...

virtual ProtocolT::CPtr	toProtocol () const
	Try downcast to Protocol class. More...

void	updateBlock (BlockT::Ptr block)

void	updateField (FieldT::Ptr field)

void	updateFieldType (FieldTypeT::Ptr type)

void	updateMessage (MessageT::Ptr msg)
	Updates given message. More...

void	updateValBlock (ValBlockT::Ptr valBlock)

std::string const &	version () const throw ()
	Returns base type of Protocol. More...

Public Member Functions inherited from FixDictionary2::Item
virtual BlockT::Ptr	toBlock ()
	Try downcast to Block class. More...

virtual BlockT::CPtr	toBlock () const
	Try downcast to Block class. More...

virtual BlockRefT::Ptr	toBlockRef ()
	Try downcast to BlockRef class. More...

virtual BlockRefT::CPtr	toBlockRef () const
	Try downcast to BlockRef class. More...

virtual FieldT::Ptr	toField ()
	Try downcast to Field class. More...

virtual FieldT::CPtr	toField () const
	Try downcast to Field class. More...

virtual FieldRefT::Ptr	toFieldRef ()
	Try downcast to FieldRef class. More...

virtual FieldRefT::CPtr	toFieldRef () const
	Try downcast to FieldRef class. More...

virtual FieldTypeT::Ptr	toFieldType ()
	Try downcast to FieldType class. More...

virtual FieldTypeT::CPtr	toFieldType () const
	Try downcast to FieldType class. More...

virtual MessageT::Ptr	toMessage ()
	Try downcast to Message class. More...

virtual MessageT::CPtr	toMessage () const
	Try downcast to Message class. More...

virtual MessageItemT::Ptr	toMessageItem ()
	Try downcast to MessageItem class. More...

virtual MessageItemT::CPtr	toMessageItem () const
	Try downcast to MessageItem class. More...

virtual RepeatingGroupT::Ptr	toRepeatingGroup ()
	Try downcast to RepeatingGroup class. More...

virtual RepeatingGroupT::CPtr	toRepeatingGroup () const
	Try downcast to RepeatingGroup class. More...

Public Member Functions inherited from Utils::ReferenceCounter
virtual bool	addRef () const throw ()
	Increments reference counter. More...

long	decrement () const throw ()

virtual long	getNRef () const throw ()
	Returns the current value of the reference counter. More...

	ReferenceCounter () throw ()
	Constructor. More...

virtual long	release () const throw ()
	Decrements reference counter. More...

Protected Member Functions
virtual	~Protocol () throw ()
	Destructor. More...

Protected Member Functions inherited from Utils::ReferenceCounter
virtual	~ReferenceCounter ()
	Destructor. More...

Additional Inherited Members
Protected Attributes inherited from Utils::ReferenceCounter
volatile System::u32	m_nRef
	The counter. More...

Detailed Description

Represents Protocol interface.

Member Typedef Documentation

typedef std::map<std::string, MessageT::Ref> FixDictionary2::Protocol::MessagesByTypeMap

Constructor & Destructor Documentation

FixDictionary2::Protocol::Protocol	(	std::string const &	name,
		std::string const &	version,
		std::string const &	title
	)

Constructor.

virtual FixDictionary2::Protocol::~Protocol	(	)
throw	(
	)

protectedvirtual

Destructor.

Member Function Documentation

void FixDictionary2::Protocol::addBlock ( BlockT::Ptr block )

void FixDictionary2::Protocol::addField ( FieldT::Ptr field )

void FixDictionary2::Protocol::addFieldType ( FieldTypeT::Ptr type )

void FixDictionary2::Protocol::addFieldTypes ( std::list< FieldTypeT::Ref > * types )

void FixDictionary2::Protocol::addFieldTypes	(	FieldTypeT::RefArray	types,
		std::size_t	size
	)

void FixDictionary2::Protocol::addMessage ( MessageT::Ptr msg )

void FixDictionary2::Protocol::addValBlock ( ValBlockT::Ptr valBlock )

ProtocolT::Ptr FixDictionary2::Protocol::clone ( ) const

virtual

Make copy of object.

Implements FixDictionary2::Item.

BlockT::CPtr FixDictionary2::Protocol::getBlock ( std::string const & id ) const

Find block in protocol by id.

Parameters

id	of block to find

Returns: found block

std::map<std::string, BlockT::Ref> const* FixDictionary2::Protocol::getBlocks	(	)	const
throw	(
	)

Returns block's set used in protocol.

Returns: block's set used in protocol

FieldT::CPtr FixDictionary2::Protocol::getField ( int tag ) const

Find field in protocol by tag.

Parameters

tag	of field to find

Returns: found tag

FieldT::CPtr FixDictionary2::Protocol::getField ( std::string const & name ) const

Find field in protocol by name.

Parameters

name	Name of the field

Returns: found tag

std::size_t FixDictionary2::Protocol::getFields	(	FieldT::CRefArray *	fields	)	const
throw	(
	)

Returns fields registered in protocol.

Returns: fields registered in protocol

FieldTypeT::CPtr FixDictionary2::Protocol::getFieldType ( std::string const & name ) const

Finds FieldType in protocol by name.

Parameters

name	of FieldType to find

Returns: found FieldType

FieldTypeT::Ptr FixDictionary2::Protocol::getFieldType ( std::string const & name )

std::map<std::string, FieldTypeT::Ref> const* FixDictionary2::Protocol::getFieldTypes	(	)	const
throw	(
	)

Returns field's types registered in protocol.

Returns: field's types registered in protocol

MessageT::CPtr FixDictionary2::Protocol::getMessage ( std::string const & msgType ) const

Find message in protocol by message type.

Parameters

type	of message to find

Returns: found message

MessagesByTypeMap const* FixDictionary2::Protocol::getMessages	(	)	const
throw	(
	)

Returns messages registered in protocol.

Returns: messages registered in protocol

ValBlockT::CPtr FixDictionary2::Protocol::getValBlock ( std::string const & id ) const

Finds ValBlock in protocol by id.

Parameters

id	of the ValBlock to find

Returns: found ValBlock

std::map<std::string, ValBlockT::Ref> const* FixDictionary2::Protocol::getValBocks	(	)	const
throw	(
	)

Returns messages registered in protocol.

Returns: messages registered in protocol

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

inline

Returns name of the Protocol, unique identifier.

Note: "name" is "id" in the FIX XML

Returns: name of the Protocol

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

virtual

Returns the ItemName of object.

Returns: ItemName of Object

Implements FixDictionary2::Item.

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

Returns name of the Protocol, unique identifier.

Note: "name" is "id" in the FIX XML

Returns: name of the Protocol

void FixDictionary2::Protocol::removeField ( int tag )

void FixDictionary2::Protocol::removeMessage ( std::string const & msgType )

Removes given message.

Warning: Please note, this change may affect all descendant protocols

ProtocolT::Ptr FixDictionary2::Protocol::shallowClone	(	std::string const &	name,
		std::string const &	title
	)		const

Makes shallow copy of object.

std::string const& FixDictionary2::Protocol::title	(	)	const
throw	(
	)

Returns name of Protocol.

Returns: name of Protocol

virtual ProtocolT::Ptr FixDictionary2::Protocol::toProtocol ( )

virtual

Try downcast to Protocol class.

Returns: downcast to Protocol class

Reimplemented from FixDictionary2::Item.

virtual ProtocolT::CPtr FixDictionary2::Protocol::toProtocol ( ) const

virtual

Try downcast to Protocol class.

Returns: downcast to Protocol class

Reimplemented from FixDictionary2::Item.

void FixDictionary2::Protocol::updateBlock ( BlockT::Ptr block )

void FixDictionary2::Protocol::updateField ( FieldT::Ptr field )

void FixDictionary2::Protocol::updateFieldType ( FieldTypeT::Ptr type )

void FixDictionary2::Protocol::updateMessage ( MessageT::Ptr msg )

Updates given message.

Warning: Please note, this change may affect all descendant protocols

void FixDictionary2::Protocol::updateValBlock ( ValBlockT::Ptr valBlock )

std::string const& FixDictionary2::Protocol::version	(	)	const
throw	(
	)

Returns base type of Protocol.

Returns: base type of Protocol

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation