LinePatternKit

class LinePatternKit : public HPS::Kit 

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

Public Functions

virtual bool Empty() const

Indicates whether this LinePatternKit has any values set on it.

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

bool Equals(LinePatternKit const &in_kit) const

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.

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

LinePatternKit(LinePatternKit &&in_that)

The move constructor creates a LinePatternKit by transferring the underlying impl of the rvalue reference to this LinePatternKit thereby avoiding a copy and allocation.

Parameters:	in_that – An rvalue reference to a LinePatternKit to take the impl from.

LinePatternKit(LinePatternKit const &in_kit)

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.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(LinePatternKit const &in_kit) const

Check if the source LinePatternKit is not equivalent to this LinePatternKit.

Parameters:	in_kit – The source LinePatternKit to compare to this LinePatternKit.
Returns:	true if the objects are not equivalent, false otherwise.

LinePatternKit &operator=(LinePatternKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternKit thereby avoiding a copy.

Parameters:	in_that – An rvalue reference to a LinePatternKit to take the impl from.
Returns:	A reference to this LinePatternKit.

LinePatternKit &operator=(LinePatternKit const &in_kit)

Copies the source LinePatternKit into this LinePatternKit.

Parameters:	in_kit – The source LinePatternKit to copy.
Returns:	A reference to this LinePatternKit.

bool operator==(LinePatternKit const &in_kit) const

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.

void Set(LinePatternKit const &in_kit)

Copies the source LinePatternKit into this LinePatternKit.

Parameters:	in_kit – The source LinePatternKit to copy.

LinePatternKit &SetJoin(LinePattern::Join in_type)

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.

LinePatternKit &SetParallel(LinePatternParallelKit const &in_parallel)

Sets the line pattern parallel for this LinePatternKit.

Parameters:	in_parallel – The line pattern parallel for this LinePatternKit.
Returns:	A reference to this LinePatternKit.

LinePatternKit &SetParallels(LinePatternParallelKitArray const &in_parallels)

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.

LinePatternKit &SetParallels(size_t in_count, LinePatternParallelKit const in_parallels[])

Sets the line pattern parallel array for this LinePatternKit.

Parameters:	in_count – Size of the following array. in_parallels – The line pattern parallel array for this LinePatternKit.
Returns:	A reference to this LinePatternKit.

void Show(LinePatternKit &out_kit) const

Copies this LinePatternKit into the given LinePatternKit.

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

bool ShowJoin(LinePattern::Join &out_type) const

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.

bool ShowParallels(LinePatternParallelKitArray &out_parallels) const

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.

LinePatternKit &UnsetEverything()

Removes all settings from this LinePatternKit.

Returns:	A reference to this LinePatternKit.

LinePatternKit &UnsetJoin()

Removes the type of join to use for this LinePatternKit.

Returns:	A reference to this LinePatternKit.

LinePatternKit &UnsetParallels()

Removes the line pattern parallel array for this LinePatternKit.

Returns:	A reference to this LinePatternKit.

virtual ~LinePatternKit()

Public Static Functions

static HPS::LinePatternKit GetDefault(LinePattern::Default in_default_line_pattern)

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LinePatternKit