HPS::Exchange::BIMRelationship

class HPS::Exchange::BIMRelationship : public HPS::Sprocket

BIM relationship

Public Functions

BIMRelationship()

The default constructor creates an empty BIMRelationship object.

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.

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.

bool 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.

BIMRelationshipEntityArray GetRelatedEntities() const

Get an array of related BIMRelationshipEntity.

Returns

an array of BIMRelationshipEntity acting as related in the BIMRelationship.

BIMRelationshipEntity GetRelatingEntity() const

Get the relating BIMRelationshipEntity.

Returns

the RelatingshipEntity acting as relating in the BIMRelationship.

BIMRelationshipType GetType() const

Get the type of this BIMRelationship.

Returns

the BIMRelationshipType of this BIMRelationship.

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!=(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.

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.

BIMRelationship &operator=(const BIMRelationship &in_relationship)

bool 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.

virtual ~BIMRelationship()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeBIMRelationship