HPS::Exchange::BIMRelationshipEntity
-
class HPS::Exchange::BIMRelationshipEntity : public HPS::Sprocket
Entity inside a BIM relationship
Public Functions
-
BIMRelationshipEntity()
The default constructor creates an empty BIMRelationshipEntity object.
-
BIMRelationshipEntity(BIMRelationshipEntity &&in_that)
The move constructor creates an BIMRelationshipEntity by transferring the underlying impl of the rvalue reference to this BIMRelationshipEntity thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to an BIMRelationshipEntity to take the impl from.
-
BIMRelationshipEntity(BIMRelationshipEntity const &in_that)
The copy constructor creates a new BIMRelationshipEntity object that is associated with the same data as the source BIMRelationshipEntity.
- Parameters
in_that – The source BIMRelationshipEntity to copy.
-
bool Equals(BIMRelationshipEntity const &in_relationshipEntity) const
Check if the source BIMRelationshipEntity is equivalent to this BIMRelationshipEntity.
- Parameters
in_relationshipEntity – The source BIMRelationshipEntity to compare to this BIMRelationshipEntity.
- Returns
true if the objects are equivalent, false otherwise.
-
HPS::Exchange::Component const &GetComponent() const
Get the component for this entity.
- Returns
the component for this entity of an empty component is the element is not loaded (such as openings).
-
HPS::UTF8 GetName(bool use_generated_if_needed = false) const
Get the name of this BIMRelationshipEntity.
- Parameters
use_generated_if_needed – Whether to use the generated name if the component has no name.
- Returns
the name of this BIMRelationshipEntity.
-
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!=(BIMRelationshipEntity const &in_relationshipEntity) const
Check if the source BIMRelationshipEntity is not equivalent to this BIMRelationshipEntity.
- Parameters
in_relationshipEntity – The source BIMRelationshipEntity to compare to this BIMRelationshipEntity.
- Returns
true if the objects are not equivalent, false otherwise.
-
BIMRelationshipEntity &operator=(BIMRelationshipEntity &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this BIMRelationshipEntity thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to an ImportNotifier to take the impl from.
- Returns
A reference to this BIMRelationshipEntity.
-
BIMRelationshipEntity &operator=(BIMRelationshipEntity const &in_that)
The copy assignment operator copies the underlying impl of the source value to this BIMRelationshipEntity.
- Parameters
in_that – The source BIMRelationshipEntity to copy.
- Returns
A reference to this BIMRelationshipEntity.
-
bool operator==(BIMRelationshipEntity const &in_relationshipEntity) const
Check if the source BIMRelationshipEntity is equivalent to this BIMRelationshipEntity.
- Parameters
in_relationshipEntity – The source BIMRelationshipEntity to compare to this BIMRelationshipEntity.
- Returns
true if the objects are equivalent, false otherwise.
-
virtual ~BIMRelationshipEntity()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::ExchangeBIMRelationshipEntity
-
BIMRelationshipEntity()