QBbgLib  0.4
Qt wrapper for the Bloomberg API
Public Types | Public Member Functions | Static Public Member Functions | Properties | Related Functions | List of all members
QBbgLib::QBbgAbstractIntradayRequest Class Referenceabstract

Base class for intraday requests. More...

#include <QBbgAbstractIntradayRequest.h>

Inheritance diagram for QBbgLib::QBbgAbstractIntradayRequest:
QBbgLib::QBbgAbstractRequest QBbgLib::QBbgIntradayTickRequest

Public Types

enum  EventType : qint8 {
  EventType::Invalid, EventType::TRADE, EventType::BID, EventType::ASK,
  EventType::BID_BEST, EventType::ASK_BEST, EventType::MID_PRICE, EventType::AT_TRADE,
  EventType::BEST_BID, EventType::BEST_ASK
}
 Type of event to capture. More...
 
- Public Types inherited from QBbgLib::QBbgAbstractRequest
enum  RequestType : qint32 {
  RequestType::Invalid = -1, RequestType::Beqs, RequestType::HistoricalData = FirstFielded, RequestType::ReferenceData,
  RequestType::PortfolioData, RequestType::IntraDayTick = FirstIntraday, RequestType::IntraDayBar
}
 Type of Request. More...
 
enum  SpecialIDs { InvalidID = -1024 }
 Special requestID codes. More...
 

Public Member Functions

virtual ~QBbgAbstractIntradayRequest ()=0
 Destructor. More...
 
virtual const QDateTime & endDateTime () const
 The last date/time of the period to retrieve data. More...
 
virtual EventType eventType () const
 Returns the type of event to retrieve. More...
 
virtual bool isValidReq () const override
 Reimplemented from QBbgAbstractRequest::isValidReq() More...
 
virtual QBbgAbstractIntradayRequestoperator= (const QBbgAbstractIntradayRequest &a)
 Copies another tick data request. More...
 
virtual bool operator== (const QBbgAbstractIntradayRequest &other) const
 Checks if two requests are identical. More...
 
virtual void setDateTimeRange (QDateTime startDt, QDateTime endDt)
 Set the period range to retrieve. More...
 
virtual void setEndDateTime (const QDateTime &val)
 Set the last date/time of the period to retrieve data. More...
 
virtual void setEventType (EventType val)
 Set the type of event to retrieve. More...
 
virtual void setSecurity (const QBbgSecurity &val) override
 Reimplemented from QBbgAbstractRequest::setSecurity() More...
 
virtual void setStartDateTime (const QDateTime &val)
 Set the first date/time of the period to retrieve data. More...
 
virtual const QDateTime & startDateTime () const
 The first date/time of the period to retrieve data. More...
 
- Public Member Functions inherited from QBbgLib::QBbgAbstractRequest
virtual ~QBbgAbstractRequest ()=0
 Destructor. More...
 
virtual qint64 getID () const
 Returns the current ID for the request. More...
 
virtual QBbgAbstractRequestoperator= (const QBbgAbstractRequest &other)
 Copies another request. More...
 
virtual bool operator== (const QBbgAbstractRequest &other) const
 Checks if two requests are identical. More...
 
virtual RequestType requestType () const
 Returns the type of request. More...
 
virtual const QBbgSecuritysecurity () const
 Returns the security associated with the request. More...
 
virtual void setID (qint64 val)
 Set the ID associated to the current request. More...
 
virtual void setSecurity (const QString &SecName, QBbgSecurity::YellowKeys SecKey)
 Overloaded from setSecurity. More...
 

Static Public Member Functions

static QString eventTypeString (const EventType &val)
 Converts EventType to its string representation. More...
 
static EventType stringEventType (QString val)
 Converts a string to the corresponding EventType. More...
 

Properties

QDateTime endDateTime
 The last date/time of the period to retrieve data. More...
 
EventType eventType
 The type of event to retrieve. More...
 
QDateTime startDateTime
 The first date/time of the period to retrieve data. More...
 
- Properties inherited from QBbgLib::QBbgAbstractRequest
bool isValidReq
 Checks if the request is valid. More...
 
qint64 requestID
 The request unique identifier. More...
 
RequestType requestType
 The type of the request. More...
 
QBbgSecurity security
 The security associated with the request. More...
 

Related Functions

(Note that these are not member functions.)

uint qHash (QBbgLib::QBbgAbstractIntradayRequest::EventType key, uint seed)
 Allows EventType to be used as a key of a QHash. More...
 

Detailed Description

Base class for intraday requests.

