CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcCompartment Class Reference

#include <IfcCompartmentAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCompartment:
OdIfc2x_final::IfcZone OdIfc2x_final::IfcGroup OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

OdDAI::Logical getHasNaturalVentilation () const
 
void setHasNaturalVentilation (OdDAI::Logical HasNaturalVentilation)
 
OdDAI::Logical getHasSprinklerProtection () const
 
void setHasSprinklerProtection (OdDAI::Logical HasSprinklerProtection)
 
int getFireRiskFactor () const
 
void setFireRiskFactor (int FireRiskFactor)
 
 IfcCompartment ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) 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 OdIfc2x_final::IfcGroup
OdDAIObjectId getInvIsGroupedBy () const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::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 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

OdDAI::Logical m_HasNaturalVentilation
 
OdDAI::Logical m_HasSprinklerProtection
 
int m_FireRiskFactor
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::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)
 
- Protected Member Functions inherited from OdIfc2x_final::IfcGroup
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

The Compartment entity (IfcCompartment) is considered as a grouping of Spaces (IfcSpace) for compartmentation purposes. It is an aggregate of spaces under this view, using the IfcRelAssignsToGroup objectified relationship.

Definition at line 41 of file IfcCompartmentAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCompartment()

OdIfc2x_final::IfcCompartment::IfcCompartment ( )

Default constructor for the IfcCompartment class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcObject.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ getFireRiskFactor()

int OdIfc2x_final::IfcCompartment::getFireRiskFactor ( ) const

Returns the value of FireRiskFactor attribute. This attribute represents fire risk factor assigned to the space.

Returns
Returns the value of FireRiskFactor attribute.

◆ getHasNaturalVentilation()

OdDAI::Logical OdIfc2x_final::IfcCompartment::getHasNaturalVentilation ( ) const

Returns the value of HasNaturalVentilation attribute. This attribute indicates whether the space is ventilated natural (true) or mechanical (false).

Returns
Returns the value of HasNaturalVentilation attribute.

◆ getHasSprinklerProtection()

OdDAI::Logical OdIfc2x_final::IfcCompartment::getHasSprinklerProtection ( ) const

Returns the value of HasSprinklerProtection attribute. This attribute indicates whether the space is sprinkler protected (true) or not (false).

Returns
Returns the value of HasSprinklerProtection attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcZone.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcZone.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcObject.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ setFireRiskFactor()

void OdIfc2x_final::IfcCompartment::setFireRiskFactor ( int FireRiskFactor)

Sets the value of FireRiskFactor attribute. This attribute represents fire risk factor assigned to the space.

Parameters
FireRiskFactor[in] FireRiskFactor attribute to set.

◆ setHasNaturalVentilation()

void OdIfc2x_final::IfcCompartment::setHasNaturalVentilation ( OdDAI::Logical HasNaturalVentilation)

Sets the value of HasNaturalVentilation attribute. This attribute indicates whether the space is ventilated natural (true) or mechanical (false).

Parameters
HasNaturalVentilation[in] HasNaturalVentilation attribute to set.

◆ setHasSprinklerProtection()

void OdIfc2x_final::IfcCompartment::setHasSprinklerProtection ( OdDAI::Logical HasSprinklerProtection)

Sets the value of HasSprinklerProtection attribute. This attribute indicates whether the space is sprinkler protected (true) or not (false).

Parameters
HasSprinklerProtection[in] HasSprinklerProtection attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcZone.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcCompartment::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcGroup.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcCompartment::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 OdIfc2x_final::IfcGroup.

Member Data Documentation

◆ m_FireRiskFactor

int OdIfc2x_final::IfcCompartment::m_FireRiskFactor
protected

Definition at line 212 of file IfcCompartmentAutoImpl.h.

◆ m_HasNaturalVentilation

OdDAI::Logical OdIfc2x_final::IfcCompartment::m_HasNaturalVentilation
protected

Definition at line 210 of file IfcCompartmentAutoImpl.h.

◆ m_HasSprinklerProtection

OdDAI::Logical OdIfc2x_final::IfcCompartment::m_HasSprinklerProtection
protected

Definition at line 211 of file IfcCompartmentAutoImpl.h.


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