The LinePatternDefinition class is a smart pointer to a database object. It is a handle to a line pattern defined within a portfolio. More...

Public Member Functions | |
override void | Dispose () |
LinePatternDefinition () | |
The default constructor creates an uninitialized LinePatternDefinition object. The Type() function will return Type::None. More... | |
LinePatternDefinition (HPS.Definition in_that) | |
This constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a line pattern definition. Otherwise the copy will fail and the resulting LinePatternDefinition will be invalid. More... | |
LinePatternDefinition (HPS.LinePatternDefinition in_that) | |
The copy constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source LinePatternDefinition. 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... | |
void | Set (HPS.LinePatternKit in_kit) |
Redefine the line pattern for this LinePatternDefinition. More... | |
void | Show (out HPS.LinePatternKit out_kit) |
Shows the line pattern for this LinePatternDefinition. More... | |
![]() | |
virtual void | Assign (HPS.Definition in_that) |
Associate this Definition with the same underlying impl as the source Definition. More... | |
Definition () | |
The default constructor creates an uninitialized Definition object. The Type() function will return Type::None. More... | |
Definition (HPS.Definition in_that) | |
The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Definition in_that) |
Check if the source Definition is equivalent to this Definition. More... | |
override int | GetHashCode () |
string | Name () |
Get the name given to this Definition when it was defined. More... | |
HPS.PortfolioKey | Owner () |
Get the portfolio that owns this Definition. More... | |
void | Undefine () |
Removes this definition from the owning portfolio. More... | |
![]() | |
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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The LinePatternDefinition class is a smart pointer to a database object. It is a handle to a line pattern defined within a portfolio.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized LinePatternDefinition object. The Type() function will return Type::None.
|
inline |
This constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a line pattern definition. Otherwise the copy will fail and the resulting LinePatternDefinition will be invalid.
- Parameters
-
in_that The source Definition to copy.
|
inline |
The copy constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source LinePatternDefinition.
- Parameters
-
in_that The source LinePatternDefinition to copy.
Member Function Documentation
|
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.Definition.
|
inline |
Redefine the line pattern for this LinePatternDefinition.
- Parameters
-
in_kit The new line pattern for this LinePatternDefinition.
|
inline |
Shows the line pattern for this LinePatternDefinition.
- Parameters
-
out_kit The line pattern for this LinePatternDefinition.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LinePatternDefinition.cs