The LinePatternKit class is a user space object. It is used when defining a line pattern. 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. This does not necessarily give the true type of the underlying object. 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 | SetParallel (HPS.LinePatternParallelKit in_parallel) |
Sets the line pattern parallel 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. 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... | |
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 |
Detailed Description
The LinePatternKit class is a user space object. It is used when defining a line pattern.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty LinePatternKit object.
|
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
|
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.
|
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.
|
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.
|
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.Object.
|
inline |
Copies the source LinePatternKit into this LinePatternKit.
- Parameters
-
in_kit The source LinePatternKit to copy.
|
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.
|
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.
|
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.
|
inline |
Copies this LinePatternKit into the given LinePatternKit.
- Parameters
-
out_kit The LinePatternKit to populate with the contents of this LinePatternKit.
|
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.
|
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.
|
inline |
Removes all settings from this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
|
inline |
Removes the type of join to use for this LinePatternKit.
- Returns
- A reference to this LinePatternKit.
|
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