ShellRelationResultsKit

class HPS::ShellRelationResultsKit : public HPS::Kit 

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

Public Functions

void Consume(ShellRelationResultsKit &in_kit)

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

Parameters: in_kit – The source ShellRelationResultsKit to consume.

virtual bool Empty() const

Indicates whether this ShellRelationResultsKit has any values set on it.

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

bool Equals(ShellRelationResultsKit const &in_kit) const

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

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

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!=(ShellRelationResultsKit const &in_kit) const

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

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

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_that – An rvalue reference to a ShellRelationResultsKit to take the impl from.
Returns: A reference to this ShellRelationResultsKit.

ShellRelationResultsKit &operator=(ShellRelationResultsKit const &in_kit)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

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

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

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

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

void Set(ShellRelationResultsKit const &in_kit)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters: in_kit – The source ShellRelationResultsKit to copy.

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

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_that – An rvalue reference to a ShellRelationResultsKit to take the impl from.

ShellRelationResultsKit(ShellRelationResultsKit const &in_kit)

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

Parameters: in_kit – The source ShellRelationResultsKit to copy.

void Show(ShellRelationResultsKit &out_kit) const

Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.

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

bool ShowDistances(FloatArray &out_distances) const

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

Parameters: out_distances – The smallest distances, one per point, of points to a target shell.
Returns: true if distances were requested and computed, false otherwise.

bool ShowNearestFaces(SizeTArray &out_faces) const

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

Parameters: out_faces – The 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 ShowRelations(ShellRelationArray &out_results) const

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

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

virtual ~ShellRelationResultsKit()

Public Static Attributes

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