HPS::Exchange::BIMData Class Reference

#include <sprk_exchange.h>

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

Public Member Functions

 BIMData ()
 
 BIMData (BIMData const &in_bim_data)
 
 BIMData (BIMData &&in_bim_data)
 
bool Equals (BIMData const &in_bim_data) const
 
BIMRelationshipEntityArray GetRelatedEntities (HPS::Exchange::Component const &in_component, BIMRelationshipType in_relationship_type) const
 
BIMRelationshipEntityArray GetRelatingEntities (HPS::Exchange::Component const &in_component, BIMRelationshipType in_relationship_type) const
 
BIMRelationshipArray GetRelationships (HPS::Exchange::Component const &in_component) const
 
BIMTypeArray GetTypes () const
 
HPS::Type ObjectType () const
 
bool operator!= (BIMData const &in_bim_data) const
 
BIMDataoperator= (BIMData const &in_that)
 
BIMDataoperator= (BIMData &&in_bim_data)
 
bool operator== (BIMData const &in_bim_data) 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::ExchangeBIMData
 
- 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 related data inside the model.

Constructor & Destructor Documentation

◆ BIMData() [1/3]

HPS::Exchange::BIMData::BIMData ( )

The default constructor creates an empty BIMData object.

◆ BIMData() [2/3]

HPS::Exchange::BIMData::BIMData ( BIMData const &  in_bim_data)

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

Parameters
in_bim_dataThe source BIMData to copy.

◆ BIMData() [3/3]

HPS::Exchange::BIMData::BIMData ( BIMData &&  in_bim_data)

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

Parameters
in_bim_dataAn rvalue reference to a BIMData to take the impl from.

Member Function Documentation

◆ Equals()

bool HPS::Exchange::BIMData::Equals ( BIMData const &  in_bim_data) const

Check if the source BIMData is equivalent to this BIMData.

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

◆ GetRelatedEntities()

BIMRelationshipEntityArray HPS::Exchange::BIMData::GetRelatedEntities ( HPS::Exchange::Component const &  in_component,
BIMRelationshipType  in_relationship_type 
) const

Get an array of BIMRelationshipEntity that are related to the component given.

Parameters
in_componentthe component used to search related BIMRelationshipEntity.
in_relationship_typethe type of BIMRelationship used for the search.
Returns
an array of BIMRelationshipEntity.

◆ GetRelatingEntities()

BIMRelationshipEntityArray HPS::Exchange::BIMData::GetRelatingEntities ( HPS::Exchange::Component const &  in_component,
BIMRelationshipType  in_relationship_type 
) const

Get an array of BIMRelationshipEntity that are relating to the component given.

Parameters
in_componentthe component used to search relating BIMRelationshipEntity.
in_relationship_typethe type of BIMRelationship used for the search.
Returns
an array of BIMRelationshipEntity.

◆ GetRelationships()

BIMRelationshipArray HPS::Exchange::BIMData::GetRelationships ( HPS::Exchange::Component const &  in_component) const

Get an array of all relationships that target the component given.

Parameters
in_componentthe component whose relationships are requested.
Returns
the array of BIMRelationship for the component.

◆ GetTypes()

BIMTypeArray HPS::Exchange::BIMData::GetTypes ( ) const

Get an array of BIMType present in this model.

Returns
the array of BIMType for this model.

◆ ObjectType()

HPS::Type HPS::Exchange::BIMData::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::BIMData::operator!= ( BIMData const &  in_bim_data) const

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

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

◆ operator=() [1/2]

BIMData& HPS::Exchange::BIMData::operator= ( BIMData const &  in_that)

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

Parameters
in_thatThe source BIMData to copy.
Returns
A reference to this BIMData.

◆ operator=() [2/2]

BIMData& HPS::Exchange::BIMData::operator= ( BIMData &&  in_bim_data)

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

Parameters
in_bim_dataAn rvalue reference to a BIMData to take the impl from.
Returns
A reference to this BIMData.

◆ operator==()

bool HPS::Exchange::BIMData::operator== ( BIMData const &  in_bim_data) const

Check if the source BIMData is equivalent to this BIMData.

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

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