
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. This does not necessarily give the true type of the underlying object. 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. Existing portfolios in use are unmodified but portfolios on top take precedence if there are conflicting definitions. 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... | |
override 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... | |
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... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
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.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
|
inline |
Removes the top portfolio from the portfolio use stack.
- Returns
- true if a portfolio was present, false otherwise.
|
inline |
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.
|
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_portfolio The portfolio to push to the top of the portfolio use stack.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Removes all portfolios from the portfolio use stack.
- Returns
- A reference to this object.
|
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