EMA C++ Edition
List of all members
refinitiv::ema::access::OmmXml Class Reference

OmmXml represents XML data format in Omm. More...

Inheritance diagram for refinitiv::ema::access::OmmXml:
refinitiv::ema::access::ComplexType refinitiv::ema::access::Data

Public Member Functions

Constructor
 OmmXml ()
  More...
 
Destructor
virtual ~OmmXml ()
  More...
 
Accessors
DataType::DataTypeEnum getDataType () const
  More...
 
Data::DataCode getCode () const
  More...
 
const EmaBuffergetAsHex () const
  More...
 
const EmaStringtoString () const
  More...
 
const EmaStringgetString () const
  More...
 
const EmaBuffergetBuffer () const
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::ComplexType
virtual ~ComplexType ()
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::Data
const EmaStringgetCodeAsString () const
  More...
 
 operator const char * () const
  More...
 
virtual ~Data ()
  More...
 

Operations

OmmXmlclear ()
  More...
 
OmmXmlset (const EmaString &value)
  More...
 
OmmXmlset (const EmaBuffer &value)
  More...
 

Additional Inherited Members

- Public Types inherited from refinitiv::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0 ,
  BlankEnum = 1
}
 
- Protected Member Functions inherited from refinitiv::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from refinitiv::ema::access::Data
 Data ()
 

Detailed Description

The following code snippet shows setting of XML data into FieldList;

OmmXml xml;
xml.set( "<xml tag>this is xml data</xml tag>" );
FieldList fList;
fList.addXml( 123, xml ).complete();
friend class FieldList
Definition: Data.h:133

The following code snippet shows extraction of xml data from FieldList;

void decodeFieldList( const FieldList& fList )
{
while ( fList.forth() )
{
const FieldEntry& fEntry = flist.getEntry();
if ( fEntry.getCode() != Data::BlankEnum )
switch ( fEntry.getLoadType() )
{
const OmmXml& ommXml = fEntry.getXml();
const EmaBuffer& xmlValue = ommXml.getBuffer();
break;
}
}
}
friend class FieldEntry
Definition: Data.h:139
Remarks
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform setting and extracting of XML and its content.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See also
Data, EmaString, EmaBuffer

Definition at line 72 of file OmmXml.h.

Constructor & Destructor Documentation

◆ OmmXml()

refinitiv::ema::access::OmmXml::OmmXml ( )

Constructs OmmXml

◆ ~OmmXml()

virtual refinitiv::ema::access::OmmXml::~OmmXml ( )
virtual

Destructor.

Member Function Documentation

◆ clear()

OmmXml& refinitiv::ema::access::OmmXml::clear ( )

Clears the OmmXml.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object

◆ getAsHex()

const EmaBuffer& refinitiv::ema::access::OmmXml::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
EmaBuffer with the object hex information

Implements refinitiv::ema::access::Data.

◆ getBuffer()

const EmaBuffer& refinitiv::ema::access::OmmXml::getBuffer ( ) const

Returns contained XML buffer.

Returns
EmaBuffer containing the XML data

◆ getCode()

Data::DataCode refinitiv::ema::access::OmmXml::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::BlankEnum if received data is blank; Data::NoCodeEnum otherwise

Implements refinitiv::ema::access::Data.

◆ getDataType()

DataType::DataTypeEnum refinitiv::ema::access::OmmXml::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type.

Returns
DataType::XmlEnum

Implements refinitiv::ema::access::Data.

◆ getString()

const EmaString& refinitiv::ema::access::OmmXml::getString ( ) const

Returns contained XML string.

Returns
EmaString containing the XML data

◆ set() [1/2]

OmmXml& refinitiv::ema::access::OmmXml::set ( const EmaBuffer value)

Specifies Set.

Parameters
[in]valuespecifies XML data using EmaBuffer
Returns
reference to this object

◆ set() [2/2]

OmmXml& refinitiv::ema::access::OmmXml::set ( const EmaString value)

Specifies Set.

Parameters
[in]valuespecifies XML data using EmaString
Returns
reference to this object

◆ toString()

const EmaString& refinitiv::ema::access::OmmXml::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements refinitiv::ema::access::Data.