Member Enumeration Documentation

Type of event to capture.

Enumerator
Invalid 

Invalid Request Event Type

TRADE 

Corresponds to LAST_PRICE

BID 

Depending on the exchange bid ticks will be returned as BID, BID_BEST or BEST_BID.

ASK 

Depending on the exchange ask ticks will be returned as ASK, ASK_BEST or BEST_ASK.

BID_BEST 

Depending on the exchange bid ticks will be returned as BID, BID_BEST or BEST_BID.

ASK_BEST 

Depending on the exchange ask ticks will be returned as ASK, ASK_BEST or BEST_ASK.

MID_PRICE 

Only applies to the LSE.
The mid price is equal to the sum of the best bid price and the best offer price divided by two, and rounded up to be consistent with the relevant price format.

AT_TRADE 

Automatic trade for London Sets stocks.

BEST_BID 

Depending on the exchange bid ticks will be returned as BID, BID_BEST or BEST_BID.

BEST_ASK 

Depending on the exchange ask ticks will be returned as ASK, ASK_BEST or BEST_ASK.

Constructor & Destructor Documentation

virtual QBbgLib::QBbgAbstractIntradayRequest::~QBbgAbstractIntradayRequest ( )
pure virtual

Destructor.

Member Function Documentation

virtual const QDateTime& QBbgLib::QBbgAbstractIntradayRequest::endDateTime ( ) const
virtual

The last date/time of the period to retrieve data.

virtual EventType QBbgLib::QBbgAbstractIntradayRequest::eventType ( ) const
virtual

Returns the type of event to retrieve.

static QString QBbgLib::QBbgAbstractIntradayRequest::eventTypeString ( const EventType val)
static

Converts EventType to its string representation.

virtual bool QBbgLib::QBbgAbstractIntradayRequest::isValidReq ( ) const
overridevirtual

Reimplemented from QBbgAbstractRequest::isValidReq()

Reimplemented from QBbgLib::QBbgAbstractRequest.

virtual QBbgAbstractIntradayRequest& QBbgLib::QBbgAbstractIntradayRequest::operator= ( const QBbgAbstractIntradayRequest a)
virtual

Copies another tick data request.

virtual bool QBbgLib::QBbgAbstractIntradayRequest::operator== ( const QBbgAbstractIntradayRequest other) const
virtual

Checks if two requests are identical.

virtual void QBbgLib::QBbgAbstractIntradayRequest::setDateTimeRange ( QDateTime  startDt,
QDateTime  endDt 
)
virtual

Set the period range to retrieve.

Equivalent to setStartDateTime(startDt); setEndDateTime(endDt); but automatically swaps the dates if endDt is earlier than startDt

virtual void QBbgLib::QBbgAbstractIntradayRequest::setEndDateTime ( const QDateTime &  val)
virtual

Set the last date/time of the period to retrieve data.

virtual void QBbgLib::QBbgAbstractIntradayRequest::setEventType ( EventType  val)
virtual

Set the type of event to retrieve.

virtual void QBbgLib::QBbgAbstractIntradayRequest::setSecurity ( const QBbgSecurity val)
overridevirtual

Reimplemented from QBbgAbstractRequest::setSecurity()

Reimplemented from QBbgLib::QBbgAbstractRequest.

virtual void QBbgLib::QBbgAbstractIntradayRequest::setStartDateTime ( const QDateTime &  val)
virtual

Set the first date/time of the period to retrieve data.

virtual const QDateTime& QBbgLib::QBbgAbstractIntradayRequest::startDateTime ( ) const
virtual

The first date/time of the period to retrieve data.

static EventType QBbgLib::QBbgAbstractIntradayRequest::stringEventType ( QString  val)
static

Converts a string to the corresponding EventType.

Friends And Related Function Documentation

uint qHash ( QBbgLib::QBbgAbstractIntradayRequest::EventType  key,
uint  seed 
)
related

Allows EventType to be used as a key of a QHash.

Property Documentation

QDateTime QBbgLib::QBbgAbstractIntradayRequest::endDateTime
readwrite

The last date/time of the period to retrieve data.

Read
endDateTime
Write
setEndDateTime
EventType QBbgLib::QBbgAbstractIntradayRequest::eventType
readwrite

The type of event to retrieve.

Read
eventType
Write
setEventType
QDateTime QBbgLib::QBbgAbstractIntradayRequest::startDateTime
readwrite

The first date/time of the period to retrieve data.

Read
startDateTime
Write
setStartDateTime

The documentation for this class was generated from the following file: