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

#include <ATBarHistoryDbResponseParser.h>

Public Member Functions

 ATBarHistoryDbResponseParser (LPATBARHISTORY_RESPONSE pResponse)
 
virtual ~ATBarHistoryDbResponseParser (void)
 
bool IsValid () const
 
bool MoveToFirstRecord ()
 
bool MoveToNextRecord ()
 
ATPRICE GetOpen () const
 
ATPRICE GetHigh () const
 
ATPRICE GetLow () const
 
ATPRICE GetClose () const
 
uint64_t GetVolume () const
 
ATTIME GetDateTime () const
 
LPATSYMBOL GetSymbol () const
 
ATSymbolStatus GetSymbolStatus () const
 
uint32_t GetRecordCount () const
 

Detailed Description

ATBarHistoryDbResponseParser class. This class is used for parsing the history database response initiated by ATCreateBarHistoryDbRequest.

See Also
ATCreateBarHistoryDbRequest

Constructor & Destructor Documentation

ATBarHistoryDbResponseParser::ATBarHistoryDbResponseParser ( LPATBARHISTORY_RESPONSE  pResponse)

ATBarHistoryDbResponseParser constructor.

Parameters
pResponsePointer to ATBARHISTORY_RESPONSE received from the API callback.
virtual ATBarHistoryDbResponseParser::~ATBarHistoryDbResponseParser ( void  )
virtual

Member Function Documentation

ATPRICE ATBarHistoryDbResponseParser::GetClose ( ) const

Retrieve current bar's close price.

Returns
ATPRICE
See Also
ATPRICE
ATTIME ATBarHistoryDbResponseParser::GetDateTime ( ) const

Retrieve current bar's date/time.

Returns
ATTIME
ATPRICE ATBarHistoryDbResponseParser::GetHigh ( ) const

Retrieve current bar's high price.

Returns
ATPRICE
See Also
ATPRICE
ATPRICE ATBarHistoryDbResponseParser::GetLow ( ) const

Retrieve current bar's low price.

Returns
ATPRICE
See Also
ATPRICE
ATPRICE ATBarHistoryDbResponseParser::GetOpen ( ) const

Retrieve current bar's open price.

Returns
ATPRICE
See Also
ATPRICE
uint32_t ATBarHistoryDbResponseParser::GetRecordCount ( ) const

Retrieve count of records within current response.

Returns
UINT Count of bar records.
LPATSYMBOL ATBarHistoryDbResponseParser::GetSymbol ( ) const

Retrieve pointer to response's symbol.

Returns
LPATSYMBOL
See Also
ATSYMBOL
ATSymbolStatus ATBarHistoryDbResponseParser::GetSymbolStatus ( ) const

Retrieve one of the ATSymbolStatus enum types.

Returns
ATSymbolStatus
See Also
ATSymbolStatus
uint64_t ATBarHistoryDbResponseParser::GetVolume ( ) const

Retrieve current bar's volume.

Returns
ULONGLONG integer.
bool ATBarHistoryDbResponseParser::IsValid ( ) const

Determine validity of the current object state.

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

Move internal parser pointer to first bar record.

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

Move internal parser pointer to next bar record.

Returns
TRUE if move was successful, FALSE otherwise.