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

Public Member Functions

 BIMRelationshipEntity ()
 
 BIMRelationshipEntity (HPS.Exchange.BIMRelationshipEntity in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.BIMRelationshipEntity in_relationshipEntity)
 
HPS.Exchange.Component GetComponent ()
 
override int GetHashCode ()
 
string GetName (bool use_generated_if_needed)
 
string GetName ()
 
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.BIMRelationshipEntity a, HPS.Exchange.BIMRelationshipEntity b)
 
static bool operator== (HPS.Exchange.BIMRelationshipEntity a, HPS.Exchange.BIMRelationshipEntity 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

Entity inside a BIM relationship

Constructor & Destructor Documentation

◆ BIMRelationshipEntity() [1/2]

HPS.Exchange.BIMRelationshipEntity.BIMRelationshipEntity ( )
inline

The default constructor creates an empty BIMRelationshipEntity object.

◆ BIMRelationshipEntity() [2/2]

HPS.Exchange.BIMRelationshipEntity.BIMRelationshipEntity ( HPS.Exchange.BIMRelationshipEntity  in_that)
inline

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

Parameters
in_thatThe source BIMRelationshipEntity to copy.

Member Function Documentation

◆ Equals()

bool HPS.Exchange.BIMRelationshipEntity.Equals ( HPS.Exchange.BIMRelationshipEntity  in_relationshipEntity)
inline

Check if the source BIMRelationshipEntity is equivalent to this BIMRelationshipEntity.

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

◆ GetComponent()

HPS.Exchange.Component HPS.Exchange.BIMRelationshipEntity.GetComponent ( )
inline

Get the component for this entity.

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

◆ GetName() [1/2]

string HPS.Exchange.BIMRelationshipEntity.GetName ( bool  use_generated_if_needed)
inline

Get the name of this BIMRelationshipEntity.

Parameters
use_generated_if_neededWhether to use the generated name if the component has no name.
Returns
the name of this BIMRelationshipEntity.

◆ GetName() [2/2]

string HPS.Exchange.BIMRelationshipEntity.GetName ( )
inline

Get the name of this BIMRelationshipEntity.

Returns
the name of this BIMRelationshipEntity.

◆ ObjectType()

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