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

#include <ATTickHistoryDBResponseParser.h>

Public Member Functions

 ATTickHistoryDBResponseParser (LPATTICKHISTORY_RESPONSE pResponse)
 
 ~ATTickHistoryDBResponseParser (void)
 
bool IsValid () const
 
uint64_t GetNextOffset () const
 
ATTIME GetOffsetDbDate () const
 
bool MoveToFirstRecord ()
 
bool MoveToNextRecord ()
 
ATTickHistoryRecordType GetRecordType () const
 
ATTIME GetRecordDateTime () const
 
ATExchangeType GetTradeLastExchange () const
 
ATPRICE GetTradeLastPrice () const
 
uint32_t GetTradeLastSize () const
 
ATTradeConditionType GetTradeCondition (uint32_t index) const
 
ATTradeConditionTypeGetTradeConditions () const
 
ATExchangeType GetQuoteBidExchange () const
 
ATExchangeType GetQuoteAskExchange () const
 
ATPRICE GetQuoteBidPrice () const
 
ATPRICE GetQuoteAskPrice () const
 
uint32_t GetQuoteBidSize () const
 
uint32_t GetQuoteAskSize () const
 
ATQuoteConditionType GetQuoteCondition () const
 
LPATSYMBOL GetSymbol () const
 
ATSymbolStatus GetSymbolStatus () const
 
uint32_t GetRecordCount () const
 

Detailed Description

ATTickHistoryDBResponseParser class. This class is used for parsing the history database response initiated by ATCreateTickHistoryDbRequest.

See Also
ATCreateTickHistoryDbRequest

Constructor & Destructor Documentation

ATTickHistoryDBResponseParser::ATTickHistoryDBResponseParser ( LPATTICKHISTORY_RESPONSE  pResponse)

ATTickHistoryDBResponseParser constructor.

Parameters
pResponsePointer to ATTICKHISTORY_RESPONSE received from the API callback.
ATTickHistoryDBResponseParser::~ATTickHistoryDBResponseParser ( void  )

Member Function Documentation

uint64_t ATTickHistoryDBResponseParser::GetNextOffset ( ) const

If request was made with offset parameter, this member function returns next offset value

Returns
uint64_t value.
ATTIME ATTickHistoryDBResponseParser::GetOffsetDbDate ( ) const
ATExchangeType ATTickHistoryDBResponseParser::GetQuoteAskExchange ( ) const

Retrieve one of ATExchangeType enum types for ask exchange for current record.

Returns
ATExchangeType
See Also
ATExchangeType
ATPRICE ATTickHistoryDBResponseParser::GetQuoteAskPrice ( ) const

Retrieve ask price for current record.

Returns
ATPRICE
See Also
ATPRICE
uint32_t ATTickHistoryDBResponseParser::GetQuoteAskSize ( ) const

Retrieve ask size for current record.

Returns
UINT
ATExchangeType ATTickHistoryDBResponseParser::GetQuoteBidExchange ( ) const

Retrieve one of ATExchangeType enum types for bid exchange for current record.

Returns
ATExchangeType
See Also
ATExchangeType
ATPRICE ATTickHistoryDBResponseParser::GetQuoteBidPrice ( ) const

Retrieve bid price for current record.

Returns
ATPRICE
See Also
ATPRICE
uint32_t ATTickHistoryDBResponseParser::GetQuoteBidSize ( ) const

Retrieve bid size for current record.

Returns
UINT
ATQuoteConditionType ATTickHistoryDBResponseParser::GetQuoteCondition ( ) const

Retrieve one of ATQuoteConditionType enum types for quote condition for current record.

Returns
ATQuoteConditionType
See Also
ATQuoteConditionType
uint32_t ATTickHistoryDBResponseParser::GetRecordCount ( ) const

Retrieve record count.

Returns
UINT
ATTIME ATTickHistoryDBResponseParser::GetRecordDateTime ( ) const

Retrieve date+time for current record.

Returns
Current record's date+time in ATTIME structure.
ATTickHistoryRecordType ATTickHistoryDBResponseParser::GetRecordType ( ) const

Retrieve one of ATTickHistoryRecordType enum types for current record.

Returns
ATTickHistoryRecordType
See Also
ATTickHistoryRecordType
LPATSYMBOL ATTickHistoryDBResponseParser::GetSymbol ( ) const

Retrieve pointer to symbol.

Returns
ATSYMBOL
See Also
ATSYMBOL
ATSymbolStatus ATTickHistoryDBResponseParser::GetSymbolStatus ( ) const

Retrieve one of ATSymbolStatus enum types for symbol status.

Returns
ATSymbolStatus
See Also
ATSymbolStatus
ATTradeConditionType ATTickHistoryDBResponseParser::GetTradeCondition ( uint32_t  index) const

Retrieve one of ATTradeConditionType enum types for last traded condition for current record.

Returns
ATTradeConditionType
See Also
ATTradeConditionType
ATTradeConditionType* ATTickHistoryDBResponseParser::GetTradeConditions ( ) const

Retrieve pointer to array of ATTradeConditionType enum types for last traded conditions for current record.

Note
Maximum number of trading conditions is defined in ATTradeConditionsCount.
Returns
ATTradeConditionType
See Also
ATTradeConditionsCount
ATTradeConditionType
ATExchangeType ATTickHistoryDBResponseParser::GetTradeLastExchange ( ) const

Retrieve one of ATExchangeType enum types for last traded exchange for current record.

Returns
ATExchangeType
See Also
ATExchangeType
ATPRICE ATTickHistoryDBResponseParser::GetTradeLastPrice ( ) const

Retrieve last traded price for current record.

Returns
ATPRICE
See Also
ATPRICE
uint32_t ATTickHistoryDBResponseParser::GetTradeLastSize ( ) const

Retrieve last traded size for current record.

Returns
UINT
bool ATTickHistoryDBResponseParser::IsValid ( ) const

Determine validity of the current object state.

Returns
TRUE if object is valid, FALSE otherwise.
bool ATTickHistoryDBResponseParser::MoveToFirstRecord ( )

Move internal parser pointer to first tick record.

Returns
TRUE if move was successful, FALSE otherwise.
bool ATTickHistoryDBResponseParser::MoveToNextRecord ( )

Move internal parser pointer to next tick record.

Returns
TRUE if move was successful, FALSE otherwise.