API Search || Global Search
HPS::ShellRelationResultsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::ShellRelationResultsKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (ShellRelationResultsKit &in_kit)
 
bool Empty () const
 
bool Equals (ShellRelationResultsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ShellRelationResultsKit const &in_kit) const
 
ShellRelationResultsKitoperator= (ShellRelationResultsKit &&in_that)
 
ShellRelationResultsKitoperator= (ShellRelationResultsKit const &in_kit)
 
bool operator== (ShellRelationResultsKit const &in_kit) const
 
void Set (ShellRelationResultsKit const &in_kit)
 
 ShellRelationResultsKit ()
 
 ShellRelationResultsKit (ShellRelationResultsKit const &in_kit)
 
 ShellRelationResultsKit (ShellRelationResultsKit &&in_that)
 
void Show (ShellRelationResultsKit &out_kit) const
 
bool ShowDistances (FloatArray &out_distances) const
 
bool ShowNearestFaces (SizeTArray &out_faces) const
 
bool ShowRelations (ShellRelationArray &out_results) const
 
- 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 Attributes

static const HPS::Type staticType = HPS::Type::ShellRelationResultsKit
 
- 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

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The ShellKit class is a user space object. It contains results from a shell relation operation.

Constructor & Destructor Documentation

HPS::ShellRelationResultsKit::ShellRelationResultsKit ( )

The default constructor creates an empty ShellRelationResultsKit object.

HPS::ShellRelationResultsKit::ShellRelationResultsKit ( ShellRelationResultsKit const &  in_kit)

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

Parameters
in_kitThe source ShellRelationResultsKit to copy.
HPS::ShellRelationResultsKit::ShellRelationResultsKit ( ShellRelationResultsKit &&  in_that)

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

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

Member Function Documentation

void HPS::ShellRelationResultsKit::Consume ( ShellRelationResultsKit in_kit)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.

Parameters
in_kitThe source ShellRelationResultsKit to consume.
bool HPS::ShellRelationResultsKit::Empty ( ) const
virtual

Indicates whether this ShellRelationResultsKit has any values set on it.

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

Reimplemented from HPS::Object.

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

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

Parameters
in_kitThe source ShellRelationResultsKit to compare to this ShellRelationResultsKit.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::ShellRelationResultsKit::operator!= ( ShellRelationResultsKit const &  in_kit) const

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

Parameters
in_kitThe source ShellRelationResultsKit to compare to this ShellRelationResultsKit.
Returns
true if the objects are not equivalent, false otherwise.
ShellRelationResultsKit& HPS::ShellRelationResultsKit::operator= ( ShellRelationResultsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ShellRelationResultsKit to take the impl from.
Returns
A reference to this ShellRelationResultsKit.
ShellRelationResultsKit& HPS::ShellRelationResultsKit::operator= ( ShellRelationResultsKit const &  in_kit)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

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

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

Parameters
in_kitThe source ShellRelationResultsKit to compare to this ShellRelationResultsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::ShellRelationResultsKit::Set ( ShellRelationResultsKit const &  in_kit)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters
in_kitThe source ShellRelationResultsKit to copy.
void HPS::ShellRelationResultsKit::Show ( ShellRelationResultsKit out_kit) const

Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.

Parameters
out_kitThe ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit.
bool HPS::ShellRelationResultsKit::ShowDistances ( FloatArray out_distances) const

Shows the smallest distance of each point in a shell relation computation to the target shell.

Parameters
out_distancesThe smallest distances, one per point, of points to a target shell.
Returns
true if distances were requested and computed, false otherwise.
bool HPS::ShellRelationResultsKit::ShowNearestFaces ( SizeTArray out_faces) const

Shows the nearest face in the target shell for each of a set of points.

Parameters
out_facesThe nearest faces, one per point, in the target shell to a set of points.
Returns
true if nearest faces were requested and computed, false otherwise.
bool HPS::ShellRelationResultsKit::ShowRelations ( ShellRelationArray out_results) const

Shows the relation of each point in a shell relation computation to the target shell.

Parameters
out_resultsThe relations, one per point, of points to a target shell.
Returns
true if any relations were requested and computed, false otherwise.

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