HPS::ShellRelationResultsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::ShellRelationResultsKit:

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
ShellRelationResultsKit &	operator= (ShellRelationResultsKit &&in_that)
ShellRelationResultsKit &	operator= (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)
Object &	operator= (Object const &other_object)
Object &	operator= (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)
Kit &	operator= (Kit &&in_that)

Detailed Description

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

Constructor & Destructor Documentation

ShellRelationResultsKit() [1/3]

HPS::ShellRelationResultsKit::ShellRelationResultsKit

(

)

The default constructor creates an empty ShellRelationResultsKit object.

ShellRelationResultsKit() [2/3]

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_kit

The source ShellRelationResultsKit to copy.

ShellRelationResultsKit() [3/3]

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_that

An rvalue reference to a ShellRelationResultsKit to take the impl from.

Member Function Documentation

Consume()

void HPS::ShellRelationResultsKit::Consume

(

ShellRelationResultsKit &

in_kit

)

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

Parameters

in_kit

The source ShellRelationResultsKit to consume.

Empty()

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.

Equals()

bool HPS::ShellRelationResultsKit::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.

ObjectType()

HPS::Type HPS::ShellRelationResultsKit::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::ShellRelationResultsKit::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.

operator=() [1/2]

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_that

An rvalue reference to a ShellRelationResultsKit to take the impl from.

Returns

A reference to this ShellRelationResultsKit.

operator=() [2/2]

ShellRelationResultsKit& HPS::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.

operator==()

bool HPS::ShellRelationResultsKit::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.

Set()

void HPS::ShellRelationResultsKit::Set

(

ShellRelationResultsKit const &

in_kit

)

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters

in_kit

The source ShellRelationResultsKit to copy.

Show()

void HPS::ShellRelationResultsKit::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.

ShowDistances()

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_distances

The smallest distances, one per point, of points to a target shell.

Returns

true if distances were requested and computed, false otherwise.

ShowNearestFaces()

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_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.

ShowRelations()

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_results

The 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:

• include/hps.h