API Search || Global Search

#include <hps.h>

Inheritance diagram for HPS::LinePatternKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (LinePatternKit const &in_kit) const
 
 LinePatternKit ()
 
 LinePatternKit (LinePatternKit const &in_kit)
 
 LinePatternKit (LinePatternKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LinePatternKit const &in_kit) const
 
LinePatternKitoperator= (LinePatternKit &&in_that)
 
LinePatternKitoperator= (LinePatternKit const &in_kit)
 
bool operator== (LinePatternKit const &in_kit) const
 
void Set (LinePatternKit const &in_kit)
 
LinePatternKitSetJoin (LinePattern::Join in_type)
 
LinePatternKitSetParallel (LinePatternParallelKit const &in_parallel)
 
LinePatternKitSetParallels (LinePatternParallelKitArray const &in_parallels)
 
LinePatternKitSetParallels (size_t in_count, LinePatternParallelKit const in_parallels[])
 
void Show (LinePatternKit &out_kit) const
 
bool ShowJoin (LinePattern::Join &out_type) const
 
bool ShowParallels (LinePatternParallelKitArray &out_parallels) const
 
LinePatternKitUnsetEverything ()
 
LinePatternKitUnsetJoin ()
 
LinePatternKitUnsetParallels ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS::LinePatternKit GetDefault (LinePattern::Default in_default_line_pattern)
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LinePatternKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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 ( LinePatternKit const &  in_kit)

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

Parameters
in_kitThe source LinePatternKit to copy.
HPS::LinePatternKit::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_thatAn rvalue reference to a LinePatternKit to take the impl from.

Member Function Documentation

bool HPS::LinePatternKit::Empty ( ) const
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 ( LinePatternKit const &  in_kit) const

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.
static HPS::LinePatternKit HPS::LinePatternKit::GetDefault ( 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 LinePatternKit.
Returns
A LinePatternKit which contains the definition of the specified default line pattern.
bool HPS::LinePatternKit::operator!= ( LinePatternKit const &  in_kit) const

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

Parameters
in_kitThe source LinePatternKit to compare to this LinePatternKit.
Returns
true if the objects are not equivalent, false otherwise.
LinePatternKit& HPS::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_thatAn rvalue reference to a LinePatternKit to take the impl from.
Returns
A reference to this LinePatternKit.
LinePatternKit& HPS::LinePatternKit::operator= ( LinePatternKit const &  in_kit)

Copies the source LinePatternKit into this LinePatternKit.

Parameters
in_kitThe source LinePatternKit to copy.
Returns
A reference to this LinePatternKit.
bool HPS::LinePatternKit::operator== ( LinePatternKit const &  in_kit) const

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.
void HPS::LinePatternKit::Set ( LinePatternKit const &  in_kit)

Copies the source LinePatternKit into this LinePatternKit.

Parameters
in_kitThe source LinePatternKit to copy.
LinePatternKit& HPS::LinePatternKit::SetJoin ( LinePattern::Join  in_type)

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.
LinePatternKit& HPS::LinePatternKit::SetParallel ( LinePatternParallelKit const &  in_parallel)

Sets the line pattern parallel for this LinePatternKit.

Parameters
in_parallelThe line pattern parallel for this LinePatternKit.
Returns
A reference to this LinePatternKit.
LinePatternKit& HPS::LinePatternKit::SetParallels ( LinePatternParallelKitArray const &  in_parallels)

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.
LinePatternKit& HPS::LinePatternKit::SetParallels ( size_t  in_count,
LinePatternParallelKit const  in_parallels[] 
)

Sets the line pattern parallel array for this LinePatternKit.

Parameters
in_countSize of the following array.
in_parallelsThe line pattern parallel array for this LinePatternKit.
Returns
A reference to this LinePatternKit.
void HPS::LinePatternKit::Show ( LinePatternKit out_kit) const

Copies this LinePatternKit into the given LinePatternKit.

Parameters
out_kitThe LinePatternKit to populate with the contents of this LinePatternKit.
bool HPS::LinePatternKit::ShowJoin ( LinePattern::Join out_type) const

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.
bool HPS::LinePatternKit::ShowParallels ( LinePatternParallelKitArray out_parallels) const

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.
LinePatternKit& HPS::LinePatternKit::UnsetEverything ( )

Removes all settings from this LinePatternKit.

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

Removes the type of join to use for this LinePatternKit.

Returns
A reference to this LinePatternKit.
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: