Inheritance diagram for HPS.Exchange.BIMData:
HPS.Sprocket HPS.Object

Public Member Functions

 BIMData ()
 
 BIMData (HPS.Exchange.BIMData in_bim_data)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.BIMData in_bim_data)
 
override int GetHashCode ()
 
HPS.Exchange.BIMRelationshipEntity [] GetRelatedEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)
 
HPS.Exchange.BIMRelationshipEntity [] GetRelatingEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)
 
HPS.Exchange.BIMRelationship [] GetRelationships (HPS.Exchange.Component in_component)
 
HPS.Exchange.BIMType [] GetTypes ()
 
override HPS.Type ObjectType ()
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.Exchange.BIMData a, HPS.Exchange.BIMData b)
 
static bool operator== (HPS.Exchange.BIMData a, HPS.Exchange.BIMData b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

BIM related data inside the model.

Constructor & Destructor Documentation

◆ BIMData() [1/2]

HPS.Exchange.BIMData.BIMData ( )
inline

The default constructor creates an empty BIMData object.

◆ BIMData() [2/2]

HPS.Exchange.BIMData.BIMData ( HPS.Exchange.BIMData  in_bim_data)
inline

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

Parameters
in_bim_dataThe source BIMData to copy.

Member Function Documentation

◆ Equals()

bool HPS.Exchange.BIMData.Equals ( HPS.Exchange.BIMData  in_bim_data)
inline

Check if the source BIMData is equivalent to this BIMData.

Parameters
in_bim_dataThe source BIMData to compare to this BIMData.
Returns
true if the objects are equivalent, false otherwise.

◆ GetRelatedEntities()

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

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

Parameters
in_componentthe component used to search related BIMRelationshipEntity.
in_relationship_typethe type of BIMRelationship used for the search.
Returns
an array of BIMRelationshipEntity.

◆ GetRelatingEntities()

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

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

Parameters
in_componentthe component used to search relating BIMRelationshipEntity.
in_relationship_typethe type of BIMRelationship used for the search.
Returns
an array of BIMRelationshipEntity.

◆ GetRelationships()

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

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

Parameters
in_componentthe component whose relationships are requested.
Returns
the array of BIMRelationship for the component.

◆ GetTypes()

HPS.Exchange.BIMType [] HPS.Exchange.BIMData.GetTypes ( )
inline

Get an array of BIMType present in this model.

Returns
the array of BIMType for this model.

◆ ObjectType()

override HPS.Type HPS.Exchange.BIMData.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.


The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs