
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LinePatternKit in_kit) |
override int | GetHashCode () |
LinePatternKit () | |
LinePatternKit (HPS.LinePatternKit in_kit) | |
override HPS.Type | ObjectType () |
void | Set (HPS.LinePatternKit in_kit) |
HPS.LinePatternKit | SetJoin (HPS.LinePattern.Join in_type) |
HPS.LinePatternKit | SetParallel (HPS.LinePatternParallelKit in_parallel) |
HPS.LinePatternKit | SetParallels (HPS.LinePatternParallelKit[] in_parallels) |
void | Show (out HPS.LinePatternKit out_kit) |
bool | ShowJoin (out HPS.LinePattern.Join out_type) |
bool | ShowParallels (out HPS.LinePatternParallelKit[] out_parallels) |
HPS.LinePatternKit | UnsetEverything () |
HPS.LinePatternKit | UnsetJoin () |
HPS.LinePatternKit | UnsetParallels () |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
Static Public Member Functions | |
static HPS.LinePatternKit | GetDefault (HPS.LinePattern.Default in_default_line_pattern) |
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 |
Detailed Description
The LinePatternKit class is a user space object. It is used when defining a line pattern.
Constructor & Destructor Documentation
◆ LinePatternKit() [1/2]
|
inline |
The default constructor creates an empty LinePatternKit object.
◆ LinePatternKit() [2/2]
|
inline |
The copy constructor creates a new LinePatternKit object that contains the same settings as the source LinePatternKit.
- Parameters
-
in_kit The source LinePatternKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this LinePatternKit has any values set on it.
- Returns
- true if no values are set on this LinePatternKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source LinePatternKit is equivalent to this LinePatternKit.
- Parameters
-
in_kit The source LinePatternKit to compare to this LinePatternKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
Creates a LinePatternKit which contains the definition of the specified default line pattern.
- Parameters
-
in_default_line_pattern The default line pattern for which to get the corresponding LinePatternKit.
- Returns
- A LinePatternKit which contains the definition of the specified default line pattern.
◆ 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.Kit.
◆ Set()
|
inline |
Copies the source LinePatternKit into this LinePatternKit.
- Parameters
-
in_kit The source LinePatternKit to copy.
◆ SetJoin()
|
inline |
Sets the type of join to use for this LinePatternKit.
- Parameters
-
in_type The type of join to use for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
◆ SetParallel()
|
inline |
Sets the line pattern parallel for this LinePatternKit.
- Parameters
-
in_parallel The line pattern parallel for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
◆ SetParallels()
|
inline |
Sets the line pattern parallel array for this LinePatternKit.
- Parameters
-
in_parallels The line pattern parallel array for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
◆ Show()
|
inline |
Copies this LinePatternKit into the given LinePatternKit.
- Parameters
-
out_kit The LinePatternKit to populate with the contents of this LinePatternKit.
◆ ShowJoin()
|
inline |
Shows the type of join to use for this LinePatternKit.
- Parameters
-
out_type The type of join to use for this LinePatternKit.
- Returns
- true if a join was set, false otherwise.
◆ ShowParallels()
|
inline |
Shows the line pattern parallel array for this LinePatternKit.
- Parameters
-
out_parallels The line pattern parallel array for this LinePatternKit.
- Returns
- true if a line pattern parallel array was set, false otherwise.
◆ UnsetEverything()
|
inline |
Removes all settings from this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
◆ UnsetJoin()
|
inline |
Removes the type of join to use for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
◆ UnsetParallels()
|
inline |
Removes the line pattern parallel array for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LinePatternKit.cs