#include <sprk_exchange.h>

Public Member Functions | |
BIMRelationship () | |
BIMRelationship (BIMRelationship const &in_relationship) | |
BIMRelationship (BIMRelationship &&in_relationship) | |
bool | Equals (BIMRelationship const &in_relationship) const |
BIMRelationshipEntityArray | GetRelatedEntities () const |
BIMRelationshipEntity | GetRelatingEntity () const |
BIMRelationshipType | GetType () const |
HPS::Type | ObjectType () const |
bool | operator!= (BIMRelationship const &in_relationship) const |
BIMRelationship & | operator= (BIMRelationship &&in_relationship) |
bool | operator== (BIMRelationship const &in_relationship) 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::ExchangeBIMRelationship |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
BIM relationship
Constructor & Destructor Documentation
◆ BIMRelationship() [1/3]
HPS::Exchange::BIMRelationship::BIMRelationship | ( | ) |
The default constructor creates an empty BIMRelationship object.
◆ BIMRelationship() [2/3]
HPS::Exchange::BIMRelationship::BIMRelationship | ( | BIMRelationship const & | in_relationship | ) |
The copy constructor creates a new BIMRelationship object that is associated with the same data as the source BIMRelationship.
- Parameters
-
in_relationship The source BIMRelationship to copy.
◆ BIMRelationship() [3/3]
HPS::Exchange::BIMRelationship::BIMRelationship | ( | BIMRelationship && | in_relationship | ) |
The move constructor creates an BIMRelationship by transferring the underlying impl of the rvalue reference to this BIMRelationship thereby avoiding a copy and allocation.
- Parameters
-
in_relationship An rvalue reference to an BIMRelationship to take the impl from.
Member Function Documentation
◆ Equals()
bool HPS::Exchange::BIMRelationship::Equals | ( | BIMRelationship const & | in_relationship | ) | const |
Check if the source BIMRelationship is equivalent to this BIMRelationship.
- Parameters
-
in_relationship The source BIMRelationship to compare to this BIMRelationship.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetRelatedEntities()
BIMRelationshipEntityArray HPS::Exchange::BIMRelationship::GetRelatedEntities | ( | ) | const |
Get an array of related BIMRelationshipEntity.
- Returns
- an array of BIMRelationshipEntity acting as related in the BIMRelationship.
◆ GetRelatingEntity()
BIMRelationshipEntity HPS::Exchange::BIMRelationship::GetRelatingEntity | ( | ) | const |
Get the relating BIMRelationshipEntity.
- Returns
- the RelatingshipEntity acting as relating in the BIMRelationship.
◆ GetType()
BIMRelationshipType HPS::Exchange::BIMRelationship::GetType | ( | ) | const |
Get the type of this BIMRelationship.
- Returns
- the BIMRelationshipType of this BIMRelationship.
◆ 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::BIMRelationship::operator!= | ( | BIMRelationship const & | in_relationship | ) | const |
Check if the source BIMRelationship is not equivalent to this BIMRelationship.
- Parameters
-
in_relationship The source BIMRelationship to compare to this BIMRelationship.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=()
BIMRelationship& HPS::Exchange::BIMRelationship::operator= | ( | BIMRelationship && | in_relationship | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this BIMRelationship thereby avoiding a copy.
- Parameters
-
in_relationship An rvalue reference to an ImportNotifier to take the impl from.
- Returns
- A reference to this BIMRelationship.
◆ operator==()
bool HPS::Exchange::BIMRelationship::operator== | ( | BIMRelationship const & | in_relationship | ) | const |
Check if the source BIMRelationship is equivalent to this BIMRelationship.
- Parameters
-
in_relationship The source BIMRelationship to compare to this BIMRelationship.
- Returns
- true if the objects are equivalent, false otherwise.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h