HPS::Exchange::BIMType

class HPS::Exchange::BIMType : public HPS::Sprocket

BIM Type

Public Functions

BIMType()

The default constructor creates an empty BIMType object.

BIMType(BIMType &&in_bim_type)

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

Parameters

in_bim_type – An rvalue reference to a BIMType to take the impl from.

BIMType(BIMType const &in_bim_type)

The copy constructor creates a new BIMType object that is associated with the same data as the source BIMType.

Parameters

in_bim_type – The source BIMType to copy.

bool Equals(BIMType const &in_bim_type) const

Check if the source BIMType is equivalent to this BIMType.

Parameters

in_bim_type – The source BIMType to compare to this BIMType.

Returns

true if the objects are equivalent, false otherwise.

ComponentArray GetComponents() const

Get the components that are associated with this type.

Returns

an array of components that are associated with this type.

HPS::UTF8 GetName() const

Get the name of this type.

Returns

the name of this type.

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!=(BIMType const &in_bim_type) const

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

Parameters

in_bim_type – The source BIMType to compare to this BIMType.

Returns

true if the objects are not equivalent, false otherwise.

BIMType &operator=(BIMType &&in_bim_type)

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

Parameters

in_bim_type – An rvalue reference to a BIMType to take the impl from.

Returns

A reference to this BIMType.

BIMType &operator=(BIMType const &in_bim_type)

The copy assignment operator copies the underlying impl of the source value to this BIMType.

Parameters

in_bim_type – The source BIMType to copy.

Returns

A reference to this BIMType.

bool operator==(BIMType const &in_bim_type) const

Check if the source BIMType is equivalent to this BIMType.

Parameters

in_bim_type – The source BIMType to compare to this BIMType.

Returns

true if the objects are equivalent, false otherwise.

virtual ~BIMType()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeBIMType