#include <hps.h>
Public Member Functions | |
| PortfolioControl (SegmentKey &in_seg) | |
| PortfolioControl (PortfolioControl const &in_that) | |
| PortfolioControl (PortfolioControl &&in_that) | |
| PortfolioControl & | operator= (PortfolioControl &&in_that) |
| ~PortfolioControl () | |
| HPS::Type | ObjectType () const |
| PortfolioControl & | operator= (PortfolioControl const &in_that) |
| size_t | GetCount () const |
| PortfolioControl & | Push (PortfolioKey const &in_portfolio) |
| bool | Pop () |
| bool | Pop (PortfolioKey &out_portfolio) |
| PortfolioControl & | Set (PortfolioKey const &in_portfolio) |
| PortfolioControl & | Set (PortfolioKeyArray const &in_portfolios) |
| PortfolioControl & | Set (size_t in_count, PortfolioKey const in_portfolios[]) |
| PortfolioControl & | UnsetTop () |
| PortfolioControl & | UnsetEverything () |
| bool | ShowTop (PortfolioKey &out_portfolio) const |
| bool | Show (PortfolioKeyArray &out_portfolios) const |
Public Member Functions inherited from HPS::Object | |
| Object & | operator= (Object const &other_object) |
| Object (Object &&in_that) | |
| Object & | operator= (Object &&in_that) |
| HPS::Type | Type () const |
| virtual bool | Empty () const |
| virtual void | Reset () |
| bool | HasType (HPS::Type in_mask) const |
| intptr_t | GetClassID () const |
| intptr_t | GetInstanceID () const |
Additional Inherited Members | |
Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.
|
explicit |
Initializes a control tied to the segment in_seg.
| HPS::PortfolioControl::PortfolioControl | ( | PortfolioControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
| HPS::PortfolioControl::PortfolioControl | ( | PortfolioControl && | in_that | ) |
The move constructor creates a PortfolioControl by transferring the underlying impl of the rvalue reference to this StyleControl thereby avoiding a copy and allocation.
| in_that | An rvalue reference to a PortfolioControl to take the impl from. |
| HPS::PortfolioControl::~PortfolioControl | ( | ) |
Releases a reference to the database object this control is tied to.
| size_t HPS::PortfolioControl::GetCount | ( | ) | const |
Returns the number of portfolios in use here.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
| PortfolioControl& HPS::PortfolioControl::operator= | ( | PortfolioControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this PortfolioControl thereby avoiding a copy.
| in_that | An rvalue reference to a PortfolioControl to take the impl from. |
| PortfolioControl& HPS::PortfolioControl::operator= | ( | PortfolioControl const & | in_that | ) |
Share the smart-pointer.
| bool HPS::PortfolioControl::Pop | ( | ) |
Removes the top portfolio from the portfolio use stack.
| bool HPS::PortfolioControl::Pop | ( | PortfolioKey & | out_portfolio | ) |
Removes the top portfolio from the portfolio use stack and gives information about it to the user.
| out_portfolio | The source portfolio. |
| PortfolioControl& HPS::PortfolioControl::Push | ( | PortfolioKey const & | in_portfolio | ) |
Adds a portfolio to the top of the portfolio use stack. Existing portfolios in use are unmodified but portfolios on top take precedence if there are conflicting definitions.
| in_portfolio | The portfolio to push to the top of the portfolio use stack. |
| PortfolioControl& HPS::PortfolioControl::Set | ( | PortfolioKey const & | in_portfolio | ) |
Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use.
| in_portfolio | A portfolio containing definitions that should be imported. |
| PortfolioControl& HPS::PortfolioControl::Set | ( | PortfolioKeyArray const & | in_portfolios | ) |
Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.
| in_portfolios | An array of source portfolios to be used. |
| PortfolioControl& HPS::PortfolioControl::Set | ( | size_t | in_count, |
| PortfolioKey const | in_portfolios[] | ||
| ) |
Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.
| in_count | The length of the source array. |
| in_portfolios | An array of source portfolios to be used. |
| bool HPS::PortfolioControl::Show | ( | PortfolioKeyArray & | out_portfolios | ) | const |
Shows all portfolios in use on this segment.
| out_portfolios | Keys to all portfolios in use on this segment. |
| bool HPS::PortfolioControl::ShowTop | ( | PortfolioKey & | out_portfolio | ) | const |
Shows the top portfolio on the portfolio use stack.
| out_portfolio | The portfolio on top of the stack. |
| PortfolioControl& HPS::PortfolioControl::UnsetEverything | ( | ) |
Removes all portfolios from the portfolio use stack.
| PortfolioControl& HPS::PortfolioControl::UnsetTop | ( | ) |
Removes the top portfolio from the portfolio use stack.