ActiveTick Feed C++ API SDK  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
ATQuoteStreamResponseParser Class Reference

#include <ATQuoteStreamResponseParser.h>

Public Member Functions

 ATQuoteStreamResponseParser (LPATQUOTESTREAM_RESPONSE pResponse)
 
virtual ~ATQuoteStreamResponseParser (void)
 
void MoveToBeginning ()
 
bool MoveToFirstDataItem ()
 
bool MoveToNextDataItem ()
 
ATStreamResponseType GetResponseType () const
 
LPATSYMBOL GetSymbol () const
 
ATSymbolStatus GetSymbolStatus () const
 

Detailed Description

ATQuoteStreamResponseParser class. This class is used for parsing the quote stream response initiated by ATCreateQuoteStreamRequest.

See Also
ATCreateQuoteStreamRequest

Constructor & Destructor Documentation

ATQuoteStreamResponseParser::ATQuoteStreamResponseParser ( LPATQUOTESTREAM_RESPONSE  pResponse)

ATQuoteStreamResponseParser constructor.

Parameters
pResponsePointer to ATQUOTESTREAM_RESPONSE received from the API callback.
virtual ATQuoteStreamResponseParser::~ATQuoteStreamResponseParser ( void  )
virtual

Member Function Documentation

ATStreamResponseType ATQuoteStreamResponseParser::GetResponseType ( ) const

Get one of ATStreamResponseType enum types for current response.

Returns
ATStreamRespomnseType for current response.
Note
This method can only be called after successful call to MoveToFirstDataItem or MoveToNextDataItem.
See Also
ATStreamResponseType
LPATSYMBOL ATQuoteStreamResponseParser::GetSymbol ( ) const

Get pointer to ATSYMBOL for current response.

Returns
ATSYMBOL for current response if object is in valid state, NULL otherwise.
Note
This method can only be called after successful call to MoveToFirstDataItem or MoveToNextDataItem.
See Also
ATSYMBOL
ATSymbolStatus ATQuoteStreamResponseParser::GetSymbolStatus ( ) const

Get one of ATSymbolStatus enum types for current response.

Returns
ATSymbolStatus for current response.
Note
This method can only be called after successful call to MoveToFirstDataItem or MoveToNextDataItem.
See Also
ATSymbolStatus
void ATQuoteStreamResponseParser::MoveToBeginning ( )

Move internal parser pointer to beginning of ATQUOTEDB_RESPONSE response.

See Also
ATQUOTEDB_RESPONSE
bool ATQuoteStreamResponseParser::MoveToFirstDataItem ( )

Move internal parser pointer to first data item within ATQUOTEDB_RESPONSE response.

Returns
TRUE if pointer was moved successfully, FALSE otherwise.
See Also
ATQUOTEDB_RESPONSE
bool ATQuoteStreamResponseParser::MoveToNextDataItem ( )

Move internal parser pointer to next data item within ATQUOTEDB_RESPONSE response.

Note
This method can only be called after successful call to MoveToFirstDataItem.
Returns
TRUE if pointer was moved successfully, FALSE otherwise.
See Also
ATQUOTEDB_RESPONSE
MoveToFirstDataItem