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 (HPS.Exchange.BIMRelationshipEntity in_that)

The copy constructor creates a new BIMRelationshipEntity object that is associated with the same data as the source BIMRelationshipEntity.

Param in_that

The source BIMRelationshipEntity to copy.

bool Equals (HPS.Exchange.BIMRelationshipEntity in_relationshipEntity)

Check if the source BIMRelationshipEntity is equivalent to this BIMRelationshipEntity.

Param in_relationshipEntity

The source BIMRelationshipEntity to compare to this BIMRelationshipEntity.

Return

true if the objects are equivalent, false otherwise.

HPS.Exchange.Component GetComponent ()

Get the component for this entity.

Return

the component for this entity of an empty component is the element is not loaded (such as openings).

string GetName ()

Get the name of this BIMRelationshipEntity.

Return

the name of this BIMRelationshipEntity.

string GetName (bool use_generated_if_needed)

Get the name of this BIMRelationshipEntity.

Param use_generated_if_needed

Whether to use the generated name if the component has no name.

Return

the name of this BIMRelationshipEntity.

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.