#include <IfcCompartmentAutoImpl.h>
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.
◆ IfcCompartment()
| OdIfc2x_final::IfcCompartment::IfcCompartment |
( |
| ) |
|
◆ 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]
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()
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]
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()
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]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc2x_final::IfcGroup.
◆ m_FireRiskFactor
| int OdIfc2x_final::IfcCompartment::m_FireRiskFactor |
|
protected |
◆ m_HasNaturalVentilation
| OdDAI::Logical OdIfc2x_final::IfcCompartment::m_HasNaturalVentilation |
|
protected |
◆ m_HasSprinklerProtection
| OdDAI::Logical OdIfc2x_final::IfcCompartment::m_HasSprinklerProtection |
|
protected |
The documentation for this class was generated from the following file: