HPS.LinePatternDefinition Class Reference

More...

Inheritance diagram for HPS.LinePatternDefinition:
HPS.Definition HPS.Object

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 (if the object is derived, this does not give the true type of the derived 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...
 
- Public Member Functions inherited from HPS.Definition
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...
 
- 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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...
 
virtual 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 ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Definition
static bool operator!= (HPS.Definition a, HPS.Definition b)
 
static bool operator== (HPS.Definition a, HPS.Definition b)
 
- 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 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

◆ LinePatternDefinition() [1/3]

HPS.LinePatternDefinition.LinePatternDefinition ( )
inline

The default constructor creates an uninitialized LinePatternDefinition object. The Type() function will return Type.None.

◆ LinePatternDefinition() [2/3]

HPS.LinePatternDefinition.LinePatternDefinition ( HPS.Definition  in_that)
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_thatThe source Definition to copy.

◆ LinePatternDefinition() [3/3]

HPS.LinePatternDefinition.LinePatternDefinition ( HPS.LinePatternDefinition  in_that)
inline

The copy constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source LinePatternDefinition.

Parameters
in_thatThe source LinePatternDefinition to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.LinePatternDefinition.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.Definition.

◆ Set()

void HPS.LinePatternDefinition.Set ( HPS.LinePatternKit  in_kit)
inline

Redefine the line pattern for this LinePatternDefinition.

Parameters
in_kitThe new line pattern for this LinePatternDefinition.

◆ Show()

void HPS.LinePatternDefinition.Show ( out HPS.LinePatternKit  out_kit)
inline

Shows the line pattern for this LinePatternDefinition.

Parameters
out_kitThe line pattern for this LinePatternDefinition.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.LinePatternDefinition.cs