HPS.Exchange.BIMData

class HPS.Exchange.BIMData : public HPS.Sprocket

BIM related data inside the model.

Public Functions

BIMData ()

The default constructor creates an empty BIMData object.

BIMData (HPS.Exchange.BIMData in_bim_data)

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

Param in_bim_data

The source BIMData to copy.

bool Equals (HPS.Exchange.BIMData in_bim_data)

Check if the source BIMData is equivalent to this BIMData.

Param in_bim_data

The source BIMData to compare to this BIMData.

Return

true if the objects are equivalent, false otherwise.

HPS.Exchange.BIMRelationshipEntity[] GetRelatedEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)

Get an array of BIMRelationshipEntity that are related to the component given.

Param in_component

the component used to search related BIMRelationshipEntity.

Param in_relationship_type

the type of BIMRelationship used for the search.

Return

an array of BIMRelationshipEntity.

HPS.Exchange.BIMRelationshipEntity[] GetRelatingEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)

Get an array of BIMRelationshipEntity that are relating to the component given.

Param in_component

the component used to search relating BIMRelationshipEntity.

Param in_relationship_type

the type of BIMRelationship used for the search.

Return

an array of BIMRelationshipEntity.

HPS.Exchange.BIMRelationship[] GetRelationships (HPS.Exchange.Component in_component)

Get an array of all relationships that target the component given.

Param in_component

the component whose relationships are requested.

Return

the array of BIMRelationship for the component.

HPS.Exchange.BIMType[] GetTypes ()

Get an array of BIMType present in this model.

Return

the array of BIMType for this model.

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.