LinePatternKit

class HPS.LinePatternKit : public HPS.Kit 

The LinePatternKit class is a user space object. It is used when defining a line pattern.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this LinePatternKit has any values set on it.

Return: true if no values are set on this LinePatternKit, false otherwise.

bool Equals (HPS.LinePatternKit in_kit)

Check if the source LinePatternKit is equivalent to this LinePatternKit.

Param in_kit: The source LinePatternKit to compare to this LinePatternKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

LinePatternKit (): The default constructor creates an empty LinePatternKit object.

LinePatternKit (HPS.LinePatternKit in_kit)

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

Param in_kit: The source LinePatternKit to copy.

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.LinePatternKit in_kit)

Copies the source LinePatternKit into this LinePatternKit.

Param in_kit: The source LinePatternKit to copy.

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

Sets the type of join to use for this LinePatternKit.

Param in_type: The type of join to use for this LinePatternKit.
Return: A reference to this LinePatternKit.

HPS.LinePatternKit SetParallel (HPS.LinePatternParallelKit in_parallel)

Sets the line pattern parallel for this LinePatternKit.

Param in_parallel: The line pattern parallel for this LinePatternKit.
Return: A reference to this LinePatternKit.

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

Sets the line pattern parallel array for this LinePatternKit.

Param in_parallels: The line pattern parallel array for this LinePatternKit.
Return: A reference to this LinePatternKit.

void Show (out HPS.LinePatternKit out_kit)

Copies this LinePatternKit into the given LinePatternKit.

Param out_kit: The LinePatternKit to populate with the contents of this LinePatternKit.

bool ShowJoin (out HPS.LinePattern.Join out_type)

Shows the type of join to use for this LinePatternKit.

Param out_type: The type of join to use for this LinePatternKit.
Return: true if a join was set, false otherwise.

bool ShowParallels (out HPS.LinePatternParallelKit[] out_parallels)

Shows the line pattern parallel array for this LinePatternKit.

Param out_parallels: The line pattern parallel array for this LinePatternKit.
Return: true if a line pattern parallel array was set, false otherwise.

HPS.LinePatternKit UnsetEverything ()

Removes all settings from this LinePatternKit.

Return: A reference to this LinePatternKit.

HPS.LinePatternKit UnsetJoin ()

Removes the type of join to use for this LinePatternKit.

Return: A reference to this LinePatternKit.

HPS.LinePatternKit UnsetParallels ()

Removes the line pattern parallel array for this LinePatternKit.

Return: A reference to this LinePatternKit.

Public Static Functions

HPS.LinePatternKit GetDefault (HPS.LinePattern.Default in_default_line_pattern)

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

Param in_default_line_pattern: The default line pattern for which to get the corresponding LinePatternKit.
Return: A LinePatternKit which contains the definition of the specified default line pattern.

bool operator!= (HPS.LinePatternKit a, HPS.LinePatternKit b)

bool operator== (HPS.LinePatternKit a, HPS.LinePatternKit b)