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

Public Member Functions

override void Dispose ()
 
ulong GetCount ()
 
override HPS.Type ObjectType ()
 
bool Pop ()
 
bool Pop (out HPS.PortfolioKey out_portfolio)
 
 PortfolioControl (HPS.SegmentKey in_seg)
 
 PortfolioControl (HPS.PortfolioControl in_that)
 
HPS.PortfolioControl Push (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioControl Set (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioControl Set (HPS.PortfolioKey[] in_portfolios)
 
bool Show (out HPS.PortfolioKey[] out_portfolios)
 
bool ShowTop (out HPS.PortfolioKey out_portfolio)
 
override HPS.Type Type ()
 
HPS.PortfolioControl UnsetEverything ()
 
HPS.PortfolioControl UnsetTop ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

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
 

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

◆ PortfolioControl() [1/2]

HPS.PortfolioControl.PortfolioControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ PortfolioControl() [2/2]

HPS.PortfolioControl.PortfolioControl ( HPS.PortfolioControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ GetCount()

ulong HPS.PortfolioControl.GetCount ( )
inline

Returns the number of portfolios in use here.

◆ ObjectType()

override HPS.Type HPS.PortfolioControl.ObjectType ( )
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.

◆ Pop() [1/2]

bool HPS.PortfolioControl.Pop ( )
inline

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 ( out HPS.PortfolioKey  out_portfolio)
inline

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.

◆ Push()

HPS.PortfolioControl HPS.PortfolioControl.Push ( HPS.PortfolioKey  in_portfolio)
inline

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.

◆ Set() [1/2]

HPS.PortfolioControl HPS.PortfolioControl.Set ( HPS.PortfolioKey  in_portfolio)
inline

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.

◆ Set() [2/2]

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

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.

◆ Show()

bool HPS.PortfolioControl.Show ( out HPS.PortfolioKey []  out_portfolios)
inline

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.

◆ ShowTop()

bool HPS.PortfolioControl.ShowTop ( out HPS.PortfolioKey  out_portfolio)
inline

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.

◆ Type()

override HPS.Type HPS.PortfolioControl.Type ( )
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()

HPS.PortfolioControl HPS.PortfolioControl.UnsetEverything ( )
inline

Removes all portfolios from the portfolio use stack.

Returns
A reference to this object.

◆ UnsetTop()

HPS.PortfolioControl HPS.PortfolioControl.UnsetTop ( )
inline

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:
  • internals/hps_core/source/cs/HPS.PortfolioControl.cs