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

#include <ATMarketMoversDbResponseParser.h>

Public Member Functions

 ATMarketMoversDbResponseParser (LPATMARKET_MOVERSDB_RESPONSE pResponse)
 
virtual ~ATMarketMoversDbResponseParser (void)
 
bool IsValid () const
 
bool MoveToFirstRecord ()
 
bool MoveToFirstItem ()
 
bool MoveToNextRecord ()
 
bool MoveToNextItem ()
 
LPATMARKET_MOVERS_RECORD GetCurrentRecord () const
 
LPATMARKET_MOVERS_ITEM GetCurrentItem () const
 
LPATSYMBOL GetRecordSymbol () const
 
ATSymbolStatus GetRecordSymbolStatus () const
 
uint32_t GetRecordCount () const
 
LPATSYMBOL GetItemSymbol () const
 
ATPRICE GetItemLastPrice () const
 
ATPRICE GetItemClosePrice () const
 
uint64_t GetItemVolume () const
 
ATTIME GetItemLastDateTime () const
 

Detailed Description

ATMarketMoversDbResponseParser class. This class is used for parsing the market movers snapshot database response initiated by ATCreateMarketMoversDbRequest.

See Also
ATCreateMarketMoversDbRequest

Constructor & Destructor Documentation

ATMarketMoversDbResponseParser::ATMarketMoversDbResponseParser ( LPATMARKET_MOVERSDB_RESPONSE  pResponse)

ATMarketMoversDbResponseParser constructor.

Parameters
pResponsePointer to ATMARKET_MOVERSDB_RESPONSE received from the API callback.
virtual ATMarketMoversDbResponseParser::~ATMarketMoversDbResponseParser ( void  )
virtual

Member Function Documentation

LPATMARKET_MOVERS_ITEM ATMarketMoversDbResponseParser::GetCurrentItem ( ) const

Retrieve pointer to current ATMARKET_MOVERS_ITEM record.

Returns
Valid pointer to the ATMARKET_MOVERS_ITEM structure if object is in a valid state, or NULL otherwise.
See Also
ATMARKET_MOVERS_ITEM
LPATMARKET_MOVERS_RECORD ATMarketMoversDbResponseParser::GetCurrentRecord ( ) const

Retrieve pointer to current ATMARKET_MOVERS_RECORD record.

Returns
Valid pointer to the ATMARKET_MOVERS_RECORD structure if object is in a valid state, or NULL otherwise.
See Also
ATMARKET_MOVERS_RECORD
ATPRICE ATMarketMoversDbResponseParser::GetItemClosePrice ( ) const

Retrieve previous close price for current item.

Returns
Previous close price for current item.
See Also
ATPRICE
ATTIME ATMarketMoversDbResponseParser::GetItemLastDateTime ( ) const

Retrieve date/time for current item.

Returns
Date/time for current item.
ATPRICE ATMarketMoversDbResponseParser::GetItemLastPrice ( ) const

Retrieve last price for current item.

Returns
Last price for current item.
See Also
ATPRICE
LPATSYMBOL ATMarketMoversDbResponseParser::GetItemSymbol ( ) const

Retrieve pointer to ATSYMBOL symbol for current item.

Returns
Valid pointer to the ATSYMBOL structure if object is in a valid state, or NULL otherwise.
See Also
ATSYMBOL
uint64_t ATMarketMoversDbResponseParser::GetItemVolume ( ) const

Retrieve volume for current item.

Returns
Volume for current item.
uint32_t ATMarketMoversDbResponseParser::GetRecordCount ( ) const

Retrieve record count.

Returns
Record count.
LPATSYMBOL ATMarketMoversDbResponseParser::GetRecordSymbol ( ) const

Retrieve pointer to ATSYMBOL symbol for current record.

Returns
Valid pointer to the ATSYMBOL structure if object is in a valid state, or NULL otherwise.
See Also
ATSYMBOL
ATSymbolStatus ATMarketMoversDbResponseParser::GetRecordSymbolStatus ( ) const

Retrieve one of the ATSymbolStatus enum types for current record.

Returns
Valid pointer to the ATSYMBOL structure if object is in a valid state, or NULL otherwise.
See Also
ATSymbolStatus
bool ATMarketMoversDbResponseParser::IsValid ( ) const

Determine validity of the current object state.

Returns
TRUE if object is valid, FALSE otherwise.
bool ATMarketMoversDbResponseParser::MoveToFirstItem ( )

Move internal parser pointer to first ATMARKET_MOVERS_ITEM record.

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

Move internal parser pointer to first ATMARKET_MOVERS_RECORD record.

Returns
TRUE if move was successful, FALSE otherwise.
See Also
ATMARKET_MOVERS_RECORD
bool ATMarketMoversDbResponseParser::MoveToNextItem ( )

Move internal parser pointer to next ATMARKET_MOVERS_ITEM record.

Note
This method can be called only after a successful call to MoveToFirstItem.
Returns
TRUE if move was successful, FALSE otherwise.
See Also
ATMARKET_MOVERS_ITEM
MoveToFirstItem
bool ATMarketMoversDbResponseParser::MoveToNextRecord ( )

Move internal parser pointer to next ATMARKET_MOVERS_RECORD record.

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