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

#include <IfcWindowAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcWindow:
OdIfc4x4::IfcBuiltElement OdIfc4x4::IfcElement OdIfc4x4::IfcProduct OdIfc4x4::IfcObject OdIfc4x4::IfcObjectDefinition OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

double getOverallHeight () const
 
void setOverallHeight (double OverallHeight)
 
double getOverallWidth () const
 
void setOverallWidth (double OverallWidth)
 
IfcWindowTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcWindowTypeEnum PredefinedType)
 
IfcWindowTypePartitioningEnum getPartitioningType () const
 
void setPartitioningType (IfcWindowTypePartitioningEnum PartitioningType)
 
const OdAnsiString & getUserDefinedPartitioningType () const
 
void setUserDefinedPartitioningType (const OdAnsiString &UserDefinedPartitioningType)
 
 IfcWindow ()
 
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 OdIfc4x4::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const
 
void getInvInterferesElements (OdDAIObjectIds &InterferesElements) const
 
void getInvHasProjections (OdDAIObjectIds &HasProjections) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const
 
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
void getInvHasCoverings (OdDAIObjectIds &HasCoverings) const
 
void getInvHasSurfaceFeatures (OdDAIObjectIds &HasSurfaceFeatures) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc4x4::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
void getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc4x4::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc4x4::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- 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

IfcPositiveLengthMeasure m_OverallHeight
 
IfcPositiveLengthMeasure m_OverallWidth
 
OdDAI::Enum m_PredefinedType
 
OdDAI::Enum m_PartitioningType
 
OdAnsiString m_UserDefinedPartitioningType
 
- Protected Attributes inherited from OdIfc4x4::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc4x4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString m_ObjectType
 
- 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

The window is a building element that is predominately used to provide natural light and fresh air. It includes vertical opening but also horizontal opening such as skylights or light domes. It includes constructions with swinging, pivoting, sliding, or revolving panels and fixed panels. A window consists of a lining and one or several panels. A window can:

be a "free standing" window, contained in an IfcSpatialElement such as an IfcBuildingStorey. fill an opening, typically in a wall. The window will then have a FillsVoids attribute which uses the IfcRelFillsElement relationship to relate the IfcWindow with the IfcOpeningElement; be part of an element assembly, typically an IfcCurtainWall. The window will then have a Decomposes attribute which uses the the IfcRelAggregates relationship to relate the window with the assembly of elements;

The IfcWindowType specifies parameters which are common to all of its occurrences of IfcWindow: the partitioning type (single panel, double panel, triple panel, more panels) the operation type (swing, tilt and turn, pivot revolve, fixed casement, etc.) the window panel hinge side (by using two different styles for right and left opening windows) the particular attributes for the lining by the IfcWindowLiningProperties the particular attributes for the panels by the IfcWindowPanelProperties

  • Material Set - This concept can be applied to the following resources: Lining - Indicates that the material constituent applies to the window lining Framing - Indicates that the material constituent applies to the windows panels(s); if not provided, the 'Lining' material information applies to panel(s) as well Glazing - Indicates that the material constituent applies to the glazing part
  • Material Single - If a single IfcMaterial is referenced, it applies to the lining and framing of the window.
  • Object Typing - The PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the same element (if specified), in which the IfcWindow is used as a filling (normally an IfcOpeningElement), as provided by the IfcRelFillsElement relationship If the IfcWindow is not inserted into an IfcOpeningElement, then the PlacementRelTo relationship of IfcLocalPlacement points (if specified) to the local placement of the same IfcSpatialStructureElement that is used in the ContainedInStructure inverse attribute or to a referenced spatial structure element at a higher level If the relative placement is not used, the absolute placement is defined within the world coordinate system
  • Profile 3D Geometry - The window profile is represented by a three-dimensional closed curve lying in the xz plane. The profile is used to apply the parameters of a parametric door representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used: RepresentationIdentifier : 'Profile' RepresentationType : 'Curve3D', only a single closed curve is contained in the set of IfcShapeRepresentation.Items

A 'Profile' representation has to be provided if: A parametric representation is applied to the window AND One of two options: the window is 'free standing' the opening into which the window is inserted is not extruded horizontally (i.e. where the opening profile does not match the window profile)

  • Property Sets for Objects - This concept can be applied to the following resources: Pset_DoorWindowGlazingType Pset_WindowCommon
  • Quantity Sets - This concept can be applied to the following resources: Qto_WindowBaseQuantities
  • Spatial Containment - The IfcWindow, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships: the Spatial Containment (defined here) the Element Composition

The IfcWindow can also be connected to the IfcOpeningElement in which it is placed as a filler. In this case, the spatial containment relationship is provided, see image below.

<IMAGE ifcwindow_containment-01>

  • Window Attributes - The parameters that defines the shape of the IfcWindow, are specified at the IfcWindowType and the property sets, which are included in the IfcWindowType. The IfcWindow only defines the local placement which determines the opening direction of the window.

The overall layout and its symbolic presentation of the IfcWindow is determined by its IfcWindowType.PartitioningType. The type determines the number and position of window panels. Depending on the type, the appropriate instances of IfcWindowLiningProperties and IfcWindowPanelProperties are attached in the list of HasPropertySets.

\changes

IFC4X3_RC1 changes: Supertype changed from "IfcBuildingElement" to "IfcBuiltElement"

Definition at line 120 of file IFC4X4/IfcWindowAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWindow()

OdIfc4x4::IfcWindow::IfcWindow ( )

Default constructor for the IfcWindow class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcWindow::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::IfcBuiltElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcWindow::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::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcWindow::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::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcWindow::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::IfcBuiltElement.

◆ getOverallHeight()

double OdIfc4x4::IfcWindow::getOverallHeight ( ) const

Returns the value of OverallHeight attribute. This attribute represents overall measure of the height, it reflects the Z Dimension of a bounding box, enclosing the window opening. If omitted, the OverallHeight should be taken from the geometric representation of the IfcOpening in which the window is inserted.

Returns
Returns the value of OverallHeight attribute.
Remarks
The body of the window might be taller then the window opening (for example in cases where the window lining includes a casing). In these cases the OverallHeight is still specified as the window opening height, and not as the total height of the window lining.

◆ getOverallWidth()

double OdIfc4x4::IfcWindow::getOverallWidth ( ) const

Returns the value of OverallWidth attribute. This attribute represents overall measure of the width, it reflects the X Dimension of a bounding box, enclosing the window opening. If omitted, the OverallWidth should be taken from the geometric representation of the IfcOpening in which the window is inserted.

Returns
Returns the value of OverallWidth attribute.
Remarks
The body of the window might be wider then the window opening (for example in cases where the window lining includes a casing). In these cases the OverallWidth is still specified as the window opening width, and not as the total width of the window lining.

◆ getPartitioningType()

IfcWindowTypePartitioningEnum OdIfc4x4::IfcWindow::getPartitioningType ( ) const

Returns the value of PartitioningType attribute. This attribute represents type defining the general layout of the window in terms of the partitioning of panels.

Returns
Returns the value of PartitioningType attribute.
Remarks
The PartitioningType is only used if no type object IfcWindowType is assigned, providing its own IfcWindowType.PartitioningType.

◆ getPredefinedType()

IfcWindowTypeEnum OdIfc4x4::IfcWindow::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a window that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Returns
Returns the value of PredefinedType attribute.
Remarks
The PredefinedType is only used if no IfcWindowType is assigned, providing its own IfcWindowType.PredefinedType.

◆ getUserDefinedPartitioningType()

const OdAnsiString & OdIfc4x4::IfcWindow::getUserDefinedPartitioningType ( ) const

Returns the value of UserDefinedPartitioningType attribute. This attribute represents designator for the user defined partitioning type, is only provided if the value of PartitioningType is set to USERDEFINED.

Returns
Returns the value of UserDefinedPartitioningType attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcWindow::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::IfcElement.

◆ isKindOf()

virtual bool OdIfc4x4::IfcWindow::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::IfcBuiltElement.

◆ outFields()

virtual OdResult OdIfc4x4::IfcWindow::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::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcWindow::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::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcWindow::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::IfcElement.

◆ setOverallHeight()

void OdIfc4x4::IfcWindow::setOverallHeight ( double OverallHeight)

Sets the value of OverallHeight attribute. This attribute represents overall measure of the height, it reflects the Z Dimension of a bounding box, enclosing the window opening. If omitted, the OverallHeight should be taken from the geometric representation of the IfcOpening in which the window is inserted.

Parameters
OverallHeight[in] Overall height to set.
Remarks
The body of the window might be taller then the window opening (for example in cases where the window lining includes a casing). In these cases the OverallHeight is still specified as the window opening height, and not as the total height of the window lining.

◆ setOverallWidth()

void OdIfc4x4::IfcWindow::setOverallWidth ( double OverallWidth)

Sets the value of OverallWidth attribute. This attribute represents overall measure of the width, it reflects the X Dimension of a bounding box, enclosing the window opening. If omitted, the OverallWidth should be taken from the geometric representation of the IfcOpening in which the window is inserted.

Parameters
OverallWidth[in] Overall width to set.
Remarks
The body of the window might be wider then the window opening (for example in cases where the window lining includes a casing). In these cases the OverallWidth is still specified as the window opening width, and not as the total width of the window lining.

◆ setPartitioningType()

void OdIfc4x4::IfcWindow::setPartitioningType ( IfcWindowTypePartitioningEnum PartitioningType)

Sets the value of PartitioningType attribute. This attribute represents type defining the general layout of the window in terms of the partitioning of panels.

Parameters
PartitioningType[in] Partitioning type to set.
Remarks
The PartitioningType is only used if no type object IfcWindowType is assigned, providing its own IfcWindowType.PartitioningType.

◆ setPredefinedType()

void OdIfc4x4::IfcWindow::setPredefinedType ( IfcWindowTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a window that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Parameters
PredefinedType[in] Predefined type to set.
Remarks
The PredefinedType is only used if no IfcWindowType is assigned, providing its own IfcWindowType.PredefinedType.

◆ setUserDefinedPartitioningType()

void OdIfc4x4::IfcWindow::setUserDefinedPartitioningType ( const OdAnsiString & UserDefinedPartitioningType)

Sets the value of UserDefinedPartitioningType attribute. This attribute represents designator for the user defined partitioning type, is only provided if the value of PartitioningType is set to USERDEFINED.

Parameters
UserDefinedPartitioningType[in] User-defined partitioning type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcWindow::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::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcWindow::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::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcWindow::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::IfcBuiltElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcWindow::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::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcWindow::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::IfcElement.

Member Data Documentation

◆ m_OverallHeight

IfcPositiveLengthMeasure OdIfc4x4::IfcWindow::m_OverallHeight
protected

Definition at line 366 of file IFC4X4/IfcWindowAutoImpl.h.

◆ m_OverallWidth

IfcPositiveLengthMeasure OdIfc4x4::IfcWindow::m_OverallWidth
protected

Definition at line 367 of file IFC4X4/IfcWindowAutoImpl.h.

◆ m_PartitioningType

OdDAI::Enum OdIfc4x4::IfcWindow::m_PartitioningType
protected

Definition at line 369 of file IFC4X4/IfcWindowAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcWindow::m_PredefinedType
protected

Definition at line 368 of file IFC4X4/IfcWindowAutoImpl.h.

◆ m_UserDefinedPartitioningType

OdAnsiString OdIfc4x4::IfcWindow::m_UserDefinedPartitioningType
protected

Definition at line 370 of file IFC4X4/IfcWindowAutoImpl.h.


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