CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcRelServicesBuildings Class Reference

#include <IfcRelServicesBuildingsAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcRelServicesBuildings:
OdIfc4x4::IfcRelConnects OdIfc4x4::IfcRelationship OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getRelatingSystem () const
 
void setRelatingSystem (const OdDAIObjectId &RelatingSystem)
 
void getRelatedBuildings (OdDAIObjectIds &RelatedBuildings) const
 
OdDAI::SetOfOdDAIObjectId & relatedBuildings ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc4x4::IfcRoot
OdDAI::CompressedGUID getGlobalId () const
 
void setGlobalId (OdDAI::CompressedGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
- Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAIObjectId m_RelatingSystem
 
OdDAI::SetOfOdDAIObjectId m_RelatedBuildings
 
- Protected Attributes inherited from OdIfc4x4::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

This entity is an objectified relationship that defines the relationship between a system and the sites, buildings, storeys, spaces, or spatial zones, it serves. Examples of systems are: Building service systems (heating, cooling, waste water system) represented by instances of IfcDistributionSystem; Building systems (fenestration, shading) represented by instances of IfcBuildingSystem; Zones as collection of logically grouped spaces represented by instances of IfcZone Idealized structural analysis systems represented by instances of IfcStructuralAnalysisModel.

Remarks
The name IfcRelServicesBuildings is a known anomaly, as the relationship is not restricted to buildings anymore.

\changes

IFC2X_FINAL changes: The data type of the attribute RelatedBuildings has been changed from IfcBuilding to its supertype IfcSpatialStructureElement with upward compatibility for file-based exchange. IFC4 changes: Type of the RelatedBuildings attribute changed from "set[1:?] of IfcSpatialStructureElement" to "set[1:?] of IfcSpatialElement". IFC4X3_RC1 changes: This definition is deprecated, use IfcRelReferencedInSpatialStructure instead.

Definition at line 58 of file IFC4X4/IfcRelServicesBuildingsAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcRelServicesBuildings::comparedToEarlyImpl ( const OdDAI::ApplicationInstance * pOther,
OdRx::Ordering & ordering ) const
overridevirtual

Early-bound version of instances comparison.

Parameters
pOther[in] Other application instance.
ordering[out] Receives the ordering (comparison) status.
Returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc4x4::IfcRelConnects.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcRelServicesBuildings::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4x4::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcRelServicesBuildings::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4x4::IfcRoot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcRelServicesBuildings::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc4x4::IfcRelConnects.

◆ getRelatedBuildings()

void OdIfc4x4::IfcRelServicesBuildings::getRelatedBuildings ( OdDAIObjectIds & RelatedBuildings) const

Returns the value of RelatedBuildings attribute. This attribute represents spatial structure elements (including site, building, storeys) that are serviced by the system.

Parameters
RelatedBuildings[out] Receives the RelatedBuildings attribute.
Remarks
IFC2x CHANGE: The data type has been changed from IfcBuilding to IfcSpatialStructureElement with upward compatibility for file-based exchange. IFC4 CHANGE: The data type has been changed from IfcSpatialStructureElement to IfcSpatialElement with upward compatibility for file-based exchange.

◆ getRelatingSystem()

const OdDAIObjectId & OdIfc4x4::IfcRelServicesBuildings::getRelatingSystem ( ) const

Returns the value of RelatingSystem attribute. This attribute represents system that services the Buildings.

Returns
Returns the value of RelatingSystem attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcRelServicesBuildings::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4x4::IfcRoot.

◆ isKindOf()

virtual bool OdIfc4x4::IfcRelServicesBuildings::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc4x4::IfcRelConnects.

◆ outFields()

virtual OdResult OdIfc4x4::IfcRelServicesBuildings::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4x4::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcRelServicesBuildings::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4x4::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcRelServicesBuildings::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4x4::IfcRoot.

◆ relatedBuildings()

OdDAI::SetOfOdDAIObjectId & OdIfc4x4::IfcRelServicesBuildings::relatedBuildings ( )

Returns the value of RelatedBuildings attribute. This attribute represents spatial structure elements (including site, building, storeys) that are serviced by the system.

Returns
Returns the value of RelatedBuildings attribute.
Remarks
IFC2x CHANGE: The data type has been changed from IfcBuilding to IfcSpatialStructureElement with upward compatibility for file-based exchange. IFC4 CHANGE: The data type has been changed from IfcSpatialStructureElement to IfcSpatialElement with upward compatibility for file-based exchange.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcRelServicesBuildings::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setRelatingSystem()

void OdIfc4x4::IfcRelServicesBuildings::setRelatingSystem ( const OdDAIObjectId & RelatingSystem)

Sets the value of RelatingSystem attribute. This attribute represents system that services the Buildings.

Parameters
RelatingSystem[in] Relating system to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcRelServicesBuildings::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4x4::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcRelServicesBuildings::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4x4::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcRelServicesBuildings::type ( ) const
overridevirtual

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4x4::IfcRelConnects.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcRelServicesBuildings::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4x4::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcRelServicesBuildings::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4x4::IfcRoot.

Member Data Documentation

◆ m_RelatedBuildings

OdDAI::SetOfOdDAIObjectId OdIfc4x4::IfcRelServicesBuildings::m_RelatedBuildings
protected

Definition at line 244 of file IFC4X4/IfcRelServicesBuildingsAutoImpl.h.

◆ m_RelatingSystem

OdDAIObjectId OdIfc4x4::IfcRelServicesBuildings::m_RelatingSystem
protected

Definition at line 243 of file IFC4X4/IfcRelServicesBuildingsAutoImpl.h.


The documentation for this class was generated from the following file: