Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.LinePatternKit Class Reference
Inheritance diagram for HPS.LinePatternKit:
HPS.Kit HPS.Object

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 ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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]

HPS.LinePatternKit.LinePatternKit ( )
inline

The default constructor creates an empty LinePatternKit object.

◆ LinePatternKit() [2/2]

HPS.LinePatternKit.LinePatternKit ( HPS.LinePatternKit  in_kit)
inline

The copy constructor creates a new LinePatternKit object that contains the same settings as the source LinePatternKit.

Parameters
in_kitThe source LinePatternKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.LinePatternKit.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()

bool HPS.LinePatternKit.Equals ( HPS.LinePatternKit  in_kit)
inline

Check if the source LinePatternKit is equivalent to this LinePatternKit.

Parameters
in_kitThe source LinePatternKit to compare to this LinePatternKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.LinePatternKit HPS.LinePatternKit.GetDefault ( HPS.LinePattern.Default  in_default_line_pattern)
inlinestatic

Creates a LinePatternKit which contains the definition of the specified default line pattern.

Parameters
in_default_line_patternThe default line pattern for which to get the corresponding LinePatternKit.
Returns
A LinePatternKit which contains the definition of the specified default line pattern.

◆ ObjectType()

override HPS.Type HPS.LinePatternKit.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()

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

Copies the source LinePatternKit into this LinePatternKit.

Parameters
in_kitThe source LinePatternKit to copy.

◆ SetJoin()

HPS.LinePatternKit HPS.LinePatternKit.SetJoin ( HPS.LinePattern.Join  in_type)
inline

Sets the type of join to use for this LinePatternKit.

Parameters
in_typeThe type of join to use for this LinePatternKit.
Returns
A reference to this LinePatternKit.

◆ SetParallel()

HPS.LinePatternKit HPS.LinePatternKit.SetParallel ( HPS.LinePatternParallelKit  in_parallel)
inline

Sets the line pattern parallel for this LinePatternKit.

Parameters
in_parallelThe line pattern parallel for this LinePatternKit.
Returns
A reference to this LinePatternKit.

◆ SetParallels()

HPS.LinePatternKit HPS.LinePatternKit.SetParallels ( HPS.LinePatternParallelKit []  in_parallels)
inline

Sets the line pattern parallel array for this LinePatternKit.

Parameters
in_parallelsThe line pattern parallel array for this LinePatternKit.
Returns
A reference to this LinePatternKit.

◆ Show()

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

Copies this LinePatternKit into the given LinePatternKit.

Parameters
out_kitThe LinePatternKit to populate with the contents of this LinePatternKit.

◆ ShowJoin()

bool HPS.LinePatternKit.ShowJoin ( out HPS.LinePattern.Join  out_type)
inline

Shows the type of join to use for this LinePatternKit.

Parameters
out_typeThe type of join to use for this LinePatternKit.
Returns
true if a join was set, false otherwise.

◆ ShowParallels()

bool HPS.LinePatternKit.ShowParallels ( out HPS.LinePatternParallelKit []  out_parallels)
inline

Shows the line pattern parallel array for this LinePatternKit.

Parameters
out_parallelsThe line pattern parallel array for this LinePatternKit.
Returns
true if a line pattern parallel array was set, false otherwise.

◆ UnsetEverything()

HPS.LinePatternKit HPS.LinePatternKit.UnsetEverything ( )
inline

Removes all settings from this LinePatternKit.

Returns
A reference to this LinePatternKit.

◆ UnsetJoin()

HPS.LinePatternKit HPS.LinePatternKit.UnsetJoin ( )
inline

Removes the type of join to use for this LinePatternKit.

Returns
A reference to this LinePatternKit.

◆ UnsetParallels()

HPS.LinePatternKit HPS.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