REFERENCE MANUAL
The LinePatternKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this LinePatternKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LinePatternKit in_kit) |
Check if the source LinePatternKit is equivalent to this LinePatternKit. More... | |
override int | GetHashCode () |
LinePatternKit () | |
The default constructor creates an empty LinePatternKit object. More... | |
LinePatternKit (HPS.LinePatternKit in_kit) | |
The copy constructor creates a new LinePatternKit object that contains the same settings as the source LinePatternKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.LinePatternKit in_kit) |
Copies the source LinePatternKit into this LinePatternKit. More... | |
HPS.LinePatternKit | SetJoin (HPS.LinePattern.Join in_type) |
Sets the type of join to use for this LinePatternKit. More... | |
HPS.LinePatternKit | SetParallels (HPS.LinePatternParallelKit[] in_parallels) |
Sets the line pattern parallel array for this LinePatternKit. More... | |
void | Show (out HPS.LinePatternKit out_kit) |
Copies this LinePatternKit into the given LinePatternKit. More... | |
bool | ShowJoin (out HPS.LinePattern.Join out_type) |
Shows the type of join to use for this LinePatternKit. More... | |
bool | ShowParallels (out HPS.LinePatternParallelKit[] out_parallels) |
Shows the line pattern parallel array for this LinePatternKit. More... | |
HPS.LinePatternKit | UnsetEverything () |
Removes all settings from this LinePatternKit. More... | |
HPS.LinePatternKit | UnsetJoin () |
Removes the type of join to use for this LinePatternKit. More... | |
HPS.LinePatternKit | UnsetParallels () |
Removes the line pattern parallel array for this LinePatternKit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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. More... | |
Static Public Member Functions | |
static HPS.LinePatternKit | GetDefault (HPS.LinePattern.Default in_default_line_pattern) |
Creates a LinePatternKit which contains the definition of the specified default line pattern. More... | |
static bool | operator!= (HPS.LinePatternKit a, HPS.LinePatternKit b) |
static bool | operator== (HPS.LinePatternKit a, HPS.LinePatternKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The LinePatternKit class is a user space object.
It is used when defining a line pattern.
HPS.LinePatternKit.LinePatternKit | ( | ) |
The default constructor creates an empty LinePatternKit object.
HPS.LinePatternKit.LinePatternKit | ( | HPS.LinePatternKit | in_kit | ) |
The copy constructor creates a new LinePatternKit object that contains the same settings as the source LinePatternKit.
in_kit | The source <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> to copy. |
|
virtual |
Indicates whether this LinePatternKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.LinePatternKit.Equals | ( | HPS.LinePatternKit | in_kit | ) |
Check if the source LinePatternKit is equivalent to this LinePatternKit.
in_kit | The source <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> to compare to this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
|
static |
Creates a LinePatternKit which contains the definition of the specified default line pattern.
in_default_line_pattern | The default line pattern for which to get the corresponding <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
|
virtual |
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.
void HPS.LinePatternKit.Set | ( | HPS.LinePatternKit | in_kit | ) |
Copies the source LinePatternKit into this LinePatternKit.
in_kit | The source <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> to copy. |
HPS.LinePatternKit HPS.LinePatternKit.SetJoin | ( | HPS.LinePattern.Join | in_type | ) |
Sets the type of join to use for this LinePatternKit.
in_type | The type of join to use for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
HPS.LinePatternKit HPS.LinePatternKit.SetParallels | ( | HPS.LinePatternParallelKit[] | in_parallels | ) |
Sets the line pattern parallel array for this LinePatternKit.
in_parallels | The line pattern parallel array for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
void HPS.LinePatternKit.Show | ( | out HPS.LinePatternKit | out_kit | ) |
Copies this LinePatternKit into the given LinePatternKit.
out_kit | The <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
bool HPS.LinePatternKit.ShowJoin | ( | out HPS.LinePattern.Join | out_type | ) |
Shows the type of join to use for this LinePatternKit.
out_type | The type of join to use for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
bool HPS.LinePatternKit.ShowParallels | ( | out HPS.LinePatternParallelKit[] | out_parallels | ) |
Shows the line pattern parallel array for this LinePatternKit.
out_parallels | The line pattern parallel array for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>. |
HPS.LinePatternKit HPS.LinePatternKit.UnsetEverything | ( | ) |
Removes all settings from this LinePatternKit.
HPS.LinePatternKit HPS.LinePatternKit.UnsetJoin | ( | ) |
Removes the type of join to use for this LinePatternKit.
HPS.LinePatternKit HPS.LinePatternKit.UnsetParallels | ( | ) |
Removes the line pattern parallel array for this LinePatternKit.