HPS::Exchange::BIMType Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::BIMType:
HPS::Sprocket HPS::Object

Public Member Functions

 BIMType ()
 
 BIMType (BIMType const &in_bim_type)
 
 BIMType (BIMType &&in_bim_type)
 
bool Equals (BIMType const &in_bim_type) const
 
ComponentArray GetComponents () const
 
HPS::UTF8 GetName () const
 
HPS::Type ObjectType () const
 
bool operator!= (BIMType const &in_bim_type) const
 
BIMTypeoperator= (BIMType const &in_bim_type)
 
BIMTypeoperator= (BIMType &&in_bim_type)
 
bool operator== (BIMType const &in_bim_type) const
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeBIMType
 
- 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 ()
 

Detailed Description

BIM Type

Constructor & Destructor Documentation

◆ BIMType() [1/3]

HPS::Exchange::BIMType::BIMType ( )

The default constructor creates an empty BIMType object.

◆ BIMType() [2/3]

HPS::Exchange::BIMType::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_typeThe source BIMType to copy.

◆ BIMType() [3/3]

HPS::Exchange::BIMType::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_typeAn rvalue reference to a BIMType to take the impl from.

Member Function Documentation

◆ Equals()

bool HPS::Exchange::BIMType::Equals ( BIMType const &  in_bim_type) const

Check if the source BIMType is equivalent to this BIMType.

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

◆ GetComponents()

ComponentArray HPS::Exchange::BIMType::GetComponents ( ) const

Get the components that are associated with this type.

Returns
an array of components that are associated with this type.

◆ GetName()

HPS::UTF8 HPS::Exchange::BIMType::GetName ( ) const

Get the name of this type.

Returns
the name of this type.

◆ ObjectType()

HPS::Type HPS::Exchange::BIMType::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::Object.

◆ operator!=()

bool HPS::Exchange::BIMType::operator!= ( BIMType const &  in_bim_type) const

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

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

◆ operator=() [1/2]

BIMType& HPS::Exchange::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_typeThe source BIMType to copy.
Returns
A reference to this BIMType.

◆ operator=() [2/2]

BIMType& HPS::Exchange::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_typeAn rvalue reference to a BIMType to take the impl from.
Returns
A reference to this BIMType.

◆ operator==()

bool HPS::Exchange::BIMType::operator== ( BIMType const &  in_bim_type) const

Check if the source BIMType is equivalent to this BIMType.

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

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