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

Base class for all requests sent to Bloomberg. More...

#include <QBbgAbstractRequest.h>

Inheritance diagram for QBbgLib::QBbgAbstractRequest:
QBbgLib::QBbgAbstractFieldRequest QBbgLib::QBbgAbstractIntradayRequest QBbgLib::QBbgHistoricalDataRequest QBbgLib::QBbgPortfolioDataRequest QBbgLib::QBbgReferenceDataRequest QBbgLib::QBbgIntradayTickRequest

Public Types

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 ~QBbgAbstractRequest ()=0
 Destructor. More...
 
virtual qint64 getID () const
 Returns the current ID for the request. More...
 
virtual bool isValidReq () const
 Checks if the request is valid. 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 QBbgSecurity &val)
 Sets the security for the current request to the specified one. More...
 
virtual void setSecurity (const QString &SecName, QBbgSecurity::YellowKeys SecKey)
 Overloaded from setSecurity. More...
 

Properties

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::QBbgAbstractRequest::RequestType key, uint seed=0)
 Allows QBbgAbstractRequest::RequestType to be used as a key of a QHash. More...
 

Detailed Description

Base class for all requests sent to Bloomberg.

Member Enumeration Documentation

Type of Request.

Enumerator
Invalid 

Invalid Type

Beqs 

Currently Unavailable

HistoricalData 

Request for historical data

ReferenceData 

Request for static data

PortfolioData 

Request for portfolio data

IntraDayTick 

Tick-by-tick historical data

IntraDayBar 

Currently Unavailable

Special requestID codes.

Enumerator
InvalidID 

Invalid Request

Constructor & Destructor Documentation

virtual QBbgLib::QBbgAbstractRequest::~QBbgAbstractRequest ( )
pure virtual

Destructor.

Member Function Documentation

virtual qint64 QBbgLib::QBbgAbstractRequest::getID ( ) const
virtual

Returns the current ID for the request.

If the ID is not set or invalid SpecialIDs::InvalidID will be returned

virtual bool QBbgLib::QBbgAbstractRequest::isValidReq ( ) const
virtual
virtual QBbgAbstractRequest& QBbgLib::QBbgAbstractRequest::operator= ( const QBbgAbstractRequest other)
virtual

Copies another request.

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

Checks if two requests are identical.

virtual RequestType QBbgLib::QBbgAbstractRequest::requestType ( ) const
virtual

Returns the type of request.

virtual const QBbgSecurity& QBbgLib::QBbgAbstractRequest::security ( ) const
virtual

Returns the security associated with the request.

virtual void QBbgLib::QBbgAbstractRequest::setID ( qint64  val)
virtual

Set the ID associated to the current request.

Note
Negative values are reserved so only 65 bits can be used to determine the ID
virtual void QBbgLib::QBbgAbstractRequest::setSecurity ( const QBbgSecurity val)
virtual

Sets the security for the current request to the specified one.

Reimplemented in QBbgLib::QBbgHistoricalDataRequest, QBbgLib::QBbgAbstractIntradayRequest, QBbgLib::QBbgPortfolioDataRequest, and QBbgLib::QBbgReferenceDataRequest.

virtual void QBbgLib::QBbgAbstractRequest::setSecurity ( const QString &  SecName,
QBbgSecurity::YellowKeys  SecKey 
)
virtual

Overloaded from setSecurity.

  • SecName Name of the security to add
  • SecKey Yellow key or code identifier for the security

Sets the security for the current request to the specified one

Friends And Related Function Documentation

uint qHash ( QBbgLib::QBbgAbstractRequest::RequestType  key,
uint  seed = 0 
)
related

Allows QBbgAbstractRequest::RequestType to be used as a key of a QHash.

Property Documentation

bool QBbgLib::QBbgAbstractRequest::isValidReq
read

Checks if the request is valid.

Read
isValidReq()
qint64 QBbgLib::QBbgAbstractRequest::requestID
readwrite

The request unique identifier.

Read
getID()
Write
setID()
RequestType QBbgLib::QBbgAbstractRequest::requestType
read

The type of the request.

Read
requestType()
QBbgSecurity QBbgLib::QBbgAbstractRequest::security
readwrite

The security associated with the request.

Read
security()
Write
setSecurity()

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