#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::PortfolioControl |
|
static const HPS::Type | staticType = HPS::Type::Control |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.
◆ PortfolioControl() [1/3]
HPS::PortfolioControl::PortfolioControl |
( |
SegmentKey & |
in_seg | ) |
|
|
explicit |
Initializes a control tied to the segment in_seg.
◆ PortfolioControl() [2/3]
Initializes a control tied to the same object as in_that.
◆ PortfolioControl() [3/3]
The move constructor creates a PortfolioControl by transferring the underlying impl of the rvalue reference to this StyleControl thereby avoiding a copy and allocation.
- Parameters
-
◆ ~PortfolioControl()
HPS::PortfolioControl::~PortfolioControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
◆ GetCount()
size_t HPS::PortfolioControl::GetCount |
( |
| ) |
const |
Returns the number of portfolios in use here.
◆ ObjectType()
HPS::Type HPS::PortfolioControl::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Control.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this PortfolioControl thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this PortfolioControl.
◆ operator=() [2/2]
◆ Pop() [1/2]
bool HPS::PortfolioControl::Pop |
( |
| ) |
|
Removes the top portfolio from the portfolio use stack.
- Returns
- true if a portfolio was present, false otherwise.
◆ Pop() [2/2]
bool HPS::PortfolioControl::Pop |
( |
PortfolioKey & |
out_portfolio | ) |
|
Removes the top portfolio from the portfolio use stack and gives information about it to the user.
- Parameters
-
out_portfolio | The source portfolio. |
- Returns
- true if a portfolio was present, false otherwise.
◆ Push()
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.
- Parameters
-
in_portfolio | The portfolio to push to the top of the portfolio use stack. |
- Returns
- A reference to this object.
◆ Set() [1/3]
Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use.
- Parameters
-
in_portfolio | A portfolio containing definitions that should be imported. |
- Returns
- A reference to this object.
◆ Set() [2/3]
Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.
- Parameters
-
in_portfolios | An array of source portfolios to be used. |
- Returns
- A reference to this object.
◆ Set() [3/3]
Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.
- Parameters
-
in_count | The length of the source array. |
in_portfolios | An array of source portfolios to be used. |
- Returns
- A reference to this object.
◆ Show()
Shows all portfolios in use on this segment.
- Parameters
-
out_portfolios | Keys to all portfolios in use on this segment. |
- Returns
- true if any portfolio was present, false otherwise.
◆ ShowTop()
bool HPS::PortfolioControl::ShowTop |
( |
PortfolioKey & |
out_portfolio | ) |
const |
Shows the top portfolio on the portfolio use stack.
- Parameters
-
out_portfolio | The portfolio on top of the stack. |
- Returns
- true if a portfolio was present, false otherwise.
◆ Type()
virtual HPS::Type HPS::PortfolioControl::Type |
( |
| ) |
const |
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ UnsetEverything()
Removes all portfolios from the portfolio use stack.
- Returns
- A reference to this object.
◆ UnsetTop()
Removes the top portfolio from the portfolio use stack.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: