#include <hps.h>

Inheritance diagram for HPS::ShapeKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ShapeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ShapeKit const &in_kit) const
 
ShapeKitoperator= (ShapeKit &&in_that)
 
ShapeKitoperator= (ShapeKit const &in_kit)
 
bool operator== (ShapeKit const &in_kit) const
 
void Set (ShapeKit const &in_kit)
 
ShapeKitSetElement (ShapeElement const &in_element)
 
ShapeKitSetElements (ShapeElementArray const &in_def)
 
ShapeKitSetElements (size_t in_count, ShapeElement const in_def [])
 
 ShapeKit ()
 
 ShapeKit (ShapeKit const &in_kit)
 
 ShapeKit (ShapeKit &&in_that)
 
void Show (ShapeKit &out_kit) const
 
bool ShowElements (ShapeElementArray &out_def) const
 
ShapeKitUnsetElements ()
 
ShapeKitUnsetEverything ()
 
- 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::ShapeKit GetDefault (Shape::Default in_default_shape)
 
- 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::ShapeKit
 
- 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 ShapeKit class is a user space object. It is used for specifying all settings related to a ShapeDefinition.

Constructor & Destructor Documentation

◆ ShapeKit() [1/3]

HPS::ShapeKit::ShapeKit ( )

The default constructor creates an empty ShapeKit object.

◆ ShapeKit() [2/3]

HPS::ShapeKit::ShapeKit ( ShapeKit const &  in_kit)

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

Parameters
in_kitThe source ShapeKit to copy.

◆ ShapeKit() [3/3]

HPS::ShapeKit::ShapeKit ( ShapeKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ShapeKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::ShapeKit::Empty ( ) const
virtual

Indicates whether this ShapeKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::ShapeKit::Equals ( ShapeKit const &  in_kit) const

Check if the source ShapeKit is equivalent to this ShapeKit.

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

◆ GetDefault()

static HPS::ShapeKit HPS::ShapeKit::GetDefault ( Shape::Default  in_default_shape)
static

Creates a ShapeKit which contains the definition of the specified default shape.

Parameters
in_default_shapeThe default shape for which to get the corresponding ShapeKit.
Returns
A ShapeKit which contains the definition of the specified default shape.

◆ ObjectType()

HPS::Type HPS::ShapeKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::ShapeKit::operator!= ( ShapeKit const &  in_kit) const

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

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

◆ operator=() [1/2]

ShapeKit& HPS::ShapeKit::operator= ( ShapeKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ShapeKit to take the impl from.
Returns
A reference to this ShapeKit.

◆ operator=() [2/2]

ShapeKit& HPS::ShapeKit::operator= ( ShapeKit const &  in_kit)

Copies the source ShapeKit into this ShapeKit.

Parameters
in_kitThe source ShapeKit to copy.
Returns
A reference to this ShapeKit.

◆ operator==()

bool HPS::ShapeKit::operator== ( ShapeKit const &  in_kit) const

Check if the source ShapeKit is equivalent to this ShapeKit.

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

◆ Set()

void HPS::ShapeKit::Set ( ShapeKit const &  in_kit)

Copies the source ShapeKit into this ShapeKit.

Parameters
in_kitThe source ShapeKit to copy.

◆ SetElement()

ShapeKit& HPS::ShapeKit::SetElement ( ShapeElement const &  in_element)

Set a single element for this ShapeKit. This must be specified when defining a shape.

Parameters
in_elementA reference to the ShapeElement to set on this kit.
Returns
A reference to this ShapeKit.

◆ SetElements() [1/2]

ShapeKit& HPS::ShapeKit::SetElements ( ShapeElementArray const &  in_def)

Sets the elements for this ShapeKit. This must be specified when defining a shape.

Parameters
in_defThe array of elements for the shape.
Returns
A reference to this ShapeKit.

◆ SetElements() [2/2]

ShapeKit& HPS::ShapeKit::SetElements ( size_t  in_count,
ShapeElement const  in_def[] 
)

Sets the elements for this ShapeKit. This must be specified when defining a shape.

Parameters
in_countSize of the following array.
in_defThe array of elements for the shape.
Returns
A reference to this ShapeKit.

◆ Show()

void HPS::ShapeKit::Show ( ShapeKit out_kit) const

Copies this ShapeKit into the given ShapeKit.

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

◆ ShowElements()

bool HPS::ShapeKit::ShowElements ( ShapeElementArray out_def) const

Shows the elements for this ShapeKit.

Parameters
out_defThe elements for the shape.
Returns
true if elements were set, false otherwise.

◆ UnsetElements()

ShapeKit& HPS::ShapeKit::UnsetElements ( )

Removes the elements for the shape.

Returns
A reference to this ShapeKit.

◆ UnsetEverything()

ShapeKit& HPS::ShapeKit::UnsetEverything ( )

Removes all settings from this ShapeKit.

Returns
A reference to this ShapeKit.

The documentation for this class was generated from the following file: