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

#include <ATQuoteDbResponseParser.h>

Public Member Functions

 ATQuoteDbResponseParser (LPATQUOTEDB_RESPONSE pResponse, uint32_t responseCount)
 
virtual ~ATQuoteDbResponseParser (void)
 
bool IsValid () const
 
bool MoveToFirstResponse ()
 
bool MoveToNextResponse ()
 
bool MoveToFirstDataItem ()
 
bool MoveToNextDataItem ()
 
LPATSYMBOL GetSymbol () const
 
ATSymbolStatus GetSymbolStatus () const
 
uint16_t GetSymbolCount () const
 
uint16_t GetDataItemCount () const
 
ATQuoteFieldType GetDataItemQuoteFieldType () const
 
ATFieldStatus GetDataItemFieldStatus () const
 
ATDataType GetDataItemDataType () const
 
const void * GetDataItemData () const
 

Detailed Description

ATQuoteDbResponseParser class. This class is used for parsing the quote database response initiated by ATCreateQuoteDbRequest.

See Also
ATCreateQuoteDbRequest

Constructor & Destructor Documentation

ATQuoteDbResponseParser::ATQuoteDbResponseParser ( LPATQUOTEDB_RESPONSE  pResponse,
uint32_t  responseCount 
)

ATQuoteDbResponseParser constructor.

Parameters
pResponsePointer to ATQUOTEDB_RESPONSE received from the API callback.
responseCountCount of responses passed in pResponse parameter.
virtual ATQuoteDbResponseParser::~ATQuoteDbResponseParser ( void  )
virtual

Member Function Documentation

uint16_t ATQuoteDbResponseParser::GetDataItemCount ( ) const

Get count of data items for current response.

Note
This method can be called only after a successful call to MoveToFirstResponse or MoveToNextResponse.
Returns
Count of data items.
See Also
MoveToFirstResponse
MoveToNextResponse
const void* ATQuoteDbResponseParser::GetDataItemData ( ) const

Get data pointer to raw value of current data item.

Note
This method can be called only after a successful call to MoveToFirstDataItem or MoveToNextDataItem.
Returns
Pointer to raw data if object is in valid state, NULL otherwise.
See Also
MoveToFirstDataItem
MoveToNextDataItem
ATDataType ATQuoteDbResponseParser::GetDataItemDataType ( ) const

Get one of the ATDataType enum types for current data item.

Note
This method can be called only after a successful call to MoveToFirstDataItem or MoveToNextDataItem.
Returns
ATDataType representing the type of the field.
See Also
ATDataType
MoveToFirstDataItem
MoveToNextDataItem
ATFieldStatus ATQuoteDbResponseParser::GetDataItemFieldStatus ( ) const

Get one of the ATFieldStatus enum types for current data item.

Note
This method can be called only after a successful call to MoveToFirstDataItem or MoveToNextDataItem.
Returns
ATFieldStatus representing the type of the field.
See Also
ATFieldStatus
MoveToFirstDataItem
MoveToNextDataItem
ATQuoteFieldType ATQuoteDbResponseParser::GetDataItemQuoteFieldType ( ) const

Get one of the ATQuoteFieldType enum types for current data item.

Note
This method can be called only after a successful call to MoveToFirstDataItem or MoveToNextDataItem.
Returns
ATQuoteFieldType representing the type of the field.
See Also
ATQuoteFieldType
MoveToFirstDataItem
MoveToNextDataItem
LPATSYMBOL ATQuoteDbResponseParser::GetSymbol ( ) const

Get symbol for current response.

Note
This method can be called only after a successful call to MoveToFirstResponse or MoveToNextResponse.
Returns
Pointer to ATSYMBOL if object is in valid state, or NULL otherwise.
See Also
ATSYMBOL
MoveToFirstResponse
MoveToNextResponse
uint16_t ATQuoteDbResponseParser::GetSymbolCount ( ) const

Get count of all symbols.

Returns
Count of symbols.
ATSymbolStatus ATQuoteDbResponseParser::GetSymbolStatus ( ) const

Get one of the ATSymbolStatus enum types for current response.

Note
This method can be called only after a successful call to MoveToFirstResponse or MoveToNextResponse.
Returns
ATSymbolStatus.
See Also
ATSymbolStatus
MoveToFirstResponse
MoveToNextResponse
bool ATQuoteDbResponseParser::IsValid ( ) const

Determine validity of the current object state.

Returns
TRUE if object is valid, FALSE otherwise.
bool ATQuoteDbResponseParser::MoveToFirstDataItem ( )

Move internal parser pointer to first data item inside current response.

Note
This method can be called only after a successful call to MoveToFirstResponse or MoveToNextResponse.
Returns
TRUE if move was successful, FALSE otherwise.
See Also
MoveToFirstResponse
MoveToNextResponse
bool ATQuoteDbResponseParser::MoveToFirstResponse ( )

Move internal parser pointer to first ATQUOTEDB_RESPONSE response.

Returns
TRUE if move was successful, FALSE otherwise.
See Also
ATQUOTEDB_RESPONSE
bool ATQuoteDbResponseParser::MoveToNextDataItem ( )

Move internal parser pointer to next data item inside current response.

Note
This method can be called only after a successful call to MoveToFirstDataItem.
Returns
TRUE if move was successful, FALSE otherwise.
See Also
MoveToFirstDataItem
bool ATQuoteDbResponseParser::MoveToNextResponse ( )

Move internal parser pointer to next ATQUOTEDB_RESPONSE response.

Note
This method can be called only after a successful call to MoveToFirstResponse.
Returns
TRUE if move was successful, FALSE otherwise.
See Also
ATQUOTEDB_RESPONSE
MoveToFirstResponse