PortfolioControl

class HPS.PortfolioControl : HPS.Control

The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.

Public Functions

override void Dispose ()

ulong GetCount ()

Returns the number of portfolios in use here.

override HPS.Type ObjectType ()

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).

Return:The declared type of the object in question, which may differ from the true, underlying type.

bool Pop ()

Removes the top portfolio from the portfolio use stack.

Return:true if a portfolio was present, false otherwise.

bool Pop (out HPS.PortfolioKey out_portfolio)

Removes the top portfolio from the portfolio use stack and gives information about it to the user.

Param out_portfolio:  The source portfolio. Return:true if a portfolio was present, false otherwise.

PortfolioControl (HPS.PortfolioControl in_that)

Initializes a control tied to the same object as in_that.

PortfolioControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

HPS.PortfolioControl Push (HPS.PortfolioKey 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.

Param in_portfolio:  The portfolio to push to the top of the portfolio use stack. Return:A reference to this object.

HPS.PortfolioControl Set (HPS.PortfolioKey in_portfolio)

Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use.

Param in_portfolio:  A portfolio containing definitions that should be imported. Return:A reference to this object.

HPS.PortfolioControl Set (HPS.PortfolioKey[] in_portfolios)

Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.

Param in_portfolios:  An array of source portfolios to be used. Return:A reference to this object.

bool Show (out HPS.PortfolioKey[] out_portfolios)

Shows all portfolios in use on this segment.

Param out_portfolios:  Keys to all portfolios in use on this segment. Return:true if any portfolio was present, false otherwise.

bool ShowTop (out HPS.PortfolioKey out_portfolio)

Shows the top portfolio on the portfolio use stack.

Param out_portfolio:  The portfolio on top of the stack. Return:true if a portfolio was present, false otherwise.

HPS.PortfolioControl UnsetEverything ()

Removes all portfolios from the portfolio use stack.

Return:A reference to this object.

HPS.PortfolioControl UnsetTop ()

Removes the top portfolio from the portfolio use stack.

Return:A reference to this object.