HPS::Exchange::BIMData
-
class HPS::Exchange::BIMData : public HPS::Sprocket
BIM related data inside the model.
Public Functions
-
BIMData()
The default constructor creates an empty BIMData object.
-
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_data – An rvalue reference to a BIMData to take the impl from.
-
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_data – The source BIMData to copy.
-
bool Equals(BIMData const &in_bim_data) const
-
BIMRelationshipEntityArray 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_component – the component used to search related BIMRelationshipEntity.
in_relationship_type – the type of BIMRelationship used for the search.
- Returns
an array of BIMRelationshipEntity.
-
BIMRelationshipEntityArray 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_component – the component used to search relating BIMRelationshipEntity.
in_relationship_type – the type of BIMRelationship used for the search.
- Returns
an array of BIMRelationshipEntity.
-
BIMRelationshipArray GetRelationships(HPS::Exchange::Component const &in_component) const
Get an array of all relationships that target the component given.
- Parameters
in_component – the component whose relationships are requested.
- Returns
the array of BIMRelationship for the component.
-
BIMTypeArray GetTypes() const
Get an array of BIMType present in this model.
- Returns
the array of BIMType for this model.
-
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!=(BIMData const &in_bim_data) const
Check if the source BIMData is not equivalent to this BIMData.
-
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.
-
BIMData()
