The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database. More...
Public Member Functions | |
override void | Dispose () |
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... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
ulong | GetCount () |
Returns the number of portfolios in use here. More... | |
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. 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... | |
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... | |
HPS.PortfolioControl | UnsetTop () |
Removes the top portfolio from the portfolio use stack. More... | |
HPS.PortfolioControl | UnsetEverything () |
Removes all portfolios from the portfolio use stack. More... | |
bool | ShowTop (out HPS.PortfolioKey out_portfolio) |
Shows the top portfolio on the portfolio use stack. More... | |
bool | Show (out HPS.PortfolioKey[] out_portfolios) |
Shows all portfolios in use on this segment. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
IntPtr | GetClassID () |
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... | |
HPS.Type | Type () |
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. More... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
|
inline |
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.Object.
|
inline |
Removes the top portfolio from the portfolio use stack.
|
inline |
Removes the top portfolio from the portfolio use stack and gives information about it to the user.
out_portfolio | The source 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.
in_portfolio | The portfolio to push to the top of the portfolio use stack. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Shows all portfolios in use on this segment.
out_portfolios | Keys to all portfolios in use on this segment. |
|
inline |
Shows the top portfolio on the portfolio use stack.
out_portfolio | The portfolio on top of the stack. |
|
inline |
Removes all portfolios from the portfolio use stack.
|
inline |
Removes the top portfolio from the portfolio use stack.