< Home

< Table of Contents

REFERENCE MANUAL

HPS.LinePatternKit Class Reference

The LinePatternKit class is a user space object. More...

Inheritance diagram for HPS.LinePatternKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 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
 
HandleRef scptr
 

Detailed Description

The LinePatternKit class is a user space object.

It is used when defining a line pattern.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> to copy.

Member Function Documentation

override bool HPS.LinePatternKit.Empty ( )
virtual

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.

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

Check if the source LinePatternKit is equivalent to this LinePatternKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.LinePatternKit HPS.LinePatternKit.GetDefault ( HPS.LinePattern.Default  in_default_line_pattern)
static

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 <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>.
Returns
A LinePatternKit which contains the definition of the specified default line pattern.
override HPS.Type HPS.LinePatternKit.ObjectType ( )
virtual

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.

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

Copies the source LinePatternKit into this LinePatternKit.

Parameters
in_kitThe 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.

Parameters
in_typeThe type of join to use for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>.
Returns
A reference to this LinePatternKit.
HPS.LinePatternKit HPS.LinePatternKit.SetParallels ( HPS.LinePatternParallelKit[]  in_parallels)

Sets the line pattern parallel array for this LinePatternKit.

Parameters
in_parallelsThe line pattern parallel array for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>.
Returns
A reference to this LinePatternKit.
void HPS.LinePatternKit.Show ( out HPS.LinePatternKit  out_kit)

Copies this LinePatternKit into the given LinePatternKit.

Parameters
out_kitThe <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.

Parameters
out_typeThe type of join to use for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>.
Returns
true if a join was set, false otherwise.
bool HPS.LinePatternKit.ShowParallels ( out HPS.LinePatternParallelKit[]  out_parallels)

Shows the line pattern parallel array for this LinePatternKit.

Parameters
out_parallelsThe line pattern parallel array for this <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref>.
Returns
true if a line pattern parallel array was set, false otherwise.
HPS.LinePatternKit HPS.LinePatternKit.UnsetEverything ( )

Removes all settings from this LinePatternKit.

Returns
A reference to this LinePatternKit.
HPS.LinePatternKit HPS.LinePatternKit.UnsetJoin ( )

Removes the type of join to use for this LinePatternKit.

Returns
A reference to this LinePatternKit.
HPS.LinePatternKit HPS.LinePatternKit.UnsetParallels ( )

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: