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

RmtesBuffer represents RMTES data. More...

Public Member Functions

Constructor
 RmtesBuffer ()
  More...
 
 RmtesBuffer (UInt32 length)
  More...
 
 RmtesBuffer (const char *buf, UInt32 length)
  More...
 
 RmtesBuffer (const RmtesBuffer &buf)
  More...
 
Destructor
virtual ~RmtesBuffer ()
  More...
 
Accessors
const EmaBuffergetAsUTF8 () const
  More...
 
const EmaBufferU16getAsUTF16 () const
  More...
 
const EmaBuffergetAsEmaBuffer () const
  More...
 
const EmaStringtoString () const
  More...
 

Operations

class OmmRmtesDecoder
 
class EmaUnitTestConnect
 
RmtesBufferclear ()
  More...
 
RmtesBufferapply (const RmtesBuffer &buf)
  More...
 
RmtesBufferapply (const char *buf, UInt32 length)
  More...
 
RmtesBufferapply (const EmaBuffer &buf)
  More...
 

Detailed Description

RmtesBuffer stores and applies RMTES data.

The following code snippet shows a simple decoding of RmtesBuffer.

rmtesBuffer.apply( fe.getRmtes() );
cout << rmtesBuffer.toString() << endl;
Remarks
RmtesBuffer class contains a copy of the buffer passed on apply methods.
All methods in this class are Lock-free Method.
See also
EmaBuffer, EmaString, EmaBufferU16, OmmInvalidUsageException

Definition at line 54 of file RmtesBuffer.h.

Constructor & Destructor Documentation

◆ RmtesBuffer() [1/4]

refinitiv::ema::access::RmtesBuffer::RmtesBuffer ( )

Constructs RmtesBuffer.

◆ RmtesBuffer() [2/4]

refinitiv::ema::access::RmtesBuffer::RmtesBuffer ( UInt32  length)

Constructs RmtesBuffer.

Remarks
Preallocates memory if length is different than 0
Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
Parameters
[in]lengthspecifies size of preallocated memory

◆ RmtesBuffer() [3/4]

refinitiv::ema::access::RmtesBuffer::RmtesBuffer ( const char *  buf,
UInt32  length 
)

Assignment constructor

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to apply passed in content
Parameters
[in]bufpointer to the memory containing copied in buffer
[in]lengthspecifies number of characters to copy

◆ RmtesBuffer() [4/4]

refinitiv::ema::access::RmtesBuffer::RmtesBuffer ( const RmtesBuffer buf)

Copy constructor.

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to apply passed in content
Parameters
[in]bufcopied in RmtesBuffer object

◆ ~RmtesBuffer()

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

Destructor.

Member Function Documentation

◆ apply() [1/3]

RmtesBuffer& refinitiv::ema::access::RmtesBuffer::apply ( const char *  buf,
UInt32  length 
)

apply passed in RMTES data

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to apply
Parameters
[in]bufspecifies pointer to the memory containing RMTES data to be applied to this object
[in]lengthspecifies size of the memory to be applied to this object
Returns
reference to this object

◆ apply() [2/3]

RmtesBuffer& refinitiv::ema::access::RmtesBuffer::apply ( const EmaBuffer buf)

apply passed in RMTES data

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to apply
Parameters
[in]bufspecifies EmaBuffer containing RMTES string to be applied to this object
Returns
reference to this object

◆ apply() [3/3]

RmtesBuffer& refinitiv::ema::access::RmtesBuffer::apply ( const RmtesBuffer buf)

apply passed in RMTES data

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to apply
Parameters
[in]bufspecifies RmtesBuffer to be applied to this object
Returns
reference to this object

◆ clear()

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

Clears contained content.

Returns
reference to this object

◆ getAsEmaBuffer()

const EmaBuffer& refinitiv::ema::access::RmtesBuffer::getAsEmaBuffer ( ) const

Returns the cached RMTES content without any conversion.

Returns
EmaBuffer containing RMTES data

◆ getAsUTF16()

const EmaBufferU16& refinitiv::ema::access::RmtesBuffer::getAsUTF16 ( ) const

Returns the content converted as UTF16.

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to convert
Returns
EmaBufferU16 containing RMTES data converted to UTF16

◆ getAsUTF8()

const EmaBuffer& refinitiv::ema::access::RmtesBuffer::getAsUTF8 ( ) const

Returns the content converted as UTF8.

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to convert
Returns
EmaBuffer containing RMTES data converted to UTF8

◆ toString()

const EmaString& refinitiv::ema::access::RmtesBuffer::toString ( ) const

Returns a string representation of the class instance which is converted to UTF8.

Exceptions
OmmMemoryExhaustionExceptionif application runs out of memory
OmmInvalidUsageExceptionif fails to convert
Returns
EmaString containing RMTES data converted to UTF8