< Home

< Table of Contents

REFERENCE MANUAL

HPS.PortfolioControl Class Reference

The PortfolioControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.PortfolioControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
ulong GetCount ()
 Returns the number of portfolios in use here. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
bool Pop ()
 Removes the top portfolio from the portfolio use stack. More...
 
bool Pop (out HPS.PortfolioKey out_portfolio)
 Removes the top portfolio from the portfolio use stack and gives information about it to the user. More...
 
 PortfolioControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 PortfolioControl (HPS.PortfolioControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
HPS.PortfolioControl Push (HPS.PortfolioKey in_portfolio)
 Adds a portfolio to the top of the portfolio use stack. More...
 
HPS.PortfolioControl Set (HPS.PortfolioKey in_portfolio)
 Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use. More...
 
HPS.PortfolioControl Set (HPS.PortfolioKey[] in_portfolios)
 Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use. More...
 
bool Show (out HPS.PortfolioKey[] out_portfolios)
 Shows all portfolios in use on this segment. More...
 
bool ShowTop (out HPS.PortfolioKey out_portfolio)
 Shows the top portfolio on the portfolio use stack. More...
 
HPS.PortfolioControl UnsetEverything ()
 Removes all portfolios from the portfolio use stack. More...
 
HPS.PortfolioControl UnsetTop ()
 Removes the top portfolio from the portfolio use stack. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The PortfolioControl class is a smart pointer that is tied to a database object.

Controls are used for manipulating settings within the database.

Constructor & Destructor Documentation

HPS.PortfolioControl.PortfolioControl ( HPS.SegmentKey  in_seg)

Initializes a control tied to the segment in_seg.

HPS.PortfolioControl.PortfolioControl ( HPS.PortfolioControl  in_that)

Initializes a control tied to the same object as in_that.

Member Function Documentation

ulong HPS.PortfolioControl.GetCount ( )

Returns the number of portfolios in use here.

override HPS.Type HPS.PortfolioControl.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

bool HPS.PortfolioControl.Pop ( )

Removes the top portfolio from the portfolio use stack.

Returns
true if a portfolio was present, false otherwise.
bool HPS.PortfolioControl.Pop ( out HPS.PortfolioKey  out_portfolio)

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

Parameters
out_portfolioThe source portfolio.
Returns
true if a portfolio was present, false otherwise.
HPS.PortfolioControl 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.

Parameters
in_portfolioThe portfolio to push to the top of the portfolio use stack.
Returns
A reference to this object.
HPS.PortfolioControl HPS.PortfolioControl.Set ( HPS.PortfolioKey  in_portfolio)

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

Parameters
in_portfolioA portfolio containing definitions that should be imported.
Returns
A reference to this object.
HPS.PortfolioControl HPS.PortfolioControl.Set ( HPS.PortfolioKey[]  in_portfolios)

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

Parameters
in_portfoliosAn array of source portfolios to be used.
Returns
A reference to this object.
bool HPS.PortfolioControl.Show ( out HPS.PortfolioKey[]  out_portfolios)

Shows all portfolios in use on this segment.

Parameters
out_portfoliosKeys to all portfolios in use on this segment.
Returns
true if any portfolio was present, false otherwise.
bool HPS.PortfolioControl.ShowTop ( out HPS.PortfolioKey  out_portfolio)

Shows the top portfolio on the portfolio use stack.

Parameters
out_portfolioThe portfolio on top of the stack.
Returns
true if a portfolio was present, false otherwise.
HPS.PortfolioControl HPS.PortfolioControl.UnsetEverything ( )

Removes all portfolios from the portfolio use stack.

Returns
A reference to this object.
HPS.PortfolioControl HPS.PortfolioControl.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: