CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcPermeableCoveringProperties Class Reference

#include <IfcPermeableCoveringPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcPermeableCoveringProperties:
OdIfc2x3::IfcPropertySetDefinition OdIfc2x3::IfcPropertyDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

IfcPermeableCoveringOperationEnum getOperationType () const
 
void setOperationType (IfcPermeableCoveringOperationEnum OperationType)
 
IfcWindowPanelPositionEnum getPanelPosition () const
 
void setPanelPosition (IfcWindowPanelPositionEnum PanelPosition)
 
double getFrameDepth () const
 
void setFrameDepth (double FrameDepth)
 
double getFrameThickness () const
 
void setFrameThickness (double FrameThickness)
 
const OdDAIObjectId & getShapeAspectStyle () const
 
void setShapeAspectStyle (const OdDAIObjectId &ShapeAspectStyle)
 
 IfcPermeableCoveringProperties ()
 
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 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 OdIfc2x3::IfcPropertySetDefinition
void getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const
 
void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
- Public Member Functions inherited from OdIfc2x3::IfcPropertyDefinition
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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

OdDAI::Enum m_OperationType
 
OdDAI::Enum m_PanelPosition
 
IfcPositiveLengthMeasure m_FrameDepth
 
IfcPositiveLengthMeasure m_FrameThickness
 
OdDAIObjectId m_ShapeAspectStyle
 
- Protected Attributes inherited from OdIfc2x3::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 OdIfc2x3::IfcPropertySetDefinition
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

This entity is a description of a panel within a door or window (as fillers for opening) which allows for air flow. It is given by its properties (IfcPermeableCoveringProperties). A permeable covering is a casement, such as a component, fixed or opening, consisting essentially of a frame and the infilling. The infilling is normally a grill, a louver or a screen. The way of operation is defined in the operation type.

  • Details - The IfcPermeableCoveringProperties are included in the list of properties (HasPropertySets) of the IfcWindowStyle or the IfcDoorStyle. More information about the permeable covering can be included in the same list of the window or door style using the IfcPropertySet for dynamic extensions. This particularly applies for additional properties for the various operation types.

<IMAGE ifcpermeablecoveringproperties>

Definition at line 52 of file Ifc2x3/IfcPermeableCoveringPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPermeableCoveringProperties()

OdIfc2x3::IfcPermeableCoveringProperties::IfcPermeableCoveringProperties ( )

Default constructor for the IfcPermeableCoveringProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ getFrameDepth()

double OdIfc2x3::IfcPermeableCoveringProperties::getFrameDepth ( ) const

Returns the value of FrameDepth attribute. This attribute represents depth of panel frame (used to include the permeable covering), measured from front face to back face horizontally (i.e. perpendicular to the window or door (elevation) plane.

Returns
Returns the value of FrameDepth attribute.

◆ getFrameThickness()

double OdIfc2x3::IfcPermeableCoveringProperties::getFrameThickness ( ) const

Returns the value of FrameThickness attribute. This attribute represents width of panel frame (used to include the permeable covering), measured from inside of panel (at permeable covering) to outside of panel (at lining), i.e. parallel to the window or door (elevation) plane.

Returns
Returns the value of FrameThickness attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ getOperationType()

IfcPermeableCoveringOperationEnum OdIfc2x3::IfcPermeableCoveringProperties::getOperationType ( ) const

Returns the value of OperationType attribute. This attribute represents types of permeable covering operations. Also used to assign standard symbolic presentations according to national building standards.

Returns
Returns the value of OperationType attribute.

◆ getPanelPosition()

IfcWindowPanelPositionEnum OdIfc2x3::IfcPermeableCoveringProperties::getPanelPosition ( ) const

Returns the value of PanelPosition attribute. This attribute represents position of this permeable covering panel within the overall window or door type.

Returns
Returns the value of PanelPosition attribute.

◆ getShapeAspectStyle()

const OdDAIObjectId & OdIfc2x3::IfcPermeableCoveringProperties::getShapeAspectStyle ( ) const

Returns the value of ShapeAspectStyle attribute. This attribute represents optional link to a shape aspect definition, which points to the part of the geometric representation of the window style, which is used to represent the permeable covering.

Returns
Returns the value of ShapeAspectStyle attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ isKindOf()

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ outFields()

virtual OdResult OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ setFrameDepth()

void OdIfc2x3::IfcPermeableCoveringProperties::setFrameDepth ( double FrameDepth)

Sets the value of FrameDepth attribute. This attribute represents depth of panel frame (used to include the permeable covering), measured from front face to back face horizontally (i.e. perpendicular to the window or door (elevation) plane.

Parameters
FrameDepth[in] Frame depth to set.

◆ setFrameThickness()

void OdIfc2x3::IfcPermeableCoveringProperties::setFrameThickness ( double FrameThickness)

Sets the value of FrameThickness attribute. This attribute represents width of panel frame (used to include the permeable covering), measured from inside of panel (at permeable covering) to outside of panel (at lining), i.e. parallel to the window or door (elevation) plane.

Parameters
FrameThickness[in] Frame thickness to set.

◆ setOperationType()

void OdIfc2x3::IfcPermeableCoveringProperties::setOperationType ( IfcPermeableCoveringOperationEnum OperationType)

Sets the value of OperationType attribute. This attribute represents types of permeable covering operations. Also used to assign standard symbolic presentations according to national building standards.

Parameters
OperationType[in] Operation type to set.

◆ setPanelPosition()

void OdIfc2x3::IfcPermeableCoveringProperties::setPanelPosition ( IfcWindowPanelPositionEnum PanelPosition)

Sets the value of PanelPosition attribute. This attribute represents position of this permeable covering panel within the overall window or door type.

Parameters
PanelPosition[in] Panel position to set.

◆ setShapeAspectStyle()

void OdIfc2x3::IfcPermeableCoveringProperties::setShapeAspectStyle ( const OdDAIObjectId & ShapeAspectStyle)

Sets the value of ShapeAspectStyle attribute. This attribute represents optional link to a shape aspect definition, which points to the part of the geometric representation of the window style, which is used to represent the permeable covering.

Parameters
ShapeAspectStyle[in] Shape aspect style to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcPermeableCoveringProperties::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcPropertySetDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcPermeableCoveringProperties::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 OdIfc2x3::IfcPropertySetDefinition.

Member Data Documentation

◆ m_FrameDepth

IfcPositiveLengthMeasure OdIfc2x3::IfcPermeableCoveringProperties::m_FrameDepth
protected

◆ m_FrameThickness

IfcPositiveLengthMeasure OdIfc2x3::IfcPermeableCoveringProperties::m_FrameThickness
protected

◆ m_OperationType

OdDAI::Enum OdIfc2x3::IfcPermeableCoveringProperties::m_OperationType
protected

◆ m_PanelPosition

OdDAI::Enum OdIfc2x3::IfcPermeableCoveringProperties::m_PanelPosition
protected

◆ m_ShapeAspectStyle

OdDAIObjectId OdIfc2x3::IfcPermeableCoveringProperties::m_ShapeAspectStyle
protected

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