#include <sprk_exchange.h>

Public Member Functions | |
BIMRelationshipEntity () | |
BIMRelationshipEntity (BIMRelationshipEntity const &in_that) | |
BIMRelationshipEntity (BIMRelationshipEntity &&in_that) | |
bool | Equals (BIMRelationshipEntity const &in_relationshipEntity) const |
HPS::Exchange::Component const & | GetComponent () const |
HPS::UTF8 | GetName (bool use_generated_if_needed=false) const |
HPS::Type | ObjectType () const |
bool | operator!= (BIMRelationshipEntity const &in_relationshipEntity) const |
BIMRelationshipEntity & | operator= (BIMRelationshipEntity const &in_that) |
BIMRelationshipEntity & | operator= (BIMRelationshipEntity &&in_that) |
bool | operator== (BIMRelationshipEntity const &in_relationshipEntity) const |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeBIMRelationshipEntity |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
Entity inside a BIM relationship
Constructor & Destructor Documentation
◆ BIMRelationshipEntity() [1/3]
HPS::Exchange::BIMRelationshipEntity::BIMRelationshipEntity | ( | ) |
The default constructor creates an empty BIMRelationshipEntity object.
◆ BIMRelationshipEntity() [2/3]
HPS::Exchange::BIMRelationshipEntity::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.
◆ BIMRelationshipEntity() [3/3]
HPS::Exchange::BIMRelationshipEntity::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.
Member Function Documentation
◆ Equals()
bool HPS::Exchange::BIMRelationshipEntity::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.
◆ GetComponent()
HPS::Exchange::Component const& HPS::Exchange::BIMRelationshipEntity::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).
◆ GetName()
HPS::UTF8 HPS::Exchange::BIMRelationshipEntity::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.
◆ ObjectType()
|
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::BIMRelationshipEntity::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.
◆ operator=() [1/2]
BIMRelationshipEntity& HPS::Exchange::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.
◆ operator=() [2/2]
BIMRelationshipEntity& HPS::Exchange::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.
◆ operator==()
bool HPS::Exchange::BIMRelationshipEntity::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.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h