B2BITS FIX Antenna C++  2.31.0
Public Types | Public Member Functions | List of all members
FixDictionary2::MessageItem Class Referenceabstract

Represents MessageItem interface. More...

#include <B2BITS_MessageItem.h>

+ Inheritance diagram for FixDictionary2::MessageItem:
+ Collaboration diagram for FixDictionary2::MessageItem:

Public Types

enum  MessageItemName { MESSAGEITEM_FIELDREF, MESSAGEITEM_REPEATINGGROUP, MESSAGEITEM_BLOCKREF }
 Dictionary Item Names. More...
 
- 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

virtual MessageItemT::Ptr clone () const =0
 Make copy of object. More...
 
std::string const & condition () const throw ()
 Returns condition of MessageItem. More...
 
std::string const & getCondition () const throw ()
 Returns condition of MessageItem. More...
 
bool isRequired () const throw ()
 Returns true, if item is required or conditionaly required. More...
 
 MessageItem ()
 Constructor. More...
 
 MessageItem (MessageItem const &msgItem)
 Copy Constructor. More...
 
virtual MessageItemName messageItemName () const =0 throw ()
 
Returns type of the Message Item More...
 
bool required () const throw ()
 Returns true, if item is required or conditionaly required. More...
 
void setCondition (std::string const &condition)
 Set condition of MessageItem. More...
 
void setRequired (bool required) throw ()
 Set true, if item is required or conditionaly required. More...
 
virtual MessageItemT::Ptr toMessageItem ()
 Converts instance of the Item to MessageItem. More...
 
virtual MessageItemT::CPtr toMessageItem () const
 Converts instance of the Item to MessageItem. More...
 
virtual ~MessageItem () throw ()
 Destructor. More...
 
- Public Member Functions inherited from FixDictionary2::Item
ItemName getItemName () const throw ()
 Returns the ItemName of object. More...
 
 Item ()
 Default constructor. More...
 
 Item (Item const &obj)
 Copy constructor. More...
 
virtual ItemName itemName () const =0 throw ()
 Returns the ItemName of object. More...
 
Itemoperator= (Item const &obj)
 Assign operator. More...
 
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 ProtocolT::Ptr toProtocol ()
 Try downcast to Protocol class. More...
 
virtual ProtocolT::CPtr toProtocol () const
 Try downcast to Protocol 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...
 
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...
 

Additional Inherited Members

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

Detailed Description

Represents MessageItem interface.

Member Enumeration Documentation

◆ MessageItemName

Dictionary Item Names.

Enumerator
MESSAGEITEM_FIELDREF 

Field ref item name.

MESSAGEITEM_REPEATINGGROUP 

Repeating group item name.

MESSAGEITEM_BLOCKREF 

BlockRef item name.

Constructor & Destructor Documentation

◆ MessageItem() [1/2]

FixDictionary2::MessageItem::MessageItem ( )

Constructor.

◆ MessageItem() [2/2]

FixDictionary2::MessageItem::MessageItem ( MessageItem const &  msgItem)

Copy Constructor.

◆ ~MessageItem()

virtual FixDictionary2::MessageItem::~MessageItem ( )
throw (
)
virtual

Destructor.

Member Function Documentation

◆ clone()

virtual MessageItemT::Ptr FixDictionary2::MessageItem::clone ( ) const
pure virtual

◆ condition()

std::string const& FixDictionary2::MessageItem::condition ( ) const
throw (
)

Returns condition of MessageItem.

Returns
condition of MessageItem

◆ getCondition()

std::string const& FixDictionary2::MessageItem::getCondition ( ) const
throw (
)
inline

Returns condition of MessageItem.

Returns
condition of MessageItem

◆ isRequired()

bool FixDictionary2::MessageItem::isRequired ( ) const
throw (
)
inline

Returns true, if item is required or conditionaly required.

Returns
true, if item is required or conditionaly required.

◆ messageItemName()

virtual MessageItemName FixDictionary2::MessageItem::messageItemName ( ) const
throw (
)
pure virtual

◆ required()

bool FixDictionary2::MessageItem::required ( ) const
throw (
)

Returns true, if item is required or conditionaly required.

Returns
true, if item is required or conditionaly required.

◆ setCondition()

void FixDictionary2::MessageItem::setCondition ( std::string const &  condition)

Set condition of MessageItem.

Returns
condition value

◆ setRequired()

void FixDictionary2::MessageItem::setRequired ( bool  required)
throw (
)

Set true, if item is required or conditionaly required.

Parameters
requiredvalue

◆ toMessageItem() [1/2]

virtual MessageItemT::Ptr FixDictionary2::MessageItem::toMessageItem ( )
virtual

Converts instance of the Item to MessageItem.

Reimplemented from the Item.

Reimplemented from FixDictionary2::Item.

◆ toMessageItem() [2/2]

virtual MessageItemT::CPtr FixDictionary2::MessageItem::toMessageItem ( ) const
virtual

Converts instance of the Item to MessageItem.

Reimplemented from the Item.

Reimplemented from FixDictionary2::Item.