QBbgLib  0.4
Qt wrapper for the Bloomberg API
Public Member Functions | Properties | List of all members
QBbgLib::QBbgReferenceDataResponse Class Reference

Response for static data. More...

#include <QBbgReferenceDataResponse.h>

Inheritance diagram for QBbgLib::QBbgReferenceDataResponse:
QBbgLib::QBbgAbstractFieldResponse QBbgLib::QBbgAbstractResponse

Public Member Functions

 QBbgReferenceDataResponse ()
 Creates an empty response. More...
 
 QBbgReferenceDataResponse (const QBbgReferenceDataResponse &other)
 Creates a copy of another response. More...
 
virtual ~QBbgReferenceDataResponse ()
 Destructor. More...
 
virtual qint32 columns () const
 Number of columns in the tabular result. More...
 
virtual const QBbgReferenceDataResponsegetTableValue (qint32 r, qint32 c) const
 Returns the result associated with a table cell. More...
 
virtual bool hasTable () const
 Checks if the response has tabular results. More...
 
virtual bool hasValue () const
 Checks if the response has a single value. More...
 
virtual bool isEmpty () const
 Reimplemented from QBbgAbstractResponse::isEmpty() More...
 
virtual QBbgReferenceDataResponseoperator= (const QBbgReferenceDataResponse &other)
 Copies another response. More...
 
virtual qint32 rows () const
 Number of rows in the tabular result. More...
 
virtual const QVariant & value () const
 Returns the single value of the result. More...
 
- Public Member Functions inherited from QBbgLib::QBbgAbstractFieldResponse
virtual ~QBbgAbstractFieldResponse ()=0
 Destructor. More...
 
virtual const QString & header () const
 Header for the response. More...
 
virtual QBbgAbstractFieldResponseoperator= (const QBbgAbstractFieldResponse &a)
 Copies another field response. More...
 
- Public Member Functions inherited from QBbgLib::QBbgAbstractResponse
virtual ~QBbgAbstractResponse ()=0
 Destructor. More...
 
virtual BbgErrorCodes errorCode () const
 The error code associated with the response. More...
 
virtual QString errorMessage () const
 The details of the error. More...
 
virtual QString errorString () const
 String representation of the error. More...
 
virtual qint64 getID () const
 The ID of the response. More...
 
virtual bool hasErrors () const
 Checks if the response has any error. More...
 
virtual QBbgAbstractResponseoperator= (const QBbgAbstractResponse &other)
 Copies another response. More...
 
virtual ResponseType responseType () const
 Returns the type of the current response. More...
 

Properties

qint32 columns
 The number of columns in the tabular result. More...
 
bool hasTable
 Whether the response has tabular results or not. More...
 
qint32 rows
 The number of rows in the tabular result. More...
 
QVariant value
 Whether the response has a single value or not. More...
 
- Properties inherited from QBbgLib::QBbgAbstractFieldResponse
QString header
 Header for the response. More...
 
- Properties inherited from QBbgLib::QBbgAbstractResponse
BbgErrorCodes errorCode
 The error code associated with the response. More...
 
QString errorMessage
 The details of the error. More...
 
QString errorString
 String representation of the error. More...
 
bool hasErrors
 Checks if the response has any error. More...
 
bool isEmpty
 Check if the response contains any value. More...
 
qint64 responseID
 The ID of the response. More...
 
ResponseType responseType
 Returns the type of the current response. More...
 

Additional Inherited Members

- Public Types inherited from QBbgLib::QBbgAbstractResponse
enum  BbgErrorCodesF {
  NoErrors = 0, ResponseError = 0x1, SecurityError = 0x2, InvalidInputs = 0x4,
  SessionError = 0x8, ServiceError = 0x10, FieldError = 0x20, UnknownError = 0x40,
  SessionStopped = 0x80, NoData = 0x100
}
 Flags representing possible errors. More...
 
enum  ResponseType : qint32 {
  ResponseType::Invalid =-1, ResponseType::BeqsResponse, ResponseType::HistoricalDataResponse = FirstFielded, ResponseType::ReferenceDataResponse,
  ResponseType::PortfolioDataResponse, ResponseType::IntraDayTickResponse = FirstRealTime, ResponseType::IntraDayBarResponse
}
 Type of response. More...
 
- Static Public Member Functions inherited from QBbgLib::QBbgAbstractResponse
static QString bbgErrorCode2String (BbgErrorCodes a)
 Converts an error code to the its string representation. More...
 

Detailed Description

Response for static data.

The result can be either a single value or a table depending on the request

Constructor & Destructor Documentation

QBbgLib::QBbgReferenceDataResponse::QBbgReferenceDataResponse ( )

Creates an empty response.

virtual QBbgLib::QBbgReferenceDataResponse::~QBbgReferenceDataResponse ( )
virtual

Destructor.

QBbgLib::QBbgReferenceDataResponse::QBbgReferenceDataResponse ( const QBbgReferenceDataResponse other)

Creates a copy of another response.

Member Function Documentation

virtual qint32 QBbgLib::QBbgReferenceDataResponse::columns ( ) const
virtual

Number of columns in the tabular result.

If hasTable() is false this will return 0

virtual const QBbgReferenceDataResponse* QBbgLib::QBbgReferenceDataResponse::getTableValue ( qint32  r,
qint32  c 
) const
virtual

Returns the result associated with a table cell.

  • r The row index of the table
  • c The column index of the table

If hasTable() is false or any index is out of range a null pointer will be returned

virtual bool QBbgLib::QBbgReferenceDataResponse::hasTable ( ) const
virtual

Checks if the response has tabular results.

virtual bool QBbgLib::QBbgReferenceDataResponse::hasValue ( ) const
virtual

Checks if the response has a single value.

virtual bool QBbgLib::QBbgReferenceDataResponse::isEmpty ( ) const
virtual
virtual QBbgReferenceDataResponse& QBbgLib::QBbgReferenceDataResponse::operator= ( const QBbgReferenceDataResponse other)
virtual

Copies another response.

virtual qint32 QBbgLib::QBbgReferenceDataResponse::rows ( ) const
virtual

Number of rows in the tabular result.

If hasTable() is false this will return 0

virtual const QVariant& QBbgLib::QBbgReferenceDataResponse::value ( ) const
virtual

Returns the single value of the result.

If hasValue() is false this will return a null QVariant

Property Documentation

qint32 QBbgLib::QBbgReferenceDataResponse::columns
read

The number of columns in the tabular result.

Read
columns()
bool QBbgLib::QBbgReferenceDataResponse::hasTable
read

Whether the response has tabular results or not.

Read
hasTable()
qint32 QBbgLib::QBbgReferenceDataResponse::rows
read

The number of rows in the tabular result.

Read
rows()
QVariant QBbgLib::QBbgReferenceDataResponse::value
read

Whether the response has a single value or not.

Read
hasTable()

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