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

A portfolio request. More...

#include <QBbgPortfolioDataRequest.h>

Inheritance diagram for QBbgLib::QBbgPortfolioDataRequest:
QBbgLib::QBbgAbstractFieldRequest QBbgLib::QBbgAbstractRequest

Public Types

enum  PortfolioFields { PortfolioFields::PORTFOLIO_MPOSITION, PortfolioFields::PORTFOLIO_MWEIGHT, PortfolioFields::PORTFOLIO_DATA, PortfolioFields::PORTFOLIO_MEMBERS }
 Available fields for the request. 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

 QBbgPortfolioDataRequest ()
 Creates an empty portfolio request. More...
 
 QBbgPortfolioDataRequest (const QBbgPortfolioDataRequest &a)
 Creates a copy of another portfolio request. More...
 
virtual ~QBbgPortfolioDataRequest ()
 Destructor. More...
 
virtual QBbgPortfolioDataRequestoperator= (const QBbgPortfolioDataRequest &a)
 Copies another portfolio request. More...
 
virtual QDate referenceDay () const
 Returns the portfolio reference date or null if not set. More...
 
virtual void setField (const QString &val)
 Reimplemented from QBbgAbstractFieldRequest::setField. More...
 
virtual void setField (PortfolioFields val)
 Sets the field to one of the 4 allowed ones for portfolio requests. More...
 
virtual void setOverrides (const QBbgOverride &Overr)
 Reimplemented from QBbgAbstractFieldRequest::setOverrides. More...
 
virtual void setPortfolio (const QString &tradingSystem, const QString &firmID, const QString &portfolioID)
 AIM/TOMS users can download their portfolios specifying the parameters. More...
 
virtual void setReferenceDay (const QDate &val)
 Sets the date for which to retrieve the portfolio. More...
 
virtual void setSecurity (const QBbgSecurity &val)
 Reimplemented from QBbgAbstractRequest::setSecurity. More...
 
- Public Member Functions inherited from QBbgLib::QBbgAbstractFieldRequest
virtual ~QBbgAbstractFieldRequest ()=0
 Destructor. More...
 
virtual void clearOverrides ()
 Remove all overrides from a request. More...
 
virtual const QString & field () const
 The field related to the request. More...
 
virtual bool isValidReq () const
 Reimplemented from QBbgAbstractRequest::isValidReq. More...
 
virtual QBbgAbstractFieldRequestoperator= (const QBbgAbstractFieldRequest &a)
 Copies another request. More...
 
virtual bool operator== (const QBbgAbstractFieldRequest &a) const
 Checks if two requests are identical. More...
 
virtual const QBbgOverrideoverrides () const
 Returns the set of overrides applied to the request. 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...
 

Properties

QDate referenceDay
 The portfolio reference date. More...
 
- Properties inherited from QBbgLib::QBbgAbstractFieldRequest
QString field
 The field associated with the request. More...
 
QBbgOverride overrides
 The overrides applied to the request. 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...
 

Additional Inherited Members

Detailed Description

A portfolio request.

This class allows to request data regarding portfolios set up in PRTU on the terminal.
Only securities with the QBbgSecurity::Client extension can be used.
This is equivalent to using BDS() bloomberg function with a Client security in excel.

Member Enumeration Documentation

Available fields for the request.

Enumerator
PORTFOLIO_MPOSITION 

The list of securities and nominal of holdings in the portfolio

PORTFOLIO_MWEIGHT 

The list of securities and relative weight of holdings in the portfolio

PORTFOLIO_DATA 

All available portfolio data

PORTFOLIO_MEMBERS 

The list of securities in the portfolio

Constructor & Destructor Documentation

virtual QBbgLib::QBbgPortfolioDataRequest::~QBbgPortfolioDataRequest ( )
virtual

Destructor.

QBbgLib::QBbgPortfolioDataRequest::QBbgPortfolioDataRequest ( )

Creates an empty portfolio request.

QBbgLib::QBbgPortfolioDataRequest::QBbgPortfolioDataRequest ( const QBbgPortfolioDataRequest a)

Creates a copy of another portfolio request.

Member Function Documentation

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

Copies another portfolio request.

virtual QDate QBbgLib::QBbgPortfolioDataRequest::referenceDay ( ) const
virtual

Returns the portfolio reference date or null if not set.

virtual void QBbgLib::QBbgPortfolioDataRequest::setField ( const QString &  val)
virtual
virtual void QBbgLib::QBbgPortfolioDataRequest::setField ( PortfolioFields  val)
virtual

Sets the field to one of the 4 allowed ones for portfolio requests.

virtual void QBbgLib::QBbgPortfolioDataRequest::setOverrides ( const QBbgOverride Overr)
virtual

Reimplemented from QBbgAbstractFieldRequest::setOverrides.

Note
The only allowed override is for this request is REFERENCE_DATE

Reimplemented from QBbgLib::QBbgAbstractFieldRequest.

virtual void QBbgLib::QBbgPortfolioDataRequest::setPortfolio ( const QString &  tradingSystem,
const QString &  firmID,
const QString &  portfolioID 
)
virtual

AIM/TOMS users can download their portfolios specifying the parameters.

  • tradingSystem The trading system code (e.g. TS)
  • firmID the firm id shown in all AIM/TOMS pages in the command bar, without # or spaces
  • portfolioID The id of the portfolio shown in the rightmost column of PRTU
    Deprecated:
    Not general, will be removed
virtual void QBbgLib::QBbgPortfolioDataRequest::setReferenceDay ( const QDate &  val)
virtual

Sets the date for which to retrieve the portfolio.

a null QDate will retrieve the current live portfolio

virtual void QBbgLib::QBbgPortfolioDataRequest::setSecurity ( const QBbgSecurity val)
virtual

Reimplemented from QBbgAbstractRequest::setSecurity.

Reimplemented from QBbgLib::QBbgAbstractRequest.

Property Documentation

QDate QBbgLib::QBbgPortfolioDataRequest::referenceDay
readwrite

The portfolio reference date.

Read
referenceDay()
Write
setReferenceDay()

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