Struct Ifc2x3

Nested Relationships

Nested Types

Struct Documentation

struct Ifc2x3

Public Types

typedef IfcUtil::IfcBaseClass IfcActorSelect

The actor select type allows a person, or an organization, or a person associated with an organization to be referenced.

NOTE Corresponds to the following entity in ISO 10303-41: person_organization_select.

HISTORY New entity in IFC Release 1.5.1

SELECT

IfcOrganization An organization. IfcPerson A person. IfcPersonAndOrganization A person related to an organization.

typedef IfcUtil::IfcBaseClass IfcAppliedValueSelect

IfcAppliedValueSelect defines the selection of whether a value (expressed as a ratio) or an amount should be used as the value for an IfcAppliedValue.

Select from:

IfcMeasureWithUnit IfcMonetaryMeasure IfcRatioMeasure

HISTORY: New SELECT type in IFC 2x2.

Use definitions Selecting IfcMeasureWithUnit allows the specification of both the actual figure for the value together with the currency in which the value is represented. Selecting IfcMonetaryMeasure allows the specification only of the value, the currency being as set by the global context Selecting IfcRatioMeasure assumes that the amount is a percentage or other REAL number. Note that if the amount is normally specified as -20%, then this figure will need to be converted to a multiplier of 0.8

typedef IfcUtil::IfcBaseClass IfcAxis2Placement

Definition from ISO/CD 10303-42:1992: This select type collects together both versions of the placement as used in two dimensional or in three dimensional Cartesian space. This enables entities requiring this information to reference them without specifying the space dimensionality.

NOTE: Corresponding STEP type: axis2_placement, please refer to ISO/IS 10303-42:1994, p. 19 for the final definition of the formal standard.

HISTORY: New type in IFC Release 1.5

typedef IfcUtil::IfcBaseClass IfcBooleanOperand

Definition from ISO/CD 10303-42:1992: This select type identifies all those types of entities which may participate in a Boolean operation to form a CSG solid.

Definition from IAI: CSG primitives are out of scope for the current IFC Release. Only faceted B-reps, swept area solids and half space solids are available as Boolean operands. Boolean results themselves can be used as operands thus enabling nested Boolean operations.

NOTE Corresponding STEP type: boolean_operand, please refer to ISO/IS 10303-42:1994, p.167 for the final definition of the formal standard. In IFC Release 1.5.1 & 2.0 only Boolean results (IfcBooleanResult), half space solids (IfcHalfSpaceSolid), faceted B-Rep, extruded solids and revolved solids (IfcSolidModel) are defined for being valid Boolean operands.

HISTORY: New Type in IFC Release 1.5.1

typedef IfcUtil::IfcBaseClass IfcCharacterStyleSelect

The character style select allows for a selection of character styles for text. Currently only text color and background color is selectable.

NOTE Corresponding ISO 10303 name: character_style_select. Please refer to ISO/IS 10303-46:1994, p. 89 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

IFC2x3 CHANGE The SELECT item IfcTextStyleForDefinedFont replaces the old IfcColour.

typedef IfcUtil::IfcBaseClass IfcClassificationNotationSelect
typedef IfcUtil::IfcBaseClass IfcColour

Definition from ISO/CD 10303-46:1992: The colour entity defines a basic appearance of elements which shall be visualized in a picture.

NOTE Corresponding STEP name: colour. It has been made into a SELECT type in IFC to avoid multiple inheritance for pre defined colour. Please refer to ISO/IS 10303-46:1994, p. 138 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcColourOrFactor

The IfcColourOrFactor enables the selection of either a RGB colour value or a scalar factor value for the use as values of the reflectance components.

HISTORY: New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcConditionCriterionSelect
typedef IfcUtil::IfcBaseClass IfcCsgSelect

Definition from ISO/CD 10303-42:1992: This type identifies the types of entity which may be selected as the root of a CSG tree including a single CSG primitive as a special case. Definition from IAI: The IfcBooleanResult, and subtypes of IfcCsgPrimitive3D are defined as potential root tree expression (at IfcCsgSolid). A subtype of IfcCsgPrimitive3D marks the special case of a CSG solid solely expressed by a single primitive.

NOTE Corresponding ISO 10303-42 type: csg_select, please refer to ISO/IS 10303-42:1994, p.168 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.5.1.

typedef IfcUtil::IfcBaseClass IfcCurveFontOrScaledCurveFontSelect

Definition from ISO/CD 10303-46:1992: The curve font or scaled curve font select is a selection of either a curve font style select (being either a predefined curve font or an explicitly defined curve font) or a curve style font and scaling.

NOTE Corresponding ISO 10303 name: curve_font_or_scaled_curve_font_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcCurveOrEdgeCurve

IfcCurveOrEdgeCurve provides the option to either select a geometric curve (IfcCurve and subtypes) within a geometric model, or a curve with associated geometry and coordinates (IfcEdgeCurve) within a topological model. SELECT

IfcCurve IfcEdgeCurve

HISTORY New select type in IFC2x Edition 3.

typedef IfcUtil::IfcBaseClass IfcCurveStyleFontSelect

Definition from ISO/CD 10303-46:1992: The curve style font select is a selection of a curve style font or a predefined curve style font.

NOTE Corresponding ISO 10303 name: curve_style_font_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcDateTimeSelect
typedef IfcUtil::IfcBaseClass IfcDefinedSymbolSelect

The defined symbol select is a selection between a predefined symbol and an externally defined symbol.

NOTE Corresponding ISO 10303 name: defined_symbol_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcDerivedMeasureValue

IfcDerivedMeasureValue is a select type for selecting between derived measure types.

SELECT

IfcAbsorbedDoseMeasure IfcAccelerationMeasure IfcAngularVelocityMeasure IfcCompoundPlaneAngleMeasure IfcDoseEquivalentMeasure IfcDynamicViscosityMeasure IfcElectricCapacitanceMeasure IfcElectricChargeMeasure IfcElectricConductanceMeasure IfcElectricResistanceMeasure IfcElectricVoltageMeasure IfcEnergyMeasure IfcForceMeasure IfcFrequencyMeasure IfcHeatFluxDensityMeasure IfcIlluminanceMeasure IfcInductanceMeasure IfcIntegerCountRateMeasure IfcIsothermalMoisturecapacityMeasure IfcKinematicViscosityMeasure IfcLinearForceMeasure IfcLinearMomentMeasure IfcLinearStiffnessMeasure IfcLinearVelocityMeasure IfcLuminousFluxMeasure IfcMagneticFluxDensityMeasure IfcMagneticFluxMeasure IfcMassDensityMeasure IfcMassFlowRateMeasure IfcModulusOfElasticityMeasure IfcModulusOfSubgradeReactionMeasure IfcMoistureDiffusivityMeasure IfcMolecularWeightMeasure IfcMomentOfInertiaMeasure IfcMonetaryMeasure IfcPlanarForceMeasure IfcPowerMeasure IfcPressureMeasure IfcRadioActivityMeasure IfcRotationalFrequencyMeasure IfcRotationalStiffnessMeasure IfcShearModulusMeasure IfcSpecificHeatCapacityMeasure IfcThermalAdmittanceMeasure IfcThermalConductivityMeasure IfcThermalResistanceMeasure IfcThermalTransmittanceMeasure IfcTimeStamp IfcTorqueMeasure IfcVaporPermeabilityMeasure IfcVolumetricFlowRateMeasure IfcCurvatureMeasure IfcMassPerLengthMeasure IfcRotationalMassMeasure IfcSectionalAreaIntegralMeasure IfcSectionModulusMeasure IfcTemperatureGradientMeasure IfcTemperatureRateOfChangeMeasure IfcWarpingConstantMeasure IfcWarpingMomentMeasure IfcThermalExpansionCoefficientMeasure IfcModulusOfLinearSubgradeReactionMeasure IfcModulusOfRotationalSubgradeReactionMeasure IfcLuminousIntensityDistributionMeasure IfcSoundPowerMeasure IfcSoundPressureMeasure

HISTORY New type in IFC Release 2x.

IFC2x4 change: added IfcTemperatureRateOfChangeMeasure.

typedef IfcUtil::IfcBaseClass IfcDocumentSelect

IfcDocumentSelect enables selection of whether document information is to be contained within an IFC model or is to be referenced from an external source.

HISTORY: New Select Type in IFC 2x

Select From:

IfcDocumentInformation (for “metadata” of an external document) IfcDocumentReference (for reference within a document)

typedef IfcUtil::IfcBaseClass IfcDraughtingCalloutElement
typedef IfcUtil::IfcBaseClass IfcFillAreaStyleTileShapeSelect

The fill area style tile shape select is used to make a selection for the style of the fill area style tile.

NOTE: The IfcFillAreaStyleTileShapeSelect is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: fill_area_style_tile_shape_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcFillStyleSelect

Definition from ISO/CD 10303-46:1992: The fill style select is a selection between different fill area styles.

NOTE Corresponding ISO 10303 name: fill_style_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcGeometricSetSelect

Definition from ISO/CD 10303-42:1992: This select type identifies the types of entities which can occur in a geometric set.

NOTE: Corresponding ISO 10303 type: geometric_set_select. Please refer to ISO/IS 10303-42:1994, p. 169 for the final definition of the formal standard.

HISTORY: New type in IFC Release 2x.

typedef IfcUtil::IfcBaseClass IfcHatchLineDistanceSelect

The IfcHatchLineDistanceSelect is a selection between different ways to determine the distance and potentially start point of hatch lines, either by an offset distance length measure or by a vector.

HISTORY New type in IFC2x3.

typedef IfcUtil::IfcBaseClass IfcLayeredItem

Definition from ISO/CD 10303-46:1992: The layered things type selects those things, which can be grouped in layers.

It is the collection of all those items, that are assigned to a single layer. These items are representation items or complete representations (IfcRepresentationItem, IfcRepresentation). If an IfcRepresentation is referenced, all IfcRepresentationItem within its set of Items are assigned to the same layer.

NOTE: Corresponding ISO 10303 name: layered_item. It was called layered_things in the ISO/CD version and had been renamed to layered_item in the ISO/IS final version. Please refer to ISO/IS 10303-46:1994, p. 13 for the final definition of the formal standard.

HISTORY: New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcLibrarySelect

IfcLibrarySelect enables selection of whether library information is to be contained within an IFC model or is to be referenced from an external source.

HISTORY: New Select Type in IFC2x

Select From:

IfcLibraryInformation (for library information) IfcLibraryReference (for reference into a library of information by location)

Generally, it is expected that selection will be IfcLibraryReference and only rarely IfcLibraryInformation. IfcLibraryInformation should only be selected in circumstances where there could be a need to indicate the libraries that will be used without making individual references. This may occur for higher level objects such as a project or building.

typedef IfcUtil::IfcBaseClass IfcLightDistributionDataSourceSelect

A goniometric light gets its intensity distribution function (how much light goes in any one direction) from one of two sources: (i) an industry-standard file, (ii) from distribution data passed directly via the IfcLightIntensityDistribution.

The light distribution provides the luminous intensity distribution according to some standardized light distribution curves.

Select:

Type Definition

IfcExternalReference Light distribution is represented by a standard photometric data file such as Eulumdat, IES, CIBSE TM14.

IfcLightIntensityDistribution For representing a light distribution directly the following values needs to be given in a table like structure with column and row headings. These headings should contain the angles (C/γ or B/β ) and the table body contains the intensity values, (normally normalized to cd/Klm). The angles can be non- equidistant and the angle steps can be almost any value in the valid range, so a list of all available angles in both directions covers all cases.

HISTORY New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcMaterialSelect

IfcMaterialSelect provides selection of either a material definition or a material usage definition that can be assigned to an element, a resource or another entity within IFC. SELECT

IfcMaterialDefinition

IfcMaterial IfcMaterialLayer IfcMaterialLayerSet IfcMaterialProfile IfcMaterialProfileSet IfcMaterialConstituent IfcMaterialConstituentSet

IfcMaterialUsageDefinition

IfcMaterialLayerSetUsage IfcMaterialProfileSetUsage

IfcMaterialList

HISTORY New select in IFC 1.0

IFC2x4 CHANGE The select now includes two new abstract entities IfcMaterialDefinition and IfcMaterialUsageDefinition with upward compatibility. The use of IfcMaterialList is deprecated from IFC2x4 onwards.

typedef IfcUtil::IfcBaseClass IfcMeasureValue

Definition from ISO/CD 10303-41:1992: A measure value is a value as defined in ISO 31-0 (clause 2).

NOTE IfcMeasureValue is a select data type for most basic measure types coming from ISO 10303-41. Select item IfcNonNegativeLengthMeasure is in addition to ISO 10303-41.

NOTE Corresponding ISO 10303 name: measure_value, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

IFC 2x4 change: added IfcNonNegativeLengthMeasure

typedef IfcUtil::IfcBaseClass IfcMetricValueSelect

IfcMetricValueSelect is a select type that enables selection of the data type for the value component of an IfcMetric.

HISTORY: New type in IFC Release 2.0

Select

IfcCostValue IfcDateTime IfcMeasureWithUnit IfcTable IfcText IfcTimeSeries

typedef IfcUtil::IfcBaseClass IfcObjectReferenceSelect

IfcObjectReferenceSelect is a select type, that holds a list of resource level entities that can be used as properties within a property set.

HISTORY New select type in IFC Release 2.0.

typedef IfcUtil::IfcBaseClass IfcOrientationSelect
typedef IfcUtil::IfcBaseClass IfcPointOrVertexPoint

IfcPointOrVertexPointprovides the option to either select a geometric point (IfcPoint and subtypes) within a geometric model, or a vertex with associated point coordinates (IfcVertexPoint) within a topological model. SELECT

IfcPoint, IfcVertexPoint

HISTORY New select type in IFC2x Edition 3.

typedef IfcUtil::IfcBaseClass IfcPresentationStyleSelect

Definition from ISO/CD 10303-46:1992: The presentation style select is a selection of one of many kinds of styles, a different one for each kind of geometric representation item to be styled.

NOTE Corresponding ISO 10303 name: presentation_style_Select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

IFC2x4 CHANGE The select type has been deprecated.

typedef IfcUtil::IfcBaseClass IfcShell

Definition from ISO/CD 10303-42:1992 This type collects together, for reference when constructing more complex models, the subtypes which have the characteristics of a shell. A shell is a connected object of fixed dimensionality d = 0; 1; or 2, typically used to bound a region. The domain of a shell, if present, includes its bounds and 0 £ X < ¥.

A shell of dimensionality 0 is represented by a graph consisting of a single vertex. The vertex shall not have any associated edges. A shell of dimensionality 1 is represented by a connected graph of dimensionality 1. A shell of dimensionality 2 is a topological entity constructed by joining faces along edges. Its domain, if present, is a connected, orientable 2-manifold with boundary, that is, a connected, oriented, finite, non-self-intersecting surface, which may be closed or open.

Shells of dimensionality 0 and 1 are not part of the current IFC release.

NOTE Corresponding ISO 10303 type: shell. Please refer to ISO/IS 10303-42:1994, p. 127 for the final definition of the formal standard. Only the select items closed_shell (IfcClosedShell) and open_shell (IfcOpenShell) have been incorporated in the current IFC release.

HISTORY New type in IFC2x.

typedef IfcUtil::IfcBaseClass IfcSimpleValue

IfcSimpleValue is a select type for selecting between simple value types.

SELECT

IfcInteger: Defined type of simple type INTEGER. IfcReal: Defined type of simple type REAL. IfcBoolean: Defined type of simple type BOOLEAN. IfcLogical: Defined type of simple type LOGICAL. IfcIdentifier: Defined type of simple type STRING for identification purposes. IfcLabel: Defined type of simple type STRING for naming purposes. IfcText: Defined type of simple type STRING for descriptive purposes. IfcDateTime: Defined type of simple type STRING to represent a date and time. IfcDate: Defined type of simple type STRING to represent a date. IfcTime: Defined type of simple type STRING to represent a time. IfcDuration: Defined type of simple type STRING to represent a duration.

HISTORY New type in IFC Release 2x.

IFC2x4 CHANGE Items IfcDateTime, IfcDate, IfcTime, IfcDuration added.

typedef IfcUtil::IfcBaseClass IfcSizeSelect

Definition from ISO/CD 10303-46:1992: The size select is a selection of a specific positive length measure.

Definition from ISO: The size (or width) measure value is given in the global drawing length units.

NOTE global units are defined at the single IfcProject instance, given by UnitsInContext:IfcUnitAssignment, the same units are used for the geometric representation items and for the style definitions.

NOTE Corresponding ISO 10303 name: size_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

IFC2x3 CHANGE The SELECT item IfcMeasureWithUnit has been removed from the IfcSizeSelect, the IfcRatioMeasure and IfcDescriptiveMeasure has been added.

typedef IfcUtil::IfcBaseClass IfcSpecularHighlightSelect

The IfcSpecularHighlightSelect defines the selectable types of value for specular highlight sharpness.

NOTE: The two select types relate to the different ways to specifiy the sharpness (or shininess) of the specular part of the reflectance equation. It relates to the attributes:

in ISO10303-46 the attribute specular_exponent is given in VRML97 the attribute shininess is given

For each surface side style only one of the two methods is needed for calculating the specular part of the equation.

HISTORY: New type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcStructuralActivityAssignmentSelect

Definition from IAI: This type definition shall be used to distinguish between a reference to an instance either of IfcStructuralItem or IfcBuildingElement. The IfcStructuralActivityAssignmentSelect type is referenced by the entity IfcRelConnectsStructuralActivity which defines the connection between activities (IfcStructuralActivity) and the loaded element.

HISTORY: New type in Release IFC2x Edition 2.

typedef IfcUtil::IfcBaseClass IfcSurfaceOrFaceSurface

IfcSurfaceOrFaceSurface provides the option to either select a geometric surface (IfcSurface and subtypes) within a geometric model, or a face with associated surface geometry and coordinates (IfcFaceSurface) within a topological model. SELECT

IfcSurface IfcFaceSurface IfcFaceBasedSurfaceModel (a connected face set, representing a faceted surface as an approximation of a non planar, non rectangular bounded surface)

HISTORY New select type in IFC2x3.

typedef IfcUtil::IfcBaseClass IfcSurfaceStyleElementSelect

Definition from ISO/CD 10303-46:1992: The surface style element select is a selection of the different surface styles to use in the presentation of the side of a surface.

The select type only includes the IfcSurfaceStyleRendering (which is the equivalent to surface_style_rendering) from the select type surface_style_element_select. In addition it has the IfcSurfaceStyleLighting, which holds the exact physically based lighting properties for lighting based calculation algorithms (as the opposite to the rendering based calculation), the IfcSurfaceStyleRefraction (for more advanced refraction indices) and IfcSurfaceStyleWithTextures (to allow for image textures applied to surfaces). In addition an IfcExternallyDefinedSurfaceStyle can be selected that points into an external material library.

NOTE The IfcSurfaceLightingProperties are needed for exact lighting calculation, because physically based lighting calculation algorithms need exact physically based parameters. The factors in IfcSurfaceStyleRendering lack the physical base, they are intended for rendering calculations, but a lighting calculation based software cannot use these values.

NOTE: Corresponding ISO 10303 type: surface_style_element_select. Please refer to ISO/IS 10303-46:1994, p. 85 for the final definition of the formal standard.

HISTORY: New Select type in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcSymbolStyleSelect

The symbol style select allows for the selection of styles to be assigned to an annotated symbol.

NOTE: The selection is restricted to colour within the current release of IFC

NOTE Corresponding ISO 10303 name: symbol_style_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

typedef IfcUtil::IfcBaseClass IfcTextFontSelect

IfcTextFontSelect allows for either a predefined text font, a text font model or an externally defined text font to be used to describe the font of a text literal. The definition of the text font model is based on W3C TR Cascading Style Sheet Version 1, whereas the definition of predefined text font is based on ISO 10303.

NOTE IfcTextFontSelect is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation. Corresponding ISO 10303 name: font_select. Please refer to ISO/IS 10303-46:1994, p. 133 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

IFC2x3 CHANGE The select type has been renamed from IfcFontSelect.

typedef IfcUtil::IfcBaseClass IfcTextStyleSelect

The text style select allows for the selection of styles to be assigned to an annotated text. The text style determines the text model that affect the visual presentation of characters, spaces, words, and paragraphs. There are two choices:

IfcTextStyleWithBoxCharacteristics for definitions from ISO/IS 10303-46:1994 for (old) vector based and monospace text. IfcTextStyleTextModel for definitions from Cascading Style Sheets, level 1, W3C Recommendation 17 Dec 1996, revised 11 Jan 1999, CSS1, for all true type text. The use of the CSS1 definitions is the preferred way to represent text styles.

HISTORY New type in IFC2x2.

IFC2x3 CHANGE The items within the IfcTextStyleSelect have changed to IfcTextStyleWithBoxCharacteristics and IfcTextStyleTextModel.

typedef IfcUtil::IfcBaseClass IfcTrimmingSelect

Definition from ISO/CD 10303-42:1992: This select type identifies the two possible ways of trimming a parametric curve; by a Cartesian point on the curve, or by a REAL number defining a parameter value within the parametric range of the curve.

NOTE Corresponding ISO 10303 type: trimming_select, please refer to ISO/IS 10303-42:1994, p. 20 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.0

typedef IfcUtil::IfcBaseClass IfcUnit

Definition from ISO/CD 10303-41:1992: A unit is a physical quantity, with a value of one, which is used as a standard in terms of which other quantities are expressed.

NOTE: Select item IfcMonetaryUnit is an addition to ISO 10303-41.

NOTE: Corresponding ISO 10303 name: unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

SELECT

IfcNamedUnit: A unit which is identified by a name. IfcDerivedUnit: A unit which is derived from an expression of units. IfcMonetaryUnit: A unit for defining currencies.

HISTORY: New type in IFC Release 1.5.1.

typedef IfcUtil::IfcBaseClass IfcValue

IfcValue is a select type for selecting between more specialised select types IfcSimpleValue, IfcMeasureValue and IfcDerivedMeasureValue.

SELECT

IfcSimpleValue A select type for basic defined types of simple data type. IfcMeasureValue A select type for basic measure types of ISO 10303-41. IfcDerivedMeasureValue A select type for derived measure types.

HISTORY New type in IFC Release 2x.

typedef IfcUtil::IfcBaseClass IfcVectorOrDirection

Definition from ISO/CD 10303-42:1992: This type is used to identify the types of entity which can participate in vector computations.

NOTE Corresponding STEP type: vector_or_direction, please refer to ISO/IS 10303-42:1994, p. 20 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.5

Public Static Functions

const IfcParse::schema_definition &get_schema()

Public Static Attributes

const char *const Identifier
class Ifc2DCompositeCurve : public Ifc2x3::IfcCompositeCurve

Public Types

typedef IfcTemplatedEntityList<Ifc2DCompositeCurve> list

Public Functions

const IfcParse::entity &declaration() const
Ifc2DCompositeCurve(IfcEntityInstanceData *e)
Ifc2DCompositeCurve(IfcTemplatedEntityList<::Ifc2x3::IfcCompositeCurveSegment>::ptr v1_Segments, bool v2_SelfIntersect)

Public Static Functions

const IfcParse::entity &Class()
class IfcAbsorbedDoseMeasure : public IfcUtil::IfcBaseType

IfcAbsorbedDoseMeasure is a measure of the absorbed radioactivity dose. Usually measured in Gray (Gy, J/kg). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcAbsorbedDoseMeasure(IfcEntityInstanceData *e)
IfcAbsorbedDoseMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcAccelerationMeasure : public IfcUtil::IfcBaseType

IfcAccelerationMeasure is a measure of acceleration. Usually measured in m/s2. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcAccelerationMeasure(IfcEntityInstanceData *e)
IfcAccelerationMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcActionRequest : public Ifc2x3::IfcControl

A request is the act or instance of asking for something, such as a request for information, bid submission, or performance of work.

Requests may take many forms depending on the need including fault reports for maintenance, requests for small works, and purchase requests (where these are to be made through a help desk or buying function).

HISTORY: New entity in IFC2x2 IFC2x4 CHANGE RequestID renamed to Identification and promoted to supertype IfcControl, attributes PredefinedType, Status, and LongDescription added.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Refer to the documentation at the supertype IfcControl and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ActionRequest

Declaration Use Definition The IfcActionRequest may be declared within the project using the IfcRelDeclares relationship where RelatingContext refers to the single IfcProject and RelatedDefinitions contains the IfcActionRequest. Alternatively, if the IfcActionRequest is aggregated within an IfcWorkPlan, then it shall not have a direct declaration relationship (whereas the containing work plan may have a declaration relationship).

Composition Use Definition As shown in Figure 155, an IfcActionRequest may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcActionRequest and RelatedObjects contains one or more components. Aggregation use is defined for the following predefined types:

(All Types): May contain IfcCostSchedule components. A cost schedule may indicate costs and quantities where the cost schedule type may designate whether rates and/or quantities are estimated or final. Such cost schedule may have assigned cost items indicating detail, where each cost item may have assigned products, processes, or resources.

The IfcActionRequest may be nested into sub-items using IfcRelNests where RelatingObject refers to the enclosing IfcActionRequest and RelatedObjects contains one or more sub-items. Nesting use is defined for the following predefined types:

(All Types): May contain IfcActionRequest sub-items. A request may be nested into follow-up requests, in order of issue.

Figure 155 — Action request composition

Assignment Use Definition As shown in Figure 156, an IfcActionRequest may be assigned to the following entities using relationships as indicated:

IfcActor (IfcRelAssignsToActor): Person or organization issuing the request such as a tenant or owner.

The IfcActionRequest may have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcActionRequest and RelatedObjects contains one or more objects of the following types: IfcActor: Person or organization(s) fulfilling the request such as a facilities manager or contractor.

Figure 156 — Action request assignment

Approval Use Definition Approvals may be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcActionRequest. Approvals may be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.

Public Types

typedef IfcTemplatedEntityList<IfcActionRequest> list

Public Functions

std::string RequestID() const
void setRequestID(std::string v)
const IfcParse::entity &declaration() const
IfcActionRequest(IfcEntityInstanceData *e)
IfcActionRequest(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_RequestID)

Public Static Functions

const IfcParse::entity &Class()
struct IfcActionSourceTypeEnum

Public Types

enum Value

Definition from IAI:This enumeration type contains possible action sources.

HISTORY: New type in Release IFC2x Edition 2.

Values:

enumerator IfcActionSourceType_DEAD_LOAD_G
enumerator IfcActionSourceType_COMPLETION_G1
enumerator IfcActionSourceType_LIVE_LOAD_Q
enumerator IfcActionSourceType_SNOW_S
enumerator IfcActionSourceType_WIND_W
enumerator IfcActionSourceType_PRESTRESSING_P
enumerator IfcActionSourceType_SETTLEMENT_U
enumerator IfcActionSourceType_TEMPERATURE_T
enumerator IfcActionSourceType_EARTHQUAKE_E
enumerator IfcActionSourceType_FIRE
enumerator IfcActionSourceType_IMPULSE
enumerator IfcActionSourceType_IMPACT
enumerator IfcActionSourceType_TRANSPORT
enumerator IfcActionSourceType_ERECTION
enumerator IfcActionSourceType_PROPPING
enumerator IfcActionSourceType_SYSTEM_IMPERFECTION
enumerator IfcActionSourceType_SHRINKAGE
enumerator IfcActionSourceType_CREEP
enumerator IfcActionSourceType_LACK_OF_FIT
enumerator IfcActionSourceType_BUOYANCY
enumerator IfcActionSourceType_ICE
enumerator IfcActionSourceType_CURRENT
enumerator IfcActionSourceType_WAVE
enumerator IfcActionSourceType_RAIN
enumerator IfcActionSourceType_BRAKES
enumerator IfcActionSourceType_USERDEFINED
enumerator IfcActionSourceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcActionTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration type is used to distinguish between possible action types at a high level. It can be used for an automated definition of load combinations and for dimensioning. The contained items and their acronyms are adopted from the Eurocode standard.

HISTORY: New type in Release IFC2x Edition 2.

Values:

enumerator IfcActionType_PERMANENT_G
enumerator IfcActionType_VARIABLE_Q
enumerator IfcActionType_EXTRAORDINARY_A
enumerator IfcActionType_USERDEFINED
enumerator IfcActionType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcActor : public Ifc2x3::IfcObject

The IfcActor defines all actors or human agents involved in a project during its full life cycle. It facilitates the use of person and organization definitions in the resource part of the IFC object model. This includes name, address, telecommunication addresses, and roles.

HISTORY New Entity in IFC Release 2.0

Relationship use definition Actors are assigned (such as to a process or a resource) by the relationship object that refers to the corresponding object:

Process: assigned using IfcRelAssignsToProcess Resource: assigned using IfcRelAssignsToResource

Property set use definition The property sets relating to the IfcActor are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to IfcActor are part of this IFC release:

Pset_ActorCommon: common property set for all actor occurrences

Subclassed by Ifc2x3::IfcOccupant

Public Types

typedef IfcTemplatedEntityList<IfcActor> list

Public Functions

::Ifc2x3::IfcActorSelect *TheActor() const

Information about the actor.

void setTheActor(::Ifc2x3::IfcActorSelect *v)
IfcTemplatedEntityList<IfcRelAssignsToActor>::ptr IsActingUpon() const
const IfcParse::entity &declaration() const
IfcActor(IfcEntityInstanceData *e)
IfcActor(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcActorSelect *v6_TheActor)

Public Static Functions

const IfcParse::entity &Class()
class IfcActorRole : public IfcUtil::IfcBaseEntity

Definition: A role which is performed by an actor, either a person, an organization or a person related to an organization.

NOTE: The list of roles of the enumeration values of the Role attribute can never be complete. Therefore using enumeration value USERDEFINED, the user can provide his/her own role as a value of the attribute UserDefinedRole.

Corresponds to the following entity in ISO-10303-41: organization_role and person_role.

HISTORY New entity in IFC Release 1.5.1

Public Types

typedef IfcTemplatedEntityList<IfcActorRole> list

Public Functions

::Ifc2x3::IfcRoleEnum::Value Role() const

The name of the role played by an actor. If the Role has value USERDEFINED, then the user defined role shall be provided as a value of the attribute UserDefinedRole.

void setRole(::Ifc2x3::IfcRoleEnum::Value v)
bool hasUserDefinedRole() const

Whether the optional attribute UserDefinedRole is defined for this IfcActorRole.

std::string UserDefinedRole() const

Allows for specification of user defined roles beyond the enumeration values provided by Role attribute of type IfcRoleEnum. When a value is provided for attribute UserDefinedRole in parallel the attribute Role shall have enumeration value USERDEFINED.

void setUserDefinedRole(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcActorRole.

std::string Description() const

A textual description relating the nature of the role played by an actor.

void setDescription(std::string v)
const IfcParse::entity &declaration() const
IfcActorRole(IfcEntityInstanceData *e)
IfcActorRole(::Ifc2x3::IfcRoleEnum::Value v1_Role, boost::optional<std::string> v2_UserDefinedRole, boost::optional<std::string> v3_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcActuatorType : public Ifc2x3::IfcDistributionControlElementType

The distribution control element type IfcActuatorType defines commonly shared information for occurrences of actuators. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a actuator specification (i.e. the specific product information, that is common to all occurrences of that product type). Actuator types may be exchanged without being already assigned to occurrences. Occurrences of IfcActuatorType are represented by instances of IfcActuator.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionControlElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ActuatorTypeCommon Pset_ActuatorTypeElectricActuator (ELECTRICACTUATOR) Pset_ActuatorTypeHydraulicActuator (HYDRAULICACTUATOR) Pset_ActuatorTypeLinearActuation Pset_ActuatorTypePneumaticActuator (PNEUMATICACTUATOR) Pset_ActuatorTypeRotationalActuation

Material Use Definition The material of the IfcActuatorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcActuatorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcActuator for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcActuatorType> list

Public Functions

::Ifc2x3::IfcActuatorTypeEnum::Value PredefinedType() const

Identifies the predefined types of actuator from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcActuatorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcActuatorType(IfcEntityInstanceData *e)
IfcActuatorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcActuatorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcActuatorTypeEnum

Public Types

enum Value

The IfcActuatorTypeEnum defines the range of different types of actuator that can be specified.

HISTORY: New type in IFC R2.0

Enumeration

ELECTRICACTUATOR: A device that electrically actuates a control element.

PNEUMATICACTUATOR<: A device that pneumatically actuates a control element

HYDRAULICACTUATOR: A device that electrically actuates a control element.

HANDOPERATEDACTUATOR: A device that manually actuates a control element. THERMOSTATICACTUATOR: A device that thermostatically actuates a control element. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

See property set of actuator common attributes for specification of properties for hand operated actuators.

Values:

enumerator IfcActuatorType_ELECTRICACTUATOR
enumerator IfcActuatorType_HANDOPERATEDACTUATOR
enumerator IfcActuatorType_HYDRAULICACTUATOR
enumerator IfcActuatorType_PNEUMATICACTUATOR
enumerator IfcActuatorType_THERMOSTATICACTUATOR
enumerator IfcActuatorType_USERDEFINED
enumerator IfcActuatorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAddress : public IfcUtil::IfcBaseEntity

Definition: An abstract entity type for various kinds of postal and telecom addresses.

NOTE Corresponds to the following entity in ISO-10303-41: address.

HISTORY New entity in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcPostalAddress, Ifc2x3::IfcTelecomAddress

Public Types

typedef IfcTemplatedEntityList<IfcAddress> list

Public Functions

bool hasPurpose() const

Whether the optional attribute Purpose is defined for this IfcAddress.

::Ifc2x3::IfcAddressTypeEnum::Value Purpose() const

Identifies the logical location of the address.

void setPurpose(::Ifc2x3::IfcAddressTypeEnum::Value v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcAddress.

std::string Description() const

Text that relates the nature of the address.

void setDescription(std::string v)
bool hasUserDefinedPurpose() const

Whether the optional attribute UserDefinedPurpose is defined for this IfcAddress.

std::string UserDefinedPurpose() const

Allows for specification of user specific purpose of the address beyond the enumeration values provided by Purpose attribute of type IfcAddressTypeEnum. When a value is provided for attribute UserDefinedPurpose, in parallel the attribute Purpose shall have enumeration value USERDEFINED.

void setUserDefinedPurpose(std::string v)
IfcTemplatedEntityList<IfcPerson>::ptr OfPerson() const
IfcTemplatedEntityList<IfcOrganization>::ptr OfOrganization() const
const IfcParse::entity &declaration() const
IfcAddress(IfcEntityInstanceData *e)
IfcAddress(boost::optional<::Ifc2x3::IfcAddressTypeEnum::Value> v1_Purpose, boost::optional<std::string> v2_Description, boost::optional<std::string> v3_UserDefinedPurpose)

Public Static Functions

const IfcParse::entity &Class()
struct IfcAddressTypeEnum

Public Types

enum Value

Definition from IAI: Identifies the logical location of the address.

HISTORY New type in IFC Release 2x.

ENUMERATION

OFFICE An office address. SITE A site address. HOME A home address. DISTRIBUTIONPOINT A postal distribution point address. USERDEFINED A user defined address type to be provided.

Values:

enumerator IfcAddressType_OFFICE
enumerator IfcAddressType_SITE
enumerator IfcAddressType_HOME
enumerator IfcAddressType_DISTRIBUTIONPOINT
enumerator IfcAddressType_USERDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcAheadOrBehind

Public Types

enum Value

Values:

enumerator IfcAheadOrBehind_AHEAD
enumerator IfcAheadOrBehind_BEHIND

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAirTerminalBoxType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcAirTerminalBoxType defines commonly shared information for occurrences of air boxes. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a air box specification (i.e. the specific product information, that is common to all occurrences of that product type). Air Box types may be exchanged without being already assigned to occurrences. Occurrences of IfcAirTerminalBoxType are represented by instances of IfcAirTerminalBox.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_AirTerminalBoxTypeCommon

Material Use Definition The material of the IfcAirTerminalBoxType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcAirTerminalBoxType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcAirTerminalBox for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcAirTerminalBoxType> list

Public Functions

::Ifc2x3::IfcAirTerminalBoxTypeEnum::Value PredefinedType() const

The air terminal box type.

void setPredefinedType(::Ifc2x3::IfcAirTerminalBoxTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcAirTerminalBoxType(IfcEntityInstanceData *e)
IfcAirTerminalBoxType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcAirTerminalBoxTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcAirTerminalBoxTypeEnum

Public Types

enum Value

This enumeration identifies different types of air terminal boxes.

Valid enumerations are:

CONSTANTFLOW: Terminal box does not include a means to reset the volume automatically to an outside signal such as thermostat. VARIABLEFLOWPRESSUREDEPENDANT: terminal box includes a means to reset the volume automatically to a different control point in response to an outside signal such as thermostat: air-flow rate depends on supply pressure. VARIABLEFLOWPRESSUREINDEPENDANT: terminal box includes a means to reset the volume automatically to a different control point in response to an outside signal such as thermostat: air-flow rate is independant of supply pressure. USERDEFINED: User-defined terminal box. NOTDEFINED: Undefined terminal box.

HISTORY: New enumeration in IFC R2.0

Values:

enumerator IfcAirTerminalBoxType_CONSTANTFLOW
enumerator IfcAirTerminalBoxType_VARIABLEFLOWPRESSUREDEPENDANT
enumerator IfcAirTerminalBoxType_VARIABLEFLOWPRESSUREINDEPENDANT
enumerator IfcAirTerminalBoxType_USERDEFINED
enumerator IfcAirTerminalBoxType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAirTerminalType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcAirTerminalType defines commonly shared information for occurrences of air terminals. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a air terminal specification (i.e. the specific product information, that is common to all occurrences of that product type). Air Terminal types may be exchanged without being already assigned to occurrences. Occurrences of IfcAirTerminalType are represented by instances of IfcAirTerminal.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_AirTerminalTypeCommon

Material Use Definition The material of the IfcAirTerminalType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcAirTerminalType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcAirTerminal for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcAirTerminalType> list

Public Functions

::Ifc2x3::IfcAirTerminalTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcAirTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcAirTerminalType(IfcEntityInstanceData *e)
IfcAirTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcAirTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcAirTerminalTypeEnum

Public Types

enum Value

Enumeration defining the functional types of air terminals. The IfcAirTerminalTypeEnum contains the following:

GRILLE: A covering for any area through which air passes. REGISTER: A grille typically equipped with a damper or control valve. DIFFUSER: An outlet discharging supply air in various directions and planes. LOUVRE: A rectilinear louvre. USERDEFINED: User-defined air terminal type. NOTDEFINED: Undefined air terminal type.

NOTE: Architectural louvres within doors or windows are defined by IfcPermeableCoveringProperties.

HISTORY: New enumeration in IFC R2x2. Modified in IFC R2x4 to add LOUVRE and remove EYEBALL, IRIS, LINEARGRILLE, LINEARDIFFUSER

Values:

enumerator IfcAirTerminalType_GRILLE
enumerator IfcAirTerminalType_REGISTER
enumerator IfcAirTerminalType_DIFFUSER
enumerator IfcAirTerminalType_EYEBALL
enumerator IfcAirTerminalType_IRIS
enumerator IfcAirTerminalType_LINEARGRILLE
enumerator IfcAirTerminalType_LINEARDIFFUSER
enumerator IfcAirTerminalType_USERDEFINED
enumerator IfcAirTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAirToAirHeatRecoveryType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcAirToAirHeatRecoveryType defines commonly shared information for occurrences of air-to-air heat recovery devices. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a air-to-air heat recovery device specification (i.e. the specific product information, that is common to all occurrences of that product type). Air-To-Air Heat Recovery Device types may be exchanged without being already assigned to occurrences. Occurrences of IfcAirToAirHeatRecoveryType are represented by instances of IfcAirToAirHeatRecovery.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_AirToAirHeatRecoveryTypeCommon

Material Use Definition The material of the IfcAirToAirHeatRecoveryType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Media’: The primary media material used for heat transfer.

Port Use Definition The distribution ports relating to the IfcAirToAirHeatRecoveryType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcAirToAirHeatRecovery for standard port definitions.

Public Functions

::Ifc2x3::IfcAirToAirHeatRecoveryTypeEnum::Value PredefinedType() const

Defines the type of air to air heat recovery device.

void setPredefinedType(::Ifc2x3::IfcAirToAirHeatRecoveryTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcAirToAirHeatRecoveryType(IfcEntityInstanceData *e)
IfcAirToAirHeatRecoveryType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcAirToAirHeatRecoveryTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcAirToAirHeatRecoveryTypeEnum

Public Types

enum Value

Defines general types of pumps. The IfcPumpTypeEnum contains the following:

FIXEDPLATECOUNTERFLOWEXCHANGER: Heat exchanger with moving parts and alternate layers of plates, separated and sealed from the exhaust and supply air stream passages with primary air enters at secondary air outlet location and exits at secondary air inlet location. FIXEDPLATECROSSFLOWEXCHANGER: Heat exchanger with moving parts and alternate layers of plates, separated and sealed from the exhaust and supply air stream passages with secondary air flow in the direction perpendicular to primary air flow. FIXEDPLATEPARALLELFLOWEXCHANGER: Heat exchanger with moving parts and alternate layers of plates, separated and sealed from the exhaust and supply air stream passages with primary air enters at secondary air inlet location and exits at secondary air outlet location. ROTARYWHEEL: A heat wheel with a revolving cylinder filled with an air-permeable medium having a large internal surface area. RUNAROUNDCOILLOOP: A typical coil energy recovery loop places extended surface, finned tube water coils in the supply and exhaust airstreams of a building. HEATPIPE: A passive energy recovery device with a heat pipe divided into evaporator and condenser sections. TWINTOWERENTHALPYRECOVERYLOOPS: An air-to-liquid, liquid-to-air enthalpy recovery system with a sorbent liquid circulates continuously between supply and exhaust airstreams, alternately contacting both airstreams directly in contactor towers. THERMOSIPHONSEALEDTUBEHEATEXCHANGERS: Sealed systems that consist of an evaporator, a condenser, interconnecting piping, and an intermediate working fluid that is present in both liquid and vapor phases where the evaporator and the condenser are usually at opposite ends of a bundle of straight, individual thermosiphon tubes and the exhaust and supply ducts are adjacent to each other. THERMOSIPHONCOILTYPEHEATEXCHANGERS: Sealed systems that consist of an evaporator, a condenser, interconnecting piping, and an intermediate working fluid that is present in both liquid and vapor phases where the evaporator and condensor coils are installed independently in the ducts and are interconnected by the working fluid piping. USERDEFINED: User-defined air to air heat recovery type. NOTDEFINED: Undefined air to air heat recovery type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcAirToAirHeatRecoveryType_FIXEDPLATECOUNTERFLOWEXCHANGER
enumerator IfcAirToAirHeatRecoveryType_FIXEDPLATECROSSFLOWEXCHANGER
enumerator IfcAirToAirHeatRecoveryType_FIXEDPLATEPARALLELFLOWEXCHANGER
enumerator IfcAirToAirHeatRecoveryType_ROTARYWHEEL
enumerator IfcAirToAirHeatRecoveryType_RUNAROUNDCOILLOOP
enumerator IfcAirToAirHeatRecoveryType_HEATPIPE
enumerator IfcAirToAirHeatRecoveryType_TWINTOWERENTHALPYRECOVERYLOOPS
enumerator IfcAirToAirHeatRecoveryType_THERMOSIPHONSEALEDTUBEHEATEXCHANGERS
enumerator IfcAirToAirHeatRecoveryType_THERMOSIPHONCOILTYPEHEATEXCHANGERS
enumerator IfcAirToAirHeatRecoveryType_USERDEFINED
enumerator IfcAirToAirHeatRecoveryType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAlarmType : public Ifc2x3::IfcDistributionControlElementType

The distribution control element type IfcAlarmType defines commonly shared information for occurrences of alarms. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a alarm specification (i.e. the specific product information, that is common to all occurrences of that product type). Alarm types may be exchanged without being already assigned to occurrences. Occurrences of IfcAlarmType are represented by instances of IfcAlarm.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionControlElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_AlarmTypeCommon

Material Use Definition The material of the IfcAlarmType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcAlarmType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcAlarm for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcAlarmType> list

Public Functions

::Ifc2x3::IfcAlarmTypeEnum::Value PredefinedType() const

Identifies the predefined types of alarm from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcAlarmTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcAlarmType(IfcEntityInstanceData *e)
IfcAlarmType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcAlarmTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcAlarmTypeEnum

Public Types

enum Value

The IfcAlarmTypeEnum defines the range of different types of alarm that can be specified.

HISTORY: New type in IFC 2x2

Enumeration

BELL: An audible alarm. BREAKGLASSBUTTON: An alarm activation mechanism in which a protective glass has to be broken to enable a button to be pressed. LIGHT: A visual alarm. MANUALPULLBOX: An alarm activation mechanism in which activation is achieved by a pulling action. SIREN: An audible alarm. WHISTLE: An audible alarm.

USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcAlarmType_BELL
enumerator IfcAlarmType_BREAKGLASSBUTTON
enumerator IfcAlarmType_LIGHT
enumerator IfcAlarmType_MANUALPULLBOX
enumerator IfcAlarmType_SIREN
enumerator IfcAlarmType_WHISTLE
enumerator IfcAlarmType_USERDEFINED
enumerator IfcAlarmType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAmountOfSubstanceMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: An amount of substance measure is the value for the quantity of a substance when compared with the number of atoms in 0.012kilogram of carbon 12.

Usually measure in mole (mol). Type: REAL

NOTE Corresponding ISO 10303 name: amount_of_substance_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcAmountOfSubstanceMeasure(IfcEntityInstanceData *e)
IfcAmountOfSubstanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcAnalysisModelTypeEnum

Public Types

enum Value

Definition from IAI: This type definition is used to distinguish between different types of structural analysis models. The analysis models are differentiated by their dimensionality.

HISTORY: New type in Release IFC2x Edition 2.

Values:

enumerator IfcAnalysisModelType_IN_PLANE_LOADING_2D
enumerator IfcAnalysisModelType_OUT_PLANE_LOADING_2D
enumerator IfcAnalysisModelType_LOADING_3D
enumerator IfcAnalysisModelType_USERDEFINED
enumerator IfcAnalysisModelType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcAnalysisTheoryTypeEnum

Public Types

enum Value

Definition from IAI: This type definition is used to distinguish between different types of structural analysis methods, i.e. first order theory, second order theory (small deformations), third order theory (large deformations) and the full nonlinear theory (geometric nonlinearity together with other nonlinearities, e.g. plasticity).

HISTORY: New type in Release IFC2x Edition 2.

Values:

enumerator IfcAnalysisTheoryType_FIRST_ORDER_THEORY
enumerator IfcAnalysisTheoryType_SECOND_ORDER_THEORY
enumerator IfcAnalysisTheoryType_THIRD_ORDER_THEORY
enumerator IfcAnalysisTheoryType_FULL_NONLINEAR_THEORY
enumerator IfcAnalysisTheoryType_USERDEFINED
enumerator IfcAnalysisTheoryType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAngularDimension : public Ifc2x3::IfcDimensionCurveDirectedCallout

Public Types

typedef IfcTemplatedEntityList<IfcAngularDimension> list

Public Functions

const IfcParse::entity &declaration() const
IfcAngularDimension(IfcEntityInstanceData *e)
IfcAngularDimension(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcAngularVelocityMeasure : public IfcUtil::IfcBaseType

IfcAngularVelocityMeasure is a measure of the velocity of a body measured in terms of angle subtended per unit time. Usually measured in radians/s. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcAngularVelocityMeasure(IfcEntityInstanceData *e)
IfcAngularVelocityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcAnnotation : public Ifc2x3::IfcProduct

Definition from IAI: An annotation is a graphical representation within the geometric (and spatial) context of a project, that adds a note or meaning to the objects which constitutes the project model. Annotations include additional line drawings, text, dimensioning, hatching and other forms of graphical notes.

NOTE Additional presentation information (often 2D) such as tag number, hatching, etc., that is directly related to a particular product representation is included within the IfcProductDefinitionShape having various IfcShapeRepresentation’s of the IfcElement (and its subtypes). Only those presentation information, that cannot be directly related to a single product, have to be wrapped within the IfcAnnotation.

If available, the annotation should be related to the spatial context of the project, by containing the annotation within the appropriate level of the building structure (site, building, storey, or space). This is handled by the IfcRelContainedInSpatialStructure relationship.

HISTORY: New entity in Release IFC2x Edition 2.

Use definition

The IfcAnnotation can provide specific 0D, 1D, and 2D geometric items as representation of the annotation, offering annotation point, curves, and surfaces.

‘Annotation point’ is an annotation provided by a point that has additional semantic. The inherited attribute ObjectType should be used to capture the type of point annotation, some predefined values are:

‘Survey’: A survey point has a set of cartesian coordinates determined by its location at point. These coordinates are determined relative to the coordinates of a reference point, which acts as the datum for the survey. The difference in elevation of the survey points enables terrain to be determined.

‘Annotation curve’ is an annotation provided by a curve that has additional semantic. The inherited attribute ObjectType should be used to capture the type of curve annotation, some predefined values are:

‘ContourLine’: A line of constant elevation typically used on geographic maps where the spacing of lines at constant intervals of elevation may be used as an indication of slope.

‘IsoBar’: A line of constant pressure typically used on weather maps or to show pressure gradient in spaces, chambers or externally.

‘IsoLux’: A line of constant illumination typically used to show the distribution of illumination levels and/or daylighting in a space or externally.

‘IsoTherm’: A line of constant temperature typically used to show the distribution and effect of heating or cooling within a space or to show temperature distribution on a geographic map.

‘Annotation surface’ is an annotation provided by a surface that has additional semantic. The inherited attribute ObjectType should be used to capture the type of surface annotation, some predefined values are:

‘SurveyArea’: A surface patch based on survey points.

Geometry Use Definitions

The geometric representation of any IfcAnnotation is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations.

Local Placement

The local placement for any IfcAnnotation is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that.

If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations

The standard representation of IfcAnnotation is defined using ‘Annotation2D’, when using 2D geometry, hatching and text, ‘GeometricCurveSet’ when using points and curves, or, when including als surfaces, the ‘GeometricSet’ geometry. Geometric representation items may be styled items by adding the style information.

Annotation2D Representation This representation is used, when the representation of the IfcAnnotation includes specific drafting representation elements. The Annotation may have:

subtypes of IfcPoint, IfcCurve being 2D

directly as Items, or within an IfcGeometricCurveSet

subtypes of IfcAnnotationFillArea for hatches

subtypes of IfcDefinedSymbol for symbols

subtypes of IfcTextLiteral for text

subtypes of IfcDraughtingCallout for dimensions

The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Annotation’

RepresentationType : ‘Annotation2D’

Annotation Curve Representation This representation is used, when the representation of the IfcAnnotation does not includes specific drafting representation elements. The Annotation may have:

subtypes of IfcPoint, IfcCurve being 2D

directly as Items, or within an IfcGeometricCurveSet

The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Annotation’

RepresentationType : ‘GeometricCurveSet’

Annotation Surface Representation This representation is used, when the representation of the IfcAnnotation does includes surfaces. The Annotation may have:

subtypes of IfcPoint, IfcCurve, or IfcSurface

directly as Items, or within an IfcGeometricCurveSet

The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Annotation’

RepresentationType : ‘GeometricSet’

Public Types

typedef IfcTemplatedEntityList<IfcAnnotation> list

Public Functions

IfcTemplatedEntityList<IfcRelContainedInSpatialStructure>::ptr ContainedInStructure() const
const IfcParse::entity &declaration() const
IfcAnnotation(IfcEntityInstanceData *e)
IfcAnnotation(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationCurveOccurrence : public Ifc2x3::IfcAnnotationOccurrence

Subclassed by Ifc2x3::IfcDimensionCurve, Ifc2x3::IfcProjectionCurve

Public Functions

const IfcParse::entity &declaration() const
IfcAnnotationCurveOccurrence(IfcEntityInstanceData *e)
IfcAnnotationCurveOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationFillArea : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-46:1992: An annotation fill area is a set of curves that may be filled with hatching, colour or tiling. The annotation fill are is described by boundaries which consist of non-intersecting, non-self-intersecting closed curves. These curves form the boundary of planar areas to be filled according to the style for the annotation fill area.

NOTE: A curve that is not surrounded by any other curve is a border between an unfilled area on the outside and a filled area on the inside. Another curve may surround an unfilled area if it is surrounded by another curve whose inside is a filled area.

Figure 300 (from ISO 10303-46) illustrates annotation fill area.

Figure 300 — Annotation fill area

NOTE Corresponding ISO 10303 name: annotation_fill_area. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

The IfcAnnotationFillArea defines an area by a definite OuterBoundary, that might include InnerBoundaries. The areas defined by the InnerBoundaries are excluded from applying the fill area style.

Informal Proposition:

Any curve that describes an inner boundary shall not intersect with, nor include, another curve defining an inner boundary. The curve defining the outer boundary shall not intersect with any curve defining an inner boundary, nor shall it be surrounded by a curve defining an inner boundary.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The two attributes OuterBoundary and InnerBoundaries are added and replace the previous single boundary.

Public Types

typedef IfcTemplatedEntityList<IfcAnnotationFillArea> list

Public Functions

::Ifc2x3::IfcCurve *OuterBoundary() const

A closed curve that defines the outer boundary of the fill area. The areas defined by the outer boundary (minus potentially defined inner boundaries) is filled by the fill area style.

IFC2x Edition 3 CHANGE The two new attributes OuterBoundary and InnerBoundaries replace the old single attribute Boundaries.

void setOuterBoundary(::Ifc2x3::IfcCurve *v)
bool hasInnerBoundaries() const

Whether the optional attribute InnerBoundaries is defined for this IfcAnnotationFillArea.

IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr InnerBoundaries() const

A set of inner curves that define the inner boundaries of the fill area. The areas defined by the inner boundaries are excluded from applying the fill area style.

IFC2x Edition 3 CHANGE The two new attributes OuterBoundary and InnerBoundaries replace the old single attribute Boundaries.

void setInnerBoundaries(IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr v)
const IfcParse::entity &declaration() const
IfcAnnotationFillArea(IfcEntityInstanceData *e)
IfcAnnotationFillArea(::Ifc2x3::IfcCurve *v1_OuterBoundary, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr> v2_InnerBoundaries)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationFillAreaOccurrence : public Ifc2x3::IfcAnnotationOccurrence

Public Functions

bool hasFillStyleTarget() const

Whether the optional attribute FillStyleTarget is defined for this IfcAnnotationFillAreaOccurrence.

::Ifc2x3::IfcPoint *FillStyleTarget() const
void setFillStyleTarget(::Ifc2x3::IfcPoint *v)
bool hasGlobalOrLocal() const

Whether the optional attribute GlobalOrLocal is defined for this IfcAnnotationFillAreaOccurrence.

::Ifc2x3::IfcGlobalOrLocalEnum::Value GlobalOrLocal() const
void setGlobalOrLocal(::Ifc2x3::IfcGlobalOrLocalEnum::Value v)
const IfcParse::entity &declaration() const
IfcAnnotationFillAreaOccurrence(IfcEntityInstanceData *e)
IfcAnnotationFillAreaOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name, ::Ifc2x3::IfcPoint *v4_FillStyleTarget, boost::optional<::Ifc2x3::IfcGlobalOrLocalEnum::Value> v5_GlobalOrLocal)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationOccurrence : public Ifc2x3::IfcStyledItem

Subclassed by Ifc2x3::IfcAnnotationCurveOccurrence, Ifc2x3::IfcAnnotationFillAreaOccurrence, Ifc2x3::IfcAnnotationSurfaceOccurrence, Ifc2x3::IfcAnnotationSymbolOccurrence, Ifc2x3::IfcAnnotationTextOccurrence

Public Types

typedef IfcTemplatedEntityList<IfcAnnotationOccurrence> list

Public Functions

const IfcParse::entity &declaration() const
IfcAnnotationOccurrence(IfcEntityInstanceData *e)
IfcAnnotationOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationSurface : public Ifc2x3::IfcGeometricRepresentationItem

Public Types

typedef IfcTemplatedEntityList<IfcAnnotationSurface> list

Public Functions

::Ifc2x3::IfcGeometricRepresentationItem *Item() const
void setItem(::Ifc2x3::IfcGeometricRepresentationItem *v)
bool hasTextureCoordinates() const

Whether the optional attribute TextureCoordinates is defined for this IfcAnnotationSurface.

::Ifc2x3::IfcTextureCoordinate *TextureCoordinates() const
void setTextureCoordinates(::Ifc2x3::IfcTextureCoordinate *v)
const IfcParse::entity &declaration() const
IfcAnnotationSurface(IfcEntityInstanceData *e)
IfcAnnotationSurface(::Ifc2x3::IfcGeometricRepresentationItem *v1_Item, ::Ifc2x3::IfcTextureCoordinate *v2_TextureCoordinates)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationSurfaceOccurrence : public Ifc2x3::IfcAnnotationOccurrence

Public Functions

const IfcParse::entity &declaration() const
IfcAnnotationSurfaceOccurrence(IfcEntityInstanceData *e)
IfcAnnotationSurfaceOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationSymbolOccurrence : public Ifc2x3::IfcAnnotationOccurrence

Subclassed by Ifc2x3::IfcTerminatorSymbol

Public Functions

const IfcParse::entity &declaration() const
IfcAnnotationSymbolOccurrence(IfcEntityInstanceData *e)
IfcAnnotationSymbolOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcAnnotationTextOccurrence : public Ifc2x3::IfcAnnotationOccurrence

Public Functions

const IfcParse::entity &declaration() const
IfcAnnotationTextOccurrence(IfcEntityInstanceData *e)
IfcAnnotationTextOccurrence(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcApplication : public IfcUtil::IfcBaseEntity

IfcApplication holds the information about an IFC compliant application developed by an application developer. The IfcApplication utilizes a short identifying name as provided by the application developer.

HISTORY New entity in IFC R1.5.

Public Types

typedef IfcTemplatedEntityList<IfcApplication> list

Public Functions

::Ifc2x3::IfcOrganization *ApplicationDeveloper() const

Name of the application developer, being requested to be member of the IAI.

void setApplicationDeveloper(::Ifc2x3::IfcOrganization *v)
std::string Version() const

The version number of this software as specified by the developer of the application.

void setVersion(std::string v)
std::string ApplicationFullName() const

The full name of the application as specified by the application developer.

void setApplicationFullName(std::string v)
std::string ApplicationIdentifier() const

Short identifying name for the application.

void setApplicationIdentifier(std::string v)
const IfcParse::entity &declaration() const
IfcApplication(IfcEntityInstanceData *e)
IfcApplication(::Ifc2x3::IfcOrganization *v1_ApplicationDeveloper, std::string v2_Version, std::string v3_ApplicationFullName, std::string v4_ApplicationIdentifier)

Public Static Functions

const IfcParse::entity &Class()
class IfcAppliedValue : public IfcUtil::IfcBaseEntity

IfcAppliedValue is an abstract supertype that specifies the common attributes for cost values.

HISTORY: New Entity in IFC2x2. Modifed in IFC2x4 to use IfcDate for date values.

Use definitions The extent of the IfcAppliedValue is determined by the AppliedValue attribute which may be defined either as an IfcMeasureWithUnit or as an IfcMonetaryMeasure or as an IfcRatioMeasure via the IfcAppliedValueSelect type.

Optionally, an IfcAppliedValue may have an applicable date. This is intended to fix the date on which the value became relevant for use. It may be the date on which the value was set in the model or it may be a prior or future date when the value becomes operable.

Similarly, an IfcAppliedValue may have a ‘fixed until’ date. This is intended to fix the date on which the value ceases to be relevant for use.

An instance of IfcAppliedValue may have a unit basis asserted. This is defined as an IfcMeasureWithUnit that determines the extent of the unit value for application purposes. It is assumed that when this attribute is asserted, then the value given to IfcAppliedValue is that for unit quantity. This is not enforced within the IFC schema and thus needs to be controlled within an application.

Applied values may be referenced from a document (such as a price list). The relationship between one or more occurrences of IfcAppliedValue (or its subtypes) is achieved through the use of the IfcExternalReferenceRelationship in which the document provides the IfcExternalReferenceRelationship.RelatingExtReference and the value occurrences are the IfcExternalReferenceRelationship.RelatedResourceObjects.

Subclassed by Ifc2x3::IfcCostValue, Ifc2x3::IfcEnvironmentalImpactValue

Public Types

typedef IfcTemplatedEntityList<IfcAppliedValue> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcAppliedValue.

std::string Name() const

A name or additional clarification given to a cost value.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcAppliedValue.

std::string Description() const

The description that may apply additional information about a cost value.

void setDescription(std::string v)
bool hasAppliedValue() const

Whether the optional attribute AppliedValue is defined for this IfcAppliedValue.

::Ifc2x3::IfcAppliedValueSelect *AppliedValue() const

The extent or quantity or amount of an applied value.

void setAppliedValue(::Ifc2x3::IfcAppliedValueSelect *v)
bool hasUnitBasis() const

Whether the optional attribute UnitBasis is defined for this IfcAppliedValue.

::Ifc2x3::IfcMeasureWithUnit *UnitBasis() const

The number and unit of measure on which the unit cost is based.

Note: As well as the normally expected units of measure such as length, area, volume etc., costs may be based on units of measure which need to be defined e.g. sack, drum, pallet, item etc. Unit costs may be based on quantities greater (or lesser) than a unitary value of the basis measure. For instance, timber may have a unit cost rate per X meters where X > 1; similarly for cable, piping and many other items. The basis number may be either an integer or a real value.

Note: This attribute should be asserted for all circumstances where the cost to be applied is per unit quantity. It may be asserted even for circumstances where an item price is used, in which case the unit cost basis should be by item (or equivalent definition).

void setUnitBasis(::Ifc2x3::IfcMeasureWithUnit *v)
bool hasApplicableDate() const

Whether the optional attribute ApplicableDate is defined for this IfcAppliedValue.

::Ifc2x3::IfcDateTimeSelect *ApplicableDate() const

The date on or from which an applied value is applicable.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setApplicableDate(::Ifc2x3::IfcDateTimeSelect *v)
bool hasFixedUntilDate() const

Whether the optional attribute FixedUntilDate is defined for this IfcAppliedValue.

::Ifc2x3::IfcDateTimeSelect *FixedUntilDate() const

The date until which applied value is applicable.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setFixedUntilDate(::Ifc2x3::IfcDateTimeSelect *v)
IfcTemplatedEntityList<IfcReferencesValueDocument>::ptr ValuesReferenced() const
IfcTemplatedEntityList<IfcAppliedValueRelationship>::ptr ValueOfComponents() const
IfcTemplatedEntityList<IfcAppliedValueRelationship>::ptr IsComponentIn() const
const IfcParse::entity &declaration() const
IfcAppliedValue(IfcEntityInstanceData *e)
IfcAppliedValue(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcAppliedValueSelect *v3_AppliedValue, ::Ifc2x3::IfcMeasureWithUnit *v4_UnitBasis, ::Ifc2x3::IfcDateTimeSelect *v5_ApplicableDate, ::Ifc2x3::IfcDateTimeSelect *v6_FixedUntilDate)

Public Static Functions

const IfcParse::entity &Class()
class IfcAppliedValueRelationship : public IfcUtil::IfcBaseEntity

An IfcAppliedValueRelationship is a relationship class that enables cost values to be aggregated together as components of another cost value.

HISTORY New Entity in Release IFC2.0.

IFC2x4 CHANGE Subtyped from IfcResourceLevelRelationship, attribute order changed.

Use definitions Dependency relationships can exist between applied values on the basis that one particular value may be determined by operations on one or more other values. This is captured through the IfcAppliedValueRelationship entity. In this relationship, one instance of IfcAppliedValue acts as the principal (IfcAppliedValueRelationship.ComponentOf) whose value may be determined from the instances of IfcAppliedValue that are defined as its components (IfcAppliedValueRelationship.Components) An IfcAppliedValueRelationship has an ArithmeticOperator attribute that specifies the form of arithmetical operation implied by the relationship. A practical consideration when using the applied value relationship is that when the arithmetic operator is ADD, then the type of the IfcAppliedValue.AppliedValue attribute will be IfcMeasureWithUnit or IfcMonetaryMeasure while if the arithmetic operator is MULTIPLY, then the type of the IfcAppliedValue.AppliedValue attribute for one instance of IfcAppliedValue will be IfcMeasureWithUnit or IfcMonetaryMeasure while for other instances it will be IfcRatioMeasure. If the arithmetic operator is SUBTRACT or DIVIDE then there can only be two occurrences of IfcAppliedValue that can contribute and the order in which they occur is significant. The value of (A - B) will usually differ from the value of (B - A) whilst (X / Y) is the reciprocal of (Y / X).

Figure 239 illustrates one level aggregation of applied values. A relationship exists between applied value A and applied values B, C and D such that the value of A is determined by the addition of B, C and D such that: A = B + C + D

Figure 239 — Applied value relationship single level

Figure 240 illustrates two level aggregation of applied values. It is possible to develop more complex applied value specifications by creating hierarchies of applied value relationships. In the diagram, the development of a applied value is shown whereby, because B = E * F and D = G * H * J, then: A = ((E * F) + C + (G * H * J)).

Figure 240 — Applied value relationship multiple level

Public Functions

::Ifc2x3::IfcAppliedValue *ComponentOfTotal() const

The applied value (total or subtotal) of which the value being considered is a component.

void setComponentOfTotal(::Ifc2x3::IfcAppliedValue *v)
IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr Components() const

Applied values that are components of another applied value and from which that applied value may be deduced.

void setComponents(IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr v)
::Ifc2x3::IfcArithmeticOperatorEnum::Value ArithmeticOperator() const

The arithmetic operator applied in an applied value relationship.

void setArithmeticOperator(::Ifc2x3::IfcArithmeticOperatorEnum::Value v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcAppliedValueRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcAppliedValueRelationship.

std::string Description() const
void setDescription(std::string v)
const IfcParse::entity &declaration() const
IfcAppliedValueRelationship(IfcEntityInstanceData *e)
IfcAppliedValueRelationship(::Ifc2x3::IfcAppliedValue *v1_ComponentOfTotal, IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr v2_Components, ::Ifc2x3::IfcArithmeticOperatorEnum::Value v3_ArithmeticOperator, boost::optional<std::string> v4_Name, boost::optional<std::string> v5_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcApproval : public IfcUtil::IfcBaseEntity

Definition: An IfcApproval represents information about approval processes such as for a plan, a design, a proposal, or a change order in a construction or facilities management project. IfcApproval is referenced by IfcRelAssociatesApproval in IfcControlExtension schema, and thereby can be related to all subtypes of IfcRoot. An approval may also be given to resource objects using IfcResourceApprovalRelationship

HISTORY New Entity in IFC Release 2.0

IFC2x Edition 4 CHANGE Attributes Identifier and Name made optional, where rule added to require at least one of them being asserted. Inverse attributes ApprovedObjects, ApprovedResources and HasExternalReferences added. Inverse attribute Properties deleted (more general relationship via inverse ApprovedResources to be used instead).

Public Types

typedef IfcTemplatedEntityList<IfcApproval> list

Public Functions

bool hasDescription() const

Whether the optional attribute Description is defined for this IfcApproval.

std::string Description() const

A general textual description of a design, work task, plan, etc. that is being approved for.

void setDescription(std::string v)
::Ifc2x3::IfcDateTimeSelect *ApprovalDateTime() const
void setApprovalDateTime(::Ifc2x3::IfcDateTimeSelect *v)
bool hasApprovalStatus() const

Whether the optional attribute ApprovalStatus is defined for this IfcApproval.

std::string ApprovalStatus() const
void setApprovalStatus(std::string v)
bool hasApprovalLevel() const

Whether the optional attribute ApprovalLevel is defined for this IfcApproval.

std::string ApprovalLevel() const
void setApprovalLevel(std::string v)
bool hasApprovalQualifier() const

Whether the optional attribute ApprovalQualifier is defined for this IfcApproval.

std::string ApprovalQualifier() const
void setApprovalQualifier(std::string v)
std::string Name() const

A human readable name given to an approval.

void setName(std::string v)
std::string Identifier() const

A computer interpretable identifier by which the approval is known.

void setIdentifier(std::string v)
IfcTemplatedEntityList<IfcApprovalActorRelationship>::ptr Actors() const
IfcTemplatedEntityList<IfcApprovalRelationship>::ptr IsRelatedWith() const
IfcTemplatedEntityList<IfcApprovalRelationship>::ptr Relates() const
const IfcParse::entity &declaration() const
IfcApproval(IfcEntityInstanceData *e)
IfcApproval(boost::optional<std::string> v1_Description, ::Ifc2x3::IfcDateTimeSelect *v2_ApprovalDateTime, boost::optional<std::string> v3_ApprovalStatus, boost::optional<std::string> v4_ApprovalLevel, boost::optional<std::string> v5_ApprovalQualifier, std::string v6_Name, std::string v7_Identifier)

Public Static Functions

const IfcParse::entity &Class()
class IfcApprovalActorRelationship : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcActorSelect *Actor() const
void setActor(::Ifc2x3::IfcActorSelect *v)
::Ifc2x3::IfcApproval *Approval() const
void setApproval(::Ifc2x3::IfcApproval *v)
::Ifc2x3::IfcActorRole *Role() const
void setRole(::Ifc2x3::IfcActorRole *v)
const IfcParse::entity &declaration() const
IfcApprovalActorRelationship(IfcEntityInstanceData *e)
IfcApprovalActorRelationship(::Ifc2x3::IfcActorSelect *v1_Actor, ::Ifc2x3::IfcApproval *v2_Approval, ::Ifc2x3::IfcActorRole *v3_Role)

Public Static Functions

const IfcParse::entity &Class()
class IfcApprovalPropertyRelationship : public IfcUtil::IfcBaseEntity

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr ApprovedProperties() const
void setApprovedProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
::Ifc2x3::IfcApproval *Approval() const
void setApproval(::Ifc2x3::IfcApproval *v)
const IfcParse::entity &declaration() const
IfcApprovalPropertyRelationship(IfcEntityInstanceData *e)
IfcApprovalPropertyRelationship(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v1_ApprovedProperties, ::Ifc2x3::IfcApproval *v2_Approval)

Public Static Functions

const IfcParse::entity &Class()
class IfcApprovalRelationship : public IfcUtil::IfcBaseEntity

An IfcApprovalRelationship associates approvals (one relating approval and one or more related approvals), each having different status or level as the approval process or the approved objects evolve.

HISTORY: New entity in Release IFC2x2.

IFC2x4 CHANGE Subtyped from IfcResourceLevelRelationship, order of attributes changed.

Public Types

typedef IfcTemplatedEntityList<IfcApprovalRelationship> list

Public Functions

::Ifc2x3::IfcApproval *RelatedApproval() const
void setRelatedApproval(::Ifc2x3::IfcApproval *v)
::Ifc2x3::IfcApproval *RelatingApproval() const

The approval that other approval is related to.

void setRelatingApproval(::Ifc2x3::IfcApproval *v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcApprovalRelationship.

std::string Description() const
void setDescription(std::string v)
std::string Name() const
void setName(std::string v)
const IfcParse::entity &declaration() const
IfcApprovalRelationship(IfcEntityInstanceData *e)
IfcApprovalRelationship(::Ifc2x3::IfcApproval *v1_RelatedApproval, ::Ifc2x3::IfcApproval *v2_RelatingApproval, boost::optional<std::string> v3_Description, std::string v4_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcArbitraryClosedProfileDef : public Ifc2x3::IfcProfileDef

The closed profile IfcArbitraryClosedProfileDef defines an arbitrary two-dimensional profile for the use within the swept surface geometry, the swept area solid or a sectioned spine. It is given by an outer boundary from which the surface or solid can be constructed.

HISTORY: New entity in IFC 1.5. Entity has been renamed from IfcArbitraryProfileDef in IFC Release 2x.

Informal proposition:

The OuterCurve has to be a closed curve. The OuterCurve shall not intersect.

Figure 307 illustrates the arbitrary closed profile definition. The OuterCurve is defined in the underlying coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. The OuterCurve attribute defines a two dimensional closed bounded curve.

Figure 307 — Arbitrary closed profile

Subclassed by Ifc2x3::IfcArbitraryProfileDefWithVoids

Public Functions

::Ifc2x3::IfcCurve *OuterCurve() const

Bounded curve, defining the outer boundaries of the arbitrary profile.

void setOuterCurve(::Ifc2x3::IfcCurve *v)
const IfcParse::entity &declaration() const
IfcArbitraryClosedProfileDef(IfcEntityInstanceData *e)
IfcArbitraryClosedProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcCurve *v3_OuterCurve)

Public Static Functions

const IfcParse::entity &Class()
class IfcArbitraryOpenProfileDef : public Ifc2x3::IfcProfileDef

The open profile IfcArbitraryOpenProfileDef defines an arbitrary two-dimensional open profile for the use within the swept surface geometry. It is given by an open boundary from with the surface can be constructed.

HISTORY New entity in IFC2x.

Informal proposition:

The Curve has to be an open curve.

Figure 308 illustrates the arbitrary open profile definition. The Curve is defined in the underlying coordinate system. The underlying coordinate system is defined by the swept surface that uses the profile definition. It is the xy plane of:

IfcSweptSurface.Position

The Curve attribute defines a two dimensional open bounded curve.

Figure 308 — Arbitrary open profile

Subclassed by Ifc2x3::IfcCenterLineProfileDef

Public Functions

::Ifc2x3::IfcBoundedCurve *Curve() const

Open bounded curve defining the profile.

void setCurve(::Ifc2x3::IfcBoundedCurve *v)
const IfcParse::entity &declaration() const
IfcArbitraryOpenProfileDef(IfcEntityInstanceData *e)
IfcArbitraryOpenProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcBoundedCurve *v3_Curve)

Public Static Functions

const IfcParse::entity &Class()
class IfcArbitraryProfileDefWithVoids : public Ifc2x3::IfcArbitraryClosedProfileDef

The IfcArbitraryProfileDefWithVoids defines an arbitrary closed two-dimensional profile with holes defined for the use for the swept area solid or a sectioned spine. It is given by an outer boundary and inner boundaries from with the solid the can be constructed.

HISTORY New entity in IFC2x.

Informal propositions:

The outer curve and all inner curves shall be closed curves. The outer curve shall enclose all inner curves. No inner curve shall intersect with the outer curve or any other inner curve. No inner curve may enclose another inner curve.

Figure 309 illustrates the arbitrary closed profile definition with voids. The OuterCurve, defined at the supertype IfcArbitraryClosedProfileDef and the inner curves are defined in the same underlying coordinate system. The common underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. The OuterCurve attribute defines a two dimensional closed bounded curve, the InnerCurves define a set of two dimensional closed bounded curves.

Figure 309 — Arbitrary profile with voids

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr InnerCurves() const

Set of bounded curves, defining the inner boundaries of the arbitrary profile.

void setInnerCurves(IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr v)
const IfcParse::entity &declaration() const
IfcArbitraryProfileDefWithVoids(IfcEntityInstanceData *e)
IfcArbitraryProfileDefWithVoids(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcCurve *v3_OuterCurve, IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr v4_InnerCurves)

Public Static Functions

const IfcParse::entity &Class()
class IfcAreaMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: An area measure is the value of the extent of a surface. Usually measured in square metre (m2). Type: REAL

NOTE Corresponding ISO 10303 name: area_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcAreaMeasure(IfcEntityInstanceData *e)
IfcAreaMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcArithmeticOperatorEnum

Public Types

enum Value

IfcArithmeticOperatorEnum specifies the form of arithmetical operation implied by the relationship. Enumeration

ADD DIVIDE MULTIPLY SUBTRACT

HISTORY: New enumeration in IFC2x2.

Use definitions There can be only one arithmetic operator for each applied value relationship. This is to enforce arithmetic consistency. Given this consistency, the cardinality of the IfcAppliedValueRelationship.Components attribute is a set of one to many applied values that are components of an applied value.

Values:

enumerator IfcArithmeticOperator_ADD
enumerator IfcArithmeticOperator_DIVIDE
enumerator IfcArithmeticOperator_MULTIPLY
enumerator IfcArithmeticOperator_SUBTRACT

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcAssemblyPlaceEnum

Public Types

enum Value

Definition from IAI: Enumeration defining where the assembly is intended to take place, either in a factory or on the building site.

HISTORY New enumeration in Release IFC2x Edition 2.

Enumeration

SITE - this assembly is assembled at site

FACTORY - this assembly is assembled in a factory

Values:

enumerator IfcAssemblyPlace_SITE
enumerator IfcAssemblyPlace_FACTORY
enumerator IfcAssemblyPlace_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcAsset : public Ifc2x3::IfcGroup

An asset is a uniquely identifiable grouping of elements acting as a single entity that has a financial value or that can be operated on as a single unit.

An asset is generally the level of granularity at which maintenance operations are undertaken. An asset is a group that can contain one or more elements. Whilst the financial value of a component or element can be defined, financial value is also defined for accounting purposes at the level of the asset. There are a number of actors that can be associated with an asset, each actor having a role. Actors within the scope of the project are indicated using the IfcRelAssignsToActor relationship in which case roles should be defined through the IfcActorRole class; otherwise principal actors are identified as attributes of the class. In the existence of both, direct attributes take precedence. There are a number of costs that can be associated with an asset, each cost having a role. These are specified through the OriginalValue, CurrentValue, TotalReplacementCost and DepreciatedValue attributes.

HISTORY: New entity in IFC2x. In IFC2x4, all attributes made optional and date values changed to use IfcDate.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Refer to the documentation at the supertype IfcGroup and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_Asset

Classification Use Definition Classifications may be applied using IfcRelAssociatesClassification where RelatedObjects contains the IfcAsset and RelatingClassification refers to an IfcClassification or IfcClassificationReference.

IfcClassificationReference: The operating function of an asset within an organization may be particularly valuable in situations where one organization provides and maintains core services and another organization adds and maintains terminal services. It can classify who owns and is responsible for the asset. Operating function can be designated through the use of one or more classification references.

Assignment Use Definition The IfcAsset may be assigned to the following entities using relationships as indicated:

IfcActor (IfcRelAssignsToActor): Indicates the actor who owns, uses, or is responsible for the asset (as indicated by role in relationship), if such actor is within the scope of the project. IfcCostItem (IfcRelAssignsToControl): Indicates a cost item encompassing the asset.

The IfcAsset may have assignments of its own using the IfcRelAssignsToGroup relationship where RelatingGroup refers to the IfcAsset and RelatedObjects contains one or more objects of the following types: IfcElement: Physical elements that comprise the asset.

Public Types

typedef IfcTemplatedEntityList<IfcAsset> list

Public Functions

std::string AssetID() const
void setAssetID(std::string v)
::Ifc2x3::IfcCostValue *OriginalValue() const

The cost value of the asset at the time of purchase.

void setOriginalValue(::Ifc2x3::IfcCostValue *v)
::Ifc2x3::IfcCostValue *CurrentValue() const

The current cost value of the asset.

void setCurrentValue(::Ifc2x3::IfcCostValue *v)
::Ifc2x3::IfcCostValue *TotalReplacementCost() const

The total cost of replacement of the asset.

void setTotalReplacementCost(::Ifc2x3::IfcCostValue *v)
::Ifc2x3::IfcActorSelect *Owner() const

The name of the person or organization that ‘owns’ the asset.

void setOwner(::Ifc2x3::IfcActorSelect *v)
::Ifc2x3::IfcActorSelect *User() const

The name of the person or organization that ‘uses’ the asset.

void setUser(::Ifc2x3::IfcActorSelect *v)
::Ifc2x3::IfcPerson *ResponsiblePerson() const

The person designated to be responsible for the asset. NOTE: In some regulations (for example, UK Health and Safety at Work Act, Electricity at Work Regulations), management of assets must have a person identified as being responsible and to whom regulatory, insurance and other organizations communicate. In places where there is not a legal requirement, the responsible person would be the asset manager but would not have a legal status.

void setResponsiblePerson(::Ifc2x3::IfcPerson *v)
::Ifc2x3::IfcCalendarDate *IncorporationDate() const

The date on which an asset was incorporated into the works, installed, constructed, erected or completed. NOTE: This is the date on which an asset is considered to start depreciating.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setIncorporationDate(::Ifc2x3::IfcCalendarDate *v)
::Ifc2x3::IfcCostValue *DepreciatedValue() const

The current value of an asset within the accounting rules and procedures of an organization.

void setDepreciatedValue(::Ifc2x3::IfcCostValue *v)
const IfcParse::entity &declaration() const
IfcAsset(IfcEntityInstanceData *e)
IfcAsset(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_AssetID, ::Ifc2x3::IfcCostValue *v7_OriginalValue, ::Ifc2x3::IfcCostValue *v8_CurrentValue, ::Ifc2x3::IfcCostValue *v9_TotalReplacementCost, ::Ifc2x3::IfcActorSelect *v10_Owner, ::Ifc2x3::IfcActorSelect *v11_User, ::Ifc2x3::IfcPerson *v12_ResponsiblePerson, ::Ifc2x3::IfcCalendarDate *v13_IncorporationDate, ::Ifc2x3::IfcCostValue *v14_DepreciatedValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcAsymmetricIShapeProfileDef : public Ifc2x3::IfcIShapeProfileDef

IfcAsymmetricIShapeProfileDef defines a section profile that provides the defining parameters of a singly symmetric I-shaped section. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The centre of the position coordinate system is in the profile’s centre of the bounding box.

The inherited attributes are redefined as:

OverallWidth BottomFlangeWidth FlangeThickness BottomFlangeThickness FilletRadius BottomFlangeFilletRadius

The overall width of the profile is implicitly given by the maximum of the bottom flange width and the top flange width.

IfcAsymmetricIShapeProfileDef can also be used to model rail profiles if the application scenario does not require a full explicit shape model of the rail profile. Alternatively, IfcArbitraryClosedProfileDef can be used to provide the exact shape of rail profiles. Either way, a reference to an external document or library should be provided to further define the profile as described at IfcProfileDef.

HISTORY New entity in Release IFC2x Edition 2.

IFC2x3 CHANGE All profile origins are now in the center of the bounding box. The attribute CentreOfGravityInY has been made OPTIONAL.

IFC2x4 CHANGE Bottom flange is not necessarily wider than top flange. TopFlangeThickness changed from OPTIONAL to mandatory. Type of TopFlangeFilletRadius relaxed to allow for zero radius. Trailing attribute CentreOfGravityInY deleted, use respective property in IfcExtendedProfileProperties instead.

Figure 310 illustrates parameters of the asymmetric I-shaped section definition. The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. The parameterized profile is defined by a set of parameter attributes. In the illustrated example, the ‘CentreOfGravityInY’ property in IfcExtendedProfileProperties, if provided, is negative.

Figure 310 — Assymetric I-shape profile

Public Functions

double TopFlangeWidth() const

Extent of the top flange, defined parallel to the x axis of the position coordinate system.

void setTopFlangeWidth(double v)
bool hasTopFlangeThickness() const

Whether the optional attribute TopFlangeThickness is defined for this IfcAsymmetricIShapeProfileDef.

double TopFlangeThickness() const

Flange thickness of the top flange of the I-shape.

void setTopFlangeThickness(double v)
bool hasTopFlangeFilletRadius() const

Whether the optional attribute TopFlangeFilletRadius is defined for this IfcAsymmetricIShapeProfileDef.

double TopFlangeFilletRadius() const

The fillet between the web and the top flange of the I-shape.

void setTopFlangeFilletRadius(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcAsymmetricIShapeProfileDef.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcAsymmetricIShapeProfileDef(IfcEntityInstanceData *e)
IfcAsymmetricIShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_OverallWidth, double v5_OverallDepth, double v6_WebThickness, double v7_FlangeThickness, boost::optional<double> v8_FilletRadius, double v9_TopFlangeWidth, boost::optional<double> v10_TopFlangeThickness, boost::optional<double> v11_TopFlangeFilletRadius, boost::optional<double> v12_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcAxis1Placement : public Ifc2x3::IfcPlacement

Definition from ISO/CD 10303-42:1992: The direction and location in three dimensional space of a single axis. An axis1_placement is defined in terms of a locating point (inherited from placement supertype) and an axis direction: this is either the direction of axis or defaults to (0.0,0.0,1.0). The actual direction for the axis placement is given by the derived attribute z (Z).

NOTE Corresponding ISO 10303 name: axis1_placement, please refer to ISO/IS 10303-42:1994, p. 28 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5

Figure 274 illustrates the definition of the IfcAxis1Placement within the three-dimensional coordinate system.

Figure 274 — Axis1 placement

Public Types

typedef IfcTemplatedEntityList<IfcAxis1Placement> list

Public Functions

bool hasAxis() const

Whether the optional attribute Axis is defined for this IfcAxis1Placement.

::Ifc2x3::IfcDirection *Axis() const

The direction of the local Z axis.

void setAxis(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcAxis1Placement(IfcEntityInstanceData *e)
IfcAxis1Placement(::Ifc2x3::IfcCartesianPoint *v1_Location, ::Ifc2x3::IfcDirection *v2_Axis)

Public Static Functions

const IfcParse::entity &Class()
class IfcAxis2Placement2D : public Ifc2x3::IfcPlacement

Definition from ISO/CD 10303-42:1992: The location and orientation in two dimensional space of two mutually perpendicular axes. An axis2_placement_2d is defined in terms of a point, (inherited from the placement supertype), and an axis. It can be used to locate and originate an object in two dimensional space and to define a placement coordinate system. The class includes a point which forms the origin of the placement coordinate system. A direction vector is required to complete the definition of the placement coordinate system. The reference direction defines the placement X axis direction, the placement Y axis is derived from this.

If the RefDirection attribute is not given, the placement defaults to P[1] (x-axis) as [1.,0.] and P[2] (y-axis) as [0.,1.].

NOTE Corresponding ISO 10303 name: axis2_placement_2d, please refer to ISO/IS 10303-42:1994, p. 28 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.

Figure 275 illustrates the definition of the IfcAxis2Placement2D within the two-dimensional coordinate system.

Figure 275 — Axis2 placement 2D

Public Types

typedef IfcTemplatedEntityList<IfcAxis2Placement2D> list

Public Functions

bool hasRefDirection() const

Whether the optional attribute RefDirection is defined for this IfcAxis2Placement2D.

::Ifc2x3::IfcDirection *RefDirection() const

The direction used to determine the direction of the local X axis. If a value is omited that it defaults to [1.0, 0.0.].

void setRefDirection(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcAxis2Placement2D(IfcEntityInstanceData *e)
IfcAxis2Placement2D(::Ifc2x3::IfcCartesianPoint *v1_Location, ::Ifc2x3::IfcDirection *v2_RefDirection)

Public Static Functions

const IfcParse::entity &Class()
class IfcAxis2Placement3D : public Ifc2x3::IfcPlacement

Definition from ISO/CD 10303-42:1992: The location and orientation in three dimensional space of three mutually perpendicular axes. An axis2_placement_3D is defined in terms of a point (inherited from placement supertype) and two (ideally orthogonal) axes. It can be used to locate and originate an object in three dimensional space and to define a placement coordinate system. The entity includes a point which forms the origin of the placement coordinate system. Two direction vectors are required to complete the definition of the placement coordinate system. The axis is the placement Z axis direction and the ref_direction is an approximation to the placement X axis direction.

If the attribute values for Axis and RefDirection are not given, the placement defaults to P[1] (x-axis) as [1.,0.,0.], P[2] (y-axis) as [0.,1.,0.] and P[3] (z-axis) as [0.,0.,1.].

NOTE Corresponding ISO 10303 name: axis2_placement_3d, please refer to ISO/IS 10303-42:1994 for the final definition of the formal standard. The WR5 is added to ensure that either both attributes Axis and RefDirection are given, or both are omitted.

HISTORY New entity in IFC Release 1.5.

Figure 276 illustrates the definition of the IfcAxis2Placement3D within the three-dimensional coordinate system.

Figure 276 — Axis2 placement 3D

Public Types

typedef IfcTemplatedEntityList<IfcAxis2Placement3D> list

Public Functions

bool hasAxis() const

Whether the optional attribute Axis is defined for this IfcAxis2Placement3D.

::Ifc2x3::IfcDirection *Axis() const

The exact direction of the local Z Axis.

void setAxis(::Ifc2x3::IfcDirection *v)
bool hasRefDirection() const

Whether the optional attribute RefDirection is defined for this IfcAxis2Placement3D.

::Ifc2x3::IfcDirection *RefDirection() const

The direction used to determine the direction of the local X Axis. If necessary an adjustment is made to maintain orthogonality to the Axis direction. If Axis and/or RefDirection is omitted, these directions are taken from the geometric coordinate system.

void setRefDirection(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcAxis2Placement3D(IfcEntityInstanceData *e)
IfcAxis2Placement3D(::Ifc2x3::IfcCartesianPoint *v1_Location, ::Ifc2x3::IfcDirection *v2_Axis, ::Ifc2x3::IfcDirection *v3_RefDirection)

Public Static Functions

const IfcParse::entity &Class()
class IfcBeam : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Structural member designed to carry loads between or beyond points of support, usually narrow in relation to its length and horizontal or nearly so.

An IfcBeam is a horizontal, or nearly horizontal, structural member that is capable of withstanding load primarily by resisting bending. It represents such a member from an architectural point of view. It is not required to be load bearing.

NOTE The representation of a beam in a structural analysis model is provided by IfcStructuralCurveMember being part of an IfcStructuralAnalysisModel.

NOTE For any longitudial structural member, not constrained to be predominately horizontal nor vertical, or where this semantic information is irrelevant, the entity IfcMember should be used.

The IFC specification provides two entities for beam occurrences:

IfcBeamStandardCase used for all occurrences of beams, that have a profile defined that is swept along a directrix. The profile might be changed uniformly by a taper definition along the directrix. The profile parameter and its cardinal point of insertion can be fully described by the IfcMaterialProfileSetUsage. These beams are always represented geometricly by an ‘Axis’ and a ‘SweptSolid’ or ‘AdvancedSweptSolid’ shape representation (or by a ‘Clipping’ geometry based on the swept solid), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialProfileSetUsage assigned. NOTE View definitions and implementer agreements may further constrain the applicable geometry types, for example, by excluding tapering from an IfcBeamStandardCase implementation.

IfcBeam used for all other occurrences of beams, particularly for beams with changing profile sizes along the extrusion, or beams defined by non-linear extrusion, or beams having only ‘Brep’, or ‘SurfaceModel’ geometry.

HISTORY New entity in IFC Release 1.0

Type Use Definition IfcBeam defines the occuurence of any beam, common information about beam types (or styles) is handled by IfcBeamType. The IfcBeamType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcBeamType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcBeamType is attached (i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcBeam is defined by the IfcMaterialProfileSet or as fallback by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note It is illegal to assign an IfcMaterialProfileSetUsage to an IfcBeam. Only the subtype IfcBeamStandardCase supports this concept. Material information can also be given at the IfcBeamType, defining the common attribute data for all occurrences of the same type. It is then accessible by the inverse IsTypedBy relationship pointing to IfcBeamType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterialProfileSet or IfcMaterial. If both are given, then the material directly assigned to IfcBeam overrides the material assigned to IfcBeamType. Property Set Use Definition The property sets relating to the IfcBeam are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcBeam are part of this IFC release:

Pset_BeamCommon: common property set for all beam occurrences

Property sets can also be given at the IfcBeamType, defining the common property data for all occurrences of the same type. It is then accessible by the inverse IsTypedBy relationship pointing to IfcBeamType.HasPropertySets. If both are given, then the properties directly assigned to IfcBeam overrides the properties assigned to IfcBeamType. Quantity Use Definition The quantities relating to the IfcBeam are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to MethodOfMeasurement. Quanties shall be never assigned to the IfcBeamType.

Qto_BeamBaseQuantities: base quantities for all beam occurrences.

Containment Use Definition The IfcBeam, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within an element assembly.

The IfcBeam is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes of IfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcBeam may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e. SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcBeam is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local Placement The local placement for IfcBeam is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that.

Exception: If the IfcBeam is part of an assembly, the PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the container element, e.g. IfcElementAssembly,

If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Axis’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Axis Representation The axis geometric representation of IfcBeam is defined using the ‘Axis’ representation.

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’, ‘Curve3D’

The ‘Axis’ can be used to represent the system axis and length of a beam that may extent the body length. Body Representation The body representation of IfcBeam can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘MappedRepresentation’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation type:

Solid: IfcExtrudedAreaSolid, IfcRevolvedAreaSolid shall be supported Profile: all subtypes of IfcProfileDef (with exception of IfcArbitraryOpenProfileDef) Extrusion: All extrusion directions shall be supported.

Figure 71 illustrates the ‘SweptSolid’ geometric representation. There are no restrictions or conventions on how to use the local placement (black), solid of extrusion placement (red) and profile placement (green).

Figure 71 — Beam swept solid

Figure 72 illustrates the use of non-perpendicular extrusion to create the IfcExtrudedAreaSolid.

Figure 72 — Beam non-perpendicular extrusion

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The following constraints apply to the advanced representation:

Solid: see ‘SweptSolid’ geometric representation Profile: see ‘SweptSolid’ geometric representation Extrusion: see ‘SweptSolid’ geometric representation Boolean result: The IfcBooleanClippingResult shall be supported, allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid (or its subtypes).

Figure 73 illustrates use of IfcBooleanClippingResult between an IfcExtrudedAreaSolid and an IfcHalfSpaceSolid to create a clipped body.

Figure 73 — Beam clipping

AdvancedSweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘AdvancedSweptSolid’

The following additional constraints apply to the ‘AdvancedSweptSolid’ representation type:

Solid: IfcSurfaceCurveSweptAreaSolid, IfcFixedReferenceSweptAreaSolid, IfcExtrudedAreaSolidTapered, IfcRevolvedAreaSolidTapered shall be supported. NOTE View definitions and implementer agreement can further constrain the allowed swept solid types.

Profile: see ‘SweptSolid’ geometric representation Extrusion: not applicable

MappedRepresentation Representation Type The ‘MappedRepresentation’ representation is supported as it allows for reusing the geometry definition of the beam type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘SurfaceModel’, and ‘Brep’ geometric representation, shall apply to the MappedRepresentation of the IfcRepresentationMap.

Public Types

typedef IfcTemplatedEntityList<IfcBeam> list

Public Functions

const IfcParse::entity &declaration() const
IfcBeam(IfcEntityInstanceData *e)
IfcBeam(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcBeamType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type IfcBeamType defines commonly shared information for occurrences of beams. The set of shared information may include:

common properties within shared property sets common material information common profile definitions common shape representations

It is used to define a beam specification, or beam style (i.e. the specific product information that is common to all occurrences of that beam type). Beam types may be exchanged without being already assigned to occurrences. Occurrences of the IfcBeamType within building models are represented by instances of IfcBeamStandardCase if the IfcBeamType has a single associated IfcMaterialProfileSet; otherwise they are represented by instances of IfcBeam. Occurrences of the IfcBeamType within structural analysis models are represented by instances of IfcStructuralCurveMember, or its applicable subtypes. HISTORY New entity in Release IFC2x Edition 2. Material Use Definition The material of the IfcBeamType is defined by the IfcMaterialProfileSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcBeamType, if there is at least one occurrences. of IfcBeamStandardCase for this type. Property Set Use Definition: The shared property sets relating to the IfcBeamType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcBeamType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcBeamType and those that are only assignable to IfcBeam. If the same property is assigned to the IfcBeamType and the IfcBeam being an occurrence of the IfcBeamType, then the occurrence property overrides the type property.

Pset_BeamCommon: common property set for all beam types.

Profile Use Definition: The shared profile definition is defined by assigning an IfcMaterialProfileSet (see material use definition above). The IfcMaterialProfile refers to the subtype of IfcProfileDef that is the common profile for all beam occurrence, if used. It is only applicable if the IfcBeamType has only occurrences of type IfcBeamStandardCase (see definition of IfcBeamStandardCase for further information). NOTE The attribute ProfileName of the IfcProfileDef subtype, referenced in IfcMaterialProfile should contain a standardized profile name according to local standards. However, an additional geometric representation of the profile is necessary (e.g. as IfcExtrudedAreaSolid). An importing application is allowed to check for the existence of the profile name: in case of identifying it as a standardized name, the corresponding profile geometry and possibly other cross sectional properties can be read from a library. Otherwise the geometric representation and possible non geometric IfcProfileProperties have to be used. Geometry Use Definition: The IfcBeamType may define the shared geometric representation for all beam occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘Axis’, or ‘Body’). It is only applicable if the IfcBeamType has only occurrences of type IfcBeam (See geometric use definition of IfcBeam for further information). NOTE If the IfcBeamType has an associated IfcMaterialProfileSet, then no shared geometric representation shall be provided. NOTE The product shape representations are defined as RepresentationMaps (attribute of the supertype IfcTypeProduct), which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[n] being an IfcMappedItem. See IfcTypeProduct for further information. NOTE The values of attributes RepresentationIdentifier and RepresentationType of IfcShapeRepresentation are restricted in the same way as those for IfcBeam and IfcBeamStandardCase

Public Types

typedef IfcTemplatedEntityList<IfcBeamType> list

Public Functions

::Ifc2x3::IfcBeamTypeEnum::Value PredefinedType() const

Identifies the predefined types of a beam element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcBeamTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcBeamType(IfcEntityInstanceData *e)
IfcBeamType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcBeamTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcBeamTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of linear elements an IfcBeamType object can fulfill:

BEAM: A standard beam usually used horizontally. JOIST: A beam used to support a floor or ceiling. HOLLOWCORE: A wide often prestressed beam with a hollow-core profile that usually serves as a slab component. LINTEL: A beam or horizontal piece of material over an opening (e.g. door, window). SPANDREL: A tall beam placed on the facade of a building. One tall side is usually finished to provide the exterior of the building. Can be used to support joists or slab elements on its interior side.

NOTE They are also referred to as “spandrel

panels”, which are parts of a facade and sometimes have supporting consoles for floor slabs integrated.

T_BEAM: A beam that forms part of a slab construction and acts together with the slab which its carries. Such beams are often of T-shape (therefore the English name), but may have other shapes as well, e.g. an L-Shape or an Inverted-T-Shape.

NOTE In order to distinguish beams by shape, the assigned IfcProfileDef subtypes provide the shape type and, if using a subtype of IfcParameterizedProfileDef, also the shape parameterization.

USERDEFINED: User-defined linear beam element. NOTDEFINED: Undefined linear beam element

HISTORY New Enumeration in Release IFC2x Edition 2. IFC2x4 CHANGE The enumerators HOLLOWCORE and SPANDREL have been added.

Values:

enumerator IfcBeamType_BEAM
enumerator IfcBeamType_JOIST
enumerator IfcBeamType_LINTEL
enumerator IfcBeamType_T_BEAM
enumerator IfcBeamType_USERDEFINED
enumerator IfcBeamType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcBenchmarkEnum

Public Types

enum Value

IfcBenchmarkEnum is an enumeration used to identify the logical comparators that can be applied in conjunction with constraint values.

HISTORY: New type in IFC Release 2.0

IFC2x4 CHANGE: Extended to include comparators for item-set and set-item comparisons: INCLUDES, NOTINCLUDES, INCLUDEDIN and NOTINCLUDEDIN, to test if an individual item is a member of a given aggregation, or if an aggregation has a given individual item as a member.

Enumeration

Value Definition

GREATERTHAN Identifies that a value must be greater than that set by the constraint.

GREATERTHANOREQUALTO Identifies that a value must be either greater than or equal to that set by the constraint.

LESSTHAN Identifies that a value must be less than that set by the constraint.

LESSTHANOREQUALTO Identifies that a value must be either less than or equal to that set by the constraint.

EQUALTO Identifies that a value must be equal to that set by the constraint.

NOTEQUALTO Identifies that a value must be not equal to that set by the constraint.

INCLUDES Identifies that an aggregation (set, list or table) must include the value (individual item) set by the constraint.

NOTINCLUDES Identifies that an aggregation (set, list or table) must not include (i.e must exclude) the value (individual item) set by the constraint.

INCLUDEDIN Identifies that a value (individual item) must be included in the aggregation (set, list or table) set by the constraint.

NOTINCLUDEDIN Identifies that a value (individual item) must not be included (i.e. must be excluded) in the aggregation (set, list or table) set by the constraint.

Values:

enumerator IfcBenchmark_GREATERTHAN
enumerator IfcBenchmark_GREATERTHANOREQUALTO
enumerator IfcBenchmark_LESSTHAN
enumerator IfcBenchmark_LESSTHANOREQUALTO
enumerator IfcBenchmark_EQUALTO
enumerator IfcBenchmark_NOTEQUALTO

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcBezierCurve : public Ifc2x3::IfcBSplineCurve

Subclassed by Ifc2x3::IfcRationalBezierCurve

Public Types

typedef IfcTemplatedEntityList<IfcBezierCurve> list

Public Functions

const IfcParse::entity &declaration() const
IfcBezierCurve(IfcEntityInstanceData *e)
IfcBezierCurve(int v1_Degree, IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v2_ControlPointsList, ::Ifc2x3::IfcBSplineCurveForm::Value v3_CurveForm, bool v4_ClosedCurve, bool v5_SelfIntersect)

Public Static Functions

const IfcParse::entity &Class()
class IfcBlobTexture : public Ifc2x3::IfcSurfaceTexture

An IfcBlobTexture provides a 2-dimensional distribution of the lighting parameters of a surface onto which it is mapped. The texture itself is given as a single binary blob, representing the content of a pixel format file. The file format of the pixel file is given by the RasterFormat attribute and allowable formats are guided by where rule SupportedRasterFormat.

NOTE Toolbox specific implementations of the binary datatype may restrict the maximum length of the binary blob to capture the raster file content.

For interpretation of the texture nodes see IfcImageTexture definition.

HISTORY New class in IFC2x3.

IFC2x4 CHANGE Data type of RasterCode has been corrected to BINARY.

Public Types

typedef IfcTemplatedEntityList<IfcBlobTexture> list

Public Functions

std::string RasterFormat() const

The format of the RasterCode often using a compression.

void setRasterFormat(std::string v)
bool RasterCode() const

Blob, given as a single binary, to capture the texture within one popular file (compression) format. The file format is provided by the RasterFormat attribute.

void setRasterCode(bool v)
const IfcParse::entity &declaration() const
IfcBlobTexture(IfcEntityInstanceData *e)
IfcBlobTexture(bool v1_RepeatS, bool v2_RepeatT, ::Ifc2x3::IfcSurfaceTextureEnum::Value v3_TextureType, ::Ifc2x3::IfcCartesianTransformationOperator2D *v4_TextureTransform, std::string v5_RasterFormat, bool v6_RasterCode)

Public Static Functions

const IfcParse::entity &Class()
class IfcBlock : public Ifc2x3::IfcCsgPrimitive3D

The IfcBlock is a Construction Solid Geometry (CSG) 3D primitive. It is defined by a position and a positve distance along the three orthogonal axes. The inherited Position attribute has the IfcAxisPlacement3D type and provides:

SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The block has one vertex at location and the edges are aligned with the placement axes in the positive sense.

The XLength, YLength, and ZLength attributes define the size of the IfcBlock along the three axes. The following definitions from ISO 10303-42 apply:

A block is a solid rectangular parallelepiped, defined with a location and placement coordinate system. The block is specified by the positive lengths x, y, and z along the axes of the placement coordinate system, and has one vertex at the origin of the placement coordinate system.

Figure 250 illustrates geometric parameters of a block where the block positioned within its own placement coordinate system. The values for XLength, YLength, and ZLength are applied to the positive direction of the X, Y, and Z axis.

Figure 250 — Block geometry

NOTE Corresponding ISO 10303-42 entity: block, the position attribute has been promoted to the immediate supertype IfcCsgPrimitive3D. Please refer to ISO 10303-42:1994, p. 244 for the definition in the international standard.

HISTORY New entity in IFC2x3.

Texture use definition On each side face, textures are aligned facing upright. On the top and bottom faces, textures are aligned facing front-to-back. Textures are stretched or repeated to the extent of each face according to RepeatS and RepeatT.

Figure 251 illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

Side Normal Origin X Origin Y Origin Z S Axis T Axis

Left -X 0 +YLength 0 -Y +Z

Right +X 0 +YLength 0 +Y +Z

Front +X 0 0 0 +X +Z

Back +Y +XLength +YLength 0 -X +Z

Bottom -Z +XLength 0 0 -X +Y

Top +Z 0 0 +ZLength +X +Y

Figure 251 — Block textures

Public Types

typedef IfcTemplatedEntityList<IfcBlock> list

Public Functions

double XLength() const

The size of the block along the placement X axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[1].

void setXLength(double v)
double YLength() const

The size of the block along the placement Y axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[2].

void setYLength(double v)
double ZLength() const

The size of the block along the placement Z axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[3].

void setZLength(double v)
const IfcParse::entity &declaration() const
IfcBlock(IfcEntityInstanceData *e)
IfcBlock(::Ifc2x3::IfcAxis2Placement3D *v1_Position, double v2_XLength, double v3_YLength, double v4_ZLength)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoilerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcBoilerType defines commonly shared information for occurrences of boilers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a boiler specification (i.e. the specific product information, that is common to all occurrences of that product type). Boiler types may be exchanged without being already assigned to occurrences. Occurrences of IfcBoilerType are represented by instances of IfcBoiler.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_BoilerTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_BoilerTypeSteam (STEAM)

Material Use Definition The material of the IfcBoilerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcBoilerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcBoiler for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcBoilerType> list

Public Functions

::Ifc2x3::IfcBoilerTypeEnum::Value PredefinedType() const

Defines types of boilers.

void setPredefinedType(::Ifc2x3::IfcBoilerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcBoilerType(IfcEntityInstanceData *e)
IfcBoilerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcBoilerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcBoilerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of boilers. The IfcBoilerTypeEnum contains the following:

WATER: Water boiler. STEAM: Steam boiler. USERDEFINED: User-defined Boiler type. NOTDEFINED: Undefined Boiler type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcBoilerType_WATER
enumerator IfcBoilerType_STEAM
enumerator IfcBoilerType_USERDEFINED
enumerator IfcBoilerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcBoolean : public IfcUtil::IfcBaseType

IfcBoolean is a defined data type of simple data type Boolean. It is required since a select type (IfcSimpleValue) cannot directly include simple types in its select list. A boolean type can have value TRUE or FALSE.

Type: BOOLEAN

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcBoolean(IfcEntityInstanceData *e)
IfcBoolean(bool v)
operator bool() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcBooleanClippingResult : public Ifc2x3::IfcBooleanResult

A clipping result is defined as a special subtype of the general Boolean result (IfcBooleanResult). It constrains the operands and the operator of the Boolean result.

A clipping result is the Boolean difference between a solid (restricted to swept area solid) and a half space solid, whereas more than one difference operation can be applied to the Boolean result.

NOTE The IfcBooleanClippingResult is defined as a special case of the boolean_result, as defined in ISO 10303-42:1994, p. 175. It has been added to apply further constraints to the CSG representation type.

HISTORY New entity in IFC Release 2.x.

Public Functions

const IfcParse::entity &declaration() const
IfcBooleanClippingResult(IfcEntityInstanceData *e)
IfcBooleanClippingResult(::Ifc2x3::IfcBooleanOperator::Value v1_Operator, ::Ifc2x3::IfcBooleanOperand *v2_FirstOperand, ::Ifc2x3::IfcBooleanOperand *v3_SecondOperand)

Public Static Functions

const IfcParse::entity &Class()
struct IfcBooleanOperator

Public Types

enum Value

Definition from ISO/CD 10303-42:1992: This type defines the three Boolean operators used in the definition of CSG solids.

UNION: The operation of constructing the regularized set theoretic union of the volumes defined by two solids. INTERSECTION: The operation of constructing the regularised set theoretic intersection of the volumes defined by two solids. DIFFERENCE: The operation of constructing the regularized set theoretic intersection of the volumes defined by two solids.

NOTE Corresponding STEP type: boolean_operator, please refer to ISO/IS 10303-42:1994, p.167 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.5.1.

Values:

enumerator IfcBooleanOperator_UNION
enumerator IfcBooleanOperator_INTERSECTION
enumerator IfcBooleanOperator_DIFFERENCE

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcBooleanResult : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A Boolean result is the result of a regularized operation on two solids to create a new solid. Valid operations are regularized union, regularized intersection, and regularized difference. For purpose of Boolean operations, a solid is considered to be a regularized set of points. The final Boolean result depends upon the operation and the two operands. In the case of the difference operator the order of the operands is also significant. The operator can be either union, intersection or difference. The effect of these operators is described below:

Union on two solids is the new solid that is the regularization of the set of all points that are in either the first operand or the second operand or in both. Intersection on two solids is the new solid that is the regularization of the set of all points that are in both the first operand and the second operand. The result of the difference operation on two solids is the regularization of the set of all points which are in the first operand, but not in the second operand.

NOTE For example if the first operand is a block and the second operand is a solid cylinder of suitable dimensions and location, the boolean result produced with the difference operator would be a block with a circular hole.

NOTE Corresponding ISO 10303-42 entity: boolean_result. The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item. Please refer to ISO/IS 10303-42:1994, p.175 for the final definition of the formal standard.

HISTORY: New class in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcBooleanClippingResult

Public Types

typedef IfcTemplatedEntityList<IfcBooleanResult> list

Public Functions

::Ifc2x3::IfcBooleanOperator::Value Operator() const

The Boolean operator used in the operation to create the result.

void setOperator(::Ifc2x3::IfcBooleanOperator::Value v)
::Ifc2x3::IfcBooleanOperand *FirstOperand() const

The first operand to be operated upon by the Boolean operation.

void setFirstOperand(::Ifc2x3::IfcBooleanOperand *v)
::Ifc2x3::IfcBooleanOperand *SecondOperand() const

The second operand specified for the operation.

void setSecondOperand(::Ifc2x3::IfcBooleanOperand *v)
const IfcParse::entity &declaration() const
IfcBooleanResult(IfcEntityInstanceData *e)
IfcBooleanResult(::Ifc2x3::IfcBooleanOperator::Value v1_Operator, ::Ifc2x3::IfcBooleanOperand *v2_FirstOperand, ::Ifc2x3::IfcBooleanOperand *v3_SecondOperand)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundaryCondition : public IfcUtil::IfcBaseEntity

Definition from IAI: The abstract entity IfcBoundaryCondition is the supertype of all boundary conditions that can be applied to structural connection definitions, either directly for the connection (e.g. the joint) or for the relation between a structural member and the connection. NOTE: The boundary conditions are used within other parts, mainly by instances of IfcStructuralConnection (for the definition of supports) and instances of IfcRelConnectsStructuralMember (for the definition of connections between structural members and structural connections).

HISTORY: New entity in Release IFC2x Edition

Subclassed by Ifc2x3::IfcBoundaryEdgeCondition, Ifc2x3::IfcBoundaryFaceCondition, Ifc2x3::IfcBoundaryNodeCondition

Public Types

typedef IfcTemplatedEntityList<IfcBoundaryCondition> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcBoundaryCondition.

std::string Name() const

Optionally defines a name for this boundary condition.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcBoundaryCondition(IfcEntityInstanceData *e)
IfcBoundaryCondition(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundaryEdgeCondition : public Ifc2x3::IfcBoundaryCondition

Definition from IAI: Describes linearly elastic support conditions or connection conditions.

Applicability:

Curve supports and connections.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Attributes LinearStiffnessX/Y/Z renamed to TranslationalStiffnessX/Y/Z.

IFC 2x4 change: All attribute data types changed from numeric to SELECT between Boolean and numeric. Stiffnesses may now also be negative, for example to capture destabilizing effects in boundary conditions. The IFC 2x3 convention of -1. representing infinite stiffness is no longer valid and must not be used. Infinite stiffness, i.e. fixed supports, are now modeled by the Boolean value TRUE.

Public Functions

bool hasLinearStiffnessByLengthX() const

Whether the optional attribute LinearStiffnessByLengthX is defined for this IfcBoundaryEdgeCondition.

double LinearStiffnessByLengthX() const
void setLinearStiffnessByLengthX(double v)
bool hasLinearStiffnessByLengthY() const

Whether the optional attribute LinearStiffnessByLengthY is defined for this IfcBoundaryEdgeCondition.

double LinearStiffnessByLengthY() const
void setLinearStiffnessByLengthY(double v)
bool hasLinearStiffnessByLengthZ() const

Whether the optional attribute LinearStiffnessByLengthZ is defined for this IfcBoundaryEdgeCondition.

double LinearStiffnessByLengthZ() const
void setLinearStiffnessByLengthZ(double v)
bool hasRotationalStiffnessByLengthX() const

Whether the optional attribute RotationalStiffnessByLengthX is defined for this IfcBoundaryEdgeCondition.

double RotationalStiffnessByLengthX() const

Rotational stiffness value about the x-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessByLengthX(double v)
bool hasRotationalStiffnessByLengthY() const

Whether the optional attribute RotationalStiffnessByLengthY is defined for this IfcBoundaryEdgeCondition.

double RotationalStiffnessByLengthY() const

Rotational stiffness value about the y-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessByLengthY(double v)
bool hasRotationalStiffnessByLengthZ() const

Whether the optional attribute RotationalStiffnessByLengthZ is defined for this IfcBoundaryEdgeCondition.

double RotationalStiffnessByLengthZ() const

Rotational stiffness value about the z-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessByLengthZ(double v)
const IfcParse::entity &declaration() const
IfcBoundaryEdgeCondition(IfcEntityInstanceData *e)
IfcBoundaryEdgeCondition(boost::optional<std::string> v1_Name, boost::optional<double> v2_LinearStiffnessByLengthX, boost::optional<double> v3_LinearStiffnessByLengthY, boost::optional<double> v4_LinearStiffnessByLengthZ, boost::optional<double> v5_RotationalStiffnessByLengthX, boost::optional<double> v6_RotationalStiffnessByLengthY, boost::optional<double> v7_RotationalStiffnessByLengthZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundaryFaceCondition : public Ifc2x3::IfcBoundaryCondition

Definition from IAI: Describes linearly elastic support conditions or connection conditions.

Applicability:

Surface supports and connections.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Attributes LinearStiffnessX/Y/Z renamed to TranslationalStiffnessX/Y/Z.

IFC 2x4 change: All attribute data types changed from numeric to SELECT between Boolean and numeric. Stiffnesses may now also be negative, for example to capture destabilizing effects in boundary conditions. The IFC 2x3 convention of -1. representing infinite stiffness is no longer valid and must not be used. Infinite stiffness, i.e. fixed supports, are now modeled by the Boolean value TRUE.

Public Functions

bool hasLinearStiffnessByAreaX() const

Whether the optional attribute LinearStiffnessByAreaX is defined for this IfcBoundaryFaceCondition.

double LinearStiffnessByAreaX() const
void setLinearStiffnessByAreaX(double v)
bool hasLinearStiffnessByAreaY() const

Whether the optional attribute LinearStiffnessByAreaY is defined for this IfcBoundaryFaceCondition.

double LinearStiffnessByAreaY() const
void setLinearStiffnessByAreaY(double v)
bool hasLinearStiffnessByAreaZ() const

Whether the optional attribute LinearStiffnessByAreaZ is defined for this IfcBoundaryFaceCondition.

double LinearStiffnessByAreaZ() const
void setLinearStiffnessByAreaZ(double v)
const IfcParse::entity &declaration() const
IfcBoundaryFaceCondition(IfcEntityInstanceData *e)
IfcBoundaryFaceCondition(boost::optional<std::string> v1_Name, boost::optional<double> v2_LinearStiffnessByAreaX, boost::optional<double> v3_LinearStiffnessByAreaY, boost::optional<double> v4_LinearStiffnessByAreaZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundaryNodeCondition : public Ifc2x3::IfcBoundaryCondition

Definition from IAI: Describes linearly elastic support conditions or connection conditions.

Applicability:

Point supports and connections.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Attributes LinearStiffnessX/Y/Z renamed to TranslationalStiffnessX/Y/Z.

IFC 2x4 change: All attribute data types changed from numeric to SELECT between Boolean and numeric. Stiffnesses may now also be negative, for example to capture destabilizing effects in boundary conditions. The IFC 2x3 convention of -1. representing infinite stiffness is no longer valid and must not be used. Infinite stiffness, i.e. fixed supports, are now modeled by the Boolean value TRUE.

Subclassed by Ifc2x3::IfcBoundaryNodeConditionWarping

Public Functions

bool hasLinearStiffnessX() const

Whether the optional attribute LinearStiffnessX is defined for this IfcBoundaryNodeCondition.

double LinearStiffnessX() const
void setLinearStiffnessX(double v)
bool hasLinearStiffnessY() const

Whether the optional attribute LinearStiffnessY is defined for this IfcBoundaryNodeCondition.

double LinearStiffnessY() const
void setLinearStiffnessY(double v)
bool hasLinearStiffnessZ() const

Whether the optional attribute LinearStiffnessZ is defined for this IfcBoundaryNodeCondition.

double LinearStiffnessZ() const
void setLinearStiffnessZ(double v)
bool hasRotationalStiffnessX() const

Whether the optional attribute RotationalStiffnessX is defined for this IfcBoundaryNodeCondition.

double RotationalStiffnessX() const

Rotational stiffness value about the x-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessX(double v)
bool hasRotationalStiffnessY() const

Whether the optional attribute RotationalStiffnessY is defined for this IfcBoundaryNodeCondition.

double RotationalStiffnessY() const

Rotational stiffness value about the y-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessY(double v)
bool hasRotationalStiffnessZ() const

Whether the optional attribute RotationalStiffnessZ is defined for this IfcBoundaryNodeCondition.

double RotationalStiffnessZ() const

Rotational stiffness value about the z-axis of the coordinate system defined by the instance which uses this resource object.

void setRotationalStiffnessZ(double v)
const IfcParse::entity &declaration() const
IfcBoundaryNodeCondition(IfcEntityInstanceData *e)
IfcBoundaryNodeCondition(boost::optional<std::string> v1_Name, boost::optional<double> v2_LinearStiffnessX, boost::optional<double> v3_LinearStiffnessY, boost::optional<double> v4_LinearStiffnessZ, boost::optional<double> v5_RotationalStiffnessX, boost::optional<double> v6_RotationalStiffnessY, boost::optional<double> v7_RotationalStiffnessZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundaryNodeConditionWarping : public Ifc2x3::IfcBoundaryNodeCondition

Definition from IAI: Describes linearly elastic support conditions or connection conditions, including linearly elastic warping restraints.

Applicability:

Point supports and connections.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: All attribute data types changed from numeric to SELECT between Boolean and numeric. Stiffnesses may now also be negative, for example to capture destabilizing effects in boundary conditions. The IFC 2x3 convention of -1. representing infinite stiffness is no longer valid and must not be used. Infinite stiffness, i.e. fixed supports, are now modeled by the Boolean value TRUE.

Public Functions

bool hasWarpingStiffness() const

Whether the optional attribute WarpingStiffness is defined for this IfcBoundaryNodeConditionWarping.

double WarpingStiffness() const

Defines the warping stiffness value.

void setWarpingStiffness(double v)
const IfcParse::entity &declaration() const
IfcBoundaryNodeConditionWarping(IfcEntityInstanceData *e)
IfcBoundaryNodeConditionWarping(boost::optional<std::string> v1_Name, boost::optional<double> v2_LinearStiffnessX, boost::optional<double> v3_LinearStiffnessY, boost::optional<double> v4_LinearStiffnessZ, boost::optional<double> v5_RotationalStiffnessX, boost::optional<double> v6_RotationalStiffnessY, boost::optional<double> v7_RotationalStiffnessZ, boost::optional<double> v8_WarpingStiffness)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundedCurve : public Ifc2x3::IfcCurve

Definition from ISO/CD 10303-42:1992: A bounded curve is a curve of finite arc length with identifiable end points.

NOTE Corresponding ISO 10303 name: bounded_curve, only the following subtypes have been incorporated into IFC: polyline as IfcPolyline, trimmed_curve as IfcTrimmedCurve, composite_curve as IfcCompositeCurve. Please refer to ISO/IS 10303-42:1994, p.44 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Informal propositions:

A bounded curve has finite arc length. A bounded curve has a start point and an end point.

Subclassed by Ifc2x3::IfcBSplineCurve, Ifc2x3::IfcCompositeCurve, Ifc2x3::IfcPolyline, Ifc2x3::IfcTrimmedCurve

Public Types

typedef IfcTemplatedEntityList<IfcBoundedCurve> list

Public Functions

const IfcParse::entity &declaration() const
IfcBoundedCurve(IfcEntityInstanceData *e)
IfcBoundedCurve()

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundedSurface : public Ifc2x3::IfcSurface

Definition from ISO/CD 10303-42:1992: A bounded surface is a surface of finite area with identifiable boundaries.

NOTE Corresponding ISO 10303 name: bounded_surface. Please refer to ISO/IS 10303-42:1994, p.78 for the final definition of the formal standard.

HISTORY New entity in IFC Release 2x

IFC2x4 CHANGE Entity made abstract.

Informal propositions:

A bounded surface has finite non-zero surface area. A bounded surface has boundary curves.

Subclassed by Ifc2x3::IfcCurveBoundedPlane, Ifc2x3::IfcRectangularTrimmedSurface

Public Types

typedef IfcTemplatedEntityList<IfcBoundedSurface> list

Public Functions

const IfcParse::entity &declaration() const
IfcBoundedSurface(IfcEntityInstanceData *e)
IfcBoundedSurface()

Public Static Functions

const IfcParse::entity &Class()
class IfcBoundingBox : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A box domain is an orthogonal box parallel to the axes of the geometric coordinate system which may be used to limit the domain of a half space solid. A box domain is specified by the coordinates of the bottom left corner, and the lengths of the sides measured in the directions of the coordinate axes.

Every semantic object having a physical extent might have a minimum default representation of a bounding box. The bounding box is therefore also used as minimal geometric representation for any geometrically represented object. Therefore the IfcBoundingBox is subtyped from IfcGeometricRepresentationItem.

NOTE Corresponding ISO 10303-42 entity: box_domain, please refer to ISO/IS 10303-42:1994, p. 186 for the final definition of the formal standard. In IFC the bounding box can also be used outside of the context of an IfcBoxedHalfSpace.

HISTORY New entity in IFC Release 1.0.

As shown in Figure 252, the IfcBoundingBox is defined with its own location which can be used to place the IfcBoundingBox relative to the geometric coordinate system. The IfcBoundingBox is defined by the lower left corner (Corner) and the upper right corner (XDim, YDim, ZDim measured within the parent co-ordinate system).

Figure 252 — Bounding box

Public Types

typedef IfcTemplatedEntityList<IfcBoundingBox> list

Public Functions

::Ifc2x3::IfcCartesianPoint *Corner() const

Location of the bottom left corner (having the minimum values).

void setCorner(::Ifc2x3::IfcCartesianPoint *v)
double XDim() const

Length attribute (measured along the edge parallel to the X Axis)

void setXDim(double v)
double YDim() const

Width attribute (measured along the edge parallel to the Y Axis)

void setYDim(double v)
double ZDim() const

Height attribute (measured along the edge parallel to the Z Axis).

void setZDim(double v)
const IfcParse::entity &declaration() const
IfcBoundingBox(IfcEntityInstanceData *e)
IfcBoundingBox(::Ifc2x3::IfcCartesianPoint *v1_Corner, double v2_XDim, double v3_YDim, double v4_ZDim)

Public Static Functions

const IfcParse::entity &Class()
class IfcBoxAlignment : public Ifc2x3::IfcLabel

The box alignment specifies the alignment of the text box relative to its position. The following string values shall be used:

top-left top-middle top-right middle-left center middle-right bottom-left bottom-middle bottom-right

NOTE The top-left is the default value.

Figure 298 illustrates alignment values.

Figure 298 — Box alignment values

Figure 299 illustrates use of alignment values together with the placement and planar extent.

Figure 299 — Box alignment examples

HISTORY New type in IFC2x2 Addendum2.

IFC2x3 CHANGE The IfcBoxAlignment has been added.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcBoxAlignment(IfcEntityInstanceData *e)
IfcBoxAlignment(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcBoxedHalfSpace : public Ifc2x3::IfcHalfSpaceSolid

Definition from ISO/CD 10303-42:1992: This entity is a subtype of the half space solid which is trimmed by a surrounding rectangular box. The box has its edges parallel to the coordinate axes of the geometric coordinate system.

NOTE The purpose of the box is to facilitate CSG computations by producing a solid of finite size.

The IfcBoxedHalfSpace is used (as its supertype IfcHalfSpaceSolid) only within Boolean operations. It divides the domain into exactly two subsets, where the domain in question is that of the attribute Enclosure. The purpose of the attribute Enclosure is to provide a search box for the other operand in the Boolean operation. It shall be sufficiently large to fully enclose the resulting solid after the Boolean operation with the half space. It however does not alter the final result. The result of the Boolean operation would be the same, as if executed by the supertype IfcHalfSpaceSolid. See Figure 253 below.

Figure 253 — Boxed half space operands

NOTE Corresponding ISO 10303-42 entity: boxed_half_space, please refer to ISO/IS 10303-42:1994, p. 185 for the final definition of the formal standard. The IFC class IfcBoundingBox is used for the definition of the enclosure, providing the same definition as box_domain.

HISTORY New entity in IFC Release 1.5.1, improved documentation available in IFC Release 2x.

IFC2x4 CHANGE Usage correct, position coordinate system for Enclosure is the object coordinate system.

The IfcBoundingBox (relating to ISO 10303-42:1994 box_domain) that provides the enclosure is given for the convenience of the receiving application to enable the use of size box comparison for efficiency (for example, to check first whether size boxes intersect, if not no calculations has to be done to check whether the solids of the entities intersect).

The Enclosure therefore helps to prevent dealing with infinite-size related issues. The enclosure box is positioned within the object coordinate system, established by the ObjectPlacement of the element represented (for example, by IfcLocalPlacement). Figure 254 shows the Enclosure box being sufficiently large to fully enclose the Boolean result.

Figure 254 — Boxed half space geometry

Public Types

typedef IfcTemplatedEntityList<IfcBoxedHalfSpace> list

Public Functions

::Ifc2x3::IfcBoundingBox *Enclosure() const

The box which bounds the resulting solid of the Boolean operation involving the half space solid for computational purposes only.

void setEnclosure(::Ifc2x3::IfcBoundingBox *v)
const IfcParse::entity &declaration() const
IfcBoxedHalfSpace(IfcEntityInstanceData *e)
IfcBoxedHalfSpace(::Ifc2x3::IfcSurface *v1_BaseSurface, bool v2_AgreementFlag, ::Ifc2x3::IfcBoundingBox *v3_Enclosure)

Public Static Functions

const IfcParse::entity &Class()
class IfcBSplineCurve : public Ifc2x3::IfcBoundedCurve

Definition from ISO/CD 10303-42:1992: A B-spline curve is a piecewise parametric polynomial or rational curve described in terms of control points and basis functions. The B-spline curve has been selected as the most stable format to represent all types of polynomial or rational parametric curves. With appropriate attribute values it is capable of representing single span or spline curves of explicit polynomial, rational, Bezier or B-spline type.

Interpretation of the data is as follows:

All weights shall be positive and the curve is given by

k+1 = number of control points

Pi = control points

wi = weights

d = degree

The knot array is an array of (k+d+2) real numbers [u-d … uk+1], such that for all indices j in [-d,k], uj <= uj+1. This array is obtained from the knot data list by repeating each multiple knot according to the multiplicity. N di, the ith normalized B-spline basis function of degree d, is defined on the subset [ui-d, … , ui+1] of this array.

Let L denote the number of distinct values among the d+k+2 knots in the knot array; L will be referred to as the ‘upper index on knots’. Let mj denote the multiplicity (number of repetitions) of the jth distinct knot. Then

All knot multiplicities except the first and the last shall be in the range 1 … degree; the first and last may have a maximum value of degree +

  1. In evaluating the basis functions, a knot u of e.g. multiplicity 3 is interpreted as a string u, u, u, in the knot array. The B-spline curve has 3 special subtypes (Note: only 1, Bezier curve, included in this IFC release) where the knots and knot multiplicities are derived to provide simple default capabilities. Logical flag is provided to indicate whether the curve self intersects or not.

Figure 277 (from ISO 10303-42) illustrates a B-spline curve.

Figure 277 — B-spline curve

NOTE Corresponding ISO 10303 entity: b_spline_curve. Please refer to ISO/IS 10303-42:1994, p. 45 for the final definition of the formal standard.

HISTORY New entity in Release IFC2x2.

Subclassed by Ifc2x3::IfcBezierCurve

Public Types

typedef IfcTemplatedEntityList<IfcBSplineCurve> list

Public Functions

int Degree() const

The algebraic degree of the basis functions.

void setDegree(int v)
IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr ControlPointsList() const

The list of control points for the curve.

void setControlPointsList(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v)
::Ifc2x3::IfcBSplineCurveForm::Value CurveForm() const

Used to identify particular types of curve; it is for information only.

void setCurveForm(::Ifc2x3::IfcBSplineCurveForm::Value v)
bool ClosedCurve() const

Indication of whether the curve is closed; it is for information only.

void setClosedCurve(bool v)
bool SelfIntersect() const

Indication whether the curve self-intersects or not; it is for information only.

void setSelfIntersect(bool v)
const IfcParse::entity &declaration() const
IfcBSplineCurve(IfcEntityInstanceData *e)
IfcBSplineCurve(int v1_Degree, IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v2_ControlPointsList, ::Ifc2x3::IfcBSplineCurveForm::Value v3_CurveForm, bool v4_ClosedCurve, bool v5_SelfIntersect)

Public Static Functions

const IfcParse::entity &Class()
struct IfcBSplineCurveForm

Public Types

enum Value

Definition from ISO/CD 10303-42:1992: This type is used to indicate that the B-spline curve represents a part of a curve of some specific form.

Enumeration

polyline form: A connected sequence of line segments represented by degree 1 B-spline basis functions. circular arc: An arc of a circle, or a complete circle represented by a B-spline curve. elliptic arc: An arc of an ellipse, or a complete ellipse, represented by a B-spline curve. parabolic arc: An arc of finite length of a parabola represented by a B-spline curve. hyperbolic arc: An arc of finite length of one branch of a hyperbola represented by a B-spline curve. unspecified: A B-spline curve for which no particular form is specified.

NOTE Corresponding ISO 10303 type: b_spline_curve_form. Please refer to ISO/IS 10303-42:1994, p. 15 for the final definition of the formal standard.

HISTORY New type in Release IFC2x2.

Values:

enumerator IfcBSplineCurveForm_POLYLINE_FORM
enumerator IfcBSplineCurveForm_CIRCULAR_ARC
enumerator IfcBSplineCurveForm_ELLIPTIC_ARC
enumerator IfcBSplineCurveForm_PARABOLIC_ARC
enumerator IfcBSplineCurveForm_HYPERBOLIC_ARC
enumerator IfcBSplineCurveForm_UNSPECIFIED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcBuilding : public Ifc2x3::IfcSpatialStructureElement

Definition from ISO 6707-1:1989: Construction work that has the provision of shelter for its occupants or contents as one of its main purpose and is normally designed to stand permanently in one place. A building represents a structure that provides shelter for its occupants or contents and stands in one place. The building is also used to provide a basic element within the spatial structure hierarchy for the components of a building project (together with site, storey, and space). A building is (if specified) associated to a site. A building may span over several connected or disconnected buildings. Therefore building complex provides for a collection of buildings included in a site. A building can also be decomposed in (vertical) parts, where each part defines a building section. This is defined by the composition type attribute of the supertype IfcSpatialStructureElements which is interpreted as follow:

COMPLEX = building complex ELEMENT = building PARTIAL = building section

HISTORY New entity in IFC Release 1.0.

Property Set Use Definition The property sets relating to the IfcBuilding are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcBuilding are part of this IFC release:

Pset_BuildingCommon: common property set for all types of buildings Pset_BuildingWaterStorage: specific property set for buildings to capture the water supply requirements Pset_BuildingUse: specific property set for buildings to capture the current and anticipated real estate context. Pset_BuildingUseAdjacent: specific property set for buildings to capture the use information about the adjacent buildings.

Quantity Use Definition The quantities relating to the IfcBuilding are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_BuildingBaseQuantities: base quantities for all building occurrences.

Spatial Structure Use Definition The IfcBuilding is used to build the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical). The spatial structure elements are linked together by using the objectified relationship IfcRelAggregates. The IfcBuilding references them by its inverse relationships:

IfcBuilding.Decomposes referencing (IfcSite || IfcBuilding) by IfcRelAggregates.RelatingObject, If it refers to another instance of IfcBuilding, the referenced IfcBuilding needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcBuilding has ELEMENT), or ELEMENT (if the other IfcBuilding has PARTIAL). IfcBuilding.IsDecomposedBy referencing (IfcBuilding || IfcBuildingStorey) by IfcRelAggregates.RelatedObjects. If it refers to another instance ofIfcBuilding, the referenced IfcBuilding needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcBuilding has COMPLEX), or PARTIAL (if the other IfcBuilding has ELEMENT).

If there are building elements and/or other elements directly related to the IfcBuilding(like a curtain wall spanning several stories), they are associated with the IfcBuilding by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcBuilding references them by its inverse relationship:

IfcBuilding.ContainsElements referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.

Figure 20 shows the IfcBuilding as part of the spatial structure. It also serves as the spatial container for building and other elements. NOTE Detailed requirements on mandatory element containment and placement structure relationships are given in view definitions and implementer agreements.

Figure 20 — Building composition

Systems, such as building service or electrical distribution systems, zonal systems, or structural analysis systems, relate to IfcBuilding by using the objectified relationship IfcRelServicesBuildings.

Attribute Use Definition

Figure 21 describes the heights and elevations of the IfcBuilding. It is used to provide the height above sea level of the project height datum for this building, that is, the internal height 0.00. The height 0.00 is often used as a building internal reference height and equal to the floor finish level of the ground floor.

base elevation of building provided by: IfcBuilding.ElevationOfRefHeight, it is usually the top of construction slab base elevation of terrain at the perimeter of the building provided by: IfcBuilding.ElevationOfTerrain, it is usually the minimum elevation is sloped terrain total height of building, also referred to as ridge height (top of roof structure, e.g the ridge against terrain): provided by BaseQuantity with Name=”TotalHeight” eaves height of building (base of roof structure, e.g the eaves against terrain): provided by BaseQuantity with Name=”EavesHeight”

Figure 21 — Building elevations

Geometry Use Definitions The geometric representation of IfcBuilding is given by the IfcProductDefinitionShape and IfcLocalPlacement, allowing multiple geometric representation. Local Placement The local placement for IfcBuilding is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if relative placement is used) to the IfcSpatialStructureElement of type IfcSite, or of type IfcBuilding (e.g. to position a building relative to a building complex, or a building section to a building). If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Currently, the use of a 2D ‘FootPrint’ representation of type ‘GeometricCurveSet’ and a 3D ‘Body’ representation of type ‘Brep’ is supported. Foot Print Representation The foot print representation of IfcBuilding is given by either a single 2D curve (such as IfcPolyline or IfcCompositeCurve), or by a list of 2D curves (in case of inner boundaries), if the building has an independent geometric representation. The representation identifier and type of this geometric representation of IfcBuilding is:

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’ IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’

Body Representation The body (or solid model) geometric representation (if the building has an independent geometric representation) of IfcBuilding is defined using faceted B-Rep capabilities (with or without voids), based on the IfcFacetedBrep or on the IfcFacetedBrepWithVoids. The representation identifier and type of this representation of IfcBuilding is:

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’ IfcShapeRepresentation.RepresentationType = ‘Brep’

Since the building shape is usually described by the exterior building elements, an independent shape representation shall only be given, if the building is exposed independently from its constituting elements.

Public Types

typedef IfcTemplatedEntityList<IfcBuilding> list

Public Functions

bool hasElevationOfRefHeight() const

Whether the optional attribute ElevationOfRefHeight is defined for this IfcBuilding.

double ElevationOfRefHeight() const

Elevation above sea level of the reference height used for all storey elevation measures, equals to height 0.0. It is usually the ground floor level.

void setElevationOfRefHeight(double v)
bool hasElevationOfTerrain() const

Whether the optional attribute ElevationOfTerrain is defined for this IfcBuilding.

double ElevationOfTerrain() const

Elevation above the minimal terrain level around the foot print of the building, given in elevation above sea level.

void setElevationOfTerrain(double v)
bool hasBuildingAddress() const

Whether the optional attribute BuildingAddress is defined for this IfcBuilding.

::Ifc2x3::IfcPostalAddress *BuildingAddress() const

Address given to the building for postal purposes.

void setBuildingAddress(::Ifc2x3::IfcPostalAddress *v)
const IfcParse::entity &declaration() const
IfcBuilding(IfcEntityInstanceData *e)
IfcBuilding(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_LongName, ::Ifc2x3::IfcElementCompositionEnum::Value v9_CompositionType, boost::optional<double> v10_ElevationOfRefHeight, boost::optional<double> v11_ElevationOfTerrain, ::Ifc2x3::IfcPostalAddress *v12_BuildingAddress)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingElement : public Ifc2x3::IfcElement

Definition from ISO 6707-1:1989: Major functional part of a building, examples are foundation, floor, roof, wall. The building element comprises all elements that are primarily part of the construction of a building, i.e., its structural and space separating system. EXAMPLEs of building elements are walls, beams, or doors, they are all physically existent and tangible things. The IfcBuildingElement utilizes the following capabilities mainly through inverse attributes referencing objectified relationships: NOTE View definitions and implementer agreements will determine those relationships that have to be supported in actual exchange.

Grouping - being part of a logical group of objects

objectified relationship: IfcRelAssignsToGroup object referenced by relationship: IfcGroup (and subtypes) inverse attribute: HasAssignment

Work processes - reference to work tasks, in which this building element is used

objectified relationship: IfcRelAssignsToProcess object referenced by relationship: IfcProcess (and subtypes) inverse attribute: HasAssignments

Structural member reference - information whether the building element is represented in a structural analysis model by a structural member

objectified relationship: IfcRelAssignsToProduct object referenced by relationship: IfcStructuralMember (and by default IfcStructuralCurveMember) inverse attribute: HasAssignments

Aggregation - aggregated together with other elements to form an aggregate

objectified relationship: IfcRelAggregates object referenced by relationship: IfcElement (and subtypes) inverse attribute (for container): IsDecomposedBy inverse attribute (for contained parts): Decomposes

Material - assignment of material used by this building element

objectified relationship: IfcRelAssociatesMaterial object referenced by relationship: IfcMaterialSelect (and selected items) inverse attribute: HasAssociations

Classification - assigned reference to an external classification

objectified relationship: IfcRelAssociatesClassification object referenced by relationship: IfcClassificationNotationSelect (and selected items, default IfcClassificationReference) inverse attribute: HasAssociations

Library - assigned reference to an external library item reference

objectified relationship: IfcRelAssociatesClassification object referenced by relationship: IfcLibrarySelect (and selected items, default IfcLibraryReference) inverse attribute: HasAssociations

Documentation - assigned reference to an external documentation

objectified relationship: IfcRelAssociatesDocumentation object referenced by relationship: IfcDocumentSelect (and selected items, default IfcDocumentReference) inverse attribute: HasAssociations

Type - reference to the common product type information for the element occurrence

objectified relationship: IfcRelDefinesByType object referenced by relationship: IfcBuildingElementType (and subtypes) inverse attribute: IsTypedBy

Properties - reference to all attached properties, including quantities

objectified relationship: IfcRelDefinesByProperties object referenced by relationship: IfcPropertySetDefinition (default IfcPropertySet) inverse attribute: IsDefinedBy

Connection - connectivity to other elements, including the definition of the joint

objectified relationship: IfcRelConnectsElements object referenced by relationship: IfcElement inverse attribute: ConnectedTo inverse attribute: ConnectedFrom

Realization - information, whether the building element is used to realize a connection (e.g. as a weld in a connection between two members)

objectified relationship: IfcRelConnectsWithRealizingElements object referenced by relationship: IfcElement inverse attribute: IsConnectionRealization

Assignment to spatial structure - hierarchical assignment to the right level within the spatial structure

objectified relationship: IfcRelContainedInSpatialStructure object referenced by relationship: IfcSpatialStructureElement inverse attribute: ContainedInStructure

Reference to spatial structure(s) - non hierarchical reference to one or more elements within the spatial structure (e.g. a curtain wall, being contained in the building, references several stories)

objectified relationship: IfcRelContainedInSpatialStructure object referenced by relationship: IfcSpatialElement inverse attribute: ContainedInStructure

Boundary - provision of space boundaries by this building element

objectified relationship: IfcRelSpaceBoundary object referenced by relationship: IfcSpace inverse attribute: ProvidesBoundaries

Coverings - assignment of covering elements to this building element (note: normally covering elements are assigned to the space, only used for special cases)

objectified relationship: IfcRelCoversBldgElements object referenced by relationship: IfcCovering inverse attribute: HasCoverings

Voids - information, whether the building element includes openings, recesses or other voids

objectified relationship: IfcRelVoidsElement object referenced by relationship: IfcFeatureElementSubtraction (default IfcOpeningElement) inverse attribute: HasOpenings

Projection - information, whether the building element has projections (such as a fascia)

objectified relationship: IfcRelProjectsElement object referenced by relationship: IfcFeatureElementAddition (default IfcProjectionElement) inverse attribute: HasProjections

Filling - information whether the building element is used to fill openings

objectified relationship: IfcRelFillsElement object referenced by relationship: IfcOpeningElement inverse attribute: FillsVoids

HISTORY New entity in IFC Release 1.0

Property Set Use Definition The properties relating to the IfcBuildingElement are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties. A detailed specification for individual property sets applicable is introduced at the level of subtypes of IfcBuildingElement. NOTE The applicable property sets are provided by an xml property set definition that includes multilingual translations for each property. The xml definition file format, psdXML, can be used to automatically configure the properties for each building element. Quantity Use Definition: The quantities relating to the IfcBuildingElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties. A detailed specification for individual quantities is introduced at the level of subtypes of IfcBuildingElement. NOTE The applicable element quantities are provided by an xml quantity definition that includes multilingual translations for each quantity. The xml definition file format, qdXML, can be used to automatically configure the quantities for each building element.

Geometry Use Definitions The geometric representation of any IfcBuildingElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. Local Placement The local placement for any IfcBuildingElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. Further constraints are defined at the level of its subtypes. Geometric Representations An IfcBuildingElement can be represented by one or several geometric representations. The following representation identifiers are used for building elements ‘Box’, ‘Axis’, ‘FootPrint’, ‘Surface’, and ‘Body’. A detailed specification is introduced at the level of subtypes. NOTE Some subtypes of IfcBuildingElement may exclude one or several geometric representation types, e.g. standard case elements, such as IfcWallStandardCase, do not allow the use of ‘SurfaceModel’, ‘Brep’, ‘AdvancedBrep’, and ‘MappedRepresentation’. In addition view definitions and implementer agreements may restrict the use of geometric representation types, e.g. the use of ‘AdvancedBrep’. Box Representation Any IfcBuildingElement may be represented as a bounding box, which shows the maximum extend of the body within the coordinated system established by the IfcLocalPlacement. The bounding box representation is the simplest geometric representation available. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Box’ RepresentationType : ‘BoundingBox’

As shown in Figure 22, the bounding box representation is given by an IfcShapeRepresentation that includes a single item, an IfcBoundingBox.

Figure 22 — Building element box representation

Axis Representation Some IfcBuildingElement may be represented by an axis as an abstract geometric representation. See each subtype for specific guidance. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’, ‘Curve3D’

Surface Representation Some IfcBuildingElement may be represented by an surface as an abstract geometric representation. See each subtype for specific guidance. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used:

RepresentationIdentifier : ‘Surface’ RepresentationType : ‘Surface2D’, ‘Surface3D’

FootPrint Representation Any IfcBuildingElement may be represented by a footprint as a specific floor plan geometric representation. See each subtype for specific guidance. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’, ‘Annotation2D’

Body Representation The body representation of any IfcBuildingElement can have the following representation types: ‘SurfaceModel’, ‘Brep’, ‘AdvancedBrep’, and ‘MappedRepresentation’. Other representation types might be specified at the level of subtypes. SurfaceModel Representation Type Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple surface models, based on either shell or face based models. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’

In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape.

As shown in Figure 23, the surface model representation is given by an IfcShapeRepresentation, which includes a single item which is either:

IfcShellBasedSurfaceModel, or IfcFaceBasedSurfaceModel.

Figure 23 — Building element surface model representation

Brep Representation Type Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape. As shown in Figure 24, the Brep representation is given by an IfcShapeRepresentation, which includes one or more items, all of type IfcFacetedBrep.

Figure 24 — Building element body boundary representation

AdvancedBrep Representation Type An IfcBuildingElement (so far no further constraints are defined at the level of its subtypes or by view definitions) may be represented as a single or multiple Boundary Representation elements (which are based on advanced surfaces, usually refered to as NURBS surfaces). The AdvancedBrep representation allows for the representation of complex free-form element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘AdvancedBrep’

In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape. MappedRepresentation Representation Type Any IfcBuildingElement (so far no further constraints are defined at the level of its subtypes) may be represented using the MappedRepresentation. This shall be supported as it allows for reusing the geometry definition of a type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for ‘SurfaceModel’, ‘Brep’, and ‘AdvancedBrep’ geometric representation, shall apply to the MappedRepresentation of the IfcRepresentationMap.

Subclassed by Ifc2x3::IfcBeam, Ifc2x3::IfcBuildingElementComponent, Ifc2x3::IfcBuildingElementProxy, Ifc2x3::IfcColumn, Ifc2x3::IfcCovering, Ifc2x3::IfcCurtainWall, Ifc2x3::IfcDoor, Ifc2x3::IfcFooting, Ifc2x3::IfcMember, Ifc2x3::IfcPile, Ifc2x3::IfcPlate, Ifc2x3::IfcRailing, Ifc2x3::IfcRamp, Ifc2x3::IfcRampFlight, Ifc2x3::IfcRoof, Ifc2x3::IfcSlab, Ifc2x3::IfcStair, Ifc2x3::IfcStairFlight, Ifc2x3::IfcWall, Ifc2x3::IfcWindow

Public Types

typedef IfcTemplatedEntityList<IfcBuildingElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcBuildingElement(IfcEntityInstanceData *e)
IfcBuildingElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingElementComponent : public Ifc2x3::IfcBuildingElement

Subclassed by Ifc2x3::IfcBuildingElementPart, Ifc2x3::IfcReinforcingElement

Public Functions

const IfcParse::entity &declaration() const
IfcBuildingElementComponent(IfcEntityInstanceData *e)
IfcBuildingElementComponent(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingElementPart : public Ifc2x3::IfcBuildingElementComponent

Definition from IAI: Layers or major components as subordinate parts of a building element. Typical usage examples include precast concrete sandwich walls, where the layers may have different geometry representations. In this case the layered material representation does not sufficiently describe the element. Each layer is represented by an own instance of the IfcBuildingElementPart with its own geometry description.

The kind of building element part is further specified by a corresponding instance of IfcBuildingElementPartType, referred to by IfcRelDefinesByType.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Moved from from IfcStructuralElementsDomain schema to IfcSharedComponentElements schema, compatible change of supertype, attribute PredefinedType added.

Public Types

typedef IfcTemplatedEntityList<IfcBuildingElementPart> list

Public Functions

const IfcParse::entity &declaration() const
IfcBuildingElementPart(IfcEntityInstanceData *e)
IfcBuildingElementPart(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingElementProxy : public Ifc2x3::IfcBuildingElement

Definition from IAI: The IfcBuildingElementProxy is a proxy definition that provides the same functionality as an IfcBuildingElement, but without having a predefined meaning of the special type of building element, it represents. Proxies can also be used as spatial place holders or provisions, that maybe later replaced by special types of elements. One use of the proxy object is a provision for voids, i.e. where a particular volume of space is requested by some engineering function that might later be accepted or rejected and if accepted potentially transformed into a void within a building element, like a wall opening, or a slab opening. The provision for voids is exchanged as an IfcBuildingElementProxy with the PredefinedType = ProvisionForVoid. Other usages of IfcBuildingElementProxy include:

The IfcBuildingElementProxy can be used to exchange special types of building elements for which the current IFC Release does not yet provide a semantic definition. The IfcBuildingElementProxy can also be used to represent building elements for which the participating applications can not provide additional semantic classification.

HISTORY New entity in IFC Release 2x. IFC2x4 CHANGE The attribute CompositionType has been replaced by PredefinedType, being a superset of the enumerators. Type Use Definition The IfcBuildingElementProxy defines the occuurence of any building element, common information about the types (or styles) is handled by IfcBuildingElementProxyType. The IfcBuildingElementProxyType (if present) may establish the common type name, usage (or predefined) type, common material, common set of properties and common shape representations (using IfcRepresentationMap). The IfcBuildingElementProxyType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

NOTE The IfcBuildingElementProxyType can be used to share common information among many occurrences of the same proxy without establishing a particular semantic meaning of the type.

If no IfcBuildingElementProxyType is attached (i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcBuildingElementProxy is defined by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note It is illegal to assign an IfcMaterial to an IfcBuildingElementProxy with the PredefinedType = ProvisionForVoid. Material information can also be given at the IfcBuildingElementProxyType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcBuildingElementProxyType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are given, then the material directly assigned to IfcBuildingElementProxy overrides the material assigned to IfcBuildingElementProxyType. Property Set Use Definition: The property sets relating to the IfcBuildingElementProxy are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcBuildingElementProxy are part of this IFC release:

Pset_BuildingElementProxyCommon: common property set for all occurrences of building element proxies. Pset_BuildingElementProxyProvisionForVoid: specific property set for all occurrences of building element proxy with the PredefinedType: PROVISIONFORVOID.

Property sets can also be given at the IfcBuildingElementProxyType, defining the common property data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcBuildingElementProxyType.HasPropertySets. If both are given, then the properties directly assigned to IfcBuildingElementProxy overrides the properties assigned to IfcBuildingElementProxyType. Containment Use Definition The IfcBuildingElementProxy, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcBuildingElementProxy is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcBuildingElementProxy may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcBuildingElementProxy is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local Placement The local placement for any IfcBuildingElementProxy is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The local placement can be given relativly.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. FootPrint Representation Any building element proxy may be represented by a geometric curve set, given by a collection of 2D points and curves. The foot pring geometric representation of IfcBuildingElementProxy is defined using the ‘FootPrint’ representation.

RepresentationIdentifier: ‘FootPrint’ RepresentationType: ‘GeometricCurveSet’, ‘Annotation2D’

Body Representation The body representation of IfcBuildingElementProxy can be represented using the representation types ‘GeometricSet’, ‘SweptSolid’, ‘CSG’ ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’. The representation types ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’ are explained at IfcBuildingElement. GeometricSet Representation Type Any building element proxy may be represented by a geometric set, given by a collection of 2D and 3D points, curves, and surfaces. It represents the body of the proxy object, when no topological structure is available. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier: ‘Body’ RepresentationType: ‘GeometricSet’

SweptSolid Representation Type Any building element proxy may be represented by swept solid geometry (either by extrusion or by revolution). The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier: ‘Body’ RepresentationType: ‘SweptSolid’

No further restrictions (e.g., for the profile or extrusion direction) are defined at this level. A single or multiple swept area solid(s) can be the Items of the IfcShapeRepresentation. CSG Representation Type Any building element proxy may be represented by a CSG primitive or CSG tree. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier: ‘Body’ RepresentationType: ‘CSG’

No further restrictions (e.g., for the depths of the CSG tree) are defined at this level.

Public Types

typedef IfcTemplatedEntityList<IfcBuildingElementProxy> list

Public Functions

bool hasCompositionType() const

Whether the optional attribute CompositionType is defined for this IfcBuildingElementProxy.

::Ifc2x3::IfcElementCompositionEnum::Value CompositionType() const
void setCompositionType(::Ifc2x3::IfcElementCompositionEnum::Value v)
const IfcParse::entity &declaration() const
IfcBuildingElementProxy(IfcEntityInstanceData *e)
IfcBuildingElementProxy(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcElementCompositionEnum::Value> v9_CompositionType)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingElementProxyType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: TheIfcBuildingElementProxyType defines a list of commonly shared property set definitions of a building element proxy and an optional set of product representations. It is used to define an element specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A building element proxy type is used to define the common properties of a certain type of a building element proxy that may be applied to many instances of thattype to assign a specific style. Building element proxy typesmay be exchanged without being already assigned to occurrences.

NOTE Although an building element proxy does not have a predefined ontological meaning the provision of a type may be helpful in sharing information among multiple occurrences. Applications that provide type information for element types not yet included in the current IFC specification can use the IfcBuildingElementProxyType to exchange such types.

The occurrences of the IfcBuildingElementProxyType are represented by instances of IfcBuildingElementProxy.

HISTORY New entity in Release IFC2x Edition 3.

Public Functions

::Ifc2x3::IfcBuildingElementProxyTypeEnum::Value PredefinedType() const

Predefined types to define the particular type of an building element proxy. There may be property set definitions available for each predefined or user defined type.

void setPredefinedType(::Ifc2x3::IfcBuildingElementProxyTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcBuildingElementProxyType(IfcEntityInstanceData *e)
IfcBuildingElementProxyType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcBuildingElementProxyTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcBuildingElementProxyTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the available generic types for IfcBuildingElementProxyType.

HISTORY New enumeration inRelease IFC2x Edition 3.

Enumeration

USERDEFINED

NOTDEFINED

Values:

enumerator IfcBuildingElementProxyType_USERDEFINED
enumerator IfcBuildingElementProxyType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcBuildingElementType : public Ifc2x3::IfcElementType

Definition from IAI: The element type (IfcBuildingElementType) defines a list of commonly shared property set definitions of a building element and an optional set of product representations. It is used to define an element specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A building element type is used to define the common properties of a certain type of a building element that may be applied to many instances of that feature type to assign a specific style. Building element types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The IfcBuildingElementType is an abstract type. Occurrences of subtypes of the IfcBuildingElementType are represented by instances of the appropriate subtypes of IfcBuildingElement.

HISTORY New entity in Release IFC2x Edition 2.

Subclassed by Ifc2x3::IfcBeamType, Ifc2x3::IfcBuildingElementProxyType, Ifc2x3::IfcColumnType, Ifc2x3::IfcCoveringType, Ifc2x3::IfcCurtainWallType, Ifc2x3::IfcMemberType, Ifc2x3::IfcPlateType, Ifc2x3::IfcRailingType, Ifc2x3::IfcRampFlightType, Ifc2x3::IfcSlabType, Ifc2x3::IfcStairFlightType, Ifc2x3::IfcWallType

Public Types

typedef IfcTemplatedEntityList<IfcBuildingElementType> list

Public Functions

const IfcParse::entity &declaration() const
IfcBuildingElementType(IfcEntityInstanceData *e)
IfcBuildingElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcBuildingStorey : public Ifc2x3::IfcSpatialStructureElement

The building storey has an elevation and typically represents a (nearly) horizontal aggregation of spaces that are vertically bound. A storey is (if specified) associated to a building. A storey may span over several connected storeys. Therefore storey complex provides for a collection of storeys included in a building. A storey can also be decomposed in (horizontical) parts, where each part defines a partial storey. This is defihned by the composition type attribute of the supertype IfcSpatialStructureElements which is interpreted as follow:

COMPLEX = building storey complex ELEMENT = building storey PARTIAL = partial building storey

EXAMPLE In split level houses, a storey is split into two or more partial storeys, each with a different elevation. It can be handled by defining a storey, which includes two or more partial storeys with the individual elevations. HISTORY New entity in IFC Release 1.0

Property Set Use Definition The property sets relating to the IfcBuildingStorey are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcBuildingStorey are part of this IFC release:

Pset_BuildingStoreyCommon: common property set for all types of building stories

Quantity Use Definition The quantities relating to the IfcBuildingStorey are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_BuildingStoreyBaseQuantities: base quantities for all building storey occurrences.

Spatial Structure Use Definition The IfcBuildingStorey is used to build the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical). The spatial structure elements are linked together by using the objectified relationship IfcRelAggregates. The IfcBuildingStoreyreferences them by its inverse relationships:

IfcBuildingStorey.Decomposes referencing (IfcBuilding || IfcBuildingStorey) by IfcRelAggregates.RelatingObject, If it refers to another instance ofIfcBuildingStorey, the referenced IfcBuildingStorey needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcBuildingStorey has ELEMENT), or ELEMENT (if the other IfcBuildingStorey has PARTIAL). IfcBuildingStorey.IsDecomposedBy referencing (IfcBuildingStorey || IfcSpace) by IfcRelAggregates.RelatedObjects. If it refers to another instance ofIfcBuildingStorey, the referenced IfcBuildingStorey needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcBuildingStorey has COMPLEX), or PARTIAL (if the other IfcBuildingStorey has ELEMENT).

If there are building elements and/or other elements directly related to the IfcBuildingStorey (like most building elements, such as walls, columns, etc.), they are associated with the IfcBuildingStorey by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcBuildingStorey references them by its inverse relationship:

IfcBuildingStorey.ContainsElements referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.

Figure 25 shows the IfcBuildingStorey as part of the spatial structure. It also serves as the spatial container for building and other elements. NOTE Detailed requirements on mandatory element containment and placement structure relationships are given in view definitions and implementer agreements.

Figure 25 — Building storey composition

Elements can also be referenced in an IfcBuildingStorey, for example, if they span through several storeys. This is expressed by using the objectified relationship IfcRelReferencedInSpatialStructure. Systems, such as building service or electrical distribution systems, zonal systems, or structural analysis systems, relate to IfcBuildingStorey by using the objectified relationship IfcRelServicesBuildings.

Attribute Use Definition

Figure 26 describes the heights and elevations of the IfcBuildingStorey.

elevation of storey provided by: IfcBuildingStorey.Elevation as a local height value relative to IfcBuilding.ElevationOfRefHeight, it is usually the top of construction slab net height of storey, also referred to as total height or system height (top of construction slab to top of construction slab above): provided by BaseQuantity with Name=”GrossHeight” net height of storey (top of construction slab to bottom of construction slab above): provided by BaseQuantity with Name=”NetHeight”

Figure 26 — Building storey elevations

Geometry Use Definitions The geometric representation of IfcBuildingStorey is given by the IfcProductDefinitionShape and IfcLocalPlacement, allowing multiple geometric representation. Local Placement The local placement for IfcBuildingStorey is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if relative placement is used) to the IfcSpatialStructureElement of type IfcBuilding, or of type IfcBuildingStorey (e.g. to position a building storey relative to a building storey complex, or a partial building storey to a building storey). If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Currently, the use of a 2D ‘FootPrint’ representation of type ‘GeometricCurveSet’ and a 3D ‘Body’ representation of type ‘Brep’ is supported.

NOTE The independent geometric representation of IfcBuildingStorey may not be required or allowed in certain view definitions. In those cases only the contained elements and spaces have an independent geometric representation.

Foot Print Representation The foot print representation of IfcBuildingStorey is given by either a single 2D curve (such as IfcPolyline or IfcCompositeCurve), or by a list of 2D curves (in case of inner boundaries), if the building storey has an independent geometric representation. The representation identifier and type of this geometric representation of IfcBuildingStorey is:

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’ IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’

Body Representation The body (or solid model) geometric representation (if the building storey has an independent geometric representation) of IfcBuildingStorey is defined using faceted B-Rep capabilities (with or without voids), based on the IfcFacetedBrep or on the IfcFacetedBrepWithVoids. The representation identifier and type of this representation of IfcBuildingStorey is:

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’ IfcShapeRepresentation.RepresentationType = ‘Brep’

Since the building storey shape is usually described by the exterior building elements, an independent shape representation shall only be given, if the building storey is exposed independently from its constituting elements.

Public Types

typedef IfcTemplatedEntityList<IfcBuildingStorey> list

Public Functions

bool hasElevation() const

Whether the optional attribute Elevation is defined for this IfcBuildingStorey.

double Elevation() const

Elevation of the base of this storey, relative to the 0,00 internal reference height of the building. The 0.00 level is given by the absolute above sea level height by the ElevationOfRefHeight attribute given at IfcBuilding.

void setElevation(double v)
const IfcParse::entity &declaration() const
IfcBuildingStorey(IfcEntityInstanceData *e)
IfcBuildingStorey(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_LongName, ::Ifc2x3::IfcElementCompositionEnum::Value v9_CompositionType, boost::optional<double> v10_Elevation)

Public Static Functions

const IfcParse::entity &Class()
class IfcCableCarrierFittingType : public Ifc2x3::IfcFlowFittingType

The flow fitting type IfcCableCarrierFittingType defines commonly shared information for occurrences of cable carrier fittings. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a cable carrier fitting specification (i.e. the specific product information, that is common to all occurrences of that product type). Cable Carrier Fitting types may be exchanged without being already assigned to occurrences. Occurrences of IfcCableCarrierFittingType are represented by instances of IfcCableCarrierFitting.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowFittingType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CableCarrierFittingTypeCommon

Material Use Definition The material of the IfcCableCarrierFittingType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcCableCarrierFittingType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCableCarrierFitting for standard port definitions.

Public Functions

::Ifc2x3::IfcCableCarrierFittingTypeEnum::Value PredefinedType() const

Identifies the predefined types of cable carrier fitting from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcCableCarrierFittingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCableCarrierFittingType(IfcEntityInstanceData *e)
IfcCableCarrierFittingType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCableCarrierFittingTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCableCarrierFittingTypeEnum

Public Types

enum Value

The IfcCableCarrierFittingTypeEnum defines the range of different types of cable carrier fitting that can be specified. HISTORY: New type in IFC 2x2

Enumeration

BEND: A fitting that changes the route of the cable carrier. CROSS: A fitting at which two branches are taken from the main route of the cable carrier simultaneously. REDUCER: A fitting that changes the physical size of the main route of the cable carrier. TEE: A fitting at which a branch is taken from the main route of the cable carrier. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcCableCarrierFittingType_BEND
enumerator IfcCableCarrierFittingType_CROSS
enumerator IfcCableCarrierFittingType_REDUCER
enumerator IfcCableCarrierFittingType_TEE
enumerator IfcCableCarrierFittingType_USERDEFINED
enumerator IfcCableCarrierFittingType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCableCarrierSegmentType : public Ifc2x3::IfcFlowSegmentType

The flow segment type IfcCableCarrierSegmentType defines commonly shared information for occurrences of cable carrier segments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a cable carrier segment specification (i.e. the specific product information, that is common to all occurrences of that product type). Cable Carrier Segment types may be exchanged without being already assigned to occurrences. Occurrences of IfcCableCarrierSegmentType are represented by instances of IfcCableCarrierSegment.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowSegmentType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CableCarrierSegmentTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_CableCarrierSegmentTypeCableLadderSegment (CABLELADDERSEGMENT) Pset_CableCarrierSegmentTypeCableTraySegment (CABLETRAYSEGMENT) Pset_CableCarrierSegmentTypeCableTrunkingSegment (CABLETRUNKINGSEGMENT) Pset_CableCarrierSegmentTypeConduitSegment (CONDUITSEGMENT)

Material Use Definition The material of the IfcCableCarrierSegmentType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Body’: Material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcCableCarrierSegmentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCableCarrierSegment for standard port definitions.

Public Functions

::Ifc2x3::IfcCableCarrierSegmentTypeEnum::Value PredefinedType() const

Identifies the predefined types of cable carrier segment from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcCableCarrierSegmentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCableCarrierSegmentType(IfcEntityInstanceData *e)
IfcCableCarrierSegmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCableCarrierSegmentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCableCarrierSegmentTypeEnum

Public Types

enum Value

The IfcCableCarrierSegmentTypeEnum defines the range of different types of cable carrier segment that can be specified. HISTORY: New type in IFC 2x2

Enumeration

CABLELADDERSEGMENT: An open carrier segment on which cables are carried on a ladder structure. CABLETRAYSEGMENT: A (typically) open carrier segment onto which cables are laid. CABLETRUNKINGSEGMENT: An enclosed carrier segment with one or more compartments into which cables are placed. CONDUITSEGMENT: An enclosed tubular carrier segment through which cables are pulled. USERDEFINED: User-defined type.

NOTDEFINED: Undefined type.

Values:

enumerator IfcCableCarrierSegmentType_CABLELADDERSEGMENT
enumerator IfcCableCarrierSegmentType_CABLETRAYSEGMENT
enumerator IfcCableCarrierSegmentType_CABLETRUNKINGSEGMENT
enumerator IfcCableCarrierSegmentType_CONDUITSEGMENT
enumerator IfcCableCarrierSegmentType_USERDEFINED
enumerator IfcCableCarrierSegmentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCableSegmentType : public Ifc2x3::IfcFlowSegmentType

The flow segment type IfcCableSegmentType defines commonly shared information for occurrences of cable segments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a cable segment specification (i.e. the specific product information, that is common to all occurrences of that product type). Cable Segment types may be exchanged without being already assigned to occurrences. Occurrences of IfcCableSegmentType are represented by instances of IfcCableSegment.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowSegmentType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CableSegmentTypeCommon Pset_ElectricalDeviceCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_CableSegmentTypeBusbarSegment (BUSBARSEGMENT) Pset_CableSegmentTypeCableSegment (CABLESEGMENT) Pset_CableSegmentTypeConductorSegment (CONDUCTORSEGMENT)

Material Use Definition The material of the IfcCableSegmentType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Conductor’: The material from which the conductor is constructed such as Aluminium or Copper. ‘Insulation’: The material from which the insulation is constructed such as PVC, PEX, EPR, etc. ‘Screen’: The material from which the screen that covers the sheath is constructed (mantel) such as Aluminium, Copper, Steel , Lead. ‘Sheath’: The outer sheathing of the cable which may be color-coded.

Composition Use Definition The IfcCableSegmentType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcCableSegmentType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

CABLESEGMENT: May contain IfcCableSegment components having PredefinedType CORESEGMENT. Cable segments may be aggregated into cable cores. CORESEGMENT: May contain IfcCableSegment components having PredefinedType CONDUCTORSEGMENT. Cable cores may be aggregated into cable conductors.

Port Use Definition The distribution ports relating to the IfcCableSegmentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCableSegment for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCableSegmentType> list

Public Functions

::Ifc2x3::IfcCableSegmentTypeEnum::Value PredefinedType() const

Identifies the predefined types of cable segment from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcCableSegmentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCableSegmentType(IfcEntityInstanceData *e)
IfcCableSegmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCableSegmentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCableSegmentTypeEnum

Public Types

enum Value

The IfcCableSegmentTypeEnum defines the range of different types of cable segment that can be specified.

HISTORY: New type in IFC 2x2. Core and busbar segment added in IFC 2x4.

Enumeration

BUSBARSEGMENT: Electrical conductor that makes a common connection between several electrical circuits. Properties of a busbar are the same as those of a cable segment and are captured by the cable segment property set. CABLESEGMENT: Cable with a specific purpose to lead electric current within a circuit or any other electric construction. Includes all types of electric cables, mainly several core segments or conductor segments wrapped together. CONDUCTORSEGMENT: A single linear element within a cable or an exposed wire (such as for grounding) with the specific purpose to lead electric current, data, or a telecommunications signal.

CORESEGMENT: A self contained element of a cable that comprises one or more conductors and sheathing.The core of one lead is normally single wired or multiwired which are intertwined.

USERDEFINED: User-defined type.

NOTDEFINED: Undefined type.

Values:

enumerator IfcCableSegmentType_CABLESEGMENT
enumerator IfcCableSegmentType_CONDUCTORSEGMENT
enumerator IfcCableSegmentType_USERDEFINED
enumerator IfcCableSegmentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCalendarDate : public IfcUtil::IfcBaseEntity

Public Types

typedef IfcTemplatedEntityList<IfcCalendarDate> list

Public Functions

int DayComponent() const
void setDayComponent(int v)
int MonthComponent() const
void setMonthComponent(int v)
int YearComponent() const
void setYearComponent(int v)
const IfcParse::entity &declaration() const
IfcCalendarDate(IfcEntityInstanceData *e)
IfcCalendarDate(int v1_DayComponent, int v2_MonthComponent, int v3_YearComponent)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianPoint : public Ifc2x3::IfcPoint

Definition from ISO/CD 10303-42:1992: A point defined by its coordinates in a two or three dimensional rectangular Cartesian coordinate system, or in a two dimensional parameter space. The entity is defined in a two or three dimensional space.

The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem). The WR1 was added to constrain the usage of IfcCartesianPoint in the context of IFC geometry. For the purpose of defining geometry in IFC only two and three dimensional Cartesian points are used.

NOTE: Corresponding STEP entity: cartesian_point, please refer to ISO/IS 10303-42:1994, p. 23 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcCartesianPoint> list

Public Functions

std::vector<double> Coordinates() const

The first, second, and third coordinate of the point location. If placed in a two or three dimensional rectangular Cartesian coordinate system, Coordinates[1] is the X coordinate, Coordinates[2] is the Y coordinate, and Coordinates[3] is the Z coordinate.

void setCoordinates(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcCartesianPoint(IfcEntityInstanceData *e)
IfcCartesianPoint(std::vector<double> v1_Coordinates)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianTransformationOperator : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A Cartesian transformation operator defines a geometric transformation composed of translation, rotation, mirroring and uniform scaling. The list of normalized vectors u defines the columns of an orthogonal matrix T. These vectors are computed, by the base axis function, from the direction attributes axis1, axis2 and, in Cartesian transformation operator 3d, axis3. If |T|= -1, the transformation includes mirroring. The local origin point A, the scale value S and the matrix T together define a transformation.

The transformation for a point with position vector P is defined by

P -> A + STP

The transformation for a direction d is defined by

d -> Td

The transformation for a vector with orientation d and magnitude k is defined by

d -> Td, and

k -> Sk

For those entities whose attributes include an axis2 placement, the transformation is applied, after the derivation, to the derived attributes p defining the placement coordinate directions. For a transformed surface, the direction of the surface normal at any point is obtained by transforming the normal, at the corresponding point, to the original surface. For geometric entities with attributes (such as the radius of a circle) which have the dimensionality of length, the values will be multiplied by S.

For curves on surface the p curve.reference to curve will be unaffected by any transformation. The Cartesian transformation operator shall only be applied to geometry defined in a consistent system of units with the same units on each axis. With all optional attributes omitted, the transformation defaults to the identity transformation. The Cartesian transformation operator shall only be instantiated as one of its subtypes.

NOTE: Corresponding ISO 10303 entity: cartesian_transformation_operator, please refer to ISO/IS 10303-42:1994, p. 32 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcCartesianTransformationOperator2D, Ifc2x3::IfcCartesianTransformationOperator3D

Public Functions

bool hasAxis1() const

Whether the optional attribute Axis1 is defined for this IfcCartesianTransformationOperator.

::Ifc2x3::IfcDirection *Axis1() const

The direction used to determine U[1], the derived X axis direction.

void setAxis1(::Ifc2x3::IfcDirection *v)
bool hasAxis2() const

Whether the optional attribute Axis2 is defined for this IfcCartesianTransformationOperator.

::Ifc2x3::IfcDirection *Axis2() const

The direction used to determine U[2], the derived Y axis direction.

void setAxis2(::Ifc2x3::IfcDirection *v)
::Ifc2x3::IfcCartesianPoint *LocalOrigin() const

The required translation, specified as a cartesian point. The actual translation included in the transformation is from the geometric origin to the local origin.

void setLocalOrigin(::Ifc2x3::IfcCartesianPoint *v)
bool hasScale() const

Whether the optional attribute Scale is defined for this IfcCartesianTransformationOperator.

double Scale() const

The scaling value specified for the transformation.

void setScale(double v)
const IfcParse::entity &declaration() const
IfcCartesianTransformationOperator(IfcEntityInstanceData *e)
IfcCartesianTransformationOperator(::Ifc2x3::IfcDirection *v1_Axis1, ::Ifc2x3::IfcDirection *v2_Axis2, ::Ifc2x3::IfcCartesianPoint *v3_LocalOrigin, boost::optional<double> v4_Scale)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianTransformationOperator2D : public Ifc2x3::IfcCartesianTransformationOperator

Definition from ISO/CD 10303-42:1992: A Cartesian transformation operator 2d defines a geometric transformation in two-dimensional space composed of translation, rotation, mirroring and uniform scaling. The list of normalized vectors u defines the columns of an orthogonal matrix T. These vectors are computed from the direction attributes axis1 and axis2 by the base axis function. If |T|= -1, the transformation includes mirroring.

NOTE: Corresponding ISO 10303 entity : cartesian_transformation_operator_2d, please refer to ISO/IS 10303-42:1994, p. 36 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcCartesianTransformationOperator2DnonUniform

Public Functions

const IfcParse::entity &declaration() const
IfcCartesianTransformationOperator2D(IfcEntityInstanceData *e)
IfcCartesianTransformationOperator2D(::Ifc2x3::IfcDirection *v1_Axis1, ::Ifc2x3::IfcDirection *v2_Axis2, ::Ifc2x3::IfcCartesianPoint *v3_LocalOrigin, boost::optional<double> v4_Scale)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianTransformationOperator2DnonUniform : public Ifc2x3::IfcCartesianTransformationOperator2D

A Cartesian transformation operator 2d non uniform defines a geometric transformation in two-dimensional space composed of translation, rotation, mirroring and non uniform scaling. Non uniform scaling is given by two different scaling factors:

SELF\IfcCartesianTransformationOperator.Scale: the x axis scale factor Scale2: the y axis scale factor

If the Scale factor (at supertype IfcCartesianTransformationOperator) is omitted, it defaults to 1.0. If the Scale2 factor is omitted, it defaults to the value of Scale (the x axis scale factor).

NOTE: The scale factor (Scl) defined at the supertype IfcCartesianTransformationOperator is used to express the calculated Scale factor (normally x axis scale factor).

HISTORY: New entity in IFC Release 2x.

Public Functions

bool hasScale2() const

Whether the optional attribute Scale2 is defined for this IfcCartesianTransformationOperator2DnonUniform.

double Scale2() const

The scaling value specified for the transformation along the axis 2. This is normally the y scale factor.

void setScale2(double v)
const IfcParse::entity &declaration() const
IfcCartesianTransformationOperator2DnonUniform(IfcEntityInstanceData *e)
IfcCartesianTransformationOperator2DnonUniform(::Ifc2x3::IfcDirection *v1_Axis1, ::Ifc2x3::IfcDirection *v2_Axis2, ::Ifc2x3::IfcCartesianPoint *v3_LocalOrigin, boost::optional<double> v4_Scale, boost::optional<double> v5_Scale2)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianTransformationOperator3D : public Ifc2x3::IfcCartesianTransformationOperator

Definition from ISO/CD 10303-42:1992: A Cartesian transformation operator 3d defines a geometric transformation in three-dimensional space composed of translation, rotation, mirroring and uniform scaling. The list of normalized vectors u defines the columns of an orthogonal matrix T. These vectors are computed from the direction attributes axis1, axis2 and axis3 by the base axis function. If |T|= -1, the transformation includes mirroring.

NOTE: Corresponding ISO 10303 entity: cartesian_transformation_operator_3d, please refer to ISO/IS 10303-42:1994, p. 33 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcCartesianTransformationOperator3DnonUniform

Public Functions

bool hasAxis3() const

Whether the optional attribute Axis3 is defined for this IfcCartesianTransformationOperator3D.

::Ifc2x3::IfcDirection *Axis3() const

The exact direction of U[3], the derived Z axis direction.

void setAxis3(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcCartesianTransformationOperator3D(IfcEntityInstanceData *e)
IfcCartesianTransformationOperator3D(::Ifc2x3::IfcDirection *v1_Axis1, ::Ifc2x3::IfcDirection *v2_Axis2, ::Ifc2x3::IfcCartesianPoint *v3_LocalOrigin, boost::optional<double> v4_Scale, ::Ifc2x3::IfcDirection *v5_Axis3)

Public Static Functions

const IfcParse::entity &Class()
class IfcCartesianTransformationOperator3DnonUniform : public Ifc2x3::IfcCartesianTransformationOperator3D

A Cartesian transformation operator 3d non uniform defines a geometric transformation in three-dimensional space composed of translation, rotation, mirroring and non uniform scaling. Non uniform scaling is given by three different scaling factors:

SELF\IfcCartesianTransformationOperator.Scale: the x axis scale factor Scale2: the y axis scale factor Scale3: the z axis scale factor

If the Scale factor (at supertype IfcCartesianTransformationOperator) is omitted, it defaults to 1.0. If the Scale2 or the Scale3 factor is omitted, it defaults to the value of Scale (the x axis scale factor).

NOTE: The scale factor (Scl) defined at the supertype IfcCartesianTransformationOperator is used to express the calculated Scale factor (normally x axis scale factor).

HISTORY: New entity in IFC Release 2x.

Public Functions

bool hasScale2() const

Whether the optional attribute Scale2 is defined for this IfcCartesianTransformationOperator3DnonUniform.

double Scale2() const

The scaling value specified for the transformation along the axis 2. This is normally the y scale factor.

void setScale2(double v)
bool hasScale3() const

Whether the optional attribute Scale3 is defined for this IfcCartesianTransformationOperator3DnonUniform.

double Scale3() const

The scaling value specified for the transformation along the axis 3. This is normally the z scale factor.

void setScale3(double v)
const IfcParse::entity &declaration() const
IfcCartesianTransformationOperator3DnonUniform(IfcEntityInstanceData *e)
IfcCartesianTransformationOperator3DnonUniform(::Ifc2x3::IfcDirection *v1_Axis1, ::Ifc2x3::IfcDirection *v2_Axis2, ::Ifc2x3::IfcCartesianPoint *v3_LocalOrigin, boost::optional<double> v4_Scale, ::Ifc2x3::IfcDirection *v5_Axis3, boost::optional<double> v6_Scale2, boost::optional<double> v7_Scale3)

Public Static Functions

const IfcParse::entity &Class()
class IfcCenterLineProfileDef : public Ifc2x3::IfcArbitraryOpenProfileDef

The profile IfcCenterLineProfileDef defines an arbitrary two-dimensional open, not self intersecting profile for the use within the swept solid geometry. It is given by an area defined by applying a constant thickness to a centerline, generating an area from which the solid can be constructed.

Among else, IfcCenterLineProfileDef is used to model cold-formed steel or aluminium sections (Sigma, Zeta, Omega, and similar sections which are not covered by subtypes of IfcParameterizedProfileDef). However, since IfcCenterLineProfileDef does not provide shape parameters except for the thickness, there is generally a need to further specify the profile definition by means of

the name, external reference to a document or library, profile properties,

or a combination of them. See IfcProfileDef for guidance on external references for profiles.

HISTORY New entity in IFC2x3.

Informal proposition:

The Curve has to be an open curve. The Curve has to be a non-intersecting curve.

Figure 311 illustrates the center line profile definition. The Curve is defined in the underlying coordinate system. The underlying coordinate system is defined by the swept surface that uses the profile definition. It is the xy plane of:

IfcSweptSurface.Position

The Curve attribute defines a two dimensional open bounded curve. The Thickness attribute defines a constant thickness along the curve.

Figure 311 — Centerline profile

Public Types

typedef IfcTemplatedEntityList<IfcCenterLineProfileDef> list

Public Functions

double Thickness() const

Constant thickness applied along the center line.

void setThickness(double v)
const IfcParse::entity &declaration() const
IfcCenterLineProfileDef(IfcEntityInstanceData *e)
IfcCenterLineProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcBoundedCurve *v3_Curve, double v4_Thickness)

Public Static Functions

const IfcParse::entity &Class()
class IfcChamferEdgeFeature : public Ifc2x3::IfcEdgeFeature

Public Types

typedef IfcTemplatedEntityList<IfcChamferEdgeFeature> list

Public Functions

bool hasWidth() const

Whether the optional attribute Width is defined for this IfcChamferEdgeFeature.

double Width() const
void setWidth(double v)
bool hasHeight() const

Whether the optional attribute Height is defined for this IfcChamferEdgeFeature.

double Height() const
void setHeight(double v)
const IfcParse::entity &declaration() const
IfcChamferEdgeFeature(IfcEntityInstanceData *e)
IfcChamferEdgeFeature(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_FeatureLength, boost::optional<double> v10_Width, boost::optional<double> v11_Height)

Public Static Functions

const IfcParse::entity &Class()
struct IfcChangeActionEnum

Public Types

enum Value

IfcChangeActionEnum identifies the type of change that might have occurred to the object during the last session (for example, added, modified, deleted). This information is required in a partial model exchange scenario so that an application or model server will know how an object might have been affected by the previous application. Valid enumerations are:

NOCHANGE: Object has not been modified.

MODIFIED: A modification to the object has been made by the user and application defined by the LastModifyingUser and LastModifyingApplication respectively.

ADDED: The object has been created by the user and application defined by the OwningUser and OwningApplication respectively.

DELETED: The object has been deleted by the user and application defined by the LastModifyingUser and LastModifyingApplication respectively.

NOTDEFINED: The change action is not known or has not been defined.

Consider Application A will create an IFC dataset that it wants to publish to others for modification and have the ability to subsequently merge these changes back into the original model. Before publication, it may want to set the IfcChangeActionEnum to NOCHANGE to establish a baseline so that other application changes can be easily identified. Application B then receives this IFC dataset and adds a new object and sets IfcChangeActionEnum to ADDED with Application B defined as the OwningApplication. Application B then modifies an existing object and (re)defines the LastModifiedDate to the time of the modification, LastModifyingUser to the IfcPersonAndOrganization making the change, and sets the LastModifyingApplication to Application B. When Application A receives this modified dataset, it can determine which objects have been added and modified by Application B and either merge or reject these changes as necessary. Consequently, the intent is that an application only modifies the value of IfcChangeActionEnum when it does something to the object, with the further intent that a model server is responsible for clearing the IfcChangeActionEnum back to NOCHANGE when it is ready to be republished.

HISTORY: New enumeration in IFC R2.0. Modified in IFC2x4.

Values:

enumerator IfcChangeAction_NOCHANGE
enumerator IfcChangeAction_MODIFIED
enumerator IfcChangeAction_ADDED
enumerator IfcChangeAction_DELETED
enumerator IfcChangeAction_MODIFIEDADDED
enumerator IfcChangeAction_MODIFIEDDELETED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcChillerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcChillerType defines commonly shared information for occurrences of chillers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a chiller specification (i.e. the specific product information, that is common to all occurrences of that product type). Chiller types may be exchanged without being already assigned to occurrences. Occurrences of IfcChillerType are represented by instances of IfcChiller.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ChillerTypeCommon

Material Use Definition The material of the IfcChillerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Refrigerant’: Refrigerant material.

Composition Use Definition The IfcChillerType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcChillerType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

(All Types): May contain IfcDistributionElement components. Chillers may aggregate distribution flow elements forming a refrigeration cycle (compressor, condenser, valve, evaporator), as well as control elements.

Port Use Definition The distribution ports relating to the IfcChillerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcChiller for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcChillerType> list

Public Functions

::Ifc2x3::IfcChillerTypeEnum::Value PredefinedType() const

Defines the typical types of chillers (e.g., air-cooled, water-cooled, etc.).

void setPredefinedType(::Ifc2x3::IfcChillerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcChillerType(IfcEntityInstanceData *e)
IfcChillerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcChillerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcChillerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of Chillers classified by their method of heat rejection. The IfcChillerTypeEnum contains the following:

AIRCOOLED: Air cooled chiller. WATERCOOLED: Water cooled chiller. HEATRECOVERY: Heat recovery chiller. USERDEFINED: User-defined chiller type. NOTDEFINED: Undefined chiller type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcChillerType_AIRCOOLED
enumerator IfcChillerType_WATERCOOLED
enumerator IfcChillerType_HEATRECOVERY
enumerator IfcChillerType_USERDEFINED
enumerator IfcChillerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCircle : public Ifc2x3::IfcConic

Definition from ISO/CD 10303-42:1992: An IfcCircle is defined by a radius and the location and orientation of the circle. Interpretation of data should be as follows:

C = SELF\IfcConic.Position.Location x = SELF\IfcConic.Position.P[1] y = SELF\IfcConic.Position.P[2] z = SELF\IfcConic.Position.P[3] R = Radius

and the circle is parameterized as

The parameterization range is 0 £ u £2p (or 0 £u £ 360 degree). In the placement coordinate system defined above, the circle is the equation C = 0, where

The positive sense of the circle at any point is in the tangent direction, T, to the curve at the point, where

NOTE A circular arc is defined by using the trimmed curve (IfcTrimmedCurve) entity in conjunction with the circle (IfcCircle) entity as the BasisCurve.

NOTE Corresponding ISO 10303 entity: circle, please refer to ISO/IS 10303-42:1994, p. 38 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Figure 278 illustrates the definition of the IfcCircle within the (in this case three-dimensional) position coordinate system.

Figure 278 — Circle geometry

Public Types

typedef IfcTemplatedEntityList<IfcCircle> list

Public Functions

double Radius() const

The radius of the circle, which shall be greater than zero.

void setRadius(double v)
const IfcParse::entity &declaration() const
IfcCircle(IfcEntityInstanceData *e)
IfcCircle(::Ifc2x3::IfcAxis2Placement *v1_Position, double v2_Radius)

Public Static Functions

const IfcParse::entity &Class()
class IfcCircleHollowProfileDef : public Ifc2x3::IfcCircleProfileDef

IfcCircleHollowProfileDef defines a section profile that provides the defining parameters of a circular hollow section (tube) to be used by the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration.The centre of the position coordinate system is in the profile’s centre of the bounding box (for symmetric profiles identical with the centre of gravity).

HISTORY New entity in IFC2x2.

Figure 312 illustrates parameters of the circular hollow profile definition. The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (for example, upper-left bound). The parameterized profile is defined by a set of parameter attributes.

Figure 312 — Circle hollow profile

Public Functions

double WallThickness() const

Thickness of the material, it is the difference between the outer and inner radius.

void setWallThickness(double v)
const IfcParse::entity &declaration() const
IfcCircleHollowProfileDef(IfcEntityInstanceData *e)
IfcCircleHollowProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Radius, double v5_WallThickness)

Public Static Functions

const IfcParse::entity &Class()
class IfcCircleProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcCircleProfileDef defines a circle as the profile definition used by the swept surface geometry or by the swept area solid. It is given by its Radius attribute and placed within the 2D position coordinate system, established by the Position attribute.

HISTORY New class in IFC 1.5.

Figure 313 illustrates parameters for the circle profile definition. The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

Or in case of sectioned spines, it is the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (e.g. upper-left bound). The Position attribute defines the 2D position coordinate system of the circle. The Radius attribute defines the radius of the circle.

Figure 313 — Circle profile

Subclassed by Ifc2x3::IfcCircleHollowProfileDef

Public Types

typedef IfcTemplatedEntityList<IfcCircleProfileDef> list

Public Functions

double Radius() const

The radius of the circle.

void setRadius(double v)
const IfcParse::entity &declaration() const
IfcCircleProfileDef(IfcEntityInstanceData *e)
IfcCircleProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Radius)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassification : public IfcUtil::IfcBaseEntity

An IfcClassification is used for the arrangement of objects into a class or category according to a common purpose or their possession of common characteristics. A classification in the sense of IfcClassification is taxonomy, or taxonomic scheme, arranged in a hierarchical structure. A category of objects relates to other categories in a generalization-specialization relationship. Therefore the classification items in an classification are organized in a tree structure.

HISTORY New class in IFC Release 1.5. Modified in IFC 2x.

IFC 2x4 CHANGE Attribute Edition made optional. Attributes: PublicationLocation, Description and ReferenceTokens added. Inverse attribute HasClassificationReferences added.

Classification use definitions IfcClassification identifies the classification system or source from which a classification notation is derived. Each classification reference or classification item, belonging to a single classification system, shall reference a single instance of IfcClassification. Therefore, each particular classification system or source used should have only one IfcClassification instance. However, because multiple classification is allowed, there may be many IfcClassification objects used, each identifying a different classification system or source.

A classification system declared may be either formally published (such as Omniclass, Uniclass, Masterformat, or DIN) or it may be a locally defined method of classifiying information. There are two methods to define a classification system within an IFC dataset:

Including the classification system structure within the dataset: Here a hierarchical tree of IfcClassificationItem’s is included that defines the classification system including the relationship between the classification items. An IfcClassificationNotation is used to classify an object. Referencing the classification system by a classification key or id: Here the IfcClassificationReference is used to assign a classification id or key to each classified object.

Public Types

typedef IfcTemplatedEntityList<IfcClassification> list

Public Functions

std::string Source() const

Source (or publisher) for this classification.

NOTE that the source of the classification means the person or organization that was the original author or the person or organization currently acting as the publisher.

void setSource(std::string v)
std::string Edition() const

The edition or version of the classification system from which the classification notation is derived.

NOTE the version labeling system is specific to the classification system.

IFC2x4 CHANGE The attribute has been changed to be optional.

void setEdition(std::string v)
bool hasEditionDate() const

Whether the optional attribute EditionDate is defined for this IfcClassification.

::Ifc2x3::IfcCalendarDate *EditionDate() const

The date on which the edition of the classification used became valid.

NOTE The indication of edition may be sufficient to identify the classification source uniquely but the edition date is provided as an optional attribute to enable more precise identification where required.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setEditionDate(::Ifc2x3::IfcCalendarDate *v)
std::string Name() const

The name or label by which the classification used is normally known.

NOTE Examples of names include CI/SfB, Masterformat, BSAB, Uniclass, STABU, DIN276, DIN277 etc.

void setName(std::string v)
IfcTemplatedEntityList<IfcClassificationItem>::ptr Contains() const
const IfcParse::entity &declaration() const
IfcClassification(IfcEntityInstanceData *e)
IfcClassification(std::string v1_Source, std::string v2_Edition, ::Ifc2x3::IfcCalendarDate *v3_EditionDate, std::string v4_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassificationItem : public IfcUtil::IfcBaseEntity

Public Types

typedef IfcTemplatedEntityList<IfcClassificationItem> list

Public Functions

::Ifc2x3::IfcClassificationNotationFacet *Notation() const
void setNotation(::Ifc2x3::IfcClassificationNotationFacet *v)
bool hasItemOf() const

Whether the optional attribute ItemOf is defined for this IfcClassificationItem.

::Ifc2x3::IfcClassification *ItemOf() const
void setItemOf(::Ifc2x3::IfcClassification *v)
std::string Title() const
void setTitle(std::string v)
IfcTemplatedEntityList<IfcClassificationItemRelationship>::ptr IsClassifiedItemIn() const
IfcTemplatedEntityList<IfcClassificationItemRelationship>::ptr IsClassifyingItemIn() const
const IfcParse::entity &declaration() const
IfcClassificationItem(IfcEntityInstanceData *e)
IfcClassificationItem(::Ifc2x3::IfcClassificationNotationFacet *v1_Notation, ::Ifc2x3::IfcClassification *v2_ItemOf, std::string v3_Title)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassificationItemRelationship : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcClassificationItem *RelatingItem() const
void setRelatingItem(::Ifc2x3::IfcClassificationItem *v)
IfcTemplatedEntityList<::Ifc2x3::IfcClassificationItem>::ptr RelatedItems() const
void setRelatedItems(IfcTemplatedEntityList<::Ifc2x3::IfcClassificationItem>::ptr v)
const IfcParse::entity &declaration() const
IfcClassificationItemRelationship(IfcEntityInstanceData *e)
IfcClassificationItemRelationship(::Ifc2x3::IfcClassificationItem *v1_RelatingItem, IfcTemplatedEntityList<::Ifc2x3::IfcClassificationItem>::ptr v2_RelatedItems)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassificationNotation : public IfcUtil::IfcBaseEntity

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcClassificationNotationFacet>::ptr NotationFacets() const
void setNotationFacets(IfcTemplatedEntityList<::Ifc2x3::IfcClassificationNotationFacet>::ptr v)
const IfcParse::entity &declaration() const
IfcClassificationNotation(IfcEntityInstanceData *e)
IfcClassificationNotation(IfcTemplatedEntityList<::Ifc2x3::IfcClassificationNotationFacet>::ptr v1_NotationFacets)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassificationNotationFacet : public IfcUtil::IfcBaseEntity

Public Functions

std::string NotationValue() const
void setNotationValue(std::string v)
const IfcParse::entity &declaration() const
IfcClassificationNotationFacet(IfcEntityInstanceData *e)
IfcClassificationNotationFacet(std::string v1_NotationValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcClassificationReference : public Ifc2x3::IfcExternalReference

An IfcClassificationReference is a reference into a classification system or source (see IfcClassification) for a specific classification key (or notation).

The inherited attributes have the following meaning:

Identification: holds the key provided for a specific references to classification items (or tables). Name: allows for a human interpretable designation of a classification notation. Location: optionally holds a direct URI link into the classification system (or source) to hyperlink the classification key.

The IfcClassificationReference can either be assigned directly to the IfcClassification, such as if no classification hierarchy has to be included, or it references the parent classification notation, if the fully classification hierarchy is included in the data set. The attribute ReferencedSource then holds the following information (choice by IfcClassificationReferenceSelect):

being of type IfcClassification: direct reference to the classification system (with meta information provided), used for highest level of classification notations, or if the classification notation hierarchy is not relevant, being of type IfcClassificationReference: reference to the parent classification notation within the classification hierarchy.

HISTORY New entity in IFC 2x.

IFC2x4 CHANGE The attribute Description and inverse attribute HasReferences are added. The attribute Identification has been renamed from ItemReference.

Use definitions The IfcClassificationReference can be used to only assign classification keys to objects, or to hold a fully classification hierarchy. The first is refered to as “lightweight classification”, and the second as “full classification”

The IfcClassificationReference can be used as a form of ‘lightweight’ classification through the ‘Identification’ attribute inherited from the abstract IfcExternalReference class. In this case, the ‘Identification’ could take (for instance) the Uniclass notation “L6814” which, if the classification was well understood by all parties and was known to be taken from a particular classification source, would be sufficient. The Name attribute could be the title “Tanking”. This would remove the need for the overhead of the more complete classification structure of the model.

Public Functions

bool hasReferencedSource() const

Whether the optional attribute ReferencedSource is defined for this IfcClassificationReference.

::Ifc2x3::IfcClassification *ReferencedSource() const

The classification system or source that is referenced.

void setReferencedSource(::Ifc2x3::IfcClassification *v)
const IfcParse::entity &declaration() const
IfcClassificationReference(IfcEntityInstanceData *e)
IfcClassificationReference(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name, ::Ifc2x3::IfcClassification *v4_ReferencedSource)

Public Static Functions

const IfcParse::entity &Class()
class IfcClosedShell : public Ifc2x3::IfcConnectedFaceSet

Definition from ISO/CD 10303-42:1992: A closed shell is a shell of the dimensionality 2 which typically serves as a bound for a region in R3. A closed shell has no boundary, and has non-zero finite extent. If the shell has a domain with coordinate space R3, it divides that space into two connected regions, one finite and the other infinite. In this case, the topological normal of the shell is defined as being directed from the finite to the infinite region.

The shell is represented by a collection of faces. The domain of the shell, if present, contains all those faces, together with their bounds. Associated with each face in the shell is a logical value which indicates whether the face normal agrees with (TRUE) or is opposed to (FALSE) the shell normal. The logical value can be applied directly as a BOOLEAN attribute of an oriented face, or be defaulted to TRUE if the shell boundary attribute member is a face without the orientation attribute.

The combinatorial restrictions on closed shells and geometrical restrictions on their domains are designed to ensure that any domain associated with a closed shell is a closed, orientable manifold. The domain of a closed shell, if present, is a connected, closed, oriented 2-manifold. It is always topologically equivalent to an H-fold torus for some H ³ 0. The number H is referred to as the surface genus of the shell. If a shell of genus H has a domain within coordinate space R3, then the finite region of space inside it is topologically equivalent to a solid ball with H tunnels drilled through it. The Euler equation (7) applies with B=0, because in this case there are no holes. As in the case of open shells, the surface genus H may not be known a priori, but shall be an integer ³ 0. Thus a necessary, but not sufficient, condition for a well-formed closed shell is the following:

In the current IFC Release only poly loops (IfcPolyLoop) are defined for bounds of face bound (IfcFaceBound). This will allow for faceted B-rep only.

NOTE: Corresponding ISO 10303 entity: closed_shell, please refer to ISO/IS 10303-42:1994, p.149 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Informal propositions:

Every edge shall be referenced exactly twice by the loops of the face.

Each oriented edge shall be unique.

No edge shall be referenced by more than two faces.

Distinct faces of the shell do not intersect, but may share edges or vertices.

Distinct edges do not intersect but may share vertices.

Each face reference shall be unique.

The loops of the shell shall not be a mixture of poly loop and other loop types. Note: this is given, since only poly loop is defined as face bound definition. The closed shell shall be an oriented arcwise connected 2-manifold. The Euler equation shall be satisfied. Note: Please refer to ISO/IS 10303-42:1994, p.149 for the equation.

Public Types

typedef IfcTemplatedEntityList<IfcClosedShell> list

Public Functions

const IfcParse::entity &declaration() const
IfcClosedShell(IfcEntityInstanceData *e)
IfcClosedShell(IfcTemplatedEntityList<::Ifc2x3::IfcFace>::ptr v1_CfsFaces)

Public Static Functions

const IfcParse::entity &Class()
class IfcCoilType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcCoilType defines commonly shared information for occurrences of coils. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a coil specification (i.e. the specific product information, that is common to all occurrences of that product type). Coil types may be exchanged without being already assigned to occurrences. Occurrences of IfcCoilType are represented by instances of IfcCoil.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CoilTypeCommon Pset_CoilTypeHydronic

Material Use Definition The material of the IfcCoilType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcCoilType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCoil for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCoilType> list

Public Functions

::Ifc2x3::IfcCoilTypeEnum::Value PredefinedType() const

Defines typical types of coils (e.g., Cooling, Heating, etc.)

void setPredefinedType(::Ifc2x3::IfcCoilTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCoilType(IfcEntityInstanceData *e)
IfcCoilType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCoilTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCoilTypeEnum

Public Types

enum Value

Enumeration defining the typical types of coils.

The IfcCoilTypeEnum contains the following:

DXCOOLINGCOIL: Cooling coil using a refrigerant to cool the air stream directly.

WATERCOOLINGCOIL: Cooling coil using chilled water. HYDRONICCOIL supercedes this enumerator.

STEAMHEATINGCOIL: Heating coil using steam as heating source.

WATERHEATINGCOIL: Heating coil using hot water as a heating source. HYDRONICCOIL supercedes this enumerator.

ELECTRICHEATINGCOIL: Heating coil using electricity as a heating source.

GASHEATINGCOIL: Heating coil using gas as a heating source.

HYDRONICCOIL: Cooling or Heating coil that uses a hydronic fluid as a cooling or heating source. USERDEFINED: User-defined coil type.

NOTDEFINED: Undefined coil type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcCoilType_DXCOOLINGCOIL
enumerator IfcCoilType_WATERCOOLINGCOIL
enumerator IfcCoilType_STEAMHEATINGCOIL
enumerator IfcCoilType_WATERHEATINGCOIL
enumerator IfcCoilType_ELECTRICHEATINGCOIL
enumerator IfcCoilType_GASHEATINGCOIL
enumerator IfcCoilType_USERDEFINED
enumerator IfcCoilType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcColourRgb : public Ifc2x3::IfcColourSpecification

Definition from ISO/CD 10303-46:1992: A colour rgb as a subtype of colour specifications is defined by three colour component values for red, green, and blue in the RGB colour model.

NOTE In contrary to the usual value range of colour components being integer from 0…255, the definition from ISO10303-46 defines the colour components as real from 0.0 … 1.0. Applications need to execute this conversion before populating the colour RGB values.

NOTE Corresponding STEP name: colour_rgb. The name attribute has been omitted, the data type for the reg, green and blue parts is IfcNormalizedRatioMeasure, that already includes the range restrictions for the values. Please refer to ISO/IS 10303-46:1994, p. 138 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcColourRgb> list

Public Functions

double Red() const

The intensity of the red colour component.

NOTE The colour component value is given within the range of 0..1, and not within the range of 0..255 as otherwise usual.

void setRed(double v)
double Green() const

The intensity of the green colour component.

NOTE The colour component value is given within the range of 0..1, and not within the range of 0..255 as otherwise usual.

void setGreen(double v)
double Blue() const

The intensity of the blue colour component.

NOTE The colour component value is given within the range of 0..1, and not within the range of 0..255 as otherwise usual.

void setBlue(double v)
const IfcParse::entity &declaration() const
IfcColourRgb(IfcEntityInstanceData *e)
IfcColourRgb(boost::optional<std::string> v1_Name, double v2_Red, double v3_Green, double v4_Blue)

Public Static Functions

const IfcParse::entity &Class()
class IfcColourSpecification : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: The colour specification entity contains a direct colour definition. Colour component values refer directly to a specific colour space.

NOTE Corresponding ISO 10303 name: colour_specification. It has been made into an abstract entity in IFC. Please refer to ISO/IS 10303-46:1994, p. 138 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Subclassed by Ifc2x3::IfcColourRgb

Public Types

typedef IfcTemplatedEntityList<IfcColourSpecification> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcColourSpecification.

std::string Name() const

Optional name given to a particular colour specification in addition to the colour components (like the RGB values).

NOTE Examples are the names of a industry colour classification, such as RAL. IFC2x Edition 3 CHANGE Attribute added.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcColourSpecification(IfcEntityInstanceData *e)
IfcColourSpecification(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcColumn : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Structural member of slender form, usually vertical, that transmits to its base the forces, primarily in compression, that are applied to it. <An IfcColumn is a vertical structural member which often is aligned with a structural grid intersection. It represents a vertical, or nearly vertical, structural member that transmits, through compression, the weight of the structure above to other structural elements below. It represents such a member from an architectural point of view. It is not required to be load bearing. NOTE The representation of a column in a structural analysis model is provided by IfcStructuralCurveMember being part of an IfcStructuralAnalysisModel.

NOTE For any longitudial structural member, not constrained to be predominately horizontal nor vertical, or where this semantic information is irrelevant, the entity IfcMember exists. The IFC specification provides two entities for column occurrences:

IfcColumnStandardCase used for all occurrences of columns, tthat have a profile defined that is swept along a directrix. The profile might be changed uniformly by a taper definition along the directrix. The profile parameter and its cardinal point of insertion can be fully described by the IfcMaterialProfileSetUsage. These beams are always represented geometricly by an ‘Axis’ and a ‘SweptSolid’ or ‘AdvancedSweptSolid’ shape representation (or by a ‘Clipping’ geometry based on the swept solid), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialProfileSetUsage assigned. NOTE View definitions and implementer agreements may further constrain the applicable geometry types, e.g. by excluding tapering from an IfcColumnStandardCase implementation.

IfcColumn used for all other occurrences of columns, particularly for columns with changing profile sizes along the extrusion, or columns defined by non-linear extrusion, or columns having only ‘Brep’, or ‘SurfaceModel’ geometry.

HISTORY New entity in IFC Release 1.0

Type Use Definition IfcColumn defines the occuurence of any column, common information about column types (or styles) is handled by IfcColumnType. The IfcColumnType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcColumnType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcColumnType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcColumn is defined by the IfcMaterialProfileSet or as fallback by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterialProfileSetUsage to an IfcColumn. Only the subtype IfcColumnStandardCase supports this concept. Material information can also be given at the IfcColumnType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcColumnType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterialProfileSet or IfcMaterial. If both are given, then the material directly assigned to IfcColumn overrides the material assigned to IfcColumnType. Property Set Use Definition: The property sets relating to the IfcColumn are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcColumn are part of this IFC release:

Pset_ColumnCommon: common property set for all column occurrences

Property sets can also be given at the IfcColumnType, defining the common property data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcColumnType.HasPropertySets. If both are given, then the properties directly assigned to IfcColumn overrides the properties assigned to IfcColumnType. Quantity Use Definition: The quantities relating to the IfcColumn are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.MethodOfMeasurement = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quanties shall be never assigned to the IfcColumnType.

Qto_ColumnBaseQuantities: base quantities for all column occurrences.

Containment Use Definition The IfcColumn, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcColumn, is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcColumn, may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcColumn is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local Placement The local placement for IfcColumn is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Axis’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Axis Representation The axis geometric representation of IfcColumn is defined using the ‘Axis’ representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’, ‘Curve3D’

The axis representation can be used to represent the system length of a column that may extent the body length of the column. Body Representation The body representation of IfcColumn can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘MappedRepresentation’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation:

Solid: IfcExtrudedAreaSolid, IfcRevolvedAreaSolid shall be supported Profile: all subtypes of IfcProfileDef (with exception of IfcArbitraryOpenProfileDef) Extrusion:All extrusion directions shall be supported

Figure 81 illustrates a ‘SweptSolid’ geometric representation. There are no restrictions or conventions on how to use the local placement (black), solid of extrusion placement (red) and profile placement (green).

Figure 81 — Column swept solid

Figure 82 illustrates use of a special profile type (here IfcIShapeProfileDef) for the definition of the IfcExtrudedAreaSolid.

Figure 82 — Column extrusion of I-Shape

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The following constraints apply to the advanced representation:

Solid: see ‘SweptSolid’ geometric representation Profile: see ‘SweptSolid’ geometric representation Extrusion: see ‘SweptSolid’ geometric representation Boolean result: The IfcBooleanClippingResult shall be supported, allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid.

Figure 83 illustrates a ‘Clipping’ geometric representation with use of IfcBooleanClippingResult between an IfcExtrudedAreaSolid and an IfcHalfSpaceSolid to create a clipped body.

Figure 83 — Column clipping

AdvancedSweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘AdvancedSweptSolid’

The following additional constraints apply to the ‘AdvancedSweptSolid’ representation type:

Solid: IfcSurfaceCurveSweptAreaSolid, IfcFixedReferenceSweptAreaSolid, IfcExtrudedAreaSolidTapered, IfcRevolvedAreaSolidTapered shall be supported. NOTE View definitions and implementer agreements can further constrain the allowed swept solid types.

Profile: see ‘SweptSolid’ geometric representation Extrusion:not applicable

MappedRepresentation Representation Type The ‘MappedRepresentation’ representation type is supported as it allows for reusing the geometry definition of the beam type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘SurfaceModel’ and ‘Bre’ geometric representation, shall apply to the MappedRepresentation of the IfcRepresentationMap.

Public Types

typedef IfcTemplatedEntityList<IfcColumn> list

Public Functions

const IfcParse::entity &declaration() const
IfcColumn(IfcEntityInstanceData *e)
IfcColumn(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcColumnType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type IfcColumnType defines commonly shared information for occurrences of columns. The set of shared information may include:

common properties within shared property sets common material information common profile definitions common shape representations

It is used to define a column specification, or column style (i.e. the specific product information that is common to all occurrences of that column type). Column types may be exchanged without being already assigned to occurrences. Occurrences of the IfcColumnType within building models are represented by instances of IfcColumnStandardCase if the IfcColumnType has a single associated IfcMaterialProfileSet; otherwise they are represented by instances of IfcColumn. Occurrences of the IfcColumnType within structural analysis models are represented by instances of IfcStructuralCurveMember, or its applicable subtypes. HISTORY New entity in Release IFC2x Edition 2. Material Use Definition The material of the IfcColumnType is defined by the IfcMaterialProfileSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcColumnType, if there is at least one occurrences of IfcColumnStandardCase for this type. Property Set Use Definition: The shared property sets relating to the IfcColumnType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcColumnType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcColumnType and those that are only assignable to IfcColumn. If the same property is assigned to the IfcColumnType and the IfcColumn being an occurrence of the IfcColumnType, then the occurrence property overrides the type property.

Pset_ColumnCommon: common property set for all column types.

Profile Use Definition: The shared profile definition is defined by assigning an IfcMaterialProfileSet (see material use definition above). The IfcMaterialProfile refers to the subtype of IfcProfileDef that is the common profile for all column occurrence, if used. It is only applicable if the IfcColumnType has only occurrences of type IfcColumnStandardCase (see definition of IfcColumnStandardCase for further information). NOTE The attribute ProfileName of the IfcProfileDef subtype, referenced in IfcMaterialProfile should contain a standardized profile name according to local standards. However, an additional geometric representation of the profile is necessary (e.g. as IfcExtrudedAreaSolid). An importing application is allowed to check for the existence of the profile name: in case of identifying it as a standardized name, the corresponding profile geometry and possibly other cross sectional properties can be read from a library. Otherwise the geometric representation and possible non geometric IfcProfileProperties have to be used. Geometry Use Definition: The IfcColumnType may define the shared geometric representation for all column occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘Axis’, or ‘Body’). It is only applicable if the IfcColumnType has only occurrences of type IfcColumn (See geometric use definition of IfcColumn for further information). NOTE If the IfcColumnType has an associated IfcMaterialProfileSet, then no shared geometric representation shall be provided. NOTE The product shape representations are defined as RepresentationMaps (attribute of the supertype IfcTypeProduct), which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[n] being an IfcMappedItem. See IfcTypeProduct for further information. NOTE The values of attributes RepresentationIdentifier and RepresentationType of IfcShapeRepresentation are restricted in the same way as those for IfcColumn and IfcColumnStandardCase

Public Types

typedef IfcTemplatedEntityList<IfcColumnType> list

Public Functions

::Ifc2x3::IfcColumnTypeEnum::Value PredefinedType() const

Identifies the predefined types of a column element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcColumnTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcColumnType(IfcEntityInstanceData *e)
IfcColumnType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcColumnTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcColumnTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of linear elements an IfcColumnType object can fulfill:

COLUMN: A standard column element usually used vertically. USERDEFINED: User-defined linear element. NOTDEFINED: Undefined linear element

NOTE: This enumeration has been mainly introduced to allow further detailing of the type information in future releases of IFC. HISTORY New Enumeration in Release IFC2x Edition 2.

Values:

enumerator IfcColumnType_COLUMN
enumerator IfcColumnType_USERDEFINED
enumerator IfcColumnType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcComplexNumber : public IfcUtil::IfcBaseType

IfcComplexNumber is a representation of a complex number expressed as an array with two elements. The first element (index 1) denotes the real component which is the numerical component of a complex number whose square roots can be calculated explicitly. The second element (index 2) denotes the imaginary component which is the numerical component of a complex number whose square roots cannot be determined other than through the provision of the square of the imaginary number j where j^2 = -1. Note that the imaginary component may be referred to as i in certain references.

Type: ARRAY [1:2] OF REAL

HISTORY New type in IFC Release 2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcComplexNumber(IfcEntityInstanceData *e)
IfcComplexNumber(std::vector<double> v)
operator std::vector<double>() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcComplexProperty : public Ifc2x3::IfcProperty

IfcComplexProperty is used to define complex properties to be handled completely within a property set. The included set of properties may be a mixed or consistent collection of IfcProperty subtypes. This enables the definition of a set of properties to be included as a single ‘property’ entry in an IfcPropertySet. The definition of such an IfcComplexProperty can be reused in many different IfcPropertySet’s.

NOTE Since an IfcComplexProperty may contain other complex properties, sets of properties can be nested. This nesting may be restricted by view definitions and implementer agreements.

HISTORY New Entity in IFC Release 2.0, capabilities enhanced in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcComplexProperty> list

Public Functions

std::string UsageName() const

Usage description of the IfcComplexProperty within the property set which references the IfcComplexProperty. NOTE: Consider a complex property for glazing properties. The Name attribute of the IfcComplexProperty could be Pset_GlazingProperties, and the UsageName attribute could be OuterGlazingPane.

void setUsageName(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr HasProperties() const

Set of properties that can be used within this complex property (may include other complex properties).

void setHasProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
const IfcParse::entity &declaration() const
IfcComplexProperty(IfcEntityInstanceData *e)
IfcComplexProperty(std::string v1_Name, boost::optional<std::string> v2_Description, std::string v3_UsageName, IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v4_HasProperties)

Public Static Functions

const IfcParse::entity &Class()
class IfcCompositeCurve : public Ifc2x3::IfcBoundedCurve

Definition from ISO/CD 10303-42:1992: A composite curve is a collection of curves joined end-to-end. The individual segments of the curve are themselves defined as composite curve segments. The parameterization of the composite curve is an accumulation of the parametric ranges of the referenced bounded curves. The first segment is parameterized from 0 to l1 and for i ≤ 2, the ith segment is parameterized from:

where lk is the parametric length (i.e., difference between maximum and minimum parameter values) of the curve underlying the kth segment.

Let T denote the parameter for the composite curve. Then, if the ith segment is not a reparameterised composite curve segment, T is related to the parameter ti; ti0 ≤ ti ≤ ti1; for the ith segment by the equation:

if Segments[i].SameSense = TRUE;

or by the equation:

if Segments[i].SameSense = FALSE;

If the segments[i] is of type reparameterised composite curve segment,

where τ is defined at reparameterized composite curve segment (see IfcReparameterizedCompositeCurveSegment).

Figure 279 illustrates an example of a composite curve.

Figure 279 — Composite curve

Consider an IfcCompositeCurve having line segment and an arc segment. The line should be parameterized:

IfcPolyline with start= 0.,0. end= 0.,1., SameSense= TRUE, parametric length = 1.

The arch should be parameterized:

IfcTrimmedCurve with start= 180’, end= 90’, SameSense= FALSE, parametric length = 90.

Then the parameterization of the composite curve is:

IfcCompositeCurve with 0. ≤ T ≤ 1. (line segment) and 1. ≤ T ≤ 91. (arc segment), parametric length = 91.

NOTE Corresponding ISO 10303 entity: composite_curve, please refer to ISO/IS 10303-42:1994, p. 56 for the final definition of the formal standard. The WR2 is added to ensure consistent Dim at all segments.

HISTORY New class in IFC Release 1.0

Informal Propositions:

The SameSense attribute of each segment correctly specifies the senses of the component curves. When traversed in the direction indicated by SameSense, the segments shall join end-to-end.

Subclassed by Ifc2x3::Ifc2DCompositeCurve

Public Types

typedef IfcTemplatedEntityList<IfcCompositeCurve> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcCompositeCurveSegment>::ptr Segments() const

The component bounded curves, their transitions and senses. The transition attribute for the last segment defines the transition between the end of the last segment and the start of the first; this transition attribute may take the value discontinuous, which indicates an open curve.

void setSegments(IfcTemplatedEntityList<::Ifc2x3::IfcCompositeCurveSegment>::ptr v)
bool SelfIntersect() const

Indication of whether the curve intersects itself or not; this is for information only.

void setSelfIntersect(bool v)
const IfcParse::entity &declaration() const
IfcCompositeCurve(IfcEntityInstanceData *e)
IfcCompositeCurve(IfcTemplatedEntityList<::Ifc2x3::IfcCompositeCurveSegment>::ptr v1_Segments, bool v2_SelfIntersect)

Public Static Functions

const IfcParse::entity &Class()
class IfcCompositeCurveSegment : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A composite curve segment is a bounded curve together with transition information which is used to construct a composite curve (IfcCompositeCurve).

The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem). The IfcCompositeCurveSegment is a subtype of IfcGeometricRepresentationItem (whereas in ISO 10303-42 composite_curve_segment is not a subtype of geometric_representation_item, the proposed 2nd edition of ISO 10303-42 however proposes the subtype relationship).

NOTE Corresponding ISO 10303 entity: composite_curve_segment. Please refer to ISO/IS 10303-42:1994, p.57 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Public Functions

::Ifc2x3::IfcTransitionCode::Value Transition() const

The state of transition (i.e., geometric continuity from the last point of this segment to the first point of the next segment) in a composite curve.

void setTransition(::Ifc2x3::IfcTransitionCode::Value v)
bool SameSense() const

An indicator of whether or not the sense of the segment agrees with, or opposes, that of the parent curve. If SameSense is false, the point with highest parameter value is taken as the first point of the segment.

NOTE If the datatype of ParentCurve is IfcTrimmedCurve, the value of SameSense overrides the value of IfcTrimmedCurve.SenseAgreement

void setSameSense(bool v)
::Ifc2x3::IfcCurve *ParentCurve() const

The bounded curve which defines the geometry of the segment.

void setParentCurve(::Ifc2x3::IfcCurve *v)
IfcTemplatedEntityList<IfcCompositeCurve>::ptr UsingCurves() const
const IfcParse::entity &declaration() const
IfcCompositeCurveSegment(IfcEntityInstanceData *e)
IfcCompositeCurveSegment(::Ifc2x3::IfcTransitionCode::Value v1_Transition, bool v2_SameSense, ::Ifc2x3::IfcCurve *v3_ParentCurve)

Public Static Functions

const IfcParse::entity &Class()
class IfcCompositeProfileDef : public Ifc2x3::IfcProfileDef

The IfcCompositeProfileDef defines the profile by composition of other profiles. The composition is given by a set of at least two other profile definitions. Any profile definition (except for another composite profile) can be used to construct the composite.

HISTORY New entity in IFC2x.

Figure 314 illustrates the composite profile definition. The IfcCompositeProfileDef does not define an own position coordinate system, it is directly defined in the underlying coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

Or in case of sectioned spines it is the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. The IfcCompositeProfileDef is defined using other profile definitions. Those other profile definitions are directly inserted into the underlying coordinate system.

In case of parameterized profile definitions, the Position attribute of those standard profiles is used to place the profiles relatively to each other. In case of arbitrary profile definitions, each Cartesian coordinate is given directly within the underlying coordinate system.

NOTE The black coordinate axes show the underlying coordinate system of the swept surface or swept area solid.

Figure 314

Twin profiles special case

If twin profiles are modeled by profile composition, the base profile should only be specified once. It is then included into the composite profile directly and additionally indirectly via IfcMirroredProfileDef. For example, a double angle made of two L100x10 with 10mm air gap between them, i.e. a _||_ shape, can be modeled as

single_L : IfcLShapeProfileDef := IfcLShapeProfileDef(AREA, ‘L100X100X10’, IfcAxis2Placement2D(IfcCartesianPoint(((.100+.010)/2., .0)), ?), .100, .100, .010, .012, ?, 0., ?, ?); double_L : IfcCompositeProfileDef := IfcCompositeProfileDef(AREA, ‘double angle’, (single_L, IfcMirroredProfileDef(AREA, ?, single_L, ?)), ‘twin profile’);

Public Types

typedef IfcTemplatedEntityList<IfcCompositeProfileDef> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr Profiles() const

The profiles which are used to define the composite profile.

void setProfiles(IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr v)
bool hasLabel() const

Whether the optional attribute Label is defined for this IfcCompositeProfileDef.

std::string Label() const

The name by which the composition may be referred to. The actual meaning of the name has to be defined in the context of applications.

void setLabel(std::string v)
const IfcParse::entity &declaration() const
IfcCompositeProfileDef(IfcEntityInstanceData *e)
IfcCompositeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr v3_Profiles, boost::optional<std::string> v4_Label)

Public Static Functions

const IfcParse::entity &Class()
class IfcCompoundPlaneAngleMeasure : public IfcUtil::IfcBaseType

IfcCompoundPlaneAngleMeasure is a compound measure of plane angle in degrees, minutes, seconds, and optionally millionth-seconds of arc.

NOTE: IfcCompoundPlaneAngleMeasure is used where angles need to be described to an accuracy as fine as one millionth of a degree and expressed as parts of an arc. It may be used for angular measurement by surveyors or for other angular measurements where precision is required. Another usage is exact or approximate global positioning against a geographic coordinate systems using longitude and latitude.

NOTE: While the unit of measurement of the type IfcPlaneAngleMeasure depends on unit assignment (radian or degree or other derived units; globally at the IfcPoject or locally at an IfcMeasureWithUnit), the units of IfcCompoundPlaneAngleMeasure are always degrees, minutes, seconds, and millionth-seconds irrespective of unit assignments.

HISTORY New type in IFC Release 1.5.1.

Type: LIST [3:4] OF INTEGER

Value restrictions

The first integer measure is the number of degrees and is generally not range-restricted. However, when IfcCompoundPlaneAngleMeasure is used to express geographic coordinates, only latitudes of [-90, 90] and longitudes of [-180, 180] are used in practice. The second integer measure is the number of minutes and shall be in the range (-60, 60). The third integer measure is the number of seconds and shall be in the range (-60, 60). The optional fourth integer measure is the number of millionth-seconds and shall be in the range (-1 000 000, 1 000 000).

Signedness

All measure components have the same sign (positive or negative). It is therefore trivial to convert between floating point representation (decimal degrees) and compound representation regardless whether the angle is greater or smaller than zero. Example:

LOCAL a : IfcPlaneAngleMeasure := -50.975864; (* decimal degrees, -50° 58’ 33” 110400 *) b : IfcPlaneAngleMeasure; c : IfcCompoundPlaneAngleMeasure; s : IfcText; END_LOCAL;

(* convert from float to compound *) c[1] := a; -50 c[2] := (a - c[1]) * 60; -58 c[3] := ((a - c[1]) * 60 - c[2]) * 60; -33 c[4] := (((a - c[1]) * 60 - c[2]) * 60 - c[3]) * 1.e6; -110400

(* convert from compound to float *) b := c[1] + c[2]/60. + c[3]/3600. + c[4]/3600.e6; -50.975864

Use in string representations

When a compound plane angle measure is formatted for display or printout, the signs of the fractional components will usually be discarded because, to a human reader, the sign of the first component alone already indicates the sense of the angle:

(* convert from compound to human-readable string *) s := FORMAT(c[1], ‘+##’) + “000000B0” + FORMAT(ABS(c[2]), ‘##’) + ‘’’’ + FORMAT(ABS(c[3]), ‘##’) + ‘”’ + FORMAT(ABS(c[4]), ‘##’); – -50° 58’ 33” 110400

Another often encountered display format of latitudes and longitudes is to omit the signs and print N, S, E, W indicators instead, for example, 50°58’33”S. When stored as IfcCompoundPlaneAngleMeasure however, a compound plane angle measure is always signed, with same sign of all components.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcCompoundPlaneAngleMeasure(IfcEntityInstanceData *e)
IfcCompoundPlaneAngleMeasure(std::vector<int> v)
operator std::vector<int>() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcCompressorType : public Ifc2x3::IfcFlowMovingDeviceType

The flow moving device type IfcCompressorType defines commonly shared information for occurrences of compressors. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a compressor specification (i.e. the specific product information, that is common to all occurrences of that product type). Compressor types may be exchanged without being already assigned to occurrences. Occurrences of IfcCompressorType are represented by instances of IfcCompressor.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowMovingDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CompressorTypeCommon

Material Use Definition The material of the IfcCompressorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed. ‘Refrigerant’: Refrigerant material.

Port Use Definition The distribution ports relating to the IfcCompressorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCompressor for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCompressorType> list

Public Functions

::Ifc2x3::IfcCompressorTypeEnum::Value PredefinedType() const

Defines the type of compressor (e.g., hermetic, reciprocating, etc.).

void setPredefinedType(::Ifc2x3::IfcCompressorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCompressorType(IfcEntityInstanceData *e)
IfcCompressorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCompressorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCompressorTypeEnum

Public Types

enum Value

Types of compressors. The IfcCompressorTypeEnum contains the following:

DYNAMIC: The pressure of refrigerant vapor is increased by a continuous transfer of angular momentum from a rotating member to the vapor followed by conversion of this momentum into static pressure. RECIPROCATING: Positive-displacement compressor using a piston driven by a connecting rod from a crankshaft. ROTARY: Positive-displacement compressor using a roller or rotor device. SCROLL: Positive-displacement compressor using two inter-fitting, spiral-shaped scroll members. TROCHOIDAL: Positive-displacement compressor using a rolling motion of one circle outside or inside the circumference of a basic circle and produce either epitrochoids or hypotrochoids. SINGLESTAGE: Positive-displacement reciprocating compressor where vapor is compressed in a single stage. BOOSTER: Positive-displacement reciprocating compressor where pressure is increased by a booster. OPENTYPE: Positive-displacement reciprocating compressor where the shaft extends through a seal in the crankcase for an external drive. HERMETIC: Positive-displacement reciprocating compressor where the motor and compressor are contained within the same housing, with the motor shaft integral with the compressor crankshaft and the motor in contact with refrigerant. SEMIHERMETIC: Positive-displacement reciprocating compressor where the hermetic compressors use bolted construction amenable to field repair. WELDEDSHELLHERMETIC: Positive-displacement reciprocating compressor where the motor compressor is mounted inside a steel shell, which, in turn is sealed by welding. ROLLINGPISTON: Positive-displacement rotary compressor using a roller mounted on the eccentric of a shaft with a single vane in the nonrotating cylindrical housing. ROTARYVANE: Positive-displacement rotary compressor using a roller mounted on the eccentric of a shaft with multiple vanes in the nontotating cylindrical housing. SINGLESCREW: Positive-displacement rotary compressor using a single cylindrical main rotor that works with a pair of gate rotors. TWINSCREW: Positive-displacement rotary compressor using two mating helically grooved rotors, male (lobes) and female (flutes) in a stationary housing with inlet and outlet gas ports. USERDEFINED: User-defined compressor type. NOTDEFINED: Undefined compressor type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcCompressorType_DYNAMIC
enumerator IfcCompressorType_RECIPROCATING
enumerator IfcCompressorType_ROTARY
enumerator IfcCompressorType_SCROLL
enumerator IfcCompressorType_TROCHOIDAL
enumerator IfcCompressorType_SINGLESTAGE
enumerator IfcCompressorType_BOOSTER
enumerator IfcCompressorType_OPENTYPE
enumerator IfcCompressorType_HERMETIC
enumerator IfcCompressorType_SEMIHERMETIC
enumerator IfcCompressorType_WELDEDSHELLHERMETIC
enumerator IfcCompressorType_ROLLINGPISTON
enumerator IfcCompressorType_ROTARYVANE
enumerator IfcCompressorType_SINGLESCREW
enumerator IfcCompressorType_TWINSCREW
enumerator IfcCompressorType_USERDEFINED
enumerator IfcCompressorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCondenserType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcCondenserType defines commonly shared information for occurrences of condensers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a condenser specification (i.e. the specific product information, that is common to all occurrences of that product type). Condenser types may be exchanged without being already assigned to occurrences. Occurrences of IfcCondenserType are represented by instances of IfcCondenser.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CondenserTypeCommon

Material Use Definition The material of the IfcCondenserType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Refrigerant’: Refrigerant material.

Port Use Definition The distribution ports relating to the IfcCondenserType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCondenser for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCondenserType> list

Public Functions

::Ifc2x3::IfcCondenserTypeEnum::Value PredefinedType() const

Defines the type of condenser.

void setPredefinedType(::Ifc2x3::IfcCondenserTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCondenserType(IfcEntityInstanceData *e)
IfcCondenserType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCondenserTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCondenserTypeEnum

Public Types

enum Value

Enumeration defining the typical types of condensers. Air is used as the cooling medium for AIRCOOLED; water is used as the cooling medium for all other types. The IfcCondenserTypeEnum contains the following:

AIRCOOLED: A condenser in which heat is transferred to an air-stream. EVAPORATIVECOOLED: A condenser that is cooled evaporatively. WATERCOOLED: Water-cooled condenser with unspecified operation. WATERCOOLEDSHELLTUBE: Water-cooled condenser with cooling water circulated through one or more tubes contained within the shell. WATERCOOLEDSHELLCOIL: Water-cooled condenser with cooling water circulated through one or more continuous or assembled coils contained within the shell. WATERCOOLEDTUBEINTUBE: Water-cooled condenser consisting of one or more assemblies of two tubes, one within the other. WATERCOOLEDBRAZEDPLATE: Water-cooled condenser condenser with plates brazed together to form an assembly of separate channels. USERDEFINED: User-defined condenser type. NOTDEFINED: Undefined condenser type.

HISTORY: New enumeration in IFC 2x2. WATERCOOLED added in IFC 2x4.

Values:

enumerator IfcCondenserType_WATERCOOLEDSHELLTUBE
enumerator IfcCondenserType_WATERCOOLEDSHELLCOIL
enumerator IfcCondenserType_WATERCOOLEDTUBEINTUBE
enumerator IfcCondenserType_WATERCOOLEDBRAZEDPLATE
enumerator IfcCondenserType_AIRCOOLED
enumerator IfcCondenserType_EVAPORATIVECOOLED
enumerator IfcCondenserType_USERDEFINED
enumerator IfcCondenserType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCondition : public Ifc2x3::IfcGroup

Public Types

typedef IfcTemplatedEntityList<IfcCondition> list

Public Functions

const IfcParse::entity &declaration() const
IfcCondition(IfcEntityInstanceData *e)
IfcCondition(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcConditionCriterion : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcConditionCriterion> list

Public Functions

::Ifc2x3::IfcConditionCriterionSelect *Criterion() const
void setCriterion(::Ifc2x3::IfcConditionCriterionSelect *v)
::Ifc2x3::IfcDateTimeSelect *CriterionDateTime() const
void setCriterionDateTime(::Ifc2x3::IfcDateTimeSelect *v)
const IfcParse::entity &declaration() const
IfcConditionCriterion(IfcEntityInstanceData *e)
IfcConditionCriterion(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcConditionCriterionSelect *v6_Criterion, ::Ifc2x3::IfcDateTimeSelect *v7_CriterionDateTime)

Public Static Functions

const IfcParse::entity &Class()
class IfcConic : public Ifc2x3::IfcCurve

Definition from ISO/CD 10303-42:1992: A conic (IfcConic) is a planar curve which could be produced by intersecting a plane with a cone. A conic is defined in terms of its intrinsic geometric properties rather than being described in terms of other geometry. A conic class always has a placement coordinate system defined by a two or three dimensional placement. The parametric representation is defined in terms of this placement coordinate system.

NOTE Corresponding ISO 10303 entity: conic, only the following subtypes have been incorporated into IFC 1.0, 1.5 & 2.0: circle as IfcCircle, ellipse as IfcEllipse. The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item. Please refer to ISO/IS 10303-42:1994, p. 38 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Subclassed by Ifc2x3::IfcCircle, Ifc2x3::IfcEllipse

Public Types

typedef IfcTemplatedEntityList<IfcConic> list

Public Functions

::Ifc2x3::IfcAxis2Placement *Position() const

The location and orientation of the conic. Further details of the interpretation of this attribute are given for the individual subtypes.”.

void setPosition(::Ifc2x3::IfcAxis2Placement *v)
const IfcParse::entity &declaration() const
IfcConic(IfcEntityInstanceData *e)
IfcConic(::Ifc2x3::IfcAxis2Placement *v1_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectedFaceSet : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A connected_face_set is a set of faces such that the domain of faces together with their bounding edges and vertices is connected.

NOTE Corresponding ISO 10303 entity: connected_face_set, the subtype closed_shell is included as IfcClosedShell and the subtype open_shell is included as IfcOpenShell. Please refer to ISO/IS 10303-42:1994, p. 144 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Informal proposition:

The union of the domains of the faces and their bounding loops shall be arcwise connected.

Subclassed by Ifc2x3::IfcClosedShell, Ifc2x3::IfcOpenShell

Public Types

typedef IfcTemplatedEntityList<IfcConnectedFaceSet> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcFace>::ptr CfsFaces() const

The set of faces arcwise connected along common edges or vertices.

void setCfsFaces(IfcTemplatedEntityList<::Ifc2x3::IfcFace>::ptr v)
const IfcParse::entity &declaration() const
IfcConnectedFaceSet(IfcEntityInstanceData *e)
IfcConnectedFaceSet(IfcTemplatedEntityList<::Ifc2x3::IfcFace>::ptr v1_CfsFaces)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionCurveGeometry : public Ifc2x3::IfcConnectionGeometry

IfcConnectionCurveGeometry is used to describe the geometric constraints that facilitate the physical connection of two objects at a curve or at an edge with curve geometry associated. It is envisioned as a control that applies to the element connection relationships.

EXAMPLE The connection relationship between two walls has a geometric constraint which describes the end caps (or cut-off of the wall ends) by a CurveOnRelatingElement for the first wall and a CurveOnRelatedElement for the second wall. The exact usage of the IfcConnectionCurveGeometry is further defined in the geometry use sections of the elements that use it.

The available geometry for the connection constraint may be further restricted to only allow straight segments by applying IfcPolyline only. Such an usage constraint is provided at the object definition of the IfcElement subtype, utilizing the element connection by referring to the subtype of IfcRelConnects with the associatedIfcConnectionCurveGeometry.

HISTORY New entity in IFC Release 1.5, has been renamed from IfcLineConnectionGeometry in IFC Release 2x.

IFC2x Edition 3 CHANGE The provision of topology with associated geometry, IfcEdgeCurve, is enabled by using the IfcCurveOrEdgeCurve.

Geometry use definitions The IfcCurve (or the IfcEdgeCurve with an associated IfcCurve) at the CurveOnRelatingElement attribute defines the curve where the basic geometry items of the connected elements connects. The curve geometry and coordinates are provided within the local coordinate system of the RelatingElement, as specified at the IfcRelConnects Subtype that utilizes the IfcConnectionCurveGeometry. Optionally, the same curve geometry and coordinates can also be provided within the local coordinate system of the RelatedElement by using the CurveOnRelatedElement attribute.

Public Functions

::Ifc2x3::IfcCurveOrEdgeCurve *CurveOnRelatingElement() const

The bounded curve at which the connected objects are aligned at the relating element, given in the LCS of the relating element.

void setCurveOnRelatingElement(::Ifc2x3::IfcCurveOrEdgeCurve *v)
bool hasCurveOnRelatedElement() const

Whether the optional attribute CurveOnRelatedElement is defined for this IfcConnectionCurveGeometry.

::Ifc2x3::IfcCurveOrEdgeCurve *CurveOnRelatedElement() const

The bounded curve at which the connected objects are aligned at the related element, given in the LCS of the related element. If the information is omitted, then the origin of the related element is used.

void setCurveOnRelatedElement(::Ifc2x3::IfcCurveOrEdgeCurve *v)
const IfcParse::entity &declaration() const
IfcConnectionCurveGeometry(IfcEntityInstanceData *e)
IfcConnectionCurveGeometry(::Ifc2x3::IfcCurveOrEdgeCurve *v1_CurveOnRelatingElement, ::Ifc2x3::IfcCurveOrEdgeCurve *v2_CurveOnRelatedElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionGeometry : public IfcUtil::IfcBaseEntity

IfcConnectionGeometry is used to describe the geometric and topological constraints that facilitate the physical connection of two objects. It is envisioned as a control that applies to the element connection relationships.

NOTE The element connection relationship normally provides for a logical connection information, by referencing the relating and related elements. If in addition an IfcConnectionGeometry is provided, physical connection information is given by specifying exactly where at the relating and related element the element connection occurs. Using the eccentricity subtypes, the connection can also be described when there is a physical distance (or eccentricity) between the connection elements.

The IfcConnectionGeometry allows for the provision of connection constraints between geometric and topological elements, the following connection geometry/topology types are in scope:

point | vertex point, curve | edge curve, surface | face surface,

HISTORY New entity in IFC Release 1.5.

IFC2x Edition 3 CHANGE The definition of the subtypes has been enhanced by allowing either geometric representation items (point | curve | surface) or topological representation items with associated geometry (vertex point | edge curve | face surface).

Subclassed by Ifc2x3::IfcConnectionCurveGeometry, Ifc2x3::IfcConnectionPointGeometry, Ifc2x3::IfcConnectionPortGeometry, Ifc2x3::IfcConnectionSurfaceGeometry

Public Types

typedef IfcTemplatedEntityList<IfcConnectionGeometry> list

Public Functions

const IfcParse::entity &declaration() const
IfcConnectionGeometry(IfcEntityInstanceData *e)
IfcConnectionGeometry()

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionPointEccentricity : public Ifc2x3::IfcConnectionPointGeometry

IfcConnectionPointEccentricity is used to describe the geometric constraints that facilitate the physical connection of two objects at a point or vertex point with associated point coordinates. There is a physical distance, or eccentricity, etween the connection points of both object. The eccentricity can be either given by:

providing the PointOnRelatingElement and the PointOnRelatedElement, where bothpoint coordinates are not identical within a common parent coordinate system (latestly within the world coordinate system), providing the PointOnRelatingElement and the three distance measures, EccentricityInX, EccentricityInY, and EccentricityInZ (or only EccentricityInX, and EccentricityInY if the underlying coordinate system is two-dimensional), or providing both.

NOTE If both, PointOnRelatedElement, and EccentricityInX, EccentricityInY, (EccentricityInZ) are provided, the values should be consistent. In case of any non-consistency, the calculated distance between PointOnRelatingElement and PointOnRelatedElement takes precedence.

The explicit values for EccentricityInX, EccentricityInY, and EccentricityInZ are always measured in the following direction and coordinate system (defining when the value is positive or negative):

from the PointOnRelatedElement to PointOnRelatingElement within the coordinate system of the RelatingElement. in addition: when used to specify connections in structural analysis models, the IfcStructuralMember is to be used as the RelatingElement of the relationship object utilizing IfcConnectionPointEccentricity, and the IfcStructuralConnection is the RelatedElement.

HISTORY New entity in IFC 2x Edition 3.

Geometry use definitions The IfcPoint (or the IfcVertexPoint with an associated IfcPoint) at the PointOnRelatingElement attribute defines the point where the basic geometry items of the connected elements connects. The point coordinates are provided within the local coordinate system of the RelatingElement, as specified at the IfcRelConnects subtype that utilizes the IfcConnectionPointGeometry. Optionally, the same point coordinates can also be provided within the local coordinate system of the RelatedElement by using the PointOnRelatedElement attribute, otherwise the distance to the point at the RelatedElement has to be given by the three eccentricity values.

Public Functions

bool hasEccentricityInX() const

Whether the optional attribute EccentricityInX is defined for this IfcConnectionPointEccentricity.

double EccentricityInX() const

Distance in x direction between the two points (or vertex points) engaged in the point connection.

void setEccentricityInX(double v)
bool hasEccentricityInY() const

Whether the optional attribute EccentricityInY is defined for this IfcConnectionPointEccentricity.

double EccentricityInY() const

Distance in y direction between the two points (or vertex points) engaged in the point connection.

void setEccentricityInY(double v)
bool hasEccentricityInZ() const

Whether the optional attribute EccentricityInZ is defined for this IfcConnectionPointEccentricity.

double EccentricityInZ() const

Distance in z direction between the two points (or vertex points) engaged in the point connection.

void setEccentricityInZ(double v)
const IfcParse::entity &declaration() const
IfcConnectionPointEccentricity(IfcEntityInstanceData *e)
IfcConnectionPointEccentricity(::Ifc2x3::IfcPointOrVertexPoint *v1_PointOnRelatingElement, ::Ifc2x3::IfcPointOrVertexPoint *v2_PointOnRelatedElement, boost::optional<double> v3_EccentricityInX, boost::optional<double> v4_EccentricityInY, boost::optional<double> v5_EccentricityInZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionPointGeometry : public Ifc2x3::IfcConnectionGeometry

IfcConnectionPointGeometry is used to describe the geometric constraints that facilitate the physical connection of two objects at a point (here IfcCartesianPoint) or at an vertex with point coordinates associated. It is envisioned as a control that applies to the element connection relationships.

EXAMPLE The connection relationship between two path based elements (like a column and a beam) has a geometric constraint which describes the connection points by a PointOnRelatingElement for the column and a PointOnRelatedElement for the beam. The exact usage of the IfcConnectionPointGeometry is further defined in the geometry use sections of the elements that use it.

NOTE If the point connection has an offset (if the two points or vertex points at the relating and related element do not physically match), the subtype IfcConnectionPointEccentricity shall be used.

HISTORY New entity in IFC Release 1.5, has been renamed from IfcPointConnectionGeometry in IFC Release 2x.

IFC2x Edition 3 CHANGE The provision of topology with associated geometry, IfcVertexPoint, is enabled by using the IfcPointOrVertexPoint.

Geometry use definitions The IfcPoint (or the IfcVertexPoint with an associated IfcPoint) at the PointOnRelatingElement attribute defines the point where the basic geometry items of the connected elements connect. The point coordinates are provided within the local coordinate system of the RelatingElement, as specified at the IfcRelConnectsSubtype that utilizes the IfcConnectionPointGeometry. Optionally, the same point coordinates can also be provided within the local coordinate system of the RelatedElement by using the PointOnRelatedElement attribute. If both point coordinates are not identical within a common parent coordinate system (ultimately within the world coordinate system), the subtype IfcConnectionPointEccentricity shall be used.

Subclassed by Ifc2x3::IfcConnectionPointEccentricity

Public Functions

::Ifc2x3::IfcPointOrVertexPoint *PointOnRelatingElement() const

Point at which the connected object is aligned at the relating element, given in the LCS of the relating element.

void setPointOnRelatingElement(::Ifc2x3::IfcPointOrVertexPoint *v)
bool hasPointOnRelatedElement() const

Whether the optional attribute PointOnRelatedElement is defined for this IfcConnectionPointGeometry.

::Ifc2x3::IfcPointOrVertexPoint *PointOnRelatedElement() const

Point at which connected objects are aligned at the related element, given in the LCS of the related element. If the information is omitted, then the origin of the related element is used.

void setPointOnRelatedElement(::Ifc2x3::IfcPointOrVertexPoint *v)
const IfcParse::entity &declaration() const
IfcConnectionPointGeometry(IfcEntityInstanceData *e)
IfcConnectionPointGeometry(::Ifc2x3::IfcPointOrVertexPoint *v1_PointOnRelatingElement, ::Ifc2x3::IfcPointOrVertexPoint *v2_PointOnRelatedElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionPortGeometry : public Ifc2x3::IfcConnectionGeometry

Public Functions

::Ifc2x3::IfcAxis2Placement *LocationAtRelatingElement() const
void setLocationAtRelatingElement(::Ifc2x3::IfcAxis2Placement *v)
bool hasLocationAtRelatedElement() const

Whether the optional attribute LocationAtRelatedElement is defined for this IfcConnectionPortGeometry.

::Ifc2x3::IfcAxis2Placement *LocationAtRelatedElement() const
void setLocationAtRelatedElement(::Ifc2x3::IfcAxis2Placement *v)
::Ifc2x3::IfcProfileDef *ProfileOfPort() const
void setProfileOfPort(::Ifc2x3::IfcProfileDef *v)
const IfcParse::entity &declaration() const
IfcConnectionPortGeometry(IfcEntityInstanceData *e)
IfcConnectionPortGeometry(::Ifc2x3::IfcAxis2Placement *v1_LocationAtRelatingElement, ::Ifc2x3::IfcAxis2Placement *v2_LocationAtRelatedElement, ::Ifc2x3::IfcProfileDef *v3_ProfileOfPort)

Public Static Functions

const IfcParse::entity &Class()
class IfcConnectionSurfaceGeometry : public Ifc2x3::IfcConnectionGeometry

IfcConnectionSurfaceGeometry is used to describe the geometric constraints that facilitate the physical connection of two objects at a surface or at a face with surface geometry associated. It is envisioned as a control that applies to the element connection relationships.

HISTORY New entity in IFC Release 2x.

IFC2x Edition 3 CHANGE The provision of topology with associated geometry, IfcFaceSurface, is enabled by using the IfcSurfaceOrFaceSurface.

Geometry use definitions The IfcSurface (or the IfcFaceSurface with an associated IfcSurface) at the SurfaceOnRelatingElement attribute defines the surface where the basic geometry items of the connected elements connects. The surface geometry and coordinates are provided within the local coordinate system of the RelatingElement, as specified at the IfcRelConnectsSubtype that utilizes the IfcConnectionSurfaceGeometry. Optionally, the samesurface geometry and coordinates can also be provided within the local coordinate system of the RelatedElement by using the SurfaceOnRelatedElement attribute.

Public Functions

::Ifc2x3::IfcSurfaceOrFaceSurface *SurfaceOnRelatingElement() const

Surface at which related object is aligned at the relating element, given in the LCS of the relating element.

void setSurfaceOnRelatingElement(::Ifc2x3::IfcSurfaceOrFaceSurface *v)
bool hasSurfaceOnRelatedElement() const

Whether the optional attribute SurfaceOnRelatedElement is defined for this IfcConnectionSurfaceGeometry.

::Ifc2x3::IfcSurfaceOrFaceSurface *SurfaceOnRelatedElement() const

Surface at which the relating element is aligned at the related element, given in the LCS of the related element. If the information is omitted, then the origin of the related element is used.

void setSurfaceOnRelatedElement(::Ifc2x3::IfcSurfaceOrFaceSurface *v)
const IfcParse::entity &declaration() const
IfcConnectionSurfaceGeometry(IfcEntityInstanceData *e)
IfcConnectionSurfaceGeometry(::Ifc2x3::IfcSurfaceOrFaceSurface *v1_SurfaceOnRelatingElement, ::Ifc2x3::IfcSurfaceOrFaceSurface *v2_SurfaceOnRelatedElement)

Public Static Functions

const IfcParse::entity &Class()
struct IfcConnectionTypeEnum

Public Types

enum Value

This enumeration defines the different ways how path based elements (such as IfcWallStandardCase) can connect, as shown in Figure 65.

HISTORY New type in IFC Release 2.0

L-Shape Connection

RelatingConnectionType: AtStart RelatedConnectionType: AtStart

L-Shape Connection

RelatingConnectionType: AtEnd RelatedConnectionType: AtStart

T-Shape Connection

RelatingConnectionType: AtPath RelatedConnectionType: AtStart

Figure 65 — Connection types</td

Values:

enumerator IfcConnectionType_ATPATH
enumerator IfcConnectionType_ATSTART
enumerator IfcConnectionType_ATEND
enumerator IfcConnectionType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcConstraint : public IfcUtil::IfcBaseEntity

An IfcConstraint is used to define a constraint or limiting value or boundary condition that may be applied to an object or to the value of a property.

HISTORY: New Entity in IFC Release 2.0

Use Definition IfcConstraint may be associated with any subtype of IfcRoot (unless restricted in specific subtypes) through the IfcRelAssociatesConstraint relationship in the IfcControlExtension schema, or may be associated with IfcProperty by IfcPropertyConstraintRelationship.

A constraint may aggregate other constraints through the IfcConstraintAggregationRelationship through which a logical association between constraints may be applied, or constraints may have other defined relationship to other constraints via IfcConstraintRelationship.

A constraint must have a name applied through the IfcConstraint.Name attribute and optionally, a description through IfcConstraint.Description. The grade of the constraint (hard, soft, advisory) must be specified through IfcConstraint.ConstraintGrade or IfcConstraint.UserDefinedGrade whilst the source, creating actor and time at which the constraint is created may be optionally asserted through IfcConstraint.ConstraintSource, IfcConstraint.CreatingActor and IfcConstraint.CreationTime.

A constraint may also have additional external information (such as classification or document information) associated to it by IfcExternalReferenceRelationship, accessible through inverse attribute IfcConstraint.HasExternalReferences

Subclassed by Ifc2x3::IfcMetric, Ifc2x3::IfcObjective

Public Types

typedef IfcTemplatedEntityList<IfcConstraint> list

Public Functions

std::string Name() const

A name to be used for the constraint (e.g., ChillerCoefficientOfPerformance).

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcConstraint.

std::string Description() const

A description that may apply additional information about a constraint.

void setDescription(std::string v)
::Ifc2x3::IfcConstraintEnum::Value ConstraintGrade() const

Enumeration that qualifies the type of constraint.

void setConstraintGrade(::Ifc2x3::IfcConstraintEnum::Value v)
bool hasConstraintSource() const

Whether the optional attribute ConstraintSource is defined for this IfcConstraint.

std::string ConstraintSource() const

Any source material, such as a code or standard, from which the constraint originated.

void setConstraintSource(std::string v)
bool hasCreatingActor() const

Whether the optional attribute CreatingActor is defined for this IfcConstraint.

::Ifc2x3::IfcActorSelect *CreatingActor() const

Person and/or organization that has created the constraint.

void setCreatingActor(::Ifc2x3::IfcActorSelect *v)
bool hasCreationTime() const

Whether the optional attribute CreationTime is defined for this IfcConstraint.

::Ifc2x3::IfcDateTimeSelect *CreationTime() const

Time when information specifying the constraint instance was created.

Note IFC2x4 CHANGE: Attribute data type changed to IfcDateTime using ISO 8601 representation

void setCreationTime(::Ifc2x3::IfcDateTimeSelect *v)
bool hasUserDefinedGrade() const

Whether the optional attribute UserDefinedGrade is defined for this IfcConstraint.

std::string UserDefinedGrade() const

Allows for specification of user defined grade of the constraint beyond the enumeration values (hard, soft, advisory) provided by ConstraintGrade attribute of type IfcConstraintEnum. When a value is provided for attribute UserDefinedGrade in parallel the attribute ConstraintGrade shall have enumeration value USERDEFINED.

void setUserDefinedGrade(std::string v)
IfcTemplatedEntityList<IfcConstraintClassificationRelationship>::ptr ClassifiedAs() const
IfcTemplatedEntityList<IfcConstraintRelationship>::ptr RelatesConstraints() const
IfcTemplatedEntityList<IfcConstraintRelationship>::ptr IsRelatedWith() const
IfcTemplatedEntityList<IfcPropertyConstraintRelationship>::ptr PropertiesForConstraint() const
IfcTemplatedEntityList<IfcConstraintAggregationRelationship>::ptr Aggregates() const
IfcTemplatedEntityList<IfcConstraintAggregationRelationship>::ptr IsAggregatedIn() const
const IfcParse::entity &declaration() const
IfcConstraint(IfcEntityInstanceData *e)
IfcConstraint(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcConstraintEnum::Value v3_ConstraintGrade, boost::optional<std::string> v4_ConstraintSource, ::Ifc2x3::IfcActorSelect *v5_CreatingActor, ::Ifc2x3::IfcDateTimeSelect *v6_CreationTime, boost::optional<std::string> v7_UserDefinedGrade)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstraintAggregationRelationship : public IfcUtil::IfcBaseEntity

An IfcConstraintAggregationRelationship is an objectified relationship that enables instances of IfcConstraint subtypes to be aggregated together logically.

HISTORY New Entity in IFC Release 2.0. Modified in IFC2x2.

IFC2x4 CHANGE Subtyped from IfcConstraintRelationship

Use definition IfcConstraintAggregationRelationship allows the aggregation link between subtypes of constraint to be logically defined (AND, OR, XOR, NOTAND, NOTOR). In this way, whereby an object or property can have multiple constraints assigned, and the logical linkage between them can be specified. Thus linked constraints might show as for example (> X AND < Y) which is useful for an allowed range, or bounded value, for example, (A OR B OR C) which is valuable for an enumerated property where a selection is constrained to be (at least) one of A, B or C. Figure 237 illustrates constraint aggregation.

Figure 237 — Constraint aggregation

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcConstraintAggregationRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcConstraintAggregationRelationship.

std::string Description() const
void setDescription(std::string v)
::Ifc2x3::IfcConstraint *RelatingConstraint() const
void setRelatingConstraint(::Ifc2x3::IfcConstraint *v)
IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr RelatedConstraints() const
void setRelatedConstraints(IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr v)
::Ifc2x3::IfcLogicalOperatorEnum::Value LogicalAggregator() const

Enumeration that identifies the logical type of aggregation.

void setLogicalAggregator(::Ifc2x3::IfcLogicalOperatorEnum::Value v)
const IfcParse::entity &declaration() const
IfcConstraintAggregationRelationship(IfcEntityInstanceData *e)
IfcConstraintAggregationRelationship(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcConstraint *v3_RelatingConstraint, IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr v4_RelatedConstraints, ::Ifc2x3::IfcLogicalOperatorEnum::Value v5_LogicalAggregator)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstraintClassificationRelationship : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcConstraint *ClassifiedConstraint() const
void setClassifiedConstraint(::Ifc2x3::IfcConstraint *v)
IfcEntityList::ptr RelatedClassifications() const
void setRelatedClassifications(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcConstraintClassificationRelationship(IfcEntityInstanceData *e)
IfcConstraintClassificationRelationship(::Ifc2x3::IfcConstraint *v1_ClassifiedConstraint, IfcEntityList::ptr v2_RelatedClassifications)

Public Static Functions

const IfcParse::entity &Class()
struct IfcConstraintEnum

Public Types

enum Value

IfcConstraintEnum is an enumeration used to qualify a constraint.

HISTORY: New type in IFC Release 2.0

Enumeration

Value Definition

HARD Qualifies a constraint such that it must be followed rigidly within or at the values set.

SOFT Qualifies a constraint such that it should be followed within or at the values set.

ADVISORY Qualifies a constraint such that it is advised that it is followed within or at the values set.

Values:

enumerator IfcConstraint_HARD
enumerator IfcConstraint_SOFT
enumerator IfcConstraint_ADVISORY
enumerator IfcConstraint_USERDEFINED
enumerator IfcConstraint_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcConstraintRelationship : public IfcUtil::IfcBaseEntity

An IfcConstraintRelationship is an objectified relationship that enables instances of IfcConstraint and its subtypes to be associated to each other. Logical aggregation of instances of IfcConstraint and its subtypes is handled by the subtype IfcConstraintAggregationRelationship.

EXAMPLE: Certain constraints related to an IfcWall may be derived from a constraint related to an IfcSpace.

HISTORY New entity in Release IFC2x2 (Addendum 1).

IFC2x4 CHANGE Subtyped from IfcResourceLevelRelationship.

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcConstraintRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcConstraintRelationship.

std::string Description() const
void setDescription(std::string v)
::Ifc2x3::IfcConstraint *RelatingConstraint() const

Constraint with which the other Constraints referenced by attribute RelatedConstraints are related.

void setRelatingConstraint(::Ifc2x3::IfcConstraint *v)
IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr RelatedConstraints() const

Constraints that are related with the one referenced as RelatingConstraint.

void setRelatedConstraints(IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr v)
const IfcParse::entity &declaration() const
IfcConstraintRelationship(IfcEntityInstanceData *e)
IfcConstraintRelationship(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcConstraint *v3_RelatingConstraint, IfcTemplatedEntityList<::Ifc2x3::IfcConstraint>::ptr v4_RelatedConstraints)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstructionEquipmentResource : public Ifc2x3::IfcConstructionResource

IfcConstructionEquipmentResource is usage of construction equipment to assist in the performance of construction. Construction Equipment resources are wholly or partially consumed or occupied in the performance of construction.

HISTORY: New Entity in IFC Release 2.0. Base type and documentation extended in IFC2x4.

Occurrences of IfcConstructionEquipmentResource are products that are used as resources to assist the process of construction. More specifically, they are products that are standalone items brought to a project to fulfil a particular purpose. Examples might be a tower crane or other mobile crane, a screwing machine, a lifting hoist etc. They are explicitly instances of IfcProduct and may be drawn from various of the subtype, for instance IfcTransportElement, IfcDiscreteAccessory, IfcProxy (for particular cases where more precise usage details are not available).

A product that is used as an IfcConstructionEquipmentResource is referenced using the IfcRelAssignsToResource.RelatedObjects relationship.

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcConstructionEquipmentResource defines the occurrence of any construction equipment resource; common information about construction equipment resource types is handled by IfcConstructionEquipmentResourceType. The IfcConstructionEquipmentResourceType (if present) may establish the common type name, common properties, and common productivities for various task types using IfcRelAssignsToProcess. The IfcConstructionEquipmentResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Quantity use definition The quantities relating to the IfcConstructionEquipmentResource are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement.

Qto_ConstructionEquipmentResourceBaseQuantities: base quantities for all construction equipment resources.

Assignment use definition In addition to assignments specified at the base class IfcConstructionResource, a construction equipment resource may have assignments of its own using IfcRelAssignsToResource where RelatingResource refers to the IfcConstructionEquipmentResource and RelatedObjects contains one or more IfcProduct subtypes as shown in Figure 183. Such relationship indicates the equipment used as input for the resource. Such products are not contained within a building structure but are referenced within a construction spatial zone, specifically IfcSpatialZone with PredefinedType=CONSTRUCTION, which is aggregated within the IfcProject. There may be multiple chains of production such that the assigned equipment may have their own task and resource assignments for assembling such equipment.

Figure 183 — Construction equipment resource assignment

Public Functions

const IfcParse::entity &declaration() const
IfcConstructionEquipmentResource(IfcEntityInstanceData *e)
IfcConstructionEquipmentResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstructionMaterialResource : public Ifc2x3::IfcConstructionResource

IfcConstructionMaterialResource identifies a material resource type in a construction project.

HISTORY: New Entity in IFC Release 2.0. Base type and documentation extended in IFC2x4.

IFC2x4 NOTE: The attribute Suppliers has been deleted; use IfcRelAssignsToResource to assign an IfcActor to fulfill the role as a supplier. The attribute UsageRatio has been deleted; use BaseQuantityConsumed and BaseQuantityProduced to indicate material usage.

Occurrences of IfcConstructionMaterialResource are consumed (wholly or partially), or occupied during a construction work task (IfcTask).

Similar to IfcConstructionProductResource, sometimes things such as 5000kg of gravel are already instantiated as an IfcProduct because it is a result of a work task (for example, &#145;transporting gravel&#146;). In this case, the instance of IfcConstructionMaterialResource can be associated with the product instance &#145;5000kg of gravel&#146; to provide more information for resource uses. Nevertheless, IfcConstructionMaterialResource should only be used to represent resource usage (for example &#145;gravel&#146;), but not product substances (for example, &#145;5000kg of gravel&#146;). Note: This class is not the same as IfcMaterial; the former can typically represent the type of bulk materials such as sand, gravels, nails and so on (note these can be instantiated from IfcProduct as well depending their uses in the system) used in a construction process. The latter is about physical materials used in a physical building element typically with detailed positioning (e.g. offset) and layering information. Quantities for an IfcConstructionMaterialResource are defined through IfcRelDefinesByProperty and use IfcElementQuantity.

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcConstructionMaterialResource defines the occurrence of any material resource; common information about material resource types is handled by IfcConstructionMaterialResourceType. The IfcConstructionMaterialResourceType (if present) may establish the common type name, common properties, and common productivities for various task types using IfcRelAssignsToProcess. The IfcConstructionMaterialResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Quantity use definition The quantities relating to the IfcConstructionMaterialResource are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement.

Qto_ConstructionMaterialResourceBaseQuantities: base quantities for all construction material resources.

Assignment use definition In addition to assignments specified at the base class IfcConstructionResource, a construction material resource may have assignments of its own using IfcRelAssignsToResource where RelatingResource refers to the IfcConstructionMaterialResource and RelatedObjects contains one or more IfcProduct subtypes as shown in Figure 184. Such relationship indicates the physical material used as input for the resource. Such products are not contained within a building structure but are referenced within a construction spatial zone, specifically IfcSpatialZone with PredefinedType=CONSTRUCTION, which is aggregated within the IfcProject. The IfcGeographicElement object is used to represent the physical material occurrence, which may optionally have placement and representation indicating intended storage on the construction site. There may be multiple chains of production such that the assigned product material(s) may have their own task and resource assignments for transporting or extracting such material.

Figure 184 — Construction material resource assignment

Public Functions

bool hasSuppliers() const

Whether the optional attribute Suppliers is defined for this IfcConstructionMaterialResource.

IfcEntityList::ptr Suppliers() const
void setSuppliers(IfcEntityList::ptr v)
bool hasUsageRatio() const

Whether the optional attribute UsageRatio is defined for this IfcConstructionMaterialResource.

double UsageRatio() const
void setUsageRatio(double v)
const IfcParse::entity &declaration() const
IfcConstructionMaterialResource(IfcEntityInstanceData *e)
IfcConstructionMaterialResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity, boost::optional<IfcEntityList::ptr> v10_Suppliers, boost::optional<double> v11_UsageRatio)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstructionProductResource : public Ifc2x3::IfcConstructionResource

IfcConstructionProductResource defines the role of a product that is consumed (wholly or partially), or occupied in the performance of construction.

HISTORY: New Entity in IFC Release 2.0. Renamed from IfcProductResource in IFC 2x. Base type and documentation extended in IFC2x4.

Occurrences of IfcConstructionProductResource are usage of products to assist the process of construction. More specifically, they are usage of products that result from some construction processes and that are then used as resources to facilitate further construction. For instance, formworks can be instantiated as products resulting from the process &#145;constructing formwork&#146;. However, they are used as resources in the process &#145;pouring concrete&#146; in a later stage of the project. IfcConstructionProductResource occurrences are explicitly instances of IfcProduct and may be drawn from various of the subtypes, for instance IfcElementComponent, IfcElementAssembly, IfcProxy (for particular cases where more precise usage details are not available). The product that is used as a construction resource is referenced using the IfcRelAssignsToResource.RelatedObjects relationship.

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcConstructionProductResource defines the occurrence of any product resource; common information about product resource types is handled by IfcConstructionProductResourceType. The IfcConstructionProductResourceType (if present) may establish the common type name, common properties, and common productivities for various task types using IfcRelAssignsToProcess. The IfcConstructionProductResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Assignment use definition In addition to assignments specified at the base class IfcConstructionResource, a construction product resource may have assignments of its own using IfcRelAssignsToResource where RelatingResource refers to the IfcConstructionProductResource and RelatedObjects contains one or more IfcProduct subtypes as shown in Figure 185. Such relationship indicates the products used as input for the resource. Such products are not contained within a building structure but are referenced within a construction spatial zone, specifically IfcSpatialZone with PredefinedType=CONSTRUCTION, which is aggregated within the IfcProject. There may be multiple chains of production such that the assigned products may have their own task and resource assignments.

Figure 185 — Construction product resource assignment

Public Functions

const IfcParse::entity &declaration() const
IfcConstructionProductResource(IfcEntityInstanceData *e)
IfcConstructionProductResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity)

Public Static Functions

const IfcParse::entity &Class()
class IfcConstructionResource : public Ifc2x3::IfcResource

IfcConstructionResource is an abstract generalization of the different resources used in construction projects, mainly labor, material, equipment and product resources, plus subcontracted resources and aggregations such as a crew resource.

A resource represents “use of something” and does not necessarily correspond to a single item such as a person or vehicle, but represents a pool of items having limited availability such as general labor or an equipment fleet. A resource can represent either a generic resource pool (not having any task assignment) or a task-specific resource allocation (having an IfcTask assignment).

HISTORY New entity in IFC2x2.

IFC2x4 CHANGE Modified in to promote ResourceIdentifer and ResourceGroup (renamed to LongDescription) to supertype IfcResource and add attributes as described.

Type use definition IfcConstructionResource defines the occurrence of any construction resource; common information about construction resource types is handled by IfcConstructionResourceType. The IfcConstructionResourceType (if present) may establish the common type name, common properties, common cost rates, and common productivities applied to specific task types. The IfcConstructionResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute as shown in Figure 186. The resource type may provide shared productivity and cost information, allowing tasks and resources to be selected according to lowest cost and/or shortest duration. Given an IfcProduct of a particular IfcTypeProduct type, an IfcTypeProcess may be selected from those assigned to the product type using IfcRelAssignsToProduct, and an IfcTypeResource may be selected from those assigned to the process type using IfcRelAssignsToProcess. Then IfcTask and IfcConstructionResource occurrences may be instantiated from the type definitions, applying productivitity and rate information to assigned quantities to calculate ResourceTime.ScheduleWork. Task durations can then be calculated by dividing ResourceTime.ScheduleWork by ResourceTime.ScheduleUsage.

Figure 186 — Construction resource type use

Composition use definition Resources may be decomposed into allocation pools using the IfcRelNests relationship as shown in Figure 187. For example, an IfcLaborResource for “Electrician” may be decomposed into three task-specific IfcLaborResource objects: “Electrical Rough-in”, “First Floor Circuits”, and “Second Floor Circuits”. Both relating and related sides may represent the same ResourceTime.ScheduleUsage quantity (for example, 6 workers time-shared), or the related side may break out ResourceTime.ScheduleUsage quantities for reserved use (for example, 4 workers and 2 workers). A common scenario is two nesting levels where the first-level resources have no task assignments; while second-level resources have specific task assignments indicating that the resource is subdivided into allocations for specific tasks. While the model allows unlimited nesting of resources, implementer agreements may restrict to two nesting levels with task assignments specifically at the second level.

Figure 187 — Construction resource composition use

Declaration use definition A root-level resource (specifically IfcCrewResource or IfcSubContractResource) is declared within the project by IfcRelDeclares where RelatingContext refers to the single IfcProject and RelatedObjects refers to one or more IfcConstructionResource, and other root-level objects within the project.

Assignment use definition A resource may be assigned to an actor by IfcRelAssignsToActor where RelatingActor refers to an IfcActor and RelatedObjects refers to one or more IfcConstructionResource or other objects. Such relationship indicates the actor responsible for allocating the resource such as partitioning into task-specific allocations, delegating to other actors, and/or scheduling over time. Note that this assignment does not indicate the person or organization performing the work; that is indicated by IfcRelAssignsToResource. The actor responsible for the resource may or may not be the same as any actor(s) performing work. A resource may be assigned to a control by IfcRelAssignsToControl where RelatingProduct refers to an IfcControl and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcWorkCalendar is assigned indicating availability of the resource, where such calendar is nested within a base calendar or an IfcWorkPlan which in turn is assigned to the IfcProject. A resource may be assigned to a group by IfcRelAssignsToGroup where RelatingGroup refers to an IfcGroup and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcAsset is assigned indicating the asset to be tracked, where such asset is nested within an IfcInventory which in turn is assigned to the IfcProject. A resource may be assigned to a product by IfcRelAssignsToProduct where RelatingProduct refers to an IfcProduct and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcElement subtype is assigned indicating the product to be constructed, where such product is connected to a spatial structure which in turn is aggregated within the IfcProject. A resource may be assigned to a process by IfcRelAssignsToProcess where RelatingProcess refers to an IfcProcess and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcTask is assigned indicating the task to be performed by the resource, where such task is nested within a summary task which in turn is assigned to the IfcProject. A resource may have assignments of other objects using IfcRelAssignsToResource where RelatingResource refers to the IfcConstructionResource and RelatedObjects refers to one or more objects such as IfcActor or IfcProduct subtypes. This relationship indicates specific objects assigned to fulfill resource usage. Figure 188 illustrates resource assignment.

Figure 188 — Construction resource assignment use

Constraint use definition Constraints may be applied to a resource to indicate fixed work (such as total person-hours) or fixed usage (such as simultaneous workers). The relationship IfcRelAssociatesConstraint is used where RelatingConstraint points to an IfcMetric and RelatedObjects includes the IfcConstructionResource as shown in Figure 189. IfcRelAssociatesConstraint.Name identifies the attribute to be constrained using a period (“.”) to dereference; for example, “ResourceTime.ScheduleWork” refers to the ScheduleWork attribute on the IfcResourceTime entity referenced on the ResourceTime attribute. The following attributes may be constrained:

‘ResourceTime.ScheduleUsage’: Indicate fixed usage (e.g. simultaneous workers) with ConstraintGrade=HARD and Benchmark=EQUALTO such that changes to ResourceTime.ScheduleWork should impact the assigned IfcTask.TaskTime.ScheduleDuration and vice-versa ‘ResourceTime.ScheduleWork’: Indicate fixed work (e.g. total person-hours) with ConstraintGrade=HARD and Benchmark=EQUALTO such that changes to ResourceTime.ScheduleUsage should impact the assigned IfcTask.TaskTime.ScheduleDuration and vice-versa.

Figure 189 — Construction resource constraint use

Time series use definition Time series may be applied to a resource to indicate the break-out of attribute values over time. The relationship IfcRelAssociatesTimeSeries is used where RelatingTimeSeries points to an IfcTimeSeries (either IfcRegularTimeSeries or IfcIrregularTimeSeries) and RelatedObjects includes the IfcConstructionResource as shown in Figure 190. IfcRelAssociatesTimeSeries.Name identifies the attribute to be constrained using a period (“.”) to dereference; for example, “ResourceTime.ScheduleWork” refers to the ScheduleWork attribute on the IfcResourceTime entity referenced on the ResourceTime attribute. Refer to attribute descriptions on IfcResourceTime for attribute-specific usage. Each IfcTimeSeriesValue indicates a LIST of values, where the sequence of the value corresponds to the IfcCostValue at IfcConstructionResource.CostRatesConsumed. For example, if CostRatesConsumed has two IfcCostValue items in the LIST, “Standard” and “Overtime”, then IfcTimeSeriesValue(IfcDuration(‘T8H0M0S’),IfcDuration(‘T2H0M0S’)) would indicate 8 hours at Standard rate and 2 hours at Overtime rate. If the list of values at IfcTimeSeriesValue.ListValues is less than the size of CostRatesConsumed, then subsequent values are considered to be zero.

Figure 190 — Construction resource time series use

Document use definition Documents may be published for work plans consisting of schedules, calendars, tasks, and resources. The relationship IfcRelAssociatesDocument may be used to preserve mappings to such document where RelatingDocument points to an IfcDocumentReference and RelatedObjects includes the IfcConstructionResource as shown in Figure 191. IfcDocumentReference.ItemReference identifies the resource within the scope of the document, such as an integer or guid. The IfcDocumentReference.ReferencedDocument corresponds to the document which is uniquely identified by IfcDocumentInformation.DocumentId and/or IfcDocumentInformation.PublicationLocation. Such document mapping allows items in the document to be updated from the building information model and vice-versa.

Figure 191 — Construction resource document use

Baseline use definition A resource may have any number of baselines defined using the relationship IfcRelDefinesByObject where RelatingObject is the “current” resource and RelatedObjects consists of multiple “baseline” resources, each representing a copy of the resource as it existed at an earlier point in time as shown in Figure 192. Each baseline IfcConstructionResource is identified by its nested IfcRelAssignsToControl relationship to an IfcWorkSchedule having PredefinedType=BASELINE, IfcWorkSchedule.CreationDate indicating the date of the baseline, and IfcWorkSchedule.Name indicating the name of the baseline.

Figure 192 — Construction resource baseline use

Subclassed by Ifc2x3::IfcConstructionEquipmentResource, Ifc2x3::IfcConstructionMaterialResource, Ifc2x3::IfcConstructionProductResource, Ifc2x3::IfcCrewResource, Ifc2x3::IfcLaborResource, Ifc2x3::IfcSubContractResource

Public Types

typedef IfcTemplatedEntityList<IfcConstructionResource> list

Public Functions

bool hasResourceIdentifier() const

Whether the optional attribute ResourceIdentifier is defined for this IfcConstructionResource.

std::string ResourceIdentifier() const
void setResourceIdentifier(std::string v)
bool hasResourceGroup() const

Whether the optional attribute ResourceGroup is defined for this IfcConstructionResource.

std::string ResourceGroup() const
void setResourceGroup(std::string v)
bool hasResourceConsumption() const

Whether the optional attribute ResourceConsumption is defined for this IfcConstructionResource.

::Ifc2x3::IfcResourceConsumptionEnum::Value ResourceConsumption() const

Indicates how the resource is consumed or occupied during its use in a process. Production-based consumption is indicated by CONSUMED, PARTIALLYCONSUMED, or NOTCONSUMED, where QuantityProduced refers to a quantity on the IfcProduct to which the assigned IfcProcess is assigned. Duration-based occupation is indicated by OCCUPIED, PARTIALLYOCCUPIED, or NOTOCCUPIED, where QuantityProduced refers to a quantity on the IfcProcess to which the resource is assigned.

void setResourceConsumption(::Ifc2x3::IfcResourceConsumptionEnum::Value v)
bool hasBaseQuantity() const

Whether the optional attribute BaseQuantity is defined for this IfcConstructionResource.

::Ifc2x3::IfcMeasureWithUnit *BaseQuantity() const
void setBaseQuantity(::Ifc2x3::IfcMeasureWithUnit *v)
const IfcParse::entity &declaration() const
IfcConstructionResource(IfcEntityInstanceData *e)
IfcConstructionResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity)

Public Static Functions

const IfcParse::entity &Class()
class IfcContextDependentMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: Is the value of a physical quantity as defined by an application context. Type: REAL

NOTE Corresponding ISO 10303 name: context_dependent_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcContextDependentMeasure(IfcEntityInstanceData *e)
IfcContextDependentMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcContextDependentUnit : public Ifc2x3::IfcNamedUnit

Definition from ISO/CD 10303-41:1992: A context dependent unit is a unit which is not related to the SI system.

NOTE The number of parts in an assembly is a physical quantity measured in units that may be called “parts” but which cannot be related to an SI unit.

NOTE Corresponding ISO 10303 name: context_dependent_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcContextDependentUnit> list

Public Functions

std::string Name() const

The word, or group of words, by which the context dependent unit is referred to.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcContextDependentUnit(IfcEntityInstanceData *e)
IfcContextDependentUnit(::Ifc2x3::IfcDimensionalExponents *v1_Dimensions, ::Ifc2x3::IfcUnitEnum::Value v2_UnitType, std::string v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcControl : public Ifc2x3::IfcObject

IfcControl is the abstract generalization of all concepts that control or constrain the utilization of products, processes, or resources in general. It can be seen as a regulation, cost schedule, request or order, or other requirements applied to a product, process or resource whose requirements and provisions must be fulfilled.

EXAMPLE Controls include action requests, cost schedules, project orders, work plans, and work calendars.

HISTORY New entity in IFC Release 1.0.

IFC2x4 CHANGE Attribute Identification added.

Relationship use definition Controls have assignments from products, processes, or other objects by using the relationship object IfcRelAssignsToControl.

Subclassed by Ifc2x3::IfcActionRequest, Ifc2x3::IfcConditionCriterion, Ifc2x3::IfcCostItem, Ifc2x3::IfcCostSchedule, Ifc2x3::IfcEquipmentStandard, Ifc2x3::IfcFurnitureStandard, Ifc2x3::IfcPerformanceHistory, Ifc2x3::IfcPermit, Ifc2x3::IfcProjectOrder, Ifc2x3::IfcProjectOrderRecord, Ifc2x3::IfcScheduleTimeControl, Ifc2x3::IfcServiceLife, Ifc2x3::IfcSpaceProgram, Ifc2x3::IfcTimeSeriesSchedule, Ifc2x3::IfcWorkControl

Public Types

typedef IfcTemplatedEntityList<IfcControl> list

Public Functions

IfcTemplatedEntityList<IfcRelAssignsToControl>::ptr Controls() const
const IfcParse::entity &declaration() const
IfcControl(IfcEntityInstanceData *e)
IfcControl(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcControllerType : public Ifc2x3::IfcDistributionControlElementType

The distribution control element type IfcControllerType defines commonly shared information for occurrences of controllers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a controller specification (i.e. the specific product information, that is common to all occurrences of that product type). Controller types may be exchanged without being already assigned to occurrences. Occurrences of IfcControllerType are represented by instances of IfcController.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionControlElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ControllerTypeCommon Pset_ControllerTypeFloating (FLOATING) Pset_ControllerTypeMultiPosition (MULTIPOSITION) Pset_ControllerTypeProgrammable (PROGRAMMABLE) Pset_ControllerTypeProportional (PROPORTIONAL) Pset_ControllerTypeTwoPosition (TWOPOSITION)

Material Use Definition The material of the IfcControllerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Composition Use Definition The IfcControllerType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcControllerType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

PROGRAMMABLE: May contain IfcController components. Programmable Logic Controllers may be decomposed into logical elements for values and operations.

Port Use Definition The distribution ports relating to the IfcControllerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcController for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcControllerType> list

Public Functions

::Ifc2x3::IfcControllerTypeEnum::Value PredefinedType() const

Identifies the predefined types of controller from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcControllerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcControllerType(IfcEntityInstanceData *e)
IfcControllerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcControllerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcControllerTypeEnum

Public Types

enum Value

The IfcControllerTypeEnum defines the range of different types of controller that can be specified.

HISTORY: New type in IFC R2.0 Documentation extended in IFC 2x4. PROPORTIONALINTEGRAL and PROPORTIONALINTEGRALDERIVATIVE values deleted (property set enumeration now used). MULTIPOSITION added.

Enumeration

FLOATING: Output increases or decreases at a constant or accelerating rate. MULTIPOSITION: Output is discrete value, can be one of three or more values. PROGRAMMABLE: Output is programmable such as Discrete Digital Control (DDC). PROPORTIONAL: Output is proportional to the control error and optionally time integral and derivative. TWOPOSITION: Output can be either on or off USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcControllerType_FLOATING
enumerator IfcControllerType_PROPORTIONAL
enumerator IfcControllerType_PROPORTIONALINTEGRAL
enumerator IfcControllerType_PROPORTIONALINTEGRALDERIVATIVE
enumerator IfcControllerType_TIMEDTWOPOSITION
enumerator IfcControllerType_TWOPOSITION
enumerator IfcControllerType_USERDEFINED
enumerator IfcControllerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcConversionBasedUnit : public Ifc2x3::IfcNamedUnit

Definition from ISO/CD 10303-41:1992: A conversion based unit is a unit that is defined based on a measure with unit.

NOTE Corresponding ISO 10303 name: conversion_based_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

IFC 2x3 change: standard names of typical units added.

IFC 2x4 change: further names added: square inch, square foot, square mile, square yard, cubic inch, cubic foot, cubic yard, fluid ounce UK/US, ton UK/US, degree.

Example: An inch is a converted unit. It is from the Imperial system, its name is “inch” and it can be related to the si unit, millimetre, through a measure with unit whose value is 25.4 millimetre. A foot is also a converted unit. It is from the Imperial system, its name is “foot” and it can be related to an IfcSIUnit, millimetre, either directly or through the unit called “inch”. Note that several US customary units differ from Imperial units (nonmetric English units) of the same name.

To identify some commonly used conversion based units, the standard designations (case insensitive) for the Name attribute include the following:

Name Description ‘inch’ Length measure equal to 25.4 mm ‘foot’ Length measure equal to 304.8 mm ‘yard’ Length measure equal to 914 mm ‘mile’ Length measure equal to 1609 m ‘square inch’ Area measure equal to 0.0006452 square meters ‘square foot’ Area measure equal to 0.09290 square meters ‘square yard’ Area measure equal to 0.83612736 square meters ‘acre’ Area measure equal to 4046.86 square meters ‘square mile’ Area measure equal to 2 588 881 square meters ‘cubic inch’ Volume measure equal to 0.00001639 cubic meters ‘cubic foot’ Volume measure equal to 0.02832 cubic meters ‘cubic yard’ Volume measure equal to 0.7636 cubic meters ‘litre’ Volume measure equal to 0.001 cubic meters ‘fluid ounce UK’ Volume measure equal to 0.0000284130625 cubic meters ‘fluid ounce US’ Volume measure equal to 0.00002957353 cubic meters ‘pint UK’ Volume measure equal to 0.000568 cubic meters ‘pint US’ Volume measure equal to 0.000473 cubic meters ‘gallon UK’ Volume measure equal to 0.004546 cubic meters ‘gallon US’ Volume measure equal to 0.003785 cubic meters ‘degree’ Angle measure equal to π/180 rad ‘ounce’ Mass measure equal to 28.35 g ‘pound’ Mass measure equal to 0.454 kg ‘ton UK’ Mass measure equal to 1016.0469088 kg, also known as long ton, gross ton, shipper’s ton ‘ton US’ Mass measure equal to 907.18474 kg, also known as short ton, net ton ‘lbf’ Force measure equal to 4.4482216153 N, pound-force ‘kip’ Force measure equal to 4448.2216153 N, kilopound-force ‘psi’ Pressure measure equal to 6894.7572932 Pa, pound-force per square inch ‘ksi’ Pressure measure equal to 6894757.2932 Pa, kilopound-force per square inch ‘minute’ Time measure equal to 60 s ‘hour’ Time measure equal to 3600 s ‘day’ Time measure equal to 86400 s ‘btu’ Energy measure equal to 1055.056 J, British Thermal Unit

Public Types

typedef IfcTemplatedEntityList<IfcConversionBasedUnit> list

Public Functions

std::string Name() const

The word, or group of words, by which the conversion based unit is referred to.

void setName(std::string v)
::Ifc2x3::IfcMeasureWithUnit *ConversionFactor() const

The physical quantity from which the converted unit is derived.

void setConversionFactor(::Ifc2x3::IfcMeasureWithUnit *v)
const IfcParse::entity &declaration() const
IfcConversionBasedUnit(IfcEntityInstanceData *e)
IfcConversionBasedUnit(::Ifc2x3::IfcDimensionalExponents *v1_Dimensions, ::Ifc2x3::IfcUnitEnum::Value v2_UnitType, std::string v3_Name, ::Ifc2x3::IfcMeasureWithUnit *v4_ConversionFactor)

Public Static Functions

const IfcParse::entity &Class()
class IfcCooledBeamType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcCooledBeamType defines commonly shared information for occurrences of cooled beams. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a cooled beam specification (i.e. the specific product information, that is common to all occurrences of that product type). Cooled Beam types may be exchanged without being already assigned to occurrences. Occurrences of IfcCooledBeamType are represented by instances of IfcCooledBeam.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CooledBeamTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_CooledBeamTypeActive (ACTIVE)

Material Use Definition The material of the IfcCooledBeamType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcCooledBeamType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCooledBeam for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCooledBeamType> list

Public Functions

::Ifc2x3::IfcCooledBeamTypeEnum::Value PredefinedType() const

Defines the type of cooled beam.

void setPredefinedType(::Ifc2x3::IfcCooledBeamTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCooledBeamType(IfcEntityInstanceData *e)
IfcCooledBeamType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCooledBeamTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCooledBeamTypeEnum

Public Types

enum Value

There are two general types of cooled or chilled beams: passive and active.

An active Cooled Beam uses a fan or other auxilliary device to aid in air recirculation, while a passive

Cooled Beam relies solely on convection to cool the space.

Enumeration defining the typical types of cooled beams.

The IfcCooledBeamTypeEnum contains the following:

ACTIVE: An active or ventilated cooled beam provides cooling (and heating) but can also function as an air terminal in a ventilation system.

PASSIVE: A passive or static cooled beam provides cooling (and heating) to a room or zone.

USERDEFINED: User-defined cooled beam type.

NOTDEFINED: Undefined cooled beam type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcCooledBeamType_ACTIVE
enumerator IfcCooledBeamType_PASSIVE
enumerator IfcCooledBeamType_USERDEFINED
enumerator IfcCooledBeamType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCoolingTowerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcCoolingTowerType defines commonly shared information for occurrences of cooling towers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a cooling tower specification (i.e. the specific product information, that is common to all occurrences of that product type). Cooling Tower types may be exchanged without being already assigned to occurrences. Occurrences of IfcCoolingTowerType are represented by instances of IfcCoolingTower.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_CoolingTowerTypeCommon

Material Use Definition The material of the IfcCoolingTowerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Fill’: Fill material.

Composition Use Definition The IfcCoolingTowerType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcCoolingTowerType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

MECHANICALFORCEDDRAFT: May contain IfcFan components. Forces air into the cooling tower. MECHANICALINDUCEDDRAFT: May contain IfcFan components. Induces air out of the cooling tower.

Port Use Definition The distribution ports relating to the IfcCoolingTowerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcCoolingTower for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcCoolingTowerType> list

Public Functions

::Ifc2x3::IfcCoolingTowerTypeEnum::Value PredefinedType() const

Defines the typical types of cooling towers (e.g., OpenTower, ClosedTower, CrossFlow, etc.).

void setPredefinedType(::Ifc2x3::IfcCoolingTowerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCoolingTowerType(IfcEntityInstanceData *e)
IfcCoolingTowerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCoolingTowerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCoolingTowerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of cooling towers. The IfcCoolingTowerTypeEnum contains the following:

NATURALDRAFT: Air flow is produced naturally. MECHANICALINDUCEDDRAFT: Air flow is produced by a mechanical device, typically one or more fans, located on

the air outlet side of the cooling tower. MECHANICALFORCEDDRAFT: Air flow is produced by a mechanical device, typically one or more fans, located on

the inlet air side of the cooling tower. USERDEFINED: User-defined cooling tower type. NOTDEFINED: Undefined cooling tower type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcCoolingTowerType_NATURALDRAFT
enumerator IfcCoolingTowerType_MECHANICALINDUCEDDRAFT
enumerator IfcCoolingTowerType_MECHANICALFORCEDDRAFT
enumerator IfcCoolingTowerType_USERDEFINED
enumerator IfcCoolingTowerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCoordinatedUniversalTimeOffset : public IfcUtil::IfcBaseEntity

Public Functions

int HourOffset() const
void setHourOffset(int v)
bool hasMinuteOffset() const

Whether the optional attribute MinuteOffset is defined for this IfcCoordinatedUniversalTimeOffset.

int MinuteOffset() const
void setMinuteOffset(int v)
::Ifc2x3::IfcAheadOrBehind::Value Sense() const
void setSense(::Ifc2x3::IfcAheadOrBehind::Value v)
const IfcParse::entity &declaration() const
IfcCoordinatedUniversalTimeOffset(IfcEntityInstanceData *e)
IfcCoordinatedUniversalTimeOffset(int v1_HourOffset, boost::optional<int> v2_MinuteOffset, ::Ifc2x3::IfcAheadOrBehind::Value v3_Sense)

Public Static Functions

const IfcParse::entity &Class()
class IfcCostItem : public Ifc2x3::IfcControl

An IfcCostItem describes a cost or financial value together with descriptive information that describes its context in a form that enables it to be used within a cost schedule. An IfcCostItem can be used to represent the cost of goods and services, the execution of works by a process, lifecycle cost and more.

Each instance of IfcCostItem may have a name and a description. Depending on the use for which the cost is intended, these values should be asserted on the basis of agreement. For instance, the Name attribute could be used to provide a common value that enables distinct instances to be brought together in a nesting arrangement (see below) while the Description attribute may be used to provide text used for item description in a costing schedule.

An IfcCostItem can link one or many IfcCostValue’s representing a unit cost, total cost, or a unit cost with one or many quantities used to generate the total cost. The quantities can be given as individual quantities, or those quantities are provided as element quantities by one or many building elements. The IfcCostValue.CostType attribute indicates the category of cost, which may be used to present the value in a particular column. For nested cost items (having IfcRelNests relationship), IfcCostValue.CostType is significant such that IfcCostValue.AppliedValue is calculated as the sum of all nested costs having the same IfcCostValue.CostType or if set to an asterisk (‘*’), then the sum of all nested costs of all cost types. An IfcCostValue may represent an original value or a value derived from formulas using IfcAppliedValueRelationship. For example, taxes may be calculated as a percentage of a subtotal.

HISTORY New Entity in IFC Release 2.0. IFC2x4 CHANGE Attribute PredefinedType, CostValues, and CostQuantities added.

Classification Use Definition

Instances of IfcCostItem are used for cost estimates, budgets, and other forms, where a variety of identification codes are used extensively to identify the meaning of the cost. Examples include project phase codes, CSI codes, takeoff sequence numbers, and cost accounts. The model allows for all classes that are ultimately subtypes of IfcObject to inherit the ability to have one or more instances of IfcClassificationReference to be assigned. Where identification codes are required, the generic IfcRelAssociatesClassification facility should be used.

Composition Use Definition

An IfcCostItem can nest other instances of IfcCostItem through its relationships to IfcRelNests. This can be used to enable the development of complex groups of costs as may be found in cost schedules through to pages, sections and complete cost schedules.

There is always a summary cost item as the root item of the tree representing the cost item nesting. Subsequent instances of IfcCostItem are assigned to the summary cost item using IfcRelNests. The summary cost item itself is assigned to IfcCostSchedule through the IfcRelAssignsToControl relationship.

Figure 157 illustrates a cost item composition used for a cost schedule. Each line item has a quantity and separate unit costs where IfcCostValue.CostType indicates the category of cost. The summary item has a hierarchy of costs calculated according to IfcAppliedValueRelationship.ArithmeticOperator, where IfcCostValue.CostType identifies the category to be totalled. The Tax component has IfcCostValue.CostType set to ‘Material’ which indicates it is the sum of all nested values of the ‘Material’ category ($3 x 3000 + $118 x 100 = $20800). The Subtotal component has IfcCostValue.CostType set to an asterisk (‘*’) which indicates it is the sum of all nested values of all categories.

Figure 157 — Cost composition

Assignment Use Definition

An IfcCostItem can be calculated based on quantities from objects through its relationship to IfcRelAssignsToControl.

For quantity-based costing, IfcElement, IfcTask, or IfcResource occurrence subtypes may be used. Multiple elements may be assigned of the same or different types, using IfcPhysicalQuantity entities defined at each object. Each IfcPhysicalQuantity type must be identical (for example, all values are IfcAreaQuantity) such that they can be added together.

For rate-based costing (specifically for IfcCostScheduleTypeEnum.SCHEDULEOFRATES), a single IfcTypeProduct, IfcTypeProcess, or IfcTypeResource subtype may be used to reflect rates for occurrences of such types. This enables the possibility to generate a quantity-based cost schedule for occurrences based on types with rate-based cost schedules.

IfcRelAssignsToControl is also used in the opposite direction to link the root IfcCostItem to an IfcCostSchedule where RelatingControl is the IfcCostSchedule.

Figure 158 illustrates cost item assignment derived from building elements. The IfcRelAssignsToControl relationship indicates building elements for which quantities are derived. Not shown, costs may also be derived from building elements by traversing assignment relationships from the assigned IfcProduct to IfcProcess to IfcResource, where all costs ultimately originate at resources. It is also possible for cost items to have assignments from processes or resources directly.

Figure 168 — Cost assignment

Public Types

typedef IfcTemplatedEntityList<IfcCostItem> list

Public Functions

const IfcParse::entity &declaration() const
IfcCostItem(IfcEntityInstanceData *e)
IfcCostItem(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcCostSchedule : public Ifc2x3::IfcControl

An IfcCostSchedule brings together instances of IfcCostItem either for the purpose of identifying purely cost information as in an estimate for constructions costs or for including cost information within another presentation form such as a work order.

HISTORY New Entity in IFC Release 2.0. Modified in IFC 2x2 IFC2x4 CHANGE Attribute ‘ID’ changed to Identification and promoted to supertype IfcControl, PredefinedType made optional, attributes PreparedBy, SubmittedBy, TargetUsers removed.

Declaration Use Definition The IfcCostSchedule may be declared within the project using the IfcRelDeclares relationship where RelatingContext refers to the single IfcProject and RelatedDefinitions contains the IfcCostSchedule. Alternatively, if the IfcCostSchedule is aggregated within another IfcControl object, then it shall not have a direct declaration relationship (whereas the containing object may have a declaration relationship).

Assignment Use Definition The IfcCostSchedule may be assigned to the following entities using relationships as indicated:

IfcActor (IfcRelAssignsToActor): Persons and organizations involved in the preparation, submittal, and as target users.

The IfcCostSchedule may have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcCostSchedule and RelatedObjects contains one or more objects of the following types: IfcCostItem: Indicates costs published within this cost schedule, typically a single root cost item forming a hierarchy of nested cost items.

Classification Use Definition Classifications may be applied using IfcRelAssociatesClassification where RelatedObjects contains the IfcCostSchedule and RelatingClassification refers to an IfcClassification or IfcClassificationReference.

IfcClassification: Classifications to be used for cost items within the cost schedule.

Approval Use Definition Approvals may be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcCostSchedule. Approvals may be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.

Public Types

typedef IfcTemplatedEntityList<IfcCostSchedule> list

Public Functions

bool hasSubmittedBy() const

Whether the optional attribute SubmittedBy is defined for this IfcCostSchedule.

::Ifc2x3::IfcActorSelect *SubmittedBy() const
void setSubmittedBy(::Ifc2x3::IfcActorSelect *v)
bool hasPreparedBy() const

Whether the optional attribute PreparedBy is defined for this IfcCostSchedule.

::Ifc2x3::IfcActorSelect *PreparedBy() const
void setPreparedBy(::Ifc2x3::IfcActorSelect *v)
bool hasSubmittedOn() const

Whether the optional attribute SubmittedOn is defined for this IfcCostSchedule.

::Ifc2x3::IfcDateTimeSelect *SubmittedOn() const

The date and time on which the cost schedule was submitted.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setSubmittedOn(::Ifc2x3::IfcDateTimeSelect *v)
bool hasStatus() const

Whether the optional attribute Status is defined for this IfcCostSchedule.

std::string Status() const

The current status of a cost schedule. Examples of status values that might be used for a cost schedule status include:

PLANNED APPROVED AGREED ISSUED STARTED

void setStatus(std::string v)
bool hasTargetUsers() const

Whether the optional attribute TargetUsers is defined for this IfcCostSchedule.

IfcEntityList::ptr TargetUsers() const
void setTargetUsers(IfcEntityList::ptr v)
bool hasUpdateDate() const

Whether the optional attribute UpdateDate is defined for this IfcCostSchedule.

::Ifc2x3::IfcDateTimeSelect *UpdateDate() const

The date and time that this cost schedule is updated; this allows tracking the schedule history.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setUpdateDate(::Ifc2x3::IfcDateTimeSelect *v)
std::string ID() const
void setID(std::string v)
::Ifc2x3::IfcCostScheduleTypeEnum::Value PredefinedType() const

Predefined generic type for a cost schedule that is specified in an enumeration. There may be a property set given specifically for the predefined types.

IFC2x4 CHANGE The attribute has been made optional.

void setPredefinedType(::Ifc2x3::IfcCostScheduleTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCostSchedule(IfcEntityInstanceData *e)
IfcCostSchedule(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcActorSelect *v6_SubmittedBy, ::Ifc2x3::IfcActorSelect *v7_PreparedBy, ::Ifc2x3::IfcDateTimeSelect *v8_SubmittedOn, boost::optional<std::string> v9_Status, boost::optional<IfcEntityList::ptr> v10_TargetUsers, ::Ifc2x3::IfcDateTimeSelect *v11_UpdateDate, std::string v12_ID, ::Ifc2x3::IfcCostScheduleTypeEnum::Value v13_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCostScheduleTypeEnum

Public Types

enum Value

An IfcCostScheduleTypeEnum is a list of the available types of cost schedule from which that required may be selected. HISTORY: New type in IFC 2x2

Enumeration

BUDGET: An allocation of money for a particular purpose. COSTPLAN: An assessment of the amount of money needing to be expended for a defined purpose based on incomplete information about the goods and services required for a construction or installation.

ESTIMATE: An assessment of the amount of money needing to be expended for a defined purpose based on actual information about the goods and services required for a construction or installation. TENDER: An offer to provide goods and services.

PRICEDBILLOFQUANTITIES: A complete listing of all work items forming construction or installation works in which costs have been allocated to work items.

UNPRICEDBILLOFQUANTITIES: A complete listing of all work items forming construction or installation works in which costs have not yet been allocated to work items. SCHEDULEOFRATES: A listing of each type of goods forming construction or installation works with the cost of purchase, construction/installation, overheads and profit assigned so that additional items of that type can be costed.

USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcCostScheduleType_BUDGET
enumerator IfcCostScheduleType_COSTPLAN
enumerator IfcCostScheduleType_ESTIMATE
enumerator IfcCostScheduleType_TENDER
enumerator IfcCostScheduleType_PRICEDBILLOFQUANTITIES
enumerator IfcCostScheduleType_UNPRICEDBILLOFQUANTITIES
enumerator IfcCostScheduleType_SCHEDULEOFRATES
enumerator IfcCostScheduleType_USERDEFINED
enumerator IfcCostScheduleType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCostValue : public Ifc2x3::IfcAppliedValue

IfcCostValue is an amount of money or a value that affects an amount of money.

HISTORY: New Entity in IFC Release 1.0

Use definitions Each instance of IfcCostValue may also have a CostType. There are many possible types of cost value that may be identified. While there is a broad understanding of the meaning of names that may be assigned to different types of costs, there is no general standard for naming cost types nor are there any broadly defined classifications. To allow for any type of cost value, the IfcLabel datatype is assigned.

The following defines some cost types that might be applied:

Annual rate of return Bonus Bulk purchase rebate Contract Consultancy Delivery Estimated cost Hire Installation Interest rate Labor Lease List price Maintenance Material Overhead Postage and packing Profit Purchase Rental Repair Replacement Sale Small quantity surcharge Spares Storage Sub-Contract Trade discount Transportation Waste allowance Whole life

In the absence of any well-defined standard, it is recommended that local agreements should be made to define allowable and understandable cost value types within a project or region.

Public Types

typedef IfcTemplatedEntityList<IfcCostValue> list

Public Functions

std::string CostType() const

Specification of the type of cost type used.

NOTE: There are many possible types of cost value that may be identified. Whilst there is a broad understanding of the meaning of names that may be assigned to different types of costs, there is no general standard for naming cost types nor are there any broadly defined classifications. To allow for any type of cost value, the IfcLabel datatype is assigned.

In the absence of any well defined standard, it is recommended that local agreements should be made to define allowable and understandable cost value types within a project or region.

void setCostType(std::string v)
bool hasCondition() const

Whether the optional attribute Condition is defined for this IfcCostValue.

std::string Condition() const

The condition under which a cost value applies.

void setCondition(std::string v)
const IfcParse::entity &declaration() const
IfcCostValue(IfcEntityInstanceData *e)
IfcCostValue(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcAppliedValueSelect *v3_AppliedValue, ::Ifc2x3::IfcMeasureWithUnit *v4_UnitBasis, ::Ifc2x3::IfcDateTimeSelect *v5_ApplicableDate, ::Ifc2x3::IfcDateTimeSelect *v6_FixedUntilDate, std::string v7_CostType, boost::optional<std::string> v8_Condition)

Public Static Functions

const IfcParse::entity &Class()
class IfcCountMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A count measure is the value of a count. Type: NUMBER

NOTE Corresponding ISO 10303 name: count_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcCountMeasure(IfcEntityInstanceData *e)
IfcCountMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcCovering : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: term used: Finishing - final coverings and treatments of surfaces and their intersections. A covering is an element which covers some part of another element and is fully dependent on that other element. The IfcCovering defines the occurrence of a covering type, that (if given) is expressed by the IfcCoveringType. Examples of coverings include wall claddings, floorings and suspended ceilings. Coverings are elements with relationships to the covered element and the space on the other side, they may contain openings, assigned by IfcRelVoidsElement, material information, assigned by IfcRelAssociatesMaterial, and others. NOTE A more basic information about claddings, floorings, and ceilings of a space can be attached to IfcSpace’s using the Pset_SpaceCommon properties. Then only a name can be provided and the covering quantities would be interpreted from the space quantities. Coverings can be assigned to

a space represented by IfcSpace

using the inverse relationship CoversSpaces pointing to IfcRelCoversSpaces. The space is then accessible via IfcRelCoversSpaces.RelatedSpace. It defines to which space a covering is facing towards.

NOTE The mere containment relationship between an IfcCovering and an IfcSpace is created by using IfcRelContainedInSpatialStructure

a space boundary represented by IfcRelSpaceBoundary

using the inverse relationship ProvidesBoundaries pointing to IfcRelSpaceBoundary. The space is then accessible via IfcRelSpaceBoundary.RelatingSpace.

a building element represented by IfcBuildingElement

using the inverse relationship Covers pointing to IfcRelCoversBldgElements. The building element is then accessible via IfcRelCoversBldgElements.RelatingBuildingElement.

The following guideline shall apply:

(default) if the space has coverings that may not have an own shape representation and no defined relationships to the building elements they cover, then the IfcCovering shall be assigned to IfcSpace using the IfcRelCoversSpaces relationship, if the space has coverings that have an own shape representation and the space has defined space boundaries, then the covering, which relates to that space, may be assigned to the space boundaries using the link toIfcRelSpaceBoundary, if the covering does not relate to a space, then the covering should be assigned to the building element or a distribution element using the IfcRelCoversBldgElements relationship.

HISTORY New entity in IFC Release 1.0. IFC2x CHANGE The attribute PredefinedType is now optional and should only be inserted when no type information, given by IfcCoveringType, is assigned to the IfcCovering occurrence by IfcRelDefinesByType. IFC2x4 CHANGE The IfcCovering is restricted to coverings of building elements by having RelatingBuildingElement pointing to IfcBuildingElement.

Type Use Definition The IfcCovering defines the occuurence of any covering, common information about covering types (or styles) is handled by IfcCoveringType. The IfcCoveringType (if present) may establish the commontype name, usage (or predefined) type, common set of properties, common material layer set, and common shape representations (using IfcRepresentationMap). The IfcCoveringType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. As an additional use agreement for standard coverings (i.e. slabs with constant thickness along the extrusion direction), the IfcCoveringType should have a unique IfcMaterialLayerSet, that is referenced by theIfcMaterialLayerSetUsage assigned to all occurrences of this covering type.

Figure 91 illustrates assignment of IfcMaterialLayerSetUsage and IfcMaterialLayerSet to the covering type and the covering occurrence.

Figure 91 — Covering material usage

If an IfcCoveringType is assigned to the IfcCovering, the attribute PredefinedType shall not be assigned, or shall be identical to IfcCoveringType.PredefinedType. Property Set Use Definition: The property sets relating to the IfcCovering are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcCovering are part of this IFC release:

Pset_CoveringCommon: common property set for all covering occurrences

Pset_CoveringCeiling: specific property set for all occurrences of coverings with the PredefinedType: CEILING Pset_CoveringFlooring: specific property set for all occurrences of coverings with the PredefinedType: FLOORING

Quantity Use Definition: The quantities relating to the IfcCovering are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcCoveringType.

Qto_CoveringBaseQuantities: base quantities for all covering occurrences.

Containment Use Definition The IfcCovering has a containment relationship within the hierarchical spatial structure.

The IfcCovering is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes of IfcSpatialStructureElement are valid spatial containers, with IfcSpace being the default container.

Geometry Use Definitions The geometric representation of IfcCovering is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Included are: Local Placement The local placement for IfcCovering is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the same IfcSpatialStructureElement , which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the IfcCovering, however, is assigned to an IfcBuildingElement, and this element defines its own local placement, than the PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the IfcBuildingElement. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations The geometric representation of the IfcCovering depends on two criteria:

Does it define an area or a volume? Is the base surface (either the IfcRelSpaceBoundary or the surface of the IfcBuildingElement it relates to) a planar surface or a cylindrical surface?

GeometricSet Representation The ‘GeometricSet’ geometric representation of IfcCovering supports area definitions as 3D surfaces.

RepresentationIdentifier : ‘Surface’ RepresentationType : ‘GeometricSet’

The following additional constraints apply to the ‘GeometricSet’ representation of IfcCovering:

for planar base surfaces - bounded surface representation for cylindrical base surfaces - swept surface representation

Figure 92 illustrates a planar surface representation where the area of IfcCovering is given by an IfcPolyLoop for planar base surfaces (here given by the IfcRelSpaceBoundary).

The implicit planar surface of the IfcPolyLoop shall be identical with the planar surface defined by the IfcRelSpaceBoundary.

Figure 92 — Covering surface planar

Figure 93 illustrates a cylindrical surface representation where the area of the IfcCovering is given by an IfcSurfaceOfLinearExtrusion for cylindrical base surfaces (here given by the IfcRelSpaceBoundary - such as caused by a round wall).

The geometry representation of the IfcCovering is given by the IfcTrimmedCurved (the Curve parameter of the IfcArbitraryOpenProfileDef - in cases of faceted representation also an IfcPolyline). It is extruded within the plane of the base surface using the Depth parameter of the IfcSurfaceOfLinearExtrusion.

Figure 93 — Covering surface cylindrical

SweptSolid Representation The ‘SweptSolid’ geometric representation of IfcCovering supports volume definitions as 3D solids.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation of IfcCovering:

for planar base surfaces - swept area representation for cylindrical base surfaces - swept area representation

Figure 94 illustrates a body representation where the volume of IfcCovering is given by an IfcExtrudedAreaSolid for planar base surfaces (here given by the IfcRelSpaceBoundary).

The extruded area (IfcArbitraryClosedProfileDef) shall be coplanar to the surface defined by the IfcRelSpaceBoundary.

Figure 94 — Covering body planar

Figure 95 illustrates a body representation where the volume of the IfcCovering is given by an IfcExtrudedAreaSolid for cylindrical base surfaces (here given by the IfcRelSpaceBoundary - such as caused by a round wall).

The geometry representation of the IfcCovering is given by the IfcCompositeCurve (the OuterCurve parameter of the IfcArbitraryClosedProfileDef - in cases of faceted representation also a closed IfcPolyline). It is extruded along the plane of the base surface using the Depth parameter of the IfcSurfaceOfLinearExtrusion.

Figure 95 — Covering body circular

Public Types

typedef IfcTemplatedEntityList<IfcCovering> list

Public Functions

bool hasPredefinedType() const

Whether the optional attribute PredefinedType is defined for this IfcCovering.

::Ifc2x3::IfcCoveringTypeEnum::Value PredefinedType() const

Predefined types to define the particular type of the covering. There may be property set definitions available for each predefined type.

void setPredefinedType(::Ifc2x3::IfcCoveringTypeEnum::Value v)
IfcTemplatedEntityList<IfcRelCoversSpaces>::ptr CoversSpaces() const
IfcTemplatedEntityList<IfcRelCoversBldgElements>::ptr Covers() const
const IfcParse::entity &declaration() const
IfcCovering(IfcEntityInstanceData *e)
IfcCovering(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcCoveringTypeEnum::Value> v9_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
class IfcCoveringType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type IfcCoveringType defines commonly shared information for occurrences of coverings. The set of shared information may include:

common properties within shared property sets common material (layer set) information common shape representations

It is used to define an covering specification or covering style (i.e. the specific product information, that is common to all occurrences of that product type). Covering types may be exchanged without being already assigned to occurrences. The occurrences of the IfcCoveringType are represented by instances of IfcCovering

HISTORY New entity in Release IFC2x Edition 2.

Informal proposition

The material assignment, if provided using the IfcRelAssociatesMaterial relationship, shall not reference the IfcMaterialLayerSetUsage.

Material Use Definition The material of the IfcCoveringType is defined by the IfcMaterialLayerSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Property Set Use Definition: The shared property sets relating to the IfcCoveringType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcCoveringType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcCoveringType and those that are only assignable to IfcCovering. If the same property is assigned to the IfcCoveringType and the IfcCovering being an occurrence of the IfcCoveringType, then the occurrence property overrides the type property.

Pset_CoveringCommon: common property set for all covering types

Pset_CoveringCeiling: specific property set for all occurrences of covering types with the PredefinedType: CEILING Pset_CoveringFlooring: specific property set for all occurrences of coverings with the PredefinedType: FLOORING

Geometry Use Definition: The IfcCoveringType may define the shared geometric representation for all covering occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘Surface’, or ‘Body’). (See geometric use definition of IfcCovering for further information). NOTE If the IfcCoveringType has an associated IfcMaterialLayerSet, then no shared geometric representation shall be provided. NOTE The product shape representations are defined as RepresentationMaps (attribute of the supertype IfcTypeProduct), which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[n] being an IfcMappedItem. See IfcTypeProduct for further information. NOTE The values of attributes RepresentationIdentifier and RepresentationType of IfcShapeRepresentation are restricted in the same way as those for IfcCoveringType.

Public Types

typedef IfcTemplatedEntityList<IfcCoveringType> list

Public Functions

::Ifc2x3::IfcCoveringTypeEnum::Value PredefinedType() const

Predefined types to define the particular type of the covering. There may be property set definitions available for each predefined type.

void setPredefinedType(::Ifc2x3::IfcCoveringTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCoveringType(IfcEntityInstanceData *e)
IfcCoveringType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCoveringTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCoveringTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the range of different types of covering that can further specify an IfcCovering or an IfcCoveringType. HISTORY New enumeration in IFC Release 1.0 IFC2x4 CHANGE The following enumerators of the IfcCoveringTypeEnum have been deprecated INSULATION, SLEEVING and WRAPPING. Enumeration

CEILING: the covering is used to represent a ceiling FLOORING: the covering is used to represent a flooring CLADDING: the covering is used to represent a cladding ROOFING: the covering is used to represent a roof

INSULATION: the covering is used to insulate an element for thermal or acoustic purposes. IFC2x4 NOTE The use of this enumerator is deprecated. MEMBRANE: an impervious layer that could be used for e.g. roof covering (below tiling - that may be known as sarking etc.) or as a damp proof course membrane IFC2x4 NOTE The use of this enumerator is deprecated. SLEEVING: the covering is used to isolate a distribution element from a space in which it is contained. IFC2x4 NOTE The use of this enumerator is deprecated. WRAPPING: the covering is used for wrapping particularly of distribution elements using tape. IFC2x4 NOTE The use of this enumerator is deprecated.

USERDEFINED: user defined type of covering NOTDEFINED: undefined type of covering

Values:

enumerator IfcCoveringType_CEILING
enumerator IfcCoveringType_FLOORING
enumerator IfcCoveringType_CLADDING
enumerator IfcCoveringType_ROOFING
enumerator IfcCoveringType_INSULATION
enumerator IfcCoveringType_MEMBRANE
enumerator IfcCoveringType_SLEEVING
enumerator IfcCoveringType_WRAPPING
enumerator IfcCoveringType_USERDEFINED
enumerator IfcCoveringType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCraneRailAShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

Public Functions

double OverallHeight() const
void setOverallHeight(double v)
double BaseWidth2() const
void setBaseWidth2(double v)
bool hasRadius() const

Whether the optional attribute Radius is defined for this IfcCraneRailAShapeProfileDef.

double Radius() const
void setRadius(double v)
double HeadWidth() const
void setHeadWidth(double v)
double HeadDepth2() const
void setHeadDepth2(double v)
double HeadDepth3() const
void setHeadDepth3(double v)
double WebThickness() const
void setWebThickness(double v)
double BaseWidth4() const
void setBaseWidth4(double v)
double BaseDepth1() const
void setBaseDepth1(double v)
double BaseDepth2() const
void setBaseDepth2(double v)
double BaseDepth3() const
void setBaseDepth3(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcCraneRailAShapeProfileDef.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcCraneRailAShapeProfileDef(IfcEntityInstanceData *e)
IfcCraneRailAShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_OverallHeight, double v5_BaseWidth2, boost::optional<double> v6_Radius, double v7_HeadWidth, double v8_HeadDepth2, double v9_HeadDepth3, double v10_WebThickness, double v11_BaseWidth4, double v12_BaseDepth1, double v13_BaseDepth2, double v14_BaseDepth3, boost::optional<double> v15_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcCraneRailFShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

Public Functions

double OverallHeight() const
void setOverallHeight(double v)
double HeadWidth() const
void setHeadWidth(double v)
bool hasRadius() const

Whether the optional attribute Radius is defined for this IfcCraneRailFShapeProfileDef.

double Radius() const
void setRadius(double v)
double HeadDepth2() const
void setHeadDepth2(double v)
double HeadDepth3() const
void setHeadDepth3(double v)
double WebThickness() const
void setWebThickness(double v)
double BaseDepth1() const
void setBaseDepth1(double v)
double BaseDepth2() const
void setBaseDepth2(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcCraneRailFShapeProfileDef.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcCraneRailFShapeProfileDef(IfcEntityInstanceData *e)
IfcCraneRailFShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_OverallHeight, double v5_HeadWidth, boost::optional<double> v6_Radius, double v7_HeadDepth2, double v8_HeadDepth3, double v9_WebThickness, double v10_BaseDepth1, double v11_BaseDepth2, boost::optional<double> v12_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcCrewResource : public Ifc2x3::IfcConstructionResource

IfcCrewResource represents a collection of internal resources used in construction processes.

HISTORY: New Entity in IFC Release 2.0. Base type and documentation extended in IFC2x4

Identification of people and equipment of a crew is achieved through their specification at the level of the component. Therefore, knowing which persons are within a crew is achieved through identifying the persons assigned to each IfcLaborResource within the IfcCrewResource. Similarly, identifying that a screwing machine for pipe fitting forms part of the crew is achieved by relating an appropriate instance of IfcElementComponent to the IfcConstructionEquipmentResource forming an element of the IfcCrewResource.

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcCrewResource defines the occurrence of any crew resource; common information about crew resource types is handled by IfcCrewResourceType. The IfcCrewResourceType (if present) may establish the common type name, common properties, and common productivities for various task types using IfcRelAssignsToProcess. The IfcCrewResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Public Types

typedef IfcTemplatedEntityList<IfcCrewResource> list

Public Functions

const IfcParse::entity &declaration() const
IfcCrewResource(IfcEntityInstanceData *e)
IfcCrewResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity)

Public Static Functions

const IfcParse::entity &Class()
class IfcCsgPrimitive3D : public Ifc2x3::IfcGeometricRepresentationItem

IfcCsgPrimitive3D is an abstract supertype of all three dimensional primitives used as either tree root item, or as Boolean results within a CSG solid model. All 3D CSG primitives are defined within a three-dimensional placement coordinate system.

NOTE No directly corresponding ISO 10303-42 entity, the select type primitive_3d covers the same individual 3D CSG primitives, the position attribute has been added to apply equally to all subtypes. Please refer to ISO/IS 10303-42:1994, p. 234 for the final definition of the formal standard.

HISTORY New entity in IFC2x3.

Subclassed by Ifc2x3::IfcBlock, Ifc2x3::IfcRectangularPyramid, Ifc2x3::IfcRightCircularCone, Ifc2x3::IfcRightCircularCylinder, Ifc2x3::IfcSphere

Public Types

typedef IfcTemplatedEntityList<IfcCsgPrimitive3D> list

Public Functions

::Ifc2x3::IfcAxis2Placement3D *Position() const

The placement coordinate system to which the parameters of each individual CSG primitive apply.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
const IfcParse::entity &declaration() const
IfcCsgPrimitive3D(IfcEntityInstanceData *e)
IfcCsgPrimitive3D(::Ifc2x3::IfcAxis2Placement3D *v1_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcCsgSolid : public Ifc2x3::IfcSolidModel

Definition from ISO/CD 10303-42:1992: A solid represented as a CSG model is defined by a collection of so-called primitive solids, combined using regularized Boolean operations. The allowed operations are intersection, union, and difference. As a special case a CSG solid can also consists of a single CSG primitive.

A CSG solid requires two kinds of information for its complete definition: geometric and structural.

The geometric information is conveyed by solid models. These typically primitive volumes such as cylinders, wedges and extrusions, but can include general B-Rep models. Solid models can also be half space solids.

The structural information is in a tree (strictly an acyclic directed graph) of Boolean result and CSG solids, which represent a &#8216;recipe&#8217; for building the solid. The terminal nodes are the geometric primitives and other solids. Every CSG solid has precisely one Boolean result associated with it which is the root of the tree that defines the solid. (There may be further Boolean results within the tree as operands). The significance of a CSG solid entity is that the solid defined by the associated tree is thus identified as a significant object itself, and in this way it is distinguished from other Boolean result entities representing intermediate results during the construction process.

Definition from IAI: The following primitive volumes can be parts of the CSG tree: solid models, i.e. faceted B-Rep (IfcFacetedBrep, IfcFacetedBrepWithVoids), swept area solid (IfcExtrudedAreaSolid, IfcRevolvedAreaSolid, IfcSurfaceCurveSweptAreaSolid), swept disk solids (IfcSweptDiskSolid), half space solids (IfcHalfSpaceSolid and subtypes), and CSG primitives (subtypes of IfcCsgPrimitive3D).

NOTE Corresponding ISO 10303-42 entity: csg_solid, please refer to ISO/IS 10303-42:1994, p.174 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.5.1

Public Types

typedef IfcTemplatedEntityList<IfcCsgSolid> list

Public Functions

::Ifc2x3::IfcCsgSelect *TreeRootExpression() const

Boolean expression of primitives and regularized operators describing the solid. The root of the tree of Boolean expressions is given explicitly as an IfcBooleanResult entitiy or as a primitive (subtypes of IfcCsgPrimitive3D).

void setTreeRootExpression(::Ifc2x3::IfcCsgSelect *v)
const IfcParse::entity &declaration() const
IfcCsgSolid(IfcEntityInstanceData *e)
IfcCsgSolid(::Ifc2x3::IfcCsgSelect *v1_TreeRootExpression)

Public Static Functions

const IfcParse::entity &Class()
class IfcCShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcCShapeProfileDef defines a section profile that provides the defining parameters of a C-shaped section to be used by the swept area solid. This section is typically produced by cold forming steel. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The centre of the position coordinate system is in the profile’s centre of the bounding box.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE All profile origins are now in the center of the bounding box.

IFC2x4 CHANGE Type of InternalFilletRadius relaxed to allow for zero radius. Trailing attribute CentreOfGravityInX deleted, use respective property in IfcExtendedProfileProperties instead.

Figure 315 illustrates parameters of the C-shape profile definition. The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. The parameterized profile is defined by a set of parameter attributes. In the illustrated example, the ‘CentreOfGravityInX’ property in IfcExtendedProfileProperties, if provided, is negative.

Figure 315 — C-shape profile

Public Types

typedef IfcTemplatedEntityList<IfcCShapeProfileDef> list

Public Functions

double Depth() const

Profile depth, see illustration above (= h).

void setDepth(double v)
double Width() const

Profile width, see illustration above (= b).

void setWidth(double v)
double WallThickness() const

Constant wall thickness of profile (= ts).

void setWallThickness(double v)
double Girth() const

Lengths of girth, see illustration above (= c).

void setGirth(double v)
bool hasInternalFilletRadius() const

Whether the optional attribute InternalFilletRadius is defined for this IfcCShapeProfileDef.

double InternalFilletRadius() const

Internal fillet radius according the above illustration (= r1).

void setInternalFilletRadius(double v)
bool hasCentreOfGravityInX() const

Whether the optional attribute CentreOfGravityInX is defined for this IfcCShapeProfileDef.

double CentreOfGravityInX() const
void setCentreOfGravityInX(double v)
const IfcParse::entity &declaration() const
IfcCShapeProfileDef(IfcEntityInstanceData *e)
IfcCShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Depth, double v5_Width, double v6_WallThickness, double v7_Girth, boost::optional<double> v8_InternalFilletRadius, boost::optional<double> v9_CentreOfGravityInX)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCurrencyEnum

Public Types

enum Value

Values:

enumerator IfcCurrency_AED
enumerator IfcCurrency_AES
enumerator IfcCurrency_ATS
enumerator IfcCurrency_AUD
enumerator IfcCurrency_BBD
enumerator IfcCurrency_BEG
enumerator IfcCurrency_BGL
enumerator IfcCurrency_BHD
enumerator IfcCurrency_BMD
enumerator IfcCurrency_BND
enumerator IfcCurrency_BRL
enumerator IfcCurrency_BSD
enumerator IfcCurrency_BWP
enumerator IfcCurrency_BZD
enumerator IfcCurrency_CAD
enumerator IfcCurrency_CBD
enumerator IfcCurrency_CHF
enumerator IfcCurrency_CLP
enumerator IfcCurrency_CNY
enumerator IfcCurrency_CYS
enumerator IfcCurrency_CZK
enumerator IfcCurrency_DDP
enumerator IfcCurrency_DEM
enumerator IfcCurrency_DKK
enumerator IfcCurrency_EGL
enumerator IfcCurrency_EST
enumerator IfcCurrency_EUR
enumerator IfcCurrency_FAK
enumerator IfcCurrency_FIM
enumerator IfcCurrency_FJD
enumerator IfcCurrency_FKP
enumerator IfcCurrency_FRF
enumerator IfcCurrency_GBP
enumerator IfcCurrency_GIP
enumerator IfcCurrency_GMD
enumerator IfcCurrency_GRX
enumerator IfcCurrency_HKD
enumerator IfcCurrency_HUF
enumerator IfcCurrency_ICK
enumerator IfcCurrency_IDR
enumerator IfcCurrency_ILS
enumerator IfcCurrency_INR
enumerator IfcCurrency_IRP
enumerator IfcCurrency_ITL
enumerator IfcCurrency_JMD
enumerator IfcCurrency_JOD
enumerator IfcCurrency_JPY
enumerator IfcCurrency_KES
enumerator IfcCurrency_KRW
enumerator IfcCurrency_KWD
enumerator IfcCurrency_KYD
enumerator IfcCurrency_LKR
enumerator IfcCurrency_LUF
enumerator IfcCurrency_MTL
enumerator IfcCurrency_MUR
enumerator IfcCurrency_MXN
enumerator IfcCurrency_MYR
enumerator IfcCurrency_NLG
enumerator IfcCurrency_NZD
enumerator IfcCurrency_OMR
enumerator IfcCurrency_PGK
enumerator IfcCurrency_PHP
enumerator IfcCurrency_PKR
enumerator IfcCurrency_PLN
enumerator IfcCurrency_PTN
enumerator IfcCurrency_QAR
enumerator IfcCurrency_RUR
enumerator IfcCurrency_SAR
enumerator IfcCurrency_SCR
enumerator IfcCurrency_SEK
enumerator IfcCurrency_SGD
enumerator IfcCurrency_SKP
enumerator IfcCurrency_THB
enumerator IfcCurrency_TRL
enumerator IfcCurrency_TTD
enumerator IfcCurrency_TWD
enumerator IfcCurrency_USD
enumerator IfcCurrency_VEB
enumerator IfcCurrency_VND
enumerator IfcCurrency_XEU
enumerator IfcCurrency_ZAR
enumerator IfcCurrency_ZWD
enumerator IfcCurrency_NOK

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCurrencyRelationship : public IfcUtil::IfcBaseEntity

IfcCurrencyRelationship defines the rate of exchange that applies between two designated currencies at a particular time and as published by a particular source.

HISTORY New Entity in IFC2x2.

IFC2x4 CHANGE Subtyped from IfcResourceLevelRelationship, attribute order changed.

Use definitions An IfcCurrencyRelationship is used where there may be a need to reference an IfcCostValue in one currency to an IfcCostValue in another currency. It takes account of fact that currency exchange rates may vary by requiring the recording the date and time of the currency exchange rate used and the source that publishes the rate. There may be many sources and there are different strategies for currency conversion (spot rate, forward buying of currency at a fixed rate). The source for the currency exchange is defined as an instance of IfcLibraryInformation that includes a name and a URL.

Public Types

typedef IfcTemplatedEntityList<IfcCurrencyRelationship> list

Public Functions

::Ifc2x3::IfcMonetaryUnit *RelatingMonetaryUnit() const

The monetary unit from which an exchange is derived. For instance, in the case of a conversion from GBP to USD, the relating monetary unit is GBP.

void setRelatingMonetaryUnit(::Ifc2x3::IfcMonetaryUnit *v)
::Ifc2x3::IfcMonetaryUnit *RelatedMonetaryUnit() const

The monetary unit to which an exchange results. For instance, in the case of a conversion from GBP to USD, the related monetary unit is USD.

void setRelatedMonetaryUnit(::Ifc2x3::IfcMonetaryUnit *v)
double ExchangeRate() const

The currently agreed ratio of the amount of a related monetary unit that is equivalent to a unit amount of the relating monetary unit in a currency relationship. For instance, in the case of a conversion from GBP to USD, the value of the exchange rate may be 1.486 (USD) : 1 (GBP).

void setExchangeRate(double v)
::Ifc2x3::IfcDateAndTime *RateDateTime() const

The date and time at which an exchange rate applies.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect. Attribute made optional.

void setRateDateTime(::Ifc2x3::IfcDateAndTime *v)
bool hasRateSource() const

Whether the optional attribute RateSource is defined for this IfcCurrencyRelationship.

::Ifc2x3::IfcLibraryInformation *RateSource() const

The source from which an exchange rate is obtained.

void setRateSource(::Ifc2x3::IfcLibraryInformation *v)
const IfcParse::entity &declaration() const
IfcCurrencyRelationship(IfcEntityInstanceData *e)
IfcCurrencyRelationship(::Ifc2x3::IfcMonetaryUnit *v1_RelatingMonetaryUnit, ::Ifc2x3::IfcMonetaryUnit *v2_RelatedMonetaryUnit, double v3_ExchangeRate, ::Ifc2x3::IfcDateAndTime *v4_RateDateTime, ::Ifc2x3::IfcLibraryInformation *v5_RateSource)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurtainWall : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Non load bearing wall positioned on the outside of a building and enclosing it. A curtain wall is an exterior wall of a building which is an assembly of components, hung from the edge of the floor/roof structure rather than bearing on a floor. Curtain wall is represented as a building element assembly and implemented as a subtype of IfcBuildingElement that uses an IfcRelAggregates relationship. HISTORY New Entity in IFC Release 2.0

Type Use Definition IfcCurtainWall defines the occuurence of any curtain wall, common information about curtain wall types (or styles) is handled by IfcCurtainWallType. The IfcCurtainWallType (if present) may establish the commontype name, usage (or predefined) type, common material information, common set of properties and common shape representations (using IfcRepresentationMap). The IfcCurtainWallType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. If no IfcCurtainWallType is attached(i.e. if only occurrence information is given) the predefined type may be given by using the ObjectType attribute. NOTE Since the IfcCurtainWall might be represented as an aggregate of parts, e.g. represented by IfcMember, or IfcPlate, these individual parts may have type information attached (represented e.g. by IfcMemberType, or IfcPlateType). Property Set Use Definition: The property sets relating to the IfcCurtainWall are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcCurtainWall are part of this IFC release:

Pset_CurtainWallCommon: common property set for all curtain wall occurrences

Quantity Use Definition The quantities relating to the IfcCurtainWall are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcCurtainWallType.

Qto_CurtainWallBaseQuantities: base quantities for all curtain wall occurrences.

Geometry Use Definitions: The geometric representation of IfcCurtainWall is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Independent geometric representations, as described below, should only be used when the IfcCurtainWall is not defined as an aggregate. If defined as an aggregate, the geometric representation is the sum of the representations of the components within the aggregate. Local placement The local placement for IfcCurtainWall is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to 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.

If the IfcCurtainWall establishes an aggregate, then all contained elements (defined by the IsDecomposedBy inverse attribute) shall be placed relative to the IfcCurtainWall.ObjectPlacement. Geometric Representation The geometric representation of IfcCurtainWall is defined using the following multiple shape representations for its definition:

Axis: A two-dimensional open curve (for restrictions see below) defining the axis for the curtain wall.

This is an optional representation for curtain walls.

Body: A surface model or boundary representation model representation defining the 3D shape of the curtain wall.

If the IfcCurtainWall has components (referenced by SELF\IfcObject.IsDecomposedBy) then no independent shape representation with RepresentationType = ‘Body’ shall be defined. The body of IfcCurtainWall is then geometrically represented by the shape representation of its components. The components are accessed via SELF\IfcObject.IsDecomposedBy[1].RelatedObjects.

If the IfcCurtainWall has no components defined (empty set of SELF\IfcObject.IsDecomposedBy) then the IfcCurtainWall may be represented by an shape representation with the RepresentationIdentifier = ‘Body’.

Axis Representation The axis geometric representation of IfcCurtainWall is defined using the ‘Axis’ representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

The following additional constraints apply to the ‘Axis’ representation:

Axis : IfcPolyline having two Points, or IfcTrimmedCurve with BasisCurve of Type IfcLine or IfcCircle.

Body Representation The body shape representation of IfcCurtainWall is defined using the ‘Body’ representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’, ‘Brep’ and ‘MappedRepresentation’

An own ‘Body’ representation shall only be included if no components of the curtain wall are defined.

Public Types

typedef IfcTemplatedEntityList<IfcCurtainWall> list

Public Functions

const IfcParse::entity &declaration() const
IfcCurtainWall(IfcEntityInstanceData *e)
IfcCurtainWall(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurtainWallType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type (IfcCurtainWallType) defines a list of commonly shared property set definitions of a curtain wall element and an optional set of product representations. It is used to define a curtain wall specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A curtain wall type is used to define the common properties of a certain type of curtain wall that may be applied to many instances of that type to assign a specific style. Curtain wall types may be exchanged without being already assigned to occurrences. The occurrences of the IfcCurtainWallType are represented by instances of IfcCurtainWall.

HISTORY New entity in Release IFC2x Editon 3.

Public Types

typedef IfcTemplatedEntityList<IfcCurtainWallType> list

Public Functions

::Ifc2x3::IfcCurtainWallTypeEnum::Value PredefinedType() const

Identifies the predefined types of a curtain wall element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcCurtainWallTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcCurtainWallType(IfcEntityInstanceData *e)
IfcCurtainWallType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcCurtainWallTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcCurtainWallTypeEnum

Public Types

enum Value

Definition from IAI: Enumeration defining the valid types of curtain wall that can be predefined using the enumeration values. HISTORY New Enumeration in ReleaseIFC2x Edition 3 NOTE Currently there are no specific enumerators defined, the IfcCurtainWallTypeEnum has been added for future extensions.

Values:

enumerator IfcCurtainWallType_USERDEFINED
enumerator IfcCurtainWallType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcCurvatureMeasure : public IfcUtil::IfcBaseType

IfcCurvatureMeasure is a measure for curvature, which is defined as the change of slope per length. This is typically a computed value in structural analysis. It is usually measured in rad/m.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcCurvatureMeasure(IfcEntityInstanceData *e)
IfcCurvatureMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcCurve : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A curve can be envisioned as the path of a point moving in its coordinate space.

NOTE: Corresponding ISO 10303 entity: curve, only the following subtypes have been incorporated into IFC: line as IfcLine, conic as IfcConic, bounded_curve as IfcBoundedCurve. Please refer to ISO/IS 10303-42:1994, p.37 for the final definition of the formal standard. The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem).

HISTORY: New entity in IFC Release 1.0

Informal proposition:

A curve shall be arcwise connected A curve shall have an arc length greater than zero.

Subclassed by Ifc2x3::IfcBoundedCurve, Ifc2x3::IfcConic, Ifc2x3::IfcLine, Ifc2x3::IfcOffsetCurve2D, Ifc2x3::IfcOffsetCurve3D

Public Types

typedef IfcTemplatedEntityList<IfcCurve> list

Public Functions

const IfcParse::entity &declaration() const
IfcCurve(IfcEntityInstanceData *e)
IfcCurve()

Public Static Functions

const IfcParse::entity &Class()
class IfcCurveBoundedPlane : public Ifc2x3::IfcBoundedSurface

Definition from ISO/CD 10303-42:1992: The curve bounded surface is a parametric surface with curved boundaries defined by one or more boundary curves. The bounded surface is defined to be the portion of the basis surface in the direction of N x T from any point on the boundary, where N is the surface normal and T the boundary curve tangent vector at this point. The region so defined shall be arcwise connected.

The IfcCurveBoundedPlane is a specialized bounded surface class that deals only with bounding basis plane surfaces. The definition varies from STEP as outer and inner boundaries are separated attributes and refer to IfcCurve. The only basis surface that is allowed is of type IfcPlane, and the implicit_outer attribute has not been incorporated, since only unbounded surfaces are used as basis surface.

The BasisSurface is an IfcPlane that establishes the position coordinate system by SELF\IfcElementarySurface.Position. The OuterBoundary and the InnerBoundaries (if provided) shall lie on the surface of IfcPlane. Therefore the IfcCurve’s establishing the outer and inner boundaries shall be:

either a 2D curve within the XY plane of the position coordinate sytem of IfcPlane or a 3D curve with all coordinates having a z value = 0.

NOTE Corresponding ISO 10303 entity curve_bounded_surface has been changed to meet the specific requirements of an easy representation of curve bounded planes.

HISTORY New entity in IFC Release 1.5

IFC2x PLATFORM CHANGE: The data type of the attribute OuterBoundary and InnerBoundaries has been changed from Ifc2DCompositeCurve to its supertype IfcCurve with upward compatibility for file based exchange.

Public Types

typedef IfcTemplatedEntityList<IfcCurveBoundedPlane> list

Public Functions

::Ifc2x3::IfcPlane *BasisSurface() const

The surface to be bound.

void setBasisSurface(::Ifc2x3::IfcPlane *v)
::Ifc2x3::IfcCurve *OuterBoundary() const

The outer boundary of the surface.

void setOuterBoundary(::Ifc2x3::IfcCurve *v)
IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr InnerBoundaries() const

An optional set of inner boundaries. They shall not intersect each other or the outer boundary.

void setInnerBoundaries(IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr v)
const IfcParse::entity &declaration() const
IfcCurveBoundedPlane(IfcEntityInstanceData *e)
IfcCurveBoundedPlane(::Ifc2x3::IfcPlane *v1_BasisSurface, ::Ifc2x3::IfcCurve *v2_OuterBoundary, IfcTemplatedEntityList<::Ifc2x3::IfcCurve>::ptr v3_InnerBoundaries)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurveStyle : public Ifc2x3::IfcPresentationStyle

Definition from ISO/CD 10303-46:1992: A curve style specifies the visual appearance of curves.

An IfcCurveStyle provides the style table for presentation information assigned to geometric curves. The style is defined by a color, a font and a width. The IfcCurveStyle defines curve patterns as model patterns, that is, the distance between visible and invisible segments of curve patterns are given in model space dimensions (that have to be scaled using the target plot scale).

Styles are intended to be shared by multiple IfcStyledItem’s, assigning the style to occurrences of (subtypes of) IfcGeometricRepresentationItem’s. Measures given to a font pattern or a curve width are given in global drawing length units.

NOTE global units are defined at the single IfcProject instance, given by UnitsInContext:IfcUnitAssignment, the same units are used for the geometric representation items and for the style definitions.

The measure values for font pattern and curve width apply to the model space with a target plot scale provided for the correct appearance in the default plot scale.. For different scale and projection dependent curve styles a different instance of IfcCurveStyle needs to be used by IfcPresentationStyleAssignment for different IfcGeometricRepresentationSubContext dependent representations.

NOTE the target plot scale is given by IfcGeometricRepresentationSubContext.TargetScale.

An IfcCurveStyle can be assigned to IfcGeometricRepresentationItem’s via the IfcPresentationStyleAssignment through an intermediate IfcStyledItem or IfcAnnotationCurveOccurrence.

NOTE Corresponding ISO 10303 name: curve_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcCurveStyle> list

Public Functions

bool hasCurveFont() const

Whether the optional attribute CurveFont is defined for this IfcCurveStyle.

::Ifc2x3::IfcCurveFontOrScaledCurveFontSelect *CurveFont() const

A curve style font which is used to present a curve. It can either be a predefined curve font, or an explicitly defined curve font. Both may be scaled. If not given, then the curve font should be taken from the layer assignment with style, if that is not given either, then the default curve font applies.

void setCurveFont(::Ifc2x3::IfcCurveFontOrScaledCurveFontSelect *v)
bool hasCurveWidth() const

Whether the optional attribute CurveWidth is defined for this IfcCurveStyle.

::Ifc2x3::IfcSizeSelect *CurveWidth() const

A positive length measure in units of the presentation area for the width of a presented curve. If not given, then the style should be taken from the layer assignment with style, if that is not given either, then the default style applies.

void setCurveWidth(::Ifc2x3::IfcSizeSelect *v)
bool hasCurveColour() const

Whether the optional attribute CurveColour is defined for this IfcCurveStyle.

::Ifc2x3::IfcColour *CurveColour() const

The colour of the visible part of the curve. If not given, then the colour should be taken from the layer assignment with style, if that is not given either, then the default colour applies.

void setCurveColour(::Ifc2x3::IfcColour *v)
const IfcParse::entity &declaration() const
IfcCurveStyle(IfcEntityInstanceData *e)
IfcCurveStyle(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcCurveFontOrScaledCurveFontSelect *v2_CurveFont, ::Ifc2x3::IfcSizeSelect *v3_CurveWidth, ::Ifc2x3::IfcColour *v4_CurveColour)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurveStyleFont : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: A curve style font combines several curve style font pattern entities into a more complex pattern. The resulting pattern is repeated along the curve.

NOTE: Corresponding ISO 10303 name: curve_style_font. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcCurveStyleFont> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcCurveStyleFont.

std::string Name() const

Name that may be assigned with the curve font.

void setName(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcCurveStyleFontPattern>::ptr PatternList() const

A list of curve font pattern entities, that contains the simple patterns used for drawing curves. The patterns are applied in the order they occur in the list.

void setPatternList(IfcTemplatedEntityList<::Ifc2x3::IfcCurveStyleFontPattern>::ptr v)
const IfcParse::entity &declaration() const
IfcCurveStyleFont(IfcEntityInstanceData *e)
IfcCurveStyleFont(boost::optional<std::string> v1_Name, IfcTemplatedEntityList<::Ifc2x3::IfcCurveStyleFontPattern>::ptr v2_PatternList)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurveStyleFontAndScaling : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: A curve style font and scaling is a curve style font and a scalar factor for that font, so that a given curve style font may be applied at various scales.

The IfcCurveStyleFontAndScaling allows for the reuse of the same curve style definition in several sizes. The definition of the CurveFontScale is the scaling of a base curve style pattern to be used as a new or derived curve style pattern.

NOTE The CurveFontScale should not be mixed up with the target plot scale.

An example for IfcCurveStyleFontAndScaling is the sizing of a basic curve style dash pattern ‘dash’ (visible 0.01m, invisible 0.005m) into ‘dash large’ withCurveFontScale = 2 (resulting invisible 0.02m, invisible 0.01m), and into ‘dash small’withCurveFontScale = 0.5 (resulting invisible 0.005m, invisible 0.0025m).

NOTE Corresponding ISO 10303 name: curve_style_font_and_scaling. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcCurveStyleFontAndScaling.

std::string Name() const

Name that may be assigned with the scaling of a curve font.

void setName(std::string v)
::Ifc2x3::IfcCurveStyleFontSelect *CurveFont() const

The curve font to be scaled.

void setCurveFont(::Ifc2x3::IfcCurveStyleFontSelect *v)
double CurveFontScaling() const

The scale factor.

void setCurveFontScaling(double v)
const IfcParse::entity &declaration() const
IfcCurveStyleFontAndScaling(IfcEntityInstanceData *e)
IfcCurveStyleFontAndScaling(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcCurveStyleFontSelect *v2_CurveFont, double v3_CurveFontScaling)

Public Static Functions

const IfcParse::entity &Class()
class IfcCurveStyleFontPattern : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: A curve style font pattern is a pair of visible and invisible curve segment length measures in presentation area units.

NOTE Corresponding ISO 10303 name: curve_style_font_pattern. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

double VisibleSegmentLength() const

The length of the visible segment in the pattern definition.

NOTE For a visible segment representing a point, the value 0. should be assigned.

IFC2x Edition 3 CHANGE The datatype has been changed to IfcLengthMeasure with upward compatibility for file-based exchange.

void setVisibleSegmentLength(double v)
double InvisibleSegmentLength() const

The length of the invisible segment in the pattern definition.

void setInvisibleSegmentLength(double v)
const IfcParse::entity &declaration() const
IfcCurveStyleFontPattern(IfcEntityInstanceData *e)
IfcCurveStyleFontPattern(double v1_VisibleSegmentLength, double v2_InvisibleSegmentLength)

Public Static Functions

const IfcParse::entity &Class()
class IfcDamperType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcDamperType defines commonly shared information for occurrences of dampers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a damper specification (i.e. the specific product information, that is common to all occurrences of that product type). Damper types may be exchanged without being already assigned to occurrences. Occurrences of IfcDamperType are represented by instances of IfcDamper.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DamperTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_DamperTypeControlDamper (CONTROLDAMPER) Pset_DamperTypeFireDamper (FIREDAMPER) Pset_DamperTypeFireSmokeDamper (FIRESMOKEDAMPER) Pset_DamperTypeSmokeDamper (SMOKEDAMPER)

Material Use Definition The material of the IfcDamperType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Blade’: The material from which the damper blades are constructed. ‘Frame’: The material from which the damper frame is constructed. ‘Seal’: The material from which the damper seals are constructed.

Port Use Definition The distribution ports relating to the IfcDamperType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcDamper for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcDamperType> list

Public Functions

::Ifc2x3::IfcDamperTypeEnum::Value PredefinedType() const

Type of damper.

void setPredefinedType(::Ifc2x3::IfcDamperTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcDamperType(IfcEntityInstanceData *e)
IfcDamperType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcDamperTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDamperTypeEnum

Public Types

enum Value

This enumeration defines the various types of damper:

BALANCINGDAMPER: Damper used for purposes of manually balancing pressure differences. Commonly operated by mechanical adjustment. BACKDRAFTDAMPER: Backdraft damper used to restrict the movement of air in one direction. Commonly operated by mechanical spring. BLASTDAMPER: Blast damper use to prevent protect occupants and equipment against overpressures resultant of an explosion. Commonly operated by mechanical spring. CONTROLDAMPER: Control damper used to modulate the flow of air by adjusting the position of the blades. Commonly operated by an actuator of a building automation system. FIREDAMPER: Fire damper used to prevent the spread of fire for a specified duration. Commonly operated by fusable link that melts above a certain temperature. FIRESMOKEDAMPER: Combination fire and smoke damper used to preven the spread of fire and smoke. Commonly operated by a fusable link and a smoke detector FUMEHOODEXHAUST: Fume hood exhaust damper. Commonly operated by actuator. GRAVITYDAMPER: Gravity damper closes from the force of gravity. Commonly operated by gravitational weight. GRAVITYRELIEFDAMPER: Gravity-relief damper used to allow air to move upon a buildup of enough pressure to overcome the gravitational force exerted upon the damper blades. Commonly operated by gravitational weight. RELIEFDAMPER: Relief damper used to allow air to move upon a buildup of a specified pressure differential. Commonly operated by mechanical spring. SMOKEDAMPER: Smoke damper used to prevent the spread of smoke. Commonly operated by a smoke detector of a building automation system. USERDEFINED: User-defined damper. NOTDEFINED: Undefined damper.

HISTORY: New enumeration in IFC R2.0

Values:

enumerator IfcDamperType_CONTROLDAMPER
enumerator IfcDamperType_FIREDAMPER
enumerator IfcDamperType_SMOKEDAMPER
enumerator IfcDamperType_FIRESMOKEDAMPER
enumerator IfcDamperType_BACKDRAFTDAMPER
enumerator IfcDamperType_RELIEFDAMPER
enumerator IfcDamperType_BLASTDAMPER
enumerator IfcDamperType_GRAVITYDAMPER
enumerator IfcDamperType_GRAVITYRELIEFDAMPER
enumerator IfcDamperType_BALANCINGDAMPER
enumerator IfcDamperType_FUMEHOODEXHAUST
enumerator IfcDamperType_USERDEFINED
enumerator IfcDamperType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcDataOriginEnum

Public Types

enum Value

IfcDataOriginEnum identifies the origin of time data:

MEASURED: The origin of the time data is a measurement device. PREDICTED: The time data are a prediction. SIMULATED: The origin of the time data is a simulation. NOTDEFINED: The origin of the time data is undefined.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcDataOrigin_MEASURED
enumerator IfcDataOrigin_PREDICTED
enumerator IfcDataOrigin_SIMULATED
enumerator IfcDataOrigin_USERDEFINED
enumerator IfcDataOrigin_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDateAndTime : public IfcUtil::IfcBaseEntity

Public Types

typedef IfcTemplatedEntityList<IfcDateAndTime> list

Public Functions

::Ifc2x3::IfcCalendarDate *DateComponent() const
void setDateComponent(::Ifc2x3::IfcCalendarDate *v)
::Ifc2x3::IfcLocalTime *TimeComponent() const
void setTimeComponent(::Ifc2x3::IfcLocalTime *v)
const IfcParse::entity &declaration() const
IfcDateAndTime(IfcEntityInstanceData *e)
IfcDateAndTime(::Ifc2x3::IfcCalendarDate *v1_DateComponent, ::Ifc2x3::IfcLocalTime *v2_TimeComponent)

Public Static Functions

const IfcParse::entity &Class()
class IfcDayInMonthNumber : public IfcUtil::IfcBaseType

Definition from IAI: The IfcDayInMonthNumber is an integer that defines the position of the specified day in a month. Type: INTEGER NOTE Corresponding STEP name: day_in_month_number, please refer to ISO/IS 10303-41:1994 for the final definition of the formal standard. HISTORY New type in IFC Release 1.5.1. IFC2x4 CHANGE Where rule ValidRange added.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDayInMonthNumber(IfcEntityInstanceData *e)
IfcDayInMonthNumber(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcDaylightSavingHour : public IfcUtil::IfcBaseType

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDaylightSavingHour(IfcEntityInstanceData *e)
IfcDaylightSavingHour(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcDefinedSymbol : public Ifc2x3::IfcGeometricRepresentationItem

A defined symbol is a symbolic representation that gets its shape information by an established convention, either through a predefined symbol, or an externally defined symbol.

NOTE: The IfcDefinedSymbol is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: defined_symbol. The target attribute used the 2d Cartesian transformation operator, including the non-uniform subtype, which is available in IFC (instead of the symbol_target). Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcDefinedSymbol> list

Public Functions

::Ifc2x3::IfcDefinedSymbolSelect *Definition() const

An implicit description of the symbol, either predefined or externally defined.

void setDefinition(::Ifc2x3::IfcDefinedSymbolSelect *v)
::Ifc2x3::IfcCartesianTransformationOperator2D *Target() const

A description of the placement, orientation and (uniform or non-uniform) scaling of the defined symbol.

void setTarget(::Ifc2x3::IfcCartesianTransformationOperator2D *v)
const IfcParse::entity &declaration() const
IfcDefinedSymbol(IfcEntityInstanceData *e)
IfcDefinedSymbol(::Ifc2x3::IfcDefinedSymbolSelect *v1_Definition, ::Ifc2x3::IfcCartesianTransformationOperator2D *v2_Target)

Public Static Functions

const IfcParse::entity &Class()
class IfcDerivedProfileDef : public Ifc2x3::IfcProfileDef

IfcDerivedProfileDef defines the profile by transformation from the parent profile. The transformation is given by a two dimensional transformation operator. Transformation includes translation, rotation, mirror and scaling. The latter can be uniform or non uniform. The derived profiles may be used to define swept surfaces, swept area solids or sectioned spines.

The transformation effects the position, rotation, mirroring or scale of the profile at the underlying coordinate system, i.e. the coordinate system defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. The position and potential rotation of the ParentProfile within the underlying coordinate system is taken into consideration before applying the Cartesian transformation operator.

Note, if only mirroring is required, IfcMirroredProfileDef should be used instead.

HISTORY: New entity in IFC Release 2x.

Figure 316 illustrates examples of derived profiles.

Parameter The IfcDerivedProfileDef is defined using the IfcCartesianTransformationOperator2D (CTO), which is applied to the parent profile definition.

Example The example shows an uniform scaling and a transformation of an IfcRectangleProfileDef to match the lower-left cardinal point. The attributes of the CTO are:

Axis1 = NIL (defaults to 1.,0.) Axis2 = NIL (defaults to 0.,1.) LocalOrigin = IfcCartesianPoint(,) Scale = 2.

Note: The ParentProfile has a Position = IfcCartesianPoint(,) already.

Parameter The IfcDerivedProfileDef is defined using non uniform transformationsby applying the IfcCartesianTransformationOperator2DnonUniform as a subtype of the 2D CTO.

Example The example shows a non-uniform scaling and a translation of an IfcRectangleProfileDef to match the lower-left cardinal point. The attributes of the CTO are:

Axis1 = NIL (defaults to 1.,0.) Axis2 = NIL (defaults to 0.,1.) LocalOrigin = IfcCartesianPoint(0.,<1/2 YDim) Scale = 1. Scale2 = 2.

Note: The ParentProfile has a Position = IfcCartesianPoint(,) already.

Parameter The IfcDerivedProfileDef is defined using mirroring by applying the IfcCartesianTransformationOperator2D (CTO) to the parent profile.

Example The example shows a mirroring of an IfcLShapeProfileDef to match the centre cardinal point. The attributes of the CTO are:

Axis1 = (-1.,0.) Axis2 = NIL (defaults to 0.,1.) LocalOrigin = IfcCartesianPoint(0.,0.) Scale = NIL (defaults to 1.)

Note: The ParentProfile has a Position = IfcCartesianPoint(0.,0.).

This example is for illustration only. If the transformation results only in mirroring like shown in the example, then IfcMirroredProfileDef should be used instead of IfcDerivedProfileDef.

Note: The following color map applies:

black coordinate axes show the underlying coordinate system of the swept surface, swept area solid, or sectioned spine

red coordinate axes show the position coordinate system of the parent profile

brown coordinate axes show the position coordinate system of the derived profile

Figure 316 — Derived profile

Public Types

typedef IfcTemplatedEntityList<IfcDerivedProfileDef> list

Public Functions

::Ifc2x3::IfcProfileDef *ParentProfile() const

The parent profile provides the origin of the transformation.

void setParentProfile(::Ifc2x3::IfcProfileDef *v)
::Ifc2x3::IfcCartesianTransformationOperator2D *Operator() const

Transformation operator applied to the parent profile.

void setOperator(::Ifc2x3::IfcCartesianTransformationOperator2D *v)
bool hasLabel() const

Whether the optional attribute Label is defined for this IfcDerivedProfileDef.

std::string Label() const

The name by which the transformation may be referred to. The actual meaning of the name has to be defined in the context of applications.

void setLabel(std::string v)
const IfcParse::entity &declaration() const
IfcDerivedProfileDef(IfcEntityInstanceData *e)
IfcDerivedProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcProfileDef *v3_ParentProfile, ::Ifc2x3::IfcCartesianTransformationOperator2D *v4_Operator, boost::optional<std::string> v5_Label)

Public Static Functions

const IfcParse::entity &Class()
class IfcDerivedUnit : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: A derived unit is an expression of units.

EXAMPLE: Newton per square millimetre is a derived unit.

NOTE: Corresponding ISO 10303 name: derived_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcDerivedUnit> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcDerivedUnitElement>::ptr Elements() const

The group of units and their exponents that define the derived unit.

void setElements(IfcTemplatedEntityList<::Ifc2x3::IfcDerivedUnitElement>::ptr v)
::Ifc2x3::IfcDerivedUnitEnum::Value UnitType() const

Name of the derived unit chosen from an enumeration of derived unit types for use in IFC models.

void setUnitType(::Ifc2x3::IfcDerivedUnitEnum::Value v)
bool hasUserDefinedType() const

Whether the optional attribute UserDefinedType is defined for this IfcDerivedUnit.

std::string UserDefinedType() const
void setUserDefinedType(std::string v)
const IfcParse::entity &declaration() const
IfcDerivedUnit(IfcEntityInstanceData *e)
IfcDerivedUnit(IfcTemplatedEntityList<::Ifc2x3::IfcDerivedUnitElement>::ptr v1_Elements, ::Ifc2x3::IfcDerivedUnitEnum::Value v2_UnitType, boost::optional<std::string> v3_UserDefinedType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDerivedUnitElement : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: A derived unit element is one of the unit quantities which makes up a derived unit.

EXAMPLE: Newtons per square millimetre is a derived unit. It has two elements, Newton whose exponent has a value of 1 and millimetre whose exponent is -2.

NOTE: Corresponding ISO 10303 name: derived_unit_element, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcDerivedUnitElement> list

Public Functions

::Ifc2x3::IfcNamedUnit *Unit() const

The fixed quantity which is used as the mathematical factor.

void setUnit(::Ifc2x3::IfcNamedUnit *v)
int Exponent() const

The power that is applied to the unit attribute.

void setExponent(int v)
const IfcParse::entity &declaration() const
IfcDerivedUnitElement(IfcEntityInstanceData *e)
IfcDerivedUnitElement(::Ifc2x3::IfcNamedUnit *v1_Unit, int v2_Exponent)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDerivedUnitEnum

Public Types

enum Value

IfcDerivedUnitEnum is an enumeration type for allowed types of derived units. ENUMERATION

ACCELERATIONUNIT ANGULARVELOCITYUNIT COMPOUNDPLANEANGLEUNIT DYNAMICVISCOSITYUNIT HEATFLUXDENSITYUNIT INTEGERCOUNTRATEUNIT ISOTHERMALMOISTURECAPACITYUNIT KINEMATICVISCOSITYUNIT LINEARFORCEUNIT LINEARMOMENTUNIT LINEARSTIFFNESSUNIT LINEARVELOCITYUNIT MASSDENSITYUNIT MASSFLOWRATEUNIT MODULUSOFELASTICITYUNIT MODULUSOFSUBGRADEREACTIONUNIT MOISTUREDIFFUSIVITYUNIT MOLECULARWEIGHTUNIT MOMENTORINERTIAUNIT PLANARFORCEUNIT ROTATIONALFREQUENCYUNIT ROTATIONALSTIFFNESSUNIT SHEARMODULUSUNIT SPECIFICHEATCAPACITYUNIT THERMALADMITTANCEUNIT THERMALCONDUCTANCEUNIT THERMALRESISTANCEUNIT THERMALTRANSMITTANCEUNIT TORQUEUNIT VAPORPERMEABILITYUNIT VOLUMETRICFLOWRATEUNIT CURVATUREUNIT HEATINGVALUEUNIT IONCONCENTRATIONUNIT LUMINOUSINTENSITYDISTRIBUTIONUNIT MASSPERLENGTHUNIT MODULUSOFLINEARSUBGRADEREACTIONUNIT MODULUSOFROTATIONALSUBGRADEREACTIONUNIT PHUNIT ROTATIONALMASSUNIT SECTIONAREAINTEGRALUNIT SECTIONMODULUSUNIT SOUNDPOWERUNIT SOUNDPRESSUREUNIT TEMPERATUREGRADIENTUNIT TEMPERATURERATEOFCHANGE THERMALEXPANSIONCOEFFICIENTUNIT WARPINGCONSTANTUNIT WARPINGMOMENTUNIT USERDEFINED: User defined derived unit.

HISTORY: New type in IFC Release 2.0.

IFC 2x4 change: added TEMPERATURERATEOFCHANGE.

Values:

enumerator IfcDerivedUnit_ANGULARVELOCITYUNIT
enumerator IfcDerivedUnit_COMPOUNDPLANEANGLEUNIT
enumerator IfcDerivedUnit_DYNAMICVISCOSITYUNIT
enumerator IfcDerivedUnit_HEATFLUXDENSITYUNIT
enumerator IfcDerivedUnit_INTEGERCOUNTRATEUNIT
enumerator IfcDerivedUnit_ISOTHERMALMOISTURECAPACITYUNIT
enumerator IfcDerivedUnit_KINEMATICVISCOSITYUNIT
enumerator IfcDerivedUnit_LINEARVELOCITYUNIT
enumerator IfcDerivedUnit_MASSDENSITYUNIT
enumerator IfcDerivedUnit_MASSFLOWRATEUNIT
enumerator IfcDerivedUnit_MOISTUREDIFFUSIVITYUNIT
enumerator IfcDerivedUnit_MOLECULARWEIGHTUNIT
enumerator IfcDerivedUnit_SPECIFICHEATCAPACITYUNIT
enumerator IfcDerivedUnit_THERMALADMITTANCEUNIT
enumerator IfcDerivedUnit_THERMALCONDUCTANCEUNIT
enumerator IfcDerivedUnit_THERMALRESISTANCEUNIT
enumerator IfcDerivedUnit_THERMALTRANSMITTANCEUNIT
enumerator IfcDerivedUnit_VAPORPERMEABILITYUNIT
enumerator IfcDerivedUnit_VOLUMETRICFLOWRATEUNIT
enumerator IfcDerivedUnit_ROTATIONALFREQUENCYUNIT
enumerator IfcDerivedUnit_TORQUEUNIT
enumerator IfcDerivedUnit_MOMENTOFINERTIAUNIT
enumerator IfcDerivedUnit_LINEARMOMENTUNIT
enumerator IfcDerivedUnit_LINEARFORCEUNIT
enumerator IfcDerivedUnit_PLANARFORCEUNIT
enumerator IfcDerivedUnit_MODULUSOFELASTICITYUNIT
enumerator IfcDerivedUnit_SHEARMODULUSUNIT
enumerator IfcDerivedUnit_LINEARSTIFFNESSUNIT
enumerator IfcDerivedUnit_ROTATIONALSTIFFNESSUNIT
enumerator IfcDerivedUnit_MODULUSOFSUBGRADEREACTIONUNIT
enumerator IfcDerivedUnit_ACCELERATIONUNIT
enumerator IfcDerivedUnit_CURVATUREUNIT
enumerator IfcDerivedUnit_HEATINGVALUEUNIT
enumerator IfcDerivedUnit_IONCONCENTRATIONUNIT
enumerator IfcDerivedUnit_LUMINOUSINTENSITYDISTRIBUTIONUNIT
enumerator IfcDerivedUnit_MASSPERLENGTHUNIT
enumerator IfcDerivedUnit_MODULUSOFLINEARSUBGRADEREACTIONUNIT
enumerator IfcDerivedUnit_MODULUSOFROTATIONALSUBGRADEREACTIONUNIT
enumerator IfcDerivedUnit_PHUNIT
enumerator IfcDerivedUnit_ROTATIONALMASSUNIT
enumerator IfcDerivedUnit_SECTIONAREAINTEGRALUNIT
enumerator IfcDerivedUnit_SECTIONMODULUSUNIT
enumerator IfcDerivedUnit_SOUNDPOWERUNIT
enumerator IfcDerivedUnit_SOUNDPRESSUREUNIT
enumerator IfcDerivedUnit_TEMPERATUREGRADIENTUNIT
enumerator IfcDerivedUnit_THERMALEXPANSIONCOEFFICIENTUNIT
enumerator IfcDerivedUnit_WARPINGCONSTANTUNIT
enumerator IfcDerivedUnit_WARPINGMOMENTUNIT
enumerator IfcDerivedUnit_USERDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDescriptiveMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A descriptive measure is a human interpretable definition of a quantifiable value. Type: STRING

NOTE Corresponding ISO 10303 name:descriptive_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDescriptiveMeasure(IfcEntityInstanceData *e)
IfcDescriptiveMeasure(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcDiameterDimension : public Ifc2x3::IfcDimensionCurveDirectedCallout

Public Types

typedef IfcTemplatedEntityList<IfcDiameterDimension> list

Public Functions

const IfcParse::entity &declaration() const
IfcDiameterDimension(IfcEntityInstanceData *e)
IfcDiameterDimension(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcDimensionalExponents : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: The dimensionality of any quantity can be expressed as a product of powers of the dimensions of base quantities. The dimensional exponents entity defines the powers of the dimensions of the base quantities. All the physical quantities are founded on seven base quantities (ISO 31 (clause 2)).

NOTE: Length, mass, time, electric current, thermodynamic temperature, amount of substance, and luminous intensity are the seven base quantities.

EXAMPLE: A length of 2 millimetres has a length exponent of 1. The remaining exponents are equal to 0.

EXAMPLE: A velocity of 2 millimetres per second has a length exponent of 1 and a time exponent of -1. The remaining exponents are equal to 0.

NOTE Corresponding STEP name: dimensional_exponents, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcDimensionalExponents> list

Public Functions

int LengthExponent() const

The power of the length base quantity.

void setLengthExponent(int v)
int MassExponent() const

The power of the mass base quantity.

void setMassExponent(int v)
int TimeExponent() const

The power of the time base quantity.

void setTimeExponent(int v)
int ElectricCurrentExponent() const

The power of the electric current base quantity.

void setElectricCurrentExponent(int v)
int ThermodynamicTemperatureExponent() const

The power of the thermodynamic temperature base quantity.

void setThermodynamicTemperatureExponent(int v)
int AmountOfSubstanceExponent() const

The power of the amount of substance base quantity.

void setAmountOfSubstanceExponent(int v)
int LuminousIntensityExponent() const

The power of the luminous intensity base quantity.

void setLuminousIntensityExponent(int v)
const IfcParse::entity &declaration() const
IfcDimensionalExponents(IfcEntityInstanceData *e)
IfcDimensionalExponents(int v1_LengthExponent, int v2_MassExponent, int v3_TimeExponent, int v4_ElectricCurrentExponent, int v5_ThermodynamicTemperatureExponent, int v6_AmountOfSubstanceExponent, int v7_LuminousIntensityExponent)

Public Static Functions

const IfcParse::entity &Class()
class IfcDimensionCalloutRelationship : public Ifc2x3::IfcDraughtingCalloutRelationship

Public Functions

const IfcParse::entity &declaration() const
IfcDimensionCalloutRelationship(IfcEntityInstanceData *e)
IfcDimensionCalloutRelationship(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDraughtingCallout *v3_RelatingDraughtingCallout, ::Ifc2x3::IfcDraughtingCallout *v4_RelatedDraughtingCallout)

Public Static Functions

const IfcParse::entity &Class()
class IfcDimensionCount : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-42:1992: A dimension count is a positive integer used to define the coordinate space dimensionality.

The IfcDimensionCount is restricted to have the dimensionality of either 1, 2, or 3 - the WR1 had been added as an addition to the ISO 10303:42 entity dimension_count. In contrary to the ISO 10303:42 constraint, that all geometric representation items within a geometric representation context are forced to have the same dimension count, the IFC geometry allows mixed dimensions, particularly when defining the boundary of planar surfaces.

NOTE Corresponding ISO 10303 type: dimension_count, please refer to ISO/IS 10303-42:1994, p. 14 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.5

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDimensionCount(IfcEntityInstanceData *e)
IfcDimensionCount(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcDimensionCurve : public Ifc2x3::IfcAnnotationCurveOccurrence

Public Types

typedef IfcTemplatedEntityList<IfcDimensionCurve> list

Public Functions

IfcTemplatedEntityList<IfcTerminatorSymbol>::ptr AnnotatedBySymbols() const
const IfcParse::entity &declaration() const
IfcDimensionCurve(IfcEntityInstanceData *e)
IfcDimensionCurve(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcDimensionCurveDirectedCallout : public Ifc2x3::IfcDraughtingCallout

Subclassed by Ifc2x3::IfcAngularDimension, Ifc2x3::IfcDiameterDimension, Ifc2x3::IfcLinearDimension, Ifc2x3::IfcRadiusDimension

Public Functions

const IfcParse::entity &declaration() const
IfcDimensionCurveDirectedCallout(IfcEntityInstanceData *e)
IfcDimensionCurveDirectedCallout(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcDimensionCurveTerminator : public Ifc2x3::IfcTerminatorSymbol

Public Functions

::Ifc2x3::IfcDimensionExtentUsage::Value Role() const
void setRole(::Ifc2x3::IfcDimensionExtentUsage::Value v)
const IfcParse::entity &declaration() const
IfcDimensionCurveTerminator(IfcEntityInstanceData *e)
IfcDimensionCurveTerminator(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name, ::Ifc2x3::IfcAnnotationCurveOccurrence *v4_AnnotatedCurve, ::Ifc2x3::IfcDimensionExtentUsage::Value v5_Role)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDimensionExtentUsage

Public Types

enum Value

Values:

enumerator IfcDimensionExtentUsage_ORIGIN
enumerator IfcDimensionExtentUsage_TARGET

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDimensionPair : public Ifc2x3::IfcDraughtingCalloutRelationship

Public Types

typedef IfcTemplatedEntityList<IfcDimensionPair> list

Public Functions

const IfcParse::entity &declaration() const
IfcDimensionPair(IfcEntityInstanceData *e)
IfcDimensionPair(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDraughtingCallout *v3_RelatingDraughtingCallout, ::Ifc2x3::IfcDraughtingCallout *v4_RelatedDraughtingCallout)

Public Static Functions

const IfcParse::entity &Class()
class IfcDirection : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: This entity defines a general direction vector in two or three dimensional space. The actual magnitudes of the components have no effect upon the direction being defined, only the ratios X:Y:Z or X:Y are significant.

NOTE: The components of this entity are not normalized. If a unit vector is required it should be normalized before use.

NOTE: Corresponding ISO 10303 entity: direction. Please refer to ISO/IS 10303-42:1994, p.26 for the final definition of the formal standard. The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem).

HISTORY: New entity in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcDirection> list

Public Functions

std::vector<double> DirectionRatios() const

The components in the direction of X axis (DirectionRatios[1]), of Y axis (DirectionRatios[2]), and of Z axis (DirectionRatios[3])

void setDirectionRatios(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcDirection(IfcEntityInstanceData *e)
IfcDirection(std::vector<double> v1_DirectionRatios)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDirectionSenseEnum

Public Types

enum Value

IfcDirectionSenseEnum is an enumeration denoting whether sense of direction is positive or negative along the given axis.

ENUMERATION

POSITIVE: Direction defined to be positive. NEGATIVE: Direction defined to be negative.

HISTORY New Type in IFC2x.

Values:

enumerator IfcDirectionSense_POSITIVE
enumerator IfcDirectionSense_NEGATIVE

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDiscreteAccessory : public Ifc2x3::IfcElementComponent

Definition from IAI: Representation of different kinds of accessories included in or added to elements.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Attribute PredefinedType added.

General usage The exact type information of the IfcDiscreteAccessory is given in the ObjectType attribute inherited from IfcObject. Standard type designations are provided for guideline below. The list is not exhaustive and the list of definitions may be extended based on local national extensions.

Accessory type Standard type designation Description

Shading devices: ‘Shading device’ Elements specifically designed to provide shading, often fixed externally and sometimes moving (e.g. by rotation)

Corbels as separate components: ‘Hidden steel corbel’ Corbel system made from steel components embedded into the master element

‘Visible steel corbel’ Corbel system made from steel components protruding from the master element

‘Visible concrete corbel’ Corbel system made as a separate precast concrete component added to the master element

‘Ladder truss connector’ A fixing device in truss form with straight cross bars in ladder form holding two precast conrete panels together in a sandwich wall panel.

‘Panel suspender’ A straight fixing device holding two precast conrete panels together in a sandwich wall panel.

Electrical accessories for precast concrete elements: ‘Protective plug’ Protective plug used in element for protecting electrical accessories during manufacturing, transportation and assembly.

Fixing parts: ‘Standard fixing plate’ Standard fixing plate.

‘Edge fixing plate’ Fixing plate attached to the edge of an element.

‘Corner fixing plate’ Fixing plate attached to the corner of an element.

‘Slab fixing plate’ Fixing plate for slabs.

‘Balcony hinge’ Accessory supporting and fixing balconies.

‘Frame shoe’ Fixing shoe for frames.

‘Thermo frame’ Thermo frame.

‘Column shoe’ Fixing shoe for columns.

‘Wall shoe’ Fixing shoe for walls.

‘Fixing socket’ Fixing socket.

Joint accessories: ‘Neoprene bearing plate’ Rubber plate used as a bearing in, for example, joints between column corbels and beams.

‘Working joint reinforcement’ Reinforcement accessory used in working joints.

‘Expansion joint reinforcement’ Reinforcement accessory used in expansion joints.

‘Ribbed steel bar extension’ Extension accessory made of a ribbed (reinforcement) bar used in joints.

‘Steel pin bolt’ Pin bolt used to join together, for example, columns and beams.

‘Concrete dowel’ Dowel pin used in joints.

‘Concrete groove’ A groove made in a joint.

‘Steel plate’ A steel plate used as an accessory in a joint.

‘Wire loop’ A joint connector accessory made from a wire loop.

‘Steel loop’ A joint connector accessory made from a steel bar loop.

‘Sealing strip’ A strip sealing the joint.

‘Sealing compound’ Sealing compound protecting and sealing the joint.

Lifting accessories: ‘Wire lifting hook’ A lifting aid in the form of a wire loop.

‘Steel lifting hook’ A lifting aid in the form of a steel bar loop.

‘Lifting socket’ A lifting aid in the form of a socket.

‘Steel lifting anchor’ A lifting aid in the form of a steel lifting anchor.

‘Lifting hole’ A lifting aid in the form of a hole.

Accessories mainly used in the building services domain: ‘Antivibration’ An isolating device to prevent other elements to be effected by vibrations.

‘Drop rod’ A length of material providing a hanging support to a bracket. Note that a drop rod is considered to include nuts and washers required for securing.

‘Duct foot’ A base support used to receive a vertical pipe (BS6100 330 3309 - duct foot).

‘Framing’ A frame placed around a penetration to prevent scraping against the building surface or structure.

‘Grommet’ An element placed within a penetration that seals the penetration for a particular reason.

‘Rack’ A set of shelving for the purposes of storage that may be freestanding or bolted to a structure.

‘Safety part’ A part, typically installed in vertical shafts at each level, to ensure safety from falling when entering the shaft.

‘Sleeve’ A thin barrier placed between a penetration and a penetrating element.

‘Support section’ A section of material that is used as an intermediate support upon which multiple brackets can be mounted.

Public Types

typedef IfcTemplatedEntityList<IfcDiscreteAccessory> list

Public Functions

const IfcParse::entity &declaration() const
IfcDiscreteAccessory(IfcEntityInstanceData *e)
IfcDiscreteAccessory(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcDiscreteAccessoryType : public Ifc2x3::IfcElementComponentType

Definition from IAI: The element type (IfcDiscreteAccessoryType) defines a list of commonly shared property set definitions of a discrete accessory and an optional set of product representations. It is used to define a supporting element mainly within structural and building services domains (i.e. the specific type information common to all occurrences of that type). The occurrences of the IfcDiscreteAccessoryType are represented by instances of IfcDiscreteAccessory. The IfcDiscreteAccessoryType is a specialization of the general building element component type to represent different type of structural and building service related auxiliary elements. HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Attribute PredefinedType added.

General usage The exact type information of the IfcDiscreteAccessoryType is given in the ElementType attribute inherited from IfcElementType. Standard type designations are provided for guideline below. The list is not exhaustive and the list of definitions may be extended based on local national extensions.

Accessory type Standard type designation Description

Shading devices: ‘Shading device’ Elements specifically designed to provide shading, often fixed externally and sometimes moving (e.g. by rotation)

Corbels as separate components: ‘Hidden steel corbel’ Corbel system made from steel components embedded into the master element

‘Visible steel corbel’ Corbel system made from steel components protruding from the master element

‘Visible concrete corbel’ Corbel system made as a separate precast concrete component added to the master element

Connecting accessories, for example for sandwich wall panels: ‘Diagonal truss connector’ A fixing device in truss form with diagonal cross bars holding two precast conrete panels together in a sandwich wall panel.

‘Ladder truss connector’ A fixing device in truss form with straight cross bars in ladder form holding two precast conrete panels together in a sandwich wall panel.

‘Panel suspender’ A straight fixing device holding two precast conrete panels together in a sandwich wall panel.

Electrical accessories for precast concrete elements: ‘Protective plug’ Protective plug used in element for protecting electrical accessories during manufacturing, transportation and assembly.

Fixing parts: ‘Standard fixing plate’ Standard fixing plate.

‘Edge fixing plate’ Fixing plate attached to the edge of an element.

‘Corner fixing plate’ Fixing plate attached to the corner of an element.

‘Slab fixing plate’ Fixing plate for slabs.

‘Balcony hinge’ Accessory supporting and fixing balconies.

‘Frame shoe’ Fixing shoe for frames.

‘Thermo frame’ Thermo frame.

‘Column shoe’ Fixing shoe for columns.

‘Wall shoe’ Fixing shoe for walls.

‘Fixing socket’ Fixing socket.

Joint accessories: ‘Neoprene bearing plate’ Rubber plate used as a bearing in, for example, joints between column corbels and beams.

‘Working joint reinforcement’ Reinforcement accessory used in working joints.

‘Expansion joint reinforcement’ Reinforcement accessory used in expansion joints.

‘Ribbed steel bar extension’ Extension accessory made of a ribbed (reinforcement) bar used in joints.

‘Steel pin bolt’ Pin bolt used to join together, for example, columns and beams.

‘Concrete dowel’ Dowel pin used in joints.

‘Concrete groove’ A groove made in a joint.

‘Steel plate’ A steel plate used as an accessory in a joint.

‘Wire loop’ A joint connector accessory made from a wire loop.

‘Steel loop’ A joint connector accessory made from a steel bar loop.

‘Sealing strip’ A strip sealing the joint.

‘Sealing compound’ Sealing compound protecting and sealing the joint.

Lifting accessories: ‘Wire lifting hook’ A lifting aid in the form of a wire loop.

‘Steel lifting hook’ A lifting aid in the form of a steel bar loop.

‘Lifting socket’ A lifting aid in the form of a socket.

‘Steel lifting anchor’ A lifting aid in the form of a steel lifting anchor.

‘Lifting hole’ A lifting aid in the form of a hole.

Accessories mainly used in the building services domain: ‘Antivibration’ An isolating device to prevent other elements to be effected by vibrations.

‘Drop rod’ A length of material providing a hanging support to a bracket. Note that a drop rod is considered to include nuts and washers required for securing.

‘Duct foot’ A base support used to receive a vertical pipe (BS6100 330 3309 - duct foot).

‘Framing’ A frame placed around a penetration to prevent scraping against the building surface or structure.

‘Grommet’ An element placed within a penetration that seals the penetration for a particular reason.

‘Rack’ A set of shelving for the purposes of storage that may be freestanding or bolted to a structure.

‘Safety part’ A part, typically installed in vertical shafts at each level, to ensure safety from falling when entering the shaft.

‘Sleeve’ A thin barrier placed between a penetration and a penetrating element.

‘Support section’ A section of material that is used as an intermediate support upon which multiple brackets can be mounted.

Subclassed by Ifc2x3::IfcVibrationIsolatorType

Public Functions

const IfcParse::entity &declaration() const
IfcDiscreteAccessoryType(IfcEntityInstanceData *e)
IfcDiscreteAccessoryType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionChamberElement : public Ifc2x3::IfcDistributionFlowElement

A distribution chamber element defines a place at which distribution systems and their constituent elements may be inspected or through which they may travel.

An IfcDistributionChamberElement is a formed volume used in a distribution system, such as a sump, trench or manhole. Instances of IfcDistributionSystem or IfcDistributionFlowElement may be related to the IfcDistributionChamberElement enabling their location in or at the chamber to be determined.

HISTORY: New entity in IFC2x2

Type Use Definition IfcDistributionChamberElement defines the occurrence of any distribution chamber element; common information about distribution chamber element types is handled by IfcDistributionChamberElementType. The IfcDistributionChamberElementType (if present) may establish the common type name, usage (predefined type), properties, materials, ports, composition, assignments, and representations. The IfcDistributionChamberElementType is attached using the IfcRelDefinesByType objectified relationship and is accessible by the IsTypedBy inverse attribute. If the IfcDistributionChamberElementType has ports or aggregated elements, such objects are reflected at the IfcDistributionChamberElement occurrence using the IfcRelDefinesByObject relationship.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Property sets may also be specified at the IfcDistributionChamberElementType, defining the common property data for all occurrences of the same type. They are then accessible by the IsTypedBy inverse attribute pointing to IfcDistributionChamberElementType.HasPropertySets. If both are given, then the properties directly defined at IfcDistributionChamberElement override the properties defined at IfcDistributionChamberElementType. Refer to the documentation at the supertype IfcDistributionFlowElement and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DistributionChamberElementCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute: Pset_DistributionChamberElementTypeFormedDuct (FORMEDDUCT) Pset_DistributionChamberElementTypeInspectionChamber (INSPECTIONCHAMBER) Pset_DistributionChamberElementTypeInspectionPit (INSPECTIONPIT) Pset_DistributionChamberElementTypeManhole (MANHOLE) Pset_DistributionChamberElementTypeMeterChamber (METERCHAMBER) Pset_DistributionChamberElementTypeSump (SUMP) Pset_DistributionChamberElementTypeTrench (TRENCH) Pset_DistributionChamberElementTypeValveChamber (VALVECHAMBER)

Material Use Definition The material of the IfcDistributionChamberElement is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. Material information can also be given at the IfcDistributionChamberElementType, defining the common attribute data for all occurrences of the same type. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Base’: The material from which the base of the duct is constructed. ‘Cover’: The material from which the access cover to the chamber is constructed. ‘Fill’: The material that is used to fill the duct (where used). ‘Wall’: The material from which the wall of the duct is constructed.

Public Functions

const IfcParse::entity &declaration() const
IfcDistributionChamberElement(IfcEntityInstanceData *e)
IfcDistributionChamberElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionChamberElementType : public Ifc2x3::IfcDistributionFlowElementType

The distribution flow element type IfcDistributionChamberElementType defines commonly shared information for occurrences of distribution chamber elements. The set of shared information may include:

common properties with shared property sets common materials common ports common composition of elements common assignment of process types common representations of shape and style

It is used to define a distribution chamber element specification (i.e. the specific product information, that is common to all occurrences of that product type). Distribution Chamber Element types may be exchanged without being already assigned to occurrences. Occurrences of IfcDistributionChamberElementType are represented by instances of IfcDistributionChamberElement.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionFlowElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DistributionChamberElementCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_DistributionChamberElementTypeFormedDuct (FORMEDDUCT) Pset_DistributionChamberElementTypeInspectionChamber (INSPECTIONCHAMBER) Pset_DistributionChamberElementTypeInspectionPit (INSPECTIONPIT) Pset_DistributionChamberElementTypeManhole (MANHOLE) Pset_DistributionChamberElementTypeMeterChamber (METERCHAMBER) Pset_DistributionChamberElementTypeSump (SUMP) Pset_DistributionChamberElementTypeTrench (TRENCH) Pset_DistributionChamberElementTypeValveChamber (VALVECHAMBER)

Material Use Definition The material of the IfcDistributionChamberElementType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Base’: The material from which the base of the duct is constructed. ‘Cover’: The material from which the access cover to the chamber is constructed. ‘Fill’: The material that is used to fill the duct (where used). ‘Wall’: The material from which the wall of the duct is constructed.

Public Functions

::Ifc2x3::IfcDistributionChamberElementTypeEnum::Value PredefinedType() const

Predefined types of distribution chambers.

void setPredefinedType(::Ifc2x3::IfcDistributionChamberElementTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcDistributionChamberElementType(IfcEntityInstanceData *e)
IfcDistributionChamberElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcDistributionChamberElementTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDistributionChamberElementTypeEnum

Public Types

enum Value

This enumeration identifies different types of distribution chambers.

Valid enumerations are:

FORMEDDUCT: Space formed in the ground for the passage of pipes, cables, ducts. INSPECTIONCHAMBER: Chamber constructed on a drain, sewer or pipeline with a removable cover that permits visble inspection. INSPECTIONPIT: Recess or chamber formed to permit access for inspection of substructure and services. MANHOLE: Chamber constructed on a drain, sewer or pipeline with a removable cover that permits the entry of a person. METERCHAMBER: Chamber that houses a meter(s). SUMP: Recessed or small chamber into which liquid is drained to facilitate its collection for removal. TRENCH: Excavated chamber, the length of which typically exceeds the width. VALVECHAMBER: Chamber that houses a valve(s). USERDEFINED: User-defined chamber type. NOTDEFINED: Undefined chamber type.

HISTORY: New enumeration in IFC R2x2

Values:

enumerator IfcDistributionChamberElementType_FORMEDDUCT
enumerator IfcDistributionChamberElementType_INSPECTIONCHAMBER
enumerator IfcDistributionChamberElementType_INSPECTIONPIT
enumerator IfcDistributionChamberElementType_MANHOLE
enumerator IfcDistributionChamberElementType_METERCHAMBER
enumerator IfcDistributionChamberElementType_SUMP
enumerator IfcDistributionChamberElementType_TRENCH
enumerator IfcDistributionChamberElementType_VALVECHAMBER
enumerator IfcDistributionChamberElementType_USERDEFINED
enumerator IfcDistributionChamberElementType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDistributionControlElement : public Ifc2x3::IfcDistributionElement

The distribution element IfcDistributionControlElement defines occurrence elements of a building automation control system that are used to impart control over elements of a distribution system.

This class defines elements of a building automation control system. These are typically used to control distribution system elements to maintain variables such as temperature, humidity, pressure, flow, power, or lighting levels, through the modulation, staging or sequencing of mechanical or electrical devices. The three general functional categories of control elements are as follows:

Impart control over flow control elements (IfcFlowController) in a distribution system such as dampers, valves, or relays, typically through the use of actuation (IfcActuator). Sensing elements (IfcSensor) that measure changes in the controlled variable such as temperature, humidity, pressure, or flow. Controllers (IfcController) typically classified according to the control action they seek to perform and generally responsible for making decisions about the elements under control.

Since this class and its subtypes typically relate to many different distribution flow elements (IfcDistributionFlowElement), the objectified relationship IfcRelFlowControlElements has been provided to relate control and flow elements as required.

IFC2x4 CHANGE: ControlElementId attribute deleted; replaced by classification usage. HISTORY: New entity in IFC R2.0.

Type Use Definition IfcDistributionControlElement defines the occurrence of any distribution control element; common information about distribution control element types is handled by IfcDistributionControlElementType. The IfcDistributionControlElementType (if present) may establish the common type name, usage (predefined type), properties, materials, ports, composition, assignments, and representations. The IfcDistributionControlElementType is attached using the IfcRelDefinesByType objectified relationship and is accessible by the IsTypedBy inverse attribute. If the IfcDistributionControlElementType has ports or aggregated elements, such objects are reflected at the IfcDistributionControlElement occurrence using the IfcRelDefinesByObject relationship. Direct instantiation of IfcDistributionControlElement with IfcObject.ObjectType asserted provides the meaning of a distribution control element proxy.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Property sets may also be specified at the IfcDistributionControlElementType, defining the common property data for all occurrences of the same type. They are then accessible by the IsTypedBy inverse attribute pointing to IfcDistributionControlElementType.HasPropertySets. If both are given, then the properties directly defined at IfcDistributionControlElement override the properties defined at IfcDistributionControlElementType. Refer to the documentation at the supertype IfcDistributionElement and ancestors for inherited property set definitions.

Classification Use Definition In addition to general product and project classification (UniFormat, etc.), classifications may also be applied to indicate a device address or addressing scheme using IfcRelAssociatesClassification where RelatedObjects contains the IfcDistributionControlElement and RelatingClassification refers to an IfcClassification or IfcClassificationReference.

IfcClassification: Indicates an addressing scheme managed by the device where ReferenceTokens defines the format of the address to be specified at IfcClassificationReference.ItemReference. A classification hierarchy may optionally be provided indicating detected or provisioned device addresses. IfcClassificationReference: Indicates the address of the control element where Identification uniquely identifies the element within the control system as determined by the ClassificationSource. Several examples are illustrated:

‘BACnet’: BACnetObjectIdentifier in the decimal form ‘12.15’ (Digital Input #15) indicating type ID and instance ID. ‘IP’: IP Address in the decimal form ‘192.168.1.2’ such as for an IPv4 network. ‘OPC’: Hierarchical ItemID in the alphanumeric form ‘B204.Tank2.Temperature’ ‘X-10’: Alphabetic and numeric code in the form ‘B12’ (House B, Device 12) indicating House Code and Device Code.

Figure 147 illustrates classification usage.

Figure 147 — Distribution control classification

Composition Use Definition The IfcDistributionControlElement may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcDistributionControlElement and RelatedObjects contains one or more components. Likewise, a control element may be aggregated within another element. For example, a thermostat may contain temperature sensors, and a programmable logic controller may contain virtual (software-based) control elements. Standard types for composition are defined at subtypes.

Connection Use Definition The IfcDistributionControlElement may be connected to other objects as follows using the indicated relationship:

IfcSpatialStructureElement (IfcRelContainedInSpatialStructure) : Indicates the spatial location containing the element. If an element is aggregated within another element, then only the top-level element participates in this relationship. IfcElement (IfcRelConnectsElements) : Indicates physical connectivity with another element (but not embedding or flow control), such as a sensor attached to a wall. IfcRelConnectsElements.RelatingElement refers to the anchored side (for example, wall hosting sensor). IfcDistributionPort (IfcRelConnectsPortToElement) : Indicates ports on the element which may be connected to other elements for control signal transmission or electric power. Standard port names, types, and directions are defined at subtypes. IfcDistributionFlowElement (IfcRelFlowControlElements) : Indicates a flow element is sensed or controlled by the control element, such as a tank for a level sensor or a valve for an actuator.

Assignment Use Definition The IfcDistributionControlElement may be assigned to the following entities using relationships as indicated:

IfcDistributionSystem (IfcRelAssignsToGroup): Indicates a system containing interconnected devices, where control elements are typically part of a control system having PredefinedType=CONTROL. IfcPerformanceHistory (IfcRelAssignsToControl): Indicates realtime or historical infomation captured for the device.

The IfcDistributionControlElement may have assignments of its own using the IfcRelAssignsToProduct relationship where RelatingProduct refers to the IfcDistributionControlElement and RelatedObjects contains one or more objects of the following types:

IfcTask: Indicates tasks used to purchase, install, renovate, demolish, operate, or otherwise act upon the element. If the element has a type, available task types are assigned to the element type. IfcProcedure: Indicates procedures used to operate the element. If the element has a type, available procedure types are assigned to the element type. IfcEvent: Indicates events raised by the element, sequenced by procedures to be followed. If the element has a type, available event types are assigned to the element type.

Material Use Definition The material of the IfcDistributionControlElement is defined using one of the following entities:

IfcMaterialConstituentSet: For elements containing multiple materials, this indicates materials at named aspects.

IfcMaterial: For elements comprised of a single material, this indicates the material.

The material is attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. Material information can also be given at the IfcDistributionControlElementType, defining the common attribute data for all occurrences of the same type. Standard names and material types are defined at subtypes.

Representation Use Definition The following shape representations are supported for subtypes of IfcDistributionControlElement, distinguished by IfcShapeRepresentation.RepresentationIdentifier:

‘Footprint’: Represents the 2D footprint outline of the item having IfcShapeRepresentation.RepresentationType of ‘GeometricCurveSet’ and containing a single IfcGeometricCurveSet consisting of one or more IfcCurve subtypes such as IfcPolyline, IfcTrimmedCurve, IfcCompositeCurve, or IfcCircle.

‘Body’: Represents the 3D shape of the item having IfcShapeRepresentation.RepresentationType of ‘SurfaceModel’, ‘SolidModel’, or any solid model specializations including ‘Brep’, ‘AdvancedBrep’, ‘SweptSolid’, ‘AdvancedSweptSolid’, ‘CSG’, ‘Clipping’, or ‘SectionedSpine’).

‘Clearance’: Represents the 3D clearance volume of the item having RepresentationType of ‘Surface3D’. Such clearance region indicates space that should not intersect with the ‘Body’ representation of other elements, though may intersect with the ‘Clearance’ representation of other elements. The particular use of clearance space may be for safety, maintenance, or other purpose.

For all representations, if a IfcDistributionControlElement occurrence is defined by a IfcDistributionControlElementType having a representation of the same identifier, then ‘MappedRepresentation’ should be used at the occurrence unless overridden.

If materials are defined, geometry of each representation (most typically the ‘Body’ representation) may be organized into shape aspects where styles may be derived by correlating IfcShapeAspect.Name to a corresponding material (IfcMaterialConstituent.Name).

Public Functions

bool hasControlElementId() const

Whether the optional attribute ControlElementId is defined for this IfcDistributionControlElement.

std::string ControlElementId() const
void setControlElementId(std::string v)
IfcTemplatedEntityList<IfcRelFlowControlElements>::ptr AssignedToFlowElement() const
const IfcParse::entity &declaration() const
IfcDistributionControlElement(IfcEntityInstanceData *e)
IfcDistributionControlElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ControlElementId)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionControlElementType : public Ifc2x3::IfcDistributionElementType

The element type IfcDistributionControlElementType defines a list of commonly shared property set definitions of an element and an optional set of product representations. It is used to define an element specification (the specific product information that is common to all occurrences of that product type).

Distribution control element types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcDistributionControlElementType are represented by instances of IfcDistributionControlElement or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Declaration Use Definition The IfcDistributionControlElementType may be declared within a project or project library using IfcRelDeclares where RelatingContext refers to the project or library and RelatedDefinitions includes the element type. Inclusion within IfcProject indicates the type is editable within the direct project and may be available to other referencing projects that may incorporate the type. Inclusion within IfcProjectLibrary indicates the type is incorporated from a referenced project. Default units and coordinate systems (used for representations, materials, and property sets) are indicated by the declaring project or library.

Classification Use Definition The IfcDistributionControlElementType may be classified using IfcRelAssociatesClassification where RelatingClassification refers to an IfcClassificationReference indicating a classification notation. Classifications may refer to industry standards such as MasterFormat, OmniFormat, or UniFormat. Classifications may also refer to organization-specific, project-specific, or system-specific designations. Classification reference identification schemes are described by IfcClassification.ReferenceTokens.

Document Use Definition The IfcDistributionControlElementType may be documented using IfcRelAssociatesDocument where RelatingDocument refers to an IfcDocumentReference indicating content within a document, or IfcDocumentInformation indicating an entire document. Document information may refer to arbitrary attachments such as text or multimedia, while document references may refer to items within particular formats (such as XML element IDs) where there is need to synchronize document information with model information. Document reference identification schemes depend on the particular document format.

Library Use Definition The IfcDistributionControlElementType may be published to a model server using IfcRelAssociatesLibrary where RelatingLibrary refers to an IfcLibraryReference indicating the unique identification within the published project. If the published project is IFC format, then IfcLibraryReference.Identification shall match IfcRoot.GlobalID of the published (master) project, using the same encoding as described for IfcGloballyUniqueId. Multiple library references may be provided to indicate alternate names and descriptions for particular languages. If the element type is declared within IfcProject, then IfcLibraryInformation.Location and IfcLibraryInformation.Version indicate the URL and version as last published. If the element type is declared within IfcProjectLibrary, then the library information indicates the location and version of the definition as last retrieved.

Composition Use Definition The IfcDistributionControlElementType may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcDistributionFlowElementType and RelatedObjects contains one or more components. For example, a thermostat type may be decomposed into temperature sensors. Standard types for composition are defined at occurrences for subtypes.

Connection Use Definition The IfcDistributionControlElementType may be connected to other objects as follows using the indicated relationship:

IfcDistributionPort (IfcRelConnectsPortToElement) : Indicates port definitions on the element to be instantiated at occurrences. Standard port names, types, and directions are defined at occurrences for subtypes.

Assignment Use Definition The IfcDistributionControlElementType may have assignments of its own using the IfcRelAssignsToProduct relationship where RelatingProduct refers to the IfcDistributionControlElementType and RelatedObjects contains one or more objects of the following types:

IfcTaskType: Indicates task types available to purchase, install, renovate, demolish, operate, or otherwise act upon occurrences of the element type. Such task types may be instantiated as task occurrences assigned to occurrences of the element type. Prices (such as for purchasing or shipping) may be established by resource types assigned to task types. IfcProcedureType: Indicates procedure types available to operate occurrences of the element type. Such procedure types may be instantiated as procedure occurrences assigned to occurrences of the element type. IfcEventType: Indicates event types available to be raised by occurrences of the element, sequenced by procedures to be followed. Such event types may be instantiated as event occurrences assigned to occurrences of the element type.

Material Use Definition The material of the IfcDistributionControlElementType is defined using one of the following entities:

IfcMaterialConstituentSet: For elements containing multiple materials, this indicates materials at named aspects.

IfcMaterial: For elements comprised of a single material, this indicates the material.

The material is attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute.

Representation Use Definition The following shape representations are supported for subtypes of IfcDistributionControlElementType, distinguished by IfcShapeRepresentation.RepresentationIdentifier:

‘Footprint’: Represents the 2D footprint outline of the item having IfcShapeRepresentation.RepresentationType of ‘GeometricCurveSet’ and containing a single IfcGeometricCurveSet consisting of one or more IfcCurve subtypes such as IfcPolyline, IfcTrimmedCurve, IfcCompositeCurve, or IfcCircle.

‘Body’: Represents the 3D shape of the item having IfcShapeRepresentation.RepresentationType of ‘SurfaceModel’, ‘SolidModel’, or any solid model specializations including ‘Brep’, ‘AdvancedBrep’, ‘SweptSolid’, ‘AdvancedSweptSolid’, ‘CSG’, ‘Clipping’, or ‘SectionedSpine’).

‘Clearance’: Represents the 3D clearance volume of the item having RepresentationType of ‘Surface3D’. Such clearance region indicates space that should not intersect with the ‘Body’ representation between element occurrences, though may intersect with the ‘Clearance’ representation of other element occurrences. The particular use of clearance space may be for safety, maintenance, or other purpose.

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

Subclassed by Ifc2x3::IfcActuatorType, Ifc2x3::IfcAlarmType, Ifc2x3::IfcControllerType, Ifc2x3::IfcFlowInstrumentType, Ifc2x3::IfcSensorType

Public Functions

const IfcParse::entity &declaration() const
IfcDistributionControlElementType(IfcEntityInstanceData *e)
IfcDistributionControlElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionElement : public Ifc2x3::IfcElement

Definition from IAI: Generalization of all elements that participate in a distribution system. Typical examples of IfcDistributionElement are (among others):

building service elements within a heating systems building service elements within a cooling system building service elements within a ventilation system building service elements within a plumbing system

e.g. sanitary elements, fire suppression elements

electrical elements elements within a communication network

The IfcDistributionElement is further specialized in the IFC model. Direct instantiation of IfcDistributionElement without an assigned subtype of IfcDistributionElementType provides the meaning of an distribution element proxy. HISTORY New entity in IFC Release 1.5. IFC2x4 CHANGE The entity is marked as deprecated for instantiation - will be made ABSTRACT after IFC2x4. Relationship Use Definition

Ports - information, whether the distribution element has ports for system connections

objectified relationship: IfcRelConnectsPortToElement object referenced by relationship: IfcPort inverse attribute: HasPorts

Type Use Definition The IfcDistributionElement defines the occurrence of any HVAC, electrical, sanitary or other element within a distribution system. Common information about distribution element types (or styles) is handled by subtypes of IfcDistributionElementType. The IfcDistributionElementType (if present) may establish the common type name, usage (or predefined) type, common material, common set of properties and common shape representations (using IfcRepresentationMap). The IfcDistributionElementType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. The assignment of types to distribution element occurrences is vital for providing the additional meaning, or ontology, of the distribution element. Many specialized type are defined in other schemas of the IFC specification. Quantity Use Definition The quantities relating to the IfcDistributionElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties. A detailed specification for individual quantities is introduced at the level of subtypes of IfcDistributionElement. Containment Use Definition The IfcDistributionElement may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcDistributionElement is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcSpace being the default container. The IfcDistributionElement may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definitions The geometric representation of IfcDistributionElement is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Local Placement The local placement for IfcDistributionElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement , which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations The geometric representation of IfcDistributionElement is defined using different geometric representation types for the various subtypes. Only general recommendations are given at the level of the supertype, further constraints are defined at the level of its subtypes.

all occurrences of IfcDistributionElement (and its subtypes) should (whenever possible) share a representation map established by the assigned type. The geometric representation of the occurrence is then an IfcMappedItem. The IfcShapeRepresentation has:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The shared geometric representation of the distribution element type (or in some cases of the distribution element) should follow (if applicable) the the following guidelines:

all fixtures (all non distribution flow elements, i.e. everything which is not a duct, a pipe, a cable, or a cable carrier) should be defined by an b-rep geometry. This includes also the complex flow fitting elements (e.g. Y branch or T branch) or distribution flow elements with size changes (e.g. reducer). The IfcShapeRepresentation has:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

if the geometric model consistency of a b-rep shape representation can not be guaranteed (arcwise connected volume bounded by faces, each being connected, oriented, finite, closed 2-manifold), a surface representation based on open shells should be used. The IfcShapeRepresentation then has:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’

all “simple” distribution flow elements (general ducts and pipes) are defined by sweep geometry. The IfcShapeRepresentation has:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

an additional representation type for all “simple” distribution flow elements (general ducts and pipes) is the ability to have a simple line based representation. The IfcShapeRepresentation has:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’

if only the analytical shape is required for which the exact interpolation between the cross sections is not required, a sectioned spine can be used.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SectionedSpine’

Subclassed by Ifc2x3::IfcDistributionControlElement, Ifc2x3::IfcDistributionFlowElement

Public Types

typedef IfcTemplatedEntityList<IfcDistributionElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcDistributionElement(IfcEntityInstanceData *e)
IfcDistributionElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionElementType : public Ifc2x3::IfcElementType

Definition from IAI: The IfcDistributionElementType defines a list of commonly shared property set definitions of an element and an optional set of product representations. It is used to define an element specification (i.e. the specific product information, that is common to all occurrences of that product type). NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. A distribution element type is used to define the common properties of a certain type of a distribution element that may be applied to many instances of that feature type to assign a specific style. Distribution element types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences. The occurrences of the IfcDistributionElementType are represented by instances of IfcDistributionElement (or its subtypes). HISTORY New entity in Release IFC2x Edition 2. IFC2x3 CHANGE The entity has been made non-abstract IFC2x4 CHANGE The entity is marked as deprecated for instantiation - will be made ABSTRACT after IFC2x4.

Subclassed by Ifc2x3::IfcDistributionControlElementType, Ifc2x3::IfcDistributionFlowElementType

Public Functions

const IfcParse::entity &declaration() const
IfcDistributionElementType(IfcEntityInstanceData *e)
IfcDistributionElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionFlowElement : public Ifc2x3::IfcDistributionElement

The distribution element IfcDistributionFlowElement defines occurrence elements of a distribution system that facilitate the distribution of energy or matter, such as air, water or power.

EXAMPLEs of distribution flow elements are ducts, pipes, wires, fittings, and equipment.

HISTORY: New entity in IFC R2.0.

Type Use Definition IfcDistributionFlowElement defines the occurrence of any distribution flow element; common information about distribution flow element types is handled by IfcDistributionFlowElementType. The IfcDistributionFlowElementType (if present) may establish the common type name, usage (predefined type), properties, materials, ports, composition, assignments, and representations. The IfcDistributionFlowElementType is attached using the IfcRelDefinesByType objectified relationship and is accessible by the IsTypedBy inverse attribute. If the IfcDistributionFlowElementType has ports or aggregated elements, such objects are reflected at the IfcDistributionFlowElement occurrence using the IfcRelDefinesByObject relationship. Direct instantiation of IfcDistributionFlowElement with IfcObject.ObjectType asserted provides the meaning of a distribution flow element proxy.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Property sets may also be specified at the IfcDistributionFlowElementType, defining the common property data for all occurrences of the same type. They are then accessible by the IsTypedBy inverse attribute pointing to IfcDistributionFlowElementType.HasPropertySets. If both are given, then the properties directly defined at IfcDistributionFlowElement override the properties defined at IfcDistributionFlowElementType. Refer to the documentation at the supertype IfcDistributionElement and ancestors for inherited property set definitions.

Composition Use Definition The IfcDistributionFlowElement may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcDistributionFlowElement and RelatedObjects contains one or more components. For example, a cable may be decomposed into wires. Standard types for composition are defined at subtypes.

Connection Use Definition The IfcDistributionFlowElement may be connected to other objects as follows using the indicated relationship:

IfcSpatialStructureElement (IfcRelContainedInSpatialStructure) : Indicates the spatial location containing the element. IfcElement (IfcRelConnectsElements) : Indicates physical connectivity with another element (but not embedding or flow transmission), such as a light fixture hanging from a ceiling (IfcCovering), or a junction box having a cover plate (IfcDiscreteAccessory). IfcRelConnectsElements.RelatingElement refers to the anchored side (ceiling for fixture, junction box for cover). IfcElement (IfcRelInterferesElements) : Indicates interference with another element and precedence, such as a pipe going through a wall. IfcOpening (IfcRelFillsElement) : Indicates embedding an element within another element (implying a cutout), such as an air terminal or junction box embedded within a wall. IfcDistributionPort (IfcRelConnectsPortToElement) : Indicates ports on the element which may be connected to other elements for flow distribution of solids, liquids, gas, or electricity. Standard port names, types, and directions are defined at subtypes. IfcDistributionControlElement (IfcRelFlowControlElements) : Indicates a control element that senses or controls some aspect of the flow element, such as a level sensor for a tank or an actuator for a valve.

Assignment Use Definition The IfcDistributionFlowElement may be assigned to the following entities using relationships as indicated:

IfcDistributionSystem (IfcRelAssignsToGroup): Indicates a system containing interconnected devices. IfcPerformanceHistory (IfcRelAssignsToControl): Indicates realtime or historical infomation captured for the device.

The IfcDistributionFlowElement may have assignments of its own using the IfcRelAssignsToProduct relationship where RelatingProduct refers to the IfcDistributionFlowElement and RelatedObjects contains one or more objects of the following types:

IfcTask: Indicates tasks used to purchase, install, renovate, demolish, operate, or otherwise act upon the element. If the element has a type, available task types are assigned to the element type. IfcProcedure: Indicates procedures used to operate the element. If the element has a type, available procedure types are assigned to the element type. IfcEvent: Indicates events raised by the element, sequenced by procedures to be followed. If the element has a type, available event types are assigned to the element type.

Material Use Definition The material of the IfcDistributionFlowElement is defined using one of the following entities:

IfcMaterialProfileSetUsage: For parametric segments, this defines the cross section and alignment to the ‘Axis’ representation, from which the ‘Body’ representation may be generated.

IfcMaterialProfileSet: For non-parametric segments (having fixed length or path), this may define the cross section for analysis purposes, however the ‘Body’ representation is independently generated.

IfcMaterialConstituentSet: For elements containing multiple materials, this indicates materials at named aspects.

IfcMaterial: For elements comprised of a single material, this indicates the material.

The material is attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. Material information can also be given at the IfcDistributionFlowElementType, defining the common attribute data for all occurrences of the same type. Standard names and material types are defined at subtypes.

Representation Use Definition The following shape representations are supported for subtypes of IfcDistributionFlowElement, distinguished by IfcShapeRepresentation.RepresentationIdentifier:

‘Axis’: Represents the 3D flow path of the item having IfcShapeRepresentation.RepresentationType of ‘Curve3D’ and containing a single IfcBoundedCurve subtype such as IfcPolyline, IfcTrimmedCurve, or IfcCompositeCurve. For elements containing directional ports (IfcDistributionPort with FlowDirection of SOURCE or SINK), the direction of the curve indicates direction of flow where a SINK port is positioned at the start of the curve and a SOURCE port is positioned at the end of the curve. This representation is most applicable to flow segments (pipes, ducts, cables), however may be used at other elements to define a primary flow path if applicable.

‘Footprint’: Represents the 2D footprint outline of the item having IfcShapeRepresentation.RepresentationType of ‘GeometricCurveSet’ and containing a single IfcGeometricCurveSet consisting of one or more IfcCurve subtypes such as IfcPolyline, IfcTrimmedCurve, IfcCompositeCurve, or IfcCircle.

‘Body’: Represents the 3D shape of the item having IfcShapeRepresentation.RepresentationType of ‘SurfaceModel’, ‘SolidModel’, or any solid model specializations including ‘Brep’, ‘AdvancedBrep’, ‘SweptSolid’, ‘AdvancedSweptSolid’, ‘CSG’, ‘Clipping’, or ‘SectionedSpine’).

‘Clearance’: Represents the 3D clearance volume of the item having RepresentationType of ‘Surface3D’. Such clearance region indicates space that should not intersect with the ‘Body’ representation of other elements, though may intersect with the ‘Clearance’ representation of other elements. The particular use of clearance space may be for safety, maintenance, or other purpose.

‘Lighting’: Represents the light emission of the item having IfcShapeRepresentation.RepresentationType of ‘LightSource’ and containing one or more IfcLightSource subtypes. This representation is most applicable to lamps and light fixtures, however may be used at other elements that emit light.

For all representations, if a IfcDistributionFlowElement occurrence is defined by a IfcDistributionFlowElementType having a representation of the same identifier, then ‘MappedRepresentation’ should be used at the occurrence unless overridden.

If materials are defined, geometry of each representation (most typically the ‘Body’ representation) may be organized into shape aspects where styles may be derived by correlating IfcShapeAspect.Name to a corresponding material (IfcMaterialConstituent.Name or IfcMaterialProfile.Name).

Representations are further defined at subtypes; for example, parametric flow segments align material profiles with the ‘Axis’ representation.

Subclassed by Ifc2x3::IfcDistributionChamberElement, Ifc2x3::IfcEnergyConversionDevice, Ifc2x3::IfcFlowController, Ifc2x3::IfcFlowFitting, Ifc2x3::IfcFlowMovingDevice, Ifc2x3::IfcFlowSegment, Ifc2x3::IfcFlowStorageDevice, Ifc2x3::IfcFlowTerminal, Ifc2x3::IfcFlowTreatmentDevice

Public Functions

IfcTemplatedEntityList<IfcRelFlowControlElements>::ptr HasControlElements() const
const IfcParse::entity &declaration() const
IfcDistributionFlowElement(IfcEntityInstanceData *e)
IfcDistributionFlowElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionFlowElementType : public Ifc2x3::IfcDistributionElementType

The element type IfcDistributionFlowElementType defines a list of commonly shared property set definitions of an element and an optional set of product representations. It is used to define an element specification (the specific product information that is common to all occurrences of that product type).

Distribution flow element types (orthe instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcDistributionFlowElementType are represented by instances of IfcDistributionFlowElement or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Declaration Use Definition The IfcDistributionFlowElementType may be declared within a project or project library using IfcRelDeclares where RelatingContext refers to the project or library and RelatedDefinitions includes the element type. Inclusion within IfcProject indicates the type is editable within the direct project and may be available to other referencing projects that may incorporate the type. Inclusion within IfcProjectLibrary indicates the type is incorporated from a referenced project. Default units and coordinate systems (used for representations, materials, and property sets) are indicated by the declaring project or library.

Classification Use Definition The IfcDistributionFlowElementType may be classified using IfcRelAssociatesClassification where RelatingClassification refers to an IfcClassificationReference indicating a classification notation. Classifications may refer to industry standards such as MasterFormat, OmniFormat, or UniFormat. Classifications may also refer to organization-specific, project-specific, or system-specific designations. Classification reference identification schemes are described by IfcClassification.ReferenceTokens.

Document Use Definition The IfcDistributionFlowElementType may be documented using IfcRelAssociatesDocument where RelatingDocument refers to an IfcDocumentReference indicating content within a document, or IfcDocumentInformation indicating an entire document. Document information may refer to arbitrary attachments such as text or multimedia, while document references may refer to items within particular formats (such as XML element IDs) where there is need to synchronize document information with model information. Document reference identification schemes depend on the particular document format.

Library Use Definition The IfcDistributionFlowElementType may be published to a model server using IfcRelAssociatesLibrary where RelatingLibrary refers to an IfcLibraryReference indicating the unique identification within the published project. If the published project is IFC format, then IfcLibraryReference.Identification shall match IfcRoot.GlobalID of the published (master) project, using the same encoding as described for IfcGloballyUniqueId. Multiple library references may be provided to indicate alternate names and descriptions for particular languages. If the element type is declared within IfcProject, then IfcLibraryInformation.Location and IfcLibraryInformation.Version indicate the URL and version as last published. If the element type is declared within IfcProjectLibrary, then the library information indicates the location and version of the definition as last retrieved.

Figure 148 illustrates a project containing a light fixture in a building, where the definition of the light fixture is obtained from an external project.

Figure 148 — Distribution flow element library

Composition Use Definition The IfcDistributionFlowElementType may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcDistributionFlowElementType and RelatedObjects contains one or more components. For example, a cable type may be decomposed into wires. Standard types for composition are defined at occurrences for subtypes.

Connection Use Definition The IfcDistributionFlowElementType may be connected to other objects as follows using the indicated relationship:

IfcDistributionPort (IfcRelConnectsPortToElement) : Indicates port definitions on the element to be instantiated at occurrences. Standard port names, types, and directions are defined at occurrences for subtypes.

Assignment Use Definition The IfcDistributionFlowElementType may have assignments of its own using the IfcRelAssignsToProduct relationship where RelatingProduct refers to the IfcDistributionFlowElementType and RelatedObjects contains one or more objects of the following types:

IfcTaskType: Indicates task types available to purchase, install, renovate, demolish, operate, or otherwise act upon occurrences of the element type. Such task types may be instantiated as task occurrences assigned to occurrences of the element type. Prices (such as for purchasing or shipping) may be established by resource types assigned to task types. IfcProcedureType: Indicates procedure types available to operate occurrences of the element type. Such procedure types may be instantiated as procedure occurrences assigned to occurrences of the element type. IfcEventType: Indicates event types available to be raised by occurrences of the element, sequenced by procedures to be followed. Such event types may be instantiated as event occurrences assigned to occurrences of the element type.

Material Use Definition The material of the IfcDistributionFlowElementType is defined using one of the following entities:

IfcMaterialProfileSet: For elements having a constant cross-section, this defines the material profile which may be used to generate the ‘Body’ representation at occurrences (for parametric definitions not having representation), or for analysis purposes. IfcMaterialConstituentSet: For elements containing multiple materials, this indicates materials at named aspects.

IfcMaterial: For elements comprised of a single material, this indicates the material.

The material is attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute.

Representation Use Definition The following shape representations are supported for subtypes of IfcDistributionFlowElementType, distinguished by IfcShapeRepresentation.RepresentationIdentifier:

‘Axis’: Represents the 3D flow path of the item having IfcShapeRepresentation.RepresentationType of ‘Curve3D’ and containing a single IfcBoundedCurve subtype such as IfcPolyline, IfcTrimmedCurve, or IfcCompositeCurve. For elements containing directional ports (IfcDistributionPort with FlowDirection of SOURCE or SINK), the direction of the curve indicates direction of flow where a SINK port is positioned at the start of the curve and a SOURCE port is positioned at the end of the curve. This representation is most applicable to flow segment types (pipes, ducts, cables), however may be used at other elements to define a primary flow path if applicable.

‘Footprint’: Represents the 2D footprint outline of the item having IfcShapeRepresentation.RepresentationType of ‘GeometricCurveSet’ and containing a single IfcGeometricCurveSet consisting of one or more IfcCurve subtypes such as IfcPolyline, IfcTrimmedCurve, IfcCompositeCurve, or IfcCircle.

‘Body’: Represents the 3D shape of the item having IfcShapeRepresentation.RepresentationType of ‘SurfaceModel’, ‘SolidModel’, or any solid model specializations including ‘Brep’, ‘AdvancedBrep’, ‘SweptSolid’, ‘AdvancedSweptSolid’, ‘CSG’, ‘Clipping’, or ‘SectionedSpine’).

‘Clearance’: Represents the 3D clearance volume of the item having RepresentationType of ‘Surface3D’. Such clearance region indicates space that should not intersect with the ‘Body’ representation between element occurrences, though may intersect with the ‘Clearance’ representation of other element occurrences. The particular use of clearance space may be for safety, maintenance, or other purpose.

‘Lighting’: Represents the light emission of the item having IfcShapeRepresentation.RepresentationType of ‘LightSource’ and containing one or more IfcLightSource subtypes. This representation is most applicable to lamps and light fixtures, however may be used at other elements that emit light.

If an element type is defined parametrically (such as a flow segment type defining common material profile but no particular length or path), then no representations shall be asserted at the type.

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

Subclassed by Ifc2x3::IfcDistributionChamberElementType, Ifc2x3::IfcEnergyConversionDeviceType, Ifc2x3::IfcFlowControllerType, Ifc2x3::IfcFlowFittingType, Ifc2x3::IfcFlowMovingDeviceType, Ifc2x3::IfcFlowSegmentType, Ifc2x3::IfcFlowStorageDeviceType, Ifc2x3::IfcFlowTerminalType, Ifc2x3::IfcFlowTreatmentDeviceType

Public Functions

const IfcParse::entity &declaration() const
IfcDistributionFlowElementType(IfcEntityInstanceData *e)
IfcDistributionFlowElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDistributionPort : public Ifc2x3::IfcPort

A distribution port is an inlet or outlet of a product through which a particular substance may flow.

Distribution ports are used for passage of solid, liquid, or gas substances, as well as electricity for power or communications. Flow segments (pipes, ducts, cables) may be used to connect ports across products. Distribution ports are defined by system type and flow direction such that for two ports to be connected, they must share the same system type and have opposite flow directions (one side being a SOURCE and the other being a SINK). Ports are similar to openings in that they do not have any visible geometry; such geometry is captured at the shape representation of the enclosing element or element type. Ports may have shape representations that indicate the position, orientation, and cross-section of the connection.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Refer to the documentation at the supertype IfcPort and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity:

Pset_DistributionPortCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_DistributionPortTypeAirConditioning (AIRCONDITIONING) Pset_DistributionPortTypeAudioVisual (AUDIOVISUAL) Pset_DistributionPortTypeData (DATA) Pset_DistributionPortTypeDomesticColdWater (DOMESTICCOLDWATER) Pset_DistributionPortTypeDomesticHotWater (DOMESTICHOTWATER) Pset_DistributionPortTypeDrainage (DRAINAGE) Pset_DistributionPortTypeElectrical (ELECTRICAL) Pset_DistributionPortTypeFireProtection (FIREPROTECTION) Pset_DistributionPortTypeGas (GAS) Pset_DistributionPortTypeHeating (HEATING) Pset_DistributionPortTypeOil (OIL) Pset_DistributionPortTypeSewage (SEWAGE) Pset_DistributionPortTypeSignal (SIGNAL) Pset_DistributionPortTypeTelephone (TELEPHONE)

The following property set definitions are applicable to IfcPerformanceHistory, for which objects are assigned:

Pset_DistributionPortPHistoryAirConditioning (AIRCONDITIONING) Pset_DistributionPortPHistoryControl (CONTROL) Pset_DistributionPortPHistoryData (DATA) Pset_DistributionPortPHistoryElectrical (ELECTRICAL) Pset_DistributionPortPHistoryGas (GAS) Pset_DistributionPortPHistoryHeating (HEATING) Pset_DistributionPortPHistoryOil (OIL) Pset_DistributionPortPHistorySignal (SIGNAL)

Material Use Definition The material of the IfcDistributionPort is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Media’: The solid, liquid, or gas media passing through the port.

Composition Use Definition The IfcDistributionPort may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcDistributionPort and RelatedObjects contains one or more components. Composition use is defined for the following predefined types:

AUDIOVISUAL: May contain IfcDistributionPort components having PredefinedType AUDIOVISUAL. If needed, audio-visual ports may be aggregated into specific streams (channels).CONTROL: May contain IfcDistributionPort components having PredefinedType SIGNAL. If needed, control ports may be aggregated into signal lines for indicating pinout specification.DATA: May contain IfcDistributionPort components having PredefinedType SIGNAL. If needed, data ports may be aggregated into signal lines for indicating pinout specification.ELECTRICAL: May contain IfcDistributionPort components having PredefinedType SIGNAL. If needed, electrical ports may be aggregated into modulated signals for data or lighting control.ELECTROACCOUSTIC: May contain IfcDistributionPort components having PredefinedType ELECTROACCOUSTIC. If needed, speaker ports may be aggregated into streams (channels) for each speaker.TELEPHONE: May contain IfcDistributionPort components having PredefinedType TELEPHONE. If needed, telephone ports may be aggregated for each line.

Connection Use Definition The IfcDistributionPort may be connected to other objects as follows using the indicated relationship:

IfcDistributionElement (IfcRelConnectsPortToElement) : Indicates the host element or element type containing the port. IfcDistributionPort (IfcRelConnectsPorts) : Indicates a connection to another port having the same type and opposite flow direction.

For port connections between elements, the RelatingPort is set to a port having FlowDirection=SOURCE and the RelatedPort is set to a port having FlowDirection=SINK.

For aggregation scenarios, ports on a device may be mapped to aggregated devices within, in which case ports on the outer device indicate a single FlowDirection but have an additional connection internally to a port on an aggregated inner device.

Refer to IfcUnitaryEquipment for an example.

Figure 149 illustrates distribution port connectivity.

Figure 149 — Distribution port connectivity

Assignment Use Definition The IfcDistributionPort may be assigned to the following entities using relationships as indicated:

IfcDistributionSystem (IfcRelAssignsToGroup): Indicates a system containing interconnected devices. IfcPerformanceHistory (IfcRelAssignsToControl): Indicates realtime or historical infomation captured for the device.

The IfcDistributionPort may have assignments of its own using the IfcRelAssignsToProduct relationship where RelatingProduct refers to the IfcDistributionPort and RelatedObjects contains one or more objects of the following types: IfcDistributionSystem: Indicates a system that is hosted by the port, as the origination.

Representation Use Definition The representation of IfcDistributionPort is given by IfcProductDefinitionShape, allowing multiple shape and topology representations. Included are:

IfcShapeRepresentation: The optional shape representation describes the connection volume and supports indication of the port position and orientation. The position is typically the midpoint of the physical connection, and the orientation points in the flow direction normal to the physical connection. Upon connecting elements through ports with rigid connections, each object is aligned such that the effective Location, Axis, and RefDirection of each port is aligned to be equal.

‘Body’: The shape of the port.

Public Types

typedef IfcTemplatedEntityList<IfcDistributionPort> list

Public Functions

bool hasFlowDirection() const

Whether the optional attribute FlowDirection is defined for this IfcDistributionPort.

::Ifc2x3::IfcFlowDirectionEnum::Value FlowDirection() const

Enumeration that identifies if this port is a Sink (inlet), a Source (outlet) or both a SinkAndSource.

void setFlowDirection(::Ifc2x3::IfcFlowDirectionEnum::Value v)
const IfcParse::entity &declaration() const
IfcDistributionPort(IfcEntityInstanceData *e)
IfcDistributionPort(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<::Ifc2x3::IfcFlowDirectionEnum::Value> v8_FlowDirection)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDocumentConfidentialityEnum

Public Types

enum Value

IfcDocumentConfidentialityEnum enables selection of the level of confidentiality of document information from a list of choices.

HISTORY: New enumeration in IFC 2x

Enumeration

PUBLIC: Document is publicly available. RESTRICTED: Document availability is restricted. CONFIDENTIAL: Document is confidential and its contents should not be revealed without permission. PERSONAL: Document is personal to the author. USERDEFINED NOTDEFINED

Values:

enumerator IfcDocumentConfidentiality_PUBLIC
enumerator IfcDocumentConfidentiality_RESTRICTED
enumerator IfcDocumentConfidentiality_CONFIDENTIAL
enumerator IfcDocumentConfidentiality_PERSONAL
enumerator IfcDocumentConfidentiality_USERDEFINED
enumerator IfcDocumentConfidentiality_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDocumentElectronicFormat : public IfcUtil::IfcBaseEntity

IfcDocumentElectronicFormat captures the type of document being referenced as an external source, and for which metadata is specified by IfcDocumentInformation.

HISTORY: New entity in IFC 2x

Public Functions

bool hasFileExtension() const

Whether the optional attribute FileExtension is defined for this IfcDocumentElectronicFormat.

std::string FileExtension() const

File extension of electronic document used by computer operating system.

void setFileExtension(std::string v)
bool hasMimeContentType() const

Whether the optional attribute MimeContentType is defined for this IfcDocumentElectronicFormat.

std::string MimeContentType() const

Main Mime type (as published by W3C or as user defined application type).

void setMimeContentType(std::string v)
bool hasMimeSubtype() const

Whether the optional attribute MimeSubtype is defined for this IfcDocumentElectronicFormat.

std::string MimeSubtype() const

Mime subtype information.

void setMimeSubtype(std::string v)
const IfcParse::entity &declaration() const
IfcDocumentElectronicFormat(IfcEntityInstanceData *e)
IfcDocumentElectronicFormat(boost::optional<std::string> v1_FileExtension, boost::optional<std::string> v2_MimeContentType, boost::optional<std::string> v3_MimeSubtype)

Public Static Functions

const IfcParse::entity &Class()
class IfcDocumentInformation : public IfcUtil::IfcBaseEntity

IfcDocumentInformation captures “metadata” of an external document. The actual content of the document is not defined in IFC; instead, it can be found following the reference given to IfcDocumentReference.

HISTORY: New entity in IFC 2x.

Public Types

typedef IfcTemplatedEntityList<IfcDocumentInformation> list

Public Functions

std::string DocumentId() const

Identifier that uniquely identifies a document.

void setDocumentId(std::string v)
std::string Name() const

File name or document name assigned by owner.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcDocumentInformation.

std::string Description() const

Description of document and its content.

void setDescription(std::string v)
bool hasDocumentReferences() const

Whether the optional attribute DocumentReferences is defined for this IfcDocumentInformation.

IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr DocumentReferences() const
void setDocumentReferences(IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr v)
bool hasPurpose() const

Whether the optional attribute Purpose is defined for this IfcDocumentInformation.

std::string Purpose() const

Purpose for this document.

void setPurpose(std::string v)
bool hasIntendedUse() const

Whether the optional attribute IntendedUse is defined for this IfcDocumentInformation.

std::string IntendedUse() const

Intended use for this document.

void setIntendedUse(std::string v)
bool hasScope() const

Whether the optional attribute Scope is defined for this IfcDocumentInformation.

std::string Scope() const

Scope for this document.

void setScope(std::string v)
bool hasRevision() const

Whether the optional attribute Revision is defined for this IfcDocumentInformation.

std::string Revision() const

Document revision designation.

void setRevision(std::string v)
bool hasDocumentOwner() const

Whether the optional attribute DocumentOwner is defined for this IfcDocumentInformation.

::Ifc2x3::IfcActorSelect *DocumentOwner() const

Information about the person and/or organization acknowledged as the ‘owner’ of this document. In some contexts, the document owner determines who has access to or editing right to the document.

void setDocumentOwner(::Ifc2x3::IfcActorSelect *v)
bool hasEditors() const

Whether the optional attribute Editors is defined for this IfcDocumentInformation.

IfcEntityList::ptr Editors() const

The persons and/or organizations who have created this document or contributed to it.

void setEditors(IfcEntityList::ptr v)
bool hasCreationTime() const

Whether the optional attribute CreationTime is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDateAndTime *CreationTime() const

Date and time stamp when the document was originally created.

IFC2x4 CHANGE The data type has been changed to IfcDateTime, the date time string according to ISO8601.

void setCreationTime(::Ifc2x3::IfcDateAndTime *v)
bool hasLastRevisionTime() const

Whether the optional attribute LastRevisionTime is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDateAndTime *LastRevisionTime() const

Date and time stamp when this document version was created.

IFC2x4 CHANGE The data type has been changed to IfcDateTime, the date time string according to ISO8601.

void setLastRevisionTime(::Ifc2x3::IfcDateAndTime *v)
bool hasElectronicFormat() const

Whether the optional attribute ElectronicFormat is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentElectronicFormat *ElectronicFormat() const

Describes the electronic format of the document being referenced, providing the file extension and the manner in which the content is provided.

void setElectronicFormat(::Ifc2x3::IfcDocumentElectronicFormat *v)
bool hasValidFrom() const

Whether the optional attribute ValidFrom is defined for this IfcDocumentInformation.

::Ifc2x3::IfcCalendarDate *ValidFrom() const

Date when the document becomes valid.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setValidFrom(::Ifc2x3::IfcCalendarDate *v)
bool hasValidUntil() const

Whether the optional attribute ValidUntil is defined for this IfcDocumentInformation.

::Ifc2x3::IfcCalendarDate *ValidUntil() const

Date until which the document remains valid.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setValidUntil(::Ifc2x3::IfcCalendarDate *v)
bool hasConfidentiality() const

Whether the optional attribute Confidentiality is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentConfidentialityEnum::Value Confidentiality() const

The level of confidentiality of the document.

void setConfidentiality(::Ifc2x3::IfcDocumentConfidentialityEnum::Value v)
bool hasStatus() const

Whether the optional attribute Status is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentStatusEnum::Value Status() const

The current status of the document. Examples of status values that might be used for a document information status include:

  • DRAFT

  • FINAL DRAFT

  • FINAL

  • REVISION

void setStatus(::Ifc2x3::IfcDocumentStatusEnum::Value v)
IfcTemplatedEntityList<IfcDocumentInformationRelationship>::ptr IsPointedTo() const
IfcTemplatedEntityList<IfcDocumentInformationRelationship>::ptr IsPointer() const
const IfcParse::entity &declaration() const
IfcDocumentInformation(IfcEntityInstanceData *e)
IfcDocumentInformation(std::string v1_DocumentId, std::string v2_Name, boost::optional<std::string> v3_Description, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr> v4_DocumentReferences, boost::optional<std::string> v5_Purpose, boost::optional<std::string> v6_IntendedUse, boost::optional<std::string> v7_Scope, boost::optional<std::string> v8_Revision, ::Ifc2x3::IfcActorSelect *v9_DocumentOwner, boost::optional<IfcEntityList::ptr> v10_Editors, ::Ifc2x3::IfcDateAndTime *v11_CreationTime, ::Ifc2x3::IfcDateAndTime *v12_LastRevisionTime, ::Ifc2x3::IfcDocumentElectronicFormat *v13_ElectronicFormat, ::Ifc2x3::IfcCalendarDate *v14_ValidFrom, ::Ifc2x3::IfcCalendarDate *v15_ValidUntil, boost::optional<::Ifc2x3::IfcDocumentConfidentialityEnum::Value> v16_Confidentiality, boost::optional<::Ifc2x3::IfcDocumentStatusEnum::Value> v17_Status)

Public Static Functions

const IfcParse::entity &Class()
class IfcDocumentInformationRelationship : public IfcUtil::IfcBaseEntity

An IfcDocumentInformationRelationship is a relationship class that enables a document to have the ability to reference other documents.

HISTORY New entity in Release IFC2x.

IFC2x4 CHANGE Subtyped from IfcResourceLevelRelationship, order of attributes changed.

Use definitions This class can be used to describe relationships in which one document may reference one or more other sub documents or where a document is used as a replacement for another document (but where both the original and the replacing document need to be retained).

Public Functions

::Ifc2x3::IfcDocumentInformation *RelatingDocument() const

The document that acts as the parent, referencing or original document in a relationship.

void setRelatingDocument(::Ifc2x3::IfcDocumentInformation *v)
IfcTemplatedEntityList<::Ifc2x3::IfcDocumentInformation>::ptr RelatedDocuments() const

The document that acts as the child, referenced or replacing document in a relationship.

void setRelatedDocuments(IfcTemplatedEntityList<::Ifc2x3::IfcDocumentInformation>::ptr v)
bool hasRelationshipType() const

Whether the optional attribute RelationshipType is defined for this IfcDocumentInformationRelationship.

std::string RelationshipType() const

Describes the type of relationship between documents. This could be sub-document, replacement etc. The interpretation has to be established in an application context.

void setRelationshipType(std::string v)
const IfcParse::entity &declaration() const
IfcDocumentInformationRelationship(IfcEntityInstanceData *e)
IfcDocumentInformationRelationship(::Ifc2x3::IfcDocumentInformation *v1_RelatingDocument, IfcTemplatedEntityList<::Ifc2x3::IfcDocumentInformation>::ptr v2_RelatedDocuments, boost::optional<std::string> v3_RelationshipType)

Public Static Functions

const IfcParse::entity &Class()
class IfcDocumentReference : public Ifc2x3::IfcExternalReference

An IfcDocumentReference is a reference to the location of a document. The reference is given by a system interpretable Location attribute (a URL string) where the document can be found, and an optional inherited internal reference Identification, which refers to a system interpretable position within the document. The optional inherited Name attribute is meant to have meaning for human readers. Optional document metadata can also be captured through reference to IfcDocumentInformation.

HISTORY: New Entity in IFC Release 2.0. Modified in IFC 2x.

Public Types

typedef IfcTemplatedEntityList<IfcDocumentReference> list

Public Functions

IfcTemplatedEntityList<IfcDocumentInformation>::ptr ReferenceToDocument() const
const IfcParse::entity &declaration() const
IfcDocumentReference(IfcEntityInstanceData *e)
IfcDocumentReference(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDocumentStatusEnum

Public Types

enum Value

IfcDocumentStatusEnum enables selection of the status of document information from a list of choices.

HISTORY: New enumeration in IFC Release 2x.

Values:

enumerator IfcDocumentStatus_DRAFT
enumerator IfcDocumentStatus_FINALDRAFT
enumerator IfcDocumentStatus_FINAL
enumerator IfcDocumentStatus_REVISION
enumerator IfcDocumentStatus_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDoor : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Construction for closing an opening, intended primarily for access with hinged, pivoted or sliding operation. The door is a building element that is predominately used to provide controlled access for people and goods. It includes constructions with hinged, pivoted, sliding, and additionally revolving and folding operations. A door consists of a lining and one or several panels. The IfcDoor defines a particular occurrence of a door inserted in the spatial context of a project. A door can:

be inserted as a filler in an opening using the IfcRelFillsElement relationship, then the IfcDoor has an inverse attribute FillsVoids provided,

NOTE View definitions or implementer agreements may restrict the relationship to only include one window (or door) into one opening.

be part of an element assembly, in general an IfcCurtainWall, using the IfcRelAggregates relationship, then the inverse attribute Decomposes is provided. or be a “free standing” door, then the IfcDoor has no inverse attributes FillsVoids or Decomposes provided.

The IFC specification provides two entities for door occurrences:

IfcDoorStandardCase used for all occurrences of doors, that have a ‘Profile’ shape representation defined to which a set of shape parameters for lining and framing properties apply. Additionally it requires the provision of an IfcDoorType that references one IfcDoorLiningProperties and on to many IfcDoorPanelProperties.

NOTE see IfcDoorStandardCase for all specific constraints imposed by this subtype.

IfcDoor used for all other occurrences of doors, particularly for doors having only ‘Brep’, or ‘SurfaceModel’ geometry without applying shape parameters.

The actual parameter of the door and/or its shape are defined by the IfcDoor as the occurrence definition (or project instance), or by the IfcDoorType as the specific definition (or project type). The following parameters are given:

at the IfcDoor or IfcDoorStandardCase for occurrence specific parameters. The IfcDoor specifies:

the door width and height the door opening direction (by the y-axis of the ObjectPlacement)

at the IfcDoorType, to which the IfcDoor is related by the inverse relationship IsDefinedBy pointing to IfcRelDefinesByType, for type parameters common to all occurrences of the same type.

the operation type (single swing, double swing, revolving, etc.) the door hinge side (by using two different styles for right and left opening doors) the construction material type the particular attributes for the lining by the IfcDoorLiningProperties the particular attributes for the panels by the IfcDoorPanelProperties

HISTORY New entity in IFC Release 1.0. IFC2x4 CHANGE The attributes PredefinedType and OperationType are added, the applicable type object has been changed to IfcDoorType.

Material Use Definition The material of the IfcDoor is defined by the IfcMaterialConstituentSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Lining’ - to indicate that the material constituent applies to to the door lining ‘Framing’ - to indicate that the material constituent applies to to the door panel(s), if not provided, the ‘Lining’ material information applied to panel(s) as well ‘Glazing’ - to indicate that the material constituent applies to to the glazing part

If the fall back single IfcMaterial is referenced, it applies to the lining and framing of the door. Property Set Use Definition: The property sets relating to the IfcDoor are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcDoor are part of this IFC release:

Pset_DoorCommon: common property set for all door occurrences Pset_DoorWindowGlazingType: specific property set for the glazing properties of the door glazing, if available Pset_DoorWindowShadingType: specific property set for the shading properties of the door glazing, if available

Quantity Use Definition The quantities relating to the IfcDoor are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to MethodOfMeasurement. Quanties shall be never assigned to the IfcDoorType.

Qto_DoorBaseQuantities: base quantities for all door occurrences.

Containment Use Definition The IfcDoor, as any subtype of IfcBuildingElement, may participate in two different containment relationships as shown in Figure 96. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcDoor is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcDoor may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Doors may be part of an IfcCurtainWall as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

NOTE The containment shall be defined independently of the filling relationship, that is, even if the IfcDoor is a filling of an opening established by IfcRelFillsElement, it is also contained in the spatial structure by an IfcRelContainedInSpatialStructure.

Figure 96 — Door containment

Geometry Use Definitions: The geometric representation of IfcDoor is given by the IfcProductDefinitionShape, allowing multiple geometric representations. The IfcDoor, in case of an occurrance object, gets its parameter and shape from the IfcDoorType. If an IfcRepresentationMap (a block definition) is defined for the IfcDoorType, then the IfcDoor inserts it through the IfcMappedItem. Local Placement The local placement for IfcDoor is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the same element (if given), in which the IfcDoor is used as a filling (normally an IfcOpeningElement), as provided by the IfcRelFillsElement relationship. If the IfcDoor is not inserted into an IfcOpeningElement, then the PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

Geometric Representation Thegeometric representation of IfcDoor is defined using the following (potentiallymultiple) IfcShapeRepresentation’s for its IfcProductDefinitionShape:

Profile: A’Curve3D’ consisting of a single losed curve defining the outer boundary of the door (lining). The door parametric representation uses this profile in order to apply the door lining and panel parameter. If not provided, the profile of the IfcOpeningElement is taken. FootPrint: A ‘GeometricCurveSet’, or ‘Annotation2D’ representation defining the 2D shape of the door Body: A ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’ representation defining the 3D shape of the door.

In addition the parametric representation of a (limited) door shape is available by applying the parameters from IfcDoorType referencing IfcDoorLiningProperties and IfcDoorPanelProperties. The purpose of the parameter is described at those entities and below (door opening operation by door type). Profile -‘Curve3D’ representation The door profile is represented by a three-dimensional closed curve within a particular shape representation. The profile is used to apply the parameter of the parametric door representation.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Profile’ RepresentationType : ‘Curve3D’, only a single closed curve shall be contained in the set of IfcShapeRepresentation.Items.

A ‘Profile’ representation has to be provided if:

a parametric representation shall be applied to the door AND

thedoor is ‘free standing’, or the opening into which thedoor is inserted is not extruded horizontally (i.e. where the opening profile does not match thedoor profile)

FootPrint -‘GeometricCurveSet’ or ‘Annotation2D’ representation The door foot print is represented by a set of two-dimensionalcurves (or in case of ‘Annotation2D’ additional hatching and text) within a particular shape representation. The foot print is used for the planview representation of the door.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’, or ‘Annotation2D’

Body - ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’ representation The door body is either represented parameterically (see parametric representation) or by explicit 3D shape. The 3D shape is given by using extrusion geometry, or surface models, or Brep models within a particular shape representation. The body is used for the model view representation of the door.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’

MappedRepresentation The ‘FootPrint’ and ‘Body’ geometric representation of IfcDoor can be shared among several identical doors using the ‘MappedRepresentation’. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’, ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘FootPrint’, ‘Body’ representation identifiers, shall apply to the MappedRepresentation of the IfcRepresentationMap. Parameteric Representation using parameters at IfcDoorType The parameters that defines the shape of the IfcDoor, are given at the IfcDoorType and the property sets, which are included in the IfcDoorType. The IfcDoor only defines the local placement which determines the opening direction of the door. The overall size of the IfcDoor to be used to apply the lining or panel parameter provided by the IfcDoorType is determined by the IfcShapeRepresentation with the RepresentationIdentifier = ‘Profile’. Only in case of an IfcDoor inserted into an IfcOpeningElement using the IfcRelFillsElement relatioship, having a horizontal extrusion (along the y-axis of the IfcDoor), the overall size is determined by the extrusion profile of the IfcOpeningElement. NOTE The OverallWidth and OverallHeight parameters are for informational purpose only. The opening direction is determined by the local placement of IfcDoor and the OperationType of the door style as shown in Figure 97. NOTE There are different definitions in various countries on what a left opening or left hung or left swing door is (same for right). Therefore the IFC definition may derivate from the local standard and need to be mapped appropriately.

Opening directions

Definitions Reference to other standards

The door panel (for swinging doors) opens always into the direction of the positive Y axis of the local placement. The determination of whether the door opens to the left or to the right is done at the level of the IfcDoorType. Here it is a left side opening door given byIfcDoorType.OperationType = SingleSwingLeft refered to as LEFT HAND (LH) in US *

refered to as DIN-R (right hung) in Germany

If the door should open to the other side, then the local placement has to be changed. It is still a left side opening door, given by IfcDoorType.OperationType = SingleSwingLeft refered to as RIGHT HAND REVERSE (RHR) in US *

refered to as DIN-R (right hung) in Germany

If the door panel (for swinging doors) opens to the right, a separate door style needs to be used (here IfcDoorTypee.OperationType = SingleSwingRight) and it always opens into the direction of the positive Y axis of the local placement. refered to as RIGHT HAND (RH) in US *

refered to as DIN-L (left hung) in Germany

If the door panel (for swinging doors) opens to the right, and into the opposite directions, the local placement of the door need to change. The door style is given by IfcDoorType.OperationType = SingleSwingRight. refered to as LEFT HAND REVERSE (LHR) in US *

refered to as DIN-L (left hung) in Germany

  • it assumes that the ‘inside/private/primary’ space is above (top in the pictures) and the ‘outside/public/secondary’ space is below (bottom in the pictures).

Figure 97 — Door swing

Public Types

typedef IfcTemplatedEntityList<IfcDoor> list

Public Functions

bool hasOverallHeight() const

Whether the optional attribute OverallHeight is defined for this IfcDoor.

double OverallHeight() const

Overall measure of the height, it reflects the Z Dimension of a bounding box, enclosing the body of the door opening. If omitted, the OverallHeight should be taken from the geometric representation of the IfcOpening in which the door is inserted.

NOTE The body of the door might be taller then the door opening (e.g. in cases where the door lining includes a casing). In these cases the OverallHeight shall still be given as the door opening height, and not as the total height of the door lining.

void setOverallHeight(double v)
bool hasOverallWidth() const

Whether the optional attribute OverallWidth is defined for this IfcDoor.

double OverallWidth() const

Overall measure of the width, it reflects the X Dimension of a bounding box, enclosing the body of the door opening. If omitted, the OverallWidth should be taken from the geometric representation of the IfcOpening in which the door is inserted.

NOTE The body of the door might be wider then the door opening (e.g. in cases where the door lining includes a casing). In these cases the OverallWidth shall still be given as the door opening width, and not as the total width of the door lining.

void setOverallWidth(double v)
const IfcParse::entity &declaration() const
IfcDoor(IfcEntityInstanceData *e)
IfcDoor(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_OverallHeight, boost::optional<double> v10_OverallWidth)

Public Static Functions

const IfcParse::entity &Class()
class IfcDoorLiningProperties : public Ifc2x3::IfcPropertySetDefinition

The door lining is the frame which enables the door leaf to be fixed in position. The door lining is used to hang the door leaf. The parameters of the door lining (IfcDoorLiningProperties) define the geometrically relevant parameter of the lining.

NOTE The IfcDoorLiningProperties shall only be applied to construct the 3D shape of a door, if the attribute IfcDoorStyle.ParameterTakesPrecedence is set TRUE.

The IfcDoorLiningProperties are included in the list of properties of IfcDoorStyle.HasPropertySets. More information about the door lining can be included in the same list of the IfcDoorStyle using another IfcPropertySet for dynamic extensions.

HISTORY New entity in IFC Release 2.0. Has been renamed from IfcDoorLining in IFC Release 2x.

IFC2x4 CHANGE The following attributes have been added LiningToPanelOffsetX, LiningToPanelOffsetY. The attribute ShapeAspectStyle is deprecated and shall no longer be used. Supertype changed to new IfcPreDefinedPropertySet.

Geometry use definitions The IfcDoorLiningProperties does not hold its own geometric representation. However it defines parameters which can be used to create the shape of the door style (which is inserted by the IfcDoor into the spatial context of the project) as shown in Figure 172. The parameters of the IfcDoorLiningProperties define a standard door lining, including (if given) a threshold and a transom. The outer boundary of the lining is determined by the occurrence parameter assigned to the IfcDoor, which inserts the IfcDoorStyle.

The lining is applied to the left, right and upper side of the opening reveal. The parameters are:

LiningDepth, if omited, equal to wall thickness - this only takes effect if a value for LiningThickness is given. If both parameters are not given, then there is no lining. LiningThickness LiningToPanelOffsetX LiningToPanelOffsetY

NOTE Parameters added in IFC2x4.

The lining can only cover part of the opening reveal.

LiningOffset : given if lining edge has an offset to the x axis of the local placement.

NOTE In addition to theLiningOffset, the local placement of the IfcDoor can already have an offset to the wall edge and thereby shift the lining along the y axis. The actual position of the lining is calculated from the origin of the local placement along the positive y axis with the distance given by LiningOffset.

The lining may include a casing, which covers part of the wall faces around the opening. The casing covers the left, right and upper side of the lining on both sides of the wall. The parameters are:

CasingDepth CasingThickness

The lining may include a threshold, which covers the bottom side of the opening. The parameters are:

ThresholdDepth if omited, equal to wall thickness - this only takes effect if a value for ThresholdThickness is given. If both parameters are not given, then there is no threshold. ThresholdThickness ThresholdOffset (not shown in figure): given, if the threshold edge has an offset to the x axis of the local placement.

The lining may have a transom which separates the door panel from a window panel. The transom, if given, is defined by:

TransomOffset : a parallel edge to the x axis of the local placement TransomThickness

The depth of the transom is identical to the depth of the lining and not given as separate parameter.

Figure 172 — Door lining properties

NOTE LiningDepth describes the length of the lining along the reveal of the door opening. It can be given by an absolute value if the door lining has a specific depth depending on the door style. However often it is equal to the wall thickness. If the same door style is used (like the same type of single swing door), but inserted into different walls with different thicknesses, it would be necessary to create a special door style for each wall thickness. Therefore several CAD systems allow to set the value to “automatically aligned” to wall thickness. This should be exchanged by leaving the optional attribute LiningDepth unassigned. The same agreement applies to ThresholdDepth.

Public Types

typedef IfcTemplatedEntityList<IfcDoorLiningProperties> list

Public Functions

bool hasLiningDepth() const

Whether the optional attribute LiningDepth is defined for this IfcDoorLiningProperties.

double LiningDepth() const

Depth of the door lining, measured perpendicular to the plane of the door lining. If omitted (and with a given value to lining thickness) it indicates an adjustable depth (i.e. a depth that adjusts to the thickness of the wall into which the occurrence of this door style is inserted).

void setLiningDepth(double v)
bool hasLiningThickness() const

Whether the optional attribute LiningThickness is defined for this IfcDoorLiningProperties.

double LiningThickness() const

Thickness (width in plane parallel to door leaf) of the door lining.

void setLiningThickness(double v)
bool hasThresholdDepth() const

Whether the optional attribute ThresholdDepth is defined for this IfcDoorLiningProperties.

double ThresholdDepth() const

Depth (dimension in plane perpendicular to door leaf) of the door threshold. Only given if the door lining includes a threshold. If omitted (and with a given value to threshold thickness) it indicates an adjustable depth (i.e. a depth that adjusts to the thickness of the wall into which the occurrence of this door style is inserted).

void setThresholdDepth(double v)
bool hasThresholdThickness() const

Whether the optional attribute ThresholdThickness is defined for this IfcDoorLiningProperties.

double ThresholdThickness() const

Thickness (width in plane parallel to door leaf) of the door threshold. Only given if the door lining includes a threshold and the parameter is known.

void setThresholdThickness(double v)
bool hasTransomThickness() const

Whether the optional attribute TransomThickness is defined for this IfcDoorLiningProperties.

double TransomThickness() const

Thickness (width in plane parallel to door leaf) of the transom (if given) which divides the door leaf from a glazing (or window) above.

void setTransomThickness(double v)
bool hasTransomOffset() const

Whether the optional attribute TransomOffset is defined for this IfcDoorLiningProperties.

double TransomOffset() const

Offset of the transom (if given) which divides the door leaf from a glazing (or window) above. The offset is given from the bottom of the door opening.

void setTransomOffset(double v)
bool hasLiningOffset() const

Whether the optional attribute LiningOffset is defined for this IfcDoorLiningProperties.

double LiningOffset() const

Offset (dimension in plane perpendicular to door leaf) of the door lining. The offset is given as distance to the x axis of the local placement.

void setLiningOffset(double v)
bool hasThresholdOffset() const

Whether the optional attribute ThresholdOffset is defined for this IfcDoorLiningProperties.

double ThresholdOffset() const

Offset (dimension in plane perpendicular to door leaf) of the door threshold. The offset is given as distance to the x axis of the local placement. Only given if the door lining includes a threshold and the parameter is known.

void setThresholdOffset(double v)
bool hasCasingThickness() const

Whether the optional attribute CasingThickness is defined for this IfcDoorLiningProperties.

double CasingThickness() const

Thickness of the casing (dimension in plane of the door leaf). If given it is applied equally to all four sides of the adjacent wall.

void setCasingThickness(double v)
bool hasCasingDepth() const

Whether the optional attribute CasingDepth is defined for this IfcDoorLiningProperties.

double CasingDepth() const

Depth of the casing (dimension in plane perpendicular to door leaf). If given it is applied equally to all four sides of the adjacent wall.

void setCasingDepth(double v)
bool hasShapeAspectStyle() const

Whether the optional attribute ShapeAspectStyle is defined for this IfcDoorLiningProperties.

::Ifc2x3::IfcShapeAspect *ShapeAspectStyle() const

Pointer to the shape aspect, if given. The shape aspect reflects the part of the door shape, which represents the door lining.

IFC2x4 CHANGE The attribute is deprecated and shall no longer be used, i.e. the value shall be NIL ($).

void setShapeAspectStyle(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcDoorLiningProperties(IfcEntityInstanceData *e)
IfcDoorLiningProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<double> v5_LiningDepth, boost::optional<double> v6_LiningThickness, boost::optional<double> v7_ThresholdDepth, boost::optional<double> v8_ThresholdThickness, boost::optional<double> v9_TransomThickness, boost::optional<double> v10_TransomOffset, boost::optional<double> v11_LiningOffset, boost::optional<double> v12_ThresholdOffset, boost::optional<double> v13_CasingThickness, boost::optional<double> v14_CasingDepth, ::Ifc2x3::IfcShapeAspect *v15_ShapeAspectStyle)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDoorPanelOperationEnum

Public Types

enum Value

This enumeration defines the basic ways how individual door panels operate as shown in Figure 164. HISTORY New Enumeration in IFC Release 2.0. IFC2x4 CHANGE Enumerator FIXEDPANELadded.

Swinging

DoubleActing

Sliding

Folding

Revolving

Rollingup

FixedPanel

NOTE Enumerator added in IFC2x4.

UserDefined

NotDefined

Figure 164 — Door operations

The opening direction of the door panels is given by the local placement of the IfcDoor. The positive y-axis determines the direction as shown in Figure 165.

Figure 165 — Door panel operations

NOTE Figures (symbolic representation) depend on the national building code. These figures are only shown as illustrations

Values:

enumerator IfcDoorPanelOperation_SWINGING
enumerator IfcDoorPanelOperation_DOUBLE_ACTING
enumerator IfcDoorPanelOperation_SLIDING
enumerator IfcDoorPanelOperation_FOLDING
enumerator IfcDoorPanelOperation_REVOLVING
enumerator IfcDoorPanelOperation_ROLLINGUP
enumerator IfcDoorPanelOperation_USERDEFINED
enumerator IfcDoorPanelOperation_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcDoorPanelPositionEnum

Public Types

enum Value

Definition: This enumeration defines the basic ways to describe the location of a door panel within a door lining.

HISTORY New Enumeration in IFC Release 2.x

Figure 166 shows the designation of a door panel with PanelPosition = LEFT and a door panel with PanelPosition = RIGHT within a door style with OperationType = DOUBLE_DOOR_SINGLE_SWING. The position is given as shown in the XZ plane of the local placement, looking into the direction of the positive Y axis.

Figure 166 — Door panel positions

Values:

enumerator IfcDoorPanelPosition_LEFT
enumerator IfcDoorPanelPosition_MIDDLE
enumerator IfcDoorPanelPosition_RIGHT
enumerator IfcDoorPanelPosition_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDoorPanelProperties : public Ifc2x3::IfcPropertySetDefinition

A door panel is normally a door leaf that opens to allow people or goods to pass. The parameters of the door panel define the geometrically relevant parameter of the panel,

The IfcDoorPanelProperties are used to parametrically describe the shape and operation of door panels. The parametric definition can be added solely or additionally to the explicit shape representation of the door.

The IfcDoorStyle can define doors consisting of more then one panel. In this case, one instance of IfcDoorPanelProperties has to be included for each door panel. The PanelPosition attribute, in conjunction with the IfcDoorStyle.OperationType attribute, determines to which panel the IfcDoorPanelProperties apply. The IfcDoorPanelProperties are included in the list of properties , given by attribute HasPropertySets of the IfcDoorStyle. More information about the door panel can be included in the same list of the IfcDoorStyle using the IfcPropertySet for dynamic extensions.

HISTORY New Entity in IFC Release 2.0.

IFC2x4 CHANGE Supertype changed to new IfcPreDefinedPropertySet.

Geometry use definitions

The IfcDoorPanelProperties does not hold a geometric representation. However it defines parameters which can be used to create the shape of the door style (which is inserted by the IfcDoor into the spatial context of the project) as shown in Figure 173. The parameters of the IfcDoorPanelProperties define a standard door panel, including (if given) a proportional width to define non-uniform double swing (or sliding, or folding) doors. The outer boundary of the panel is determined by the occurrence parameter assigned to the IfcDoor, which inserts the IfcDoorStyle. It has to take the lining parameter into account as well.

The depth of the panel (swinging, double-acting, and sliding panels) is defined by the PanelDepth parameter.

PanelDepth

For door operation types that include more than one panel, the width of (at least) one panel is given by a normalised ratio measure. It determines the width of that panel, which is defined as a ratio of the overall width of the door opening.

PanelWidth

Figure 173 — Door panel properties

Public Types

typedef IfcTemplatedEntityList<IfcDoorPanelProperties> list

Public Functions

bool hasPanelDepth() const

Whether the optional attribute PanelDepth is defined for this IfcDoorPanelProperties.

double PanelDepth() const

Depth of the door panel, measured perpendicular to the plane of the door leaf.

void setPanelDepth(double v)
::Ifc2x3::IfcDoorPanelOperationEnum::Value PanelOperation() const

The PanelOperation defines the way of operation of that panel. The PanelOperation of the door panel has to correspond with the OperationType of the IfcDoorStyle by which it is referenced.

void setPanelOperation(::Ifc2x3::IfcDoorPanelOperationEnum::Value v)
bool hasPanelWidth() const

Whether the optional attribute PanelWidth is defined for this IfcDoorPanelProperties.

double PanelWidth() const

Width of this panel, given as ratio relative to the total clear opening width of the door. If omited, it defaults to 1. A value has to be provided for all doors with OperationType’s at IfcDoorStyle defining a door with more then one panel.

void setPanelWidth(double v)
::Ifc2x3::IfcDoorPanelPositionEnum::Value PanelPosition() const

Position of this panel within the door. The PanelPosition of the door panel has to correspond with the OperationType of the IfcDoorStyle by which it is referenced.

void setPanelPosition(::Ifc2x3::IfcDoorPanelPositionEnum::Value v)
bool hasShapeAspectStyle() const

Whether the optional attribute ShapeAspectStyle is defined for this IfcDoorPanelProperties.

::Ifc2x3::IfcShapeAspect *ShapeAspectStyle() const

Pointer to the shape aspect, if given. The shape aspect reflects the part of the door shape, which represents the door panel.

IFC2x4 CHANGE The attribute is deprecated and shall no longer be used, i.e. the value shall be NIL ($).

void setShapeAspectStyle(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcDoorPanelProperties(IfcEntityInstanceData *e)
IfcDoorPanelProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<double> v5_PanelDepth, ::Ifc2x3::IfcDoorPanelOperationEnum::Value v6_PanelOperation, boost::optional<double> v7_PanelWidth, ::Ifc2x3::IfcDoorPanelPositionEnum::Value v8_PanelPosition, ::Ifc2x3::IfcShapeAspect *v9_ShapeAspectStyle)

Public Static Functions

const IfcParse::entity &Class()
class IfcDoorStyle : public Ifc2x3::IfcTypeProduct

Definition: The door style, IfcDoorStyle, defines a particular style of doors, which may be included into the spatial context of the building model through instances of IfcDoor. A door style defines the overall parameter of the door style and refers to the particular parameter of the lining and one (or several) panels through the IfcDoorLiningProperties and the IfcDoorPanelProperties.

The door entity, IfcDoor, defines a particular occurrence of a door inserted in the spatial context of a project. The actual parameter of the door and/or its shape is defined at the IfcDoorStyle, to which the IfcDoor is related by the inverse relationship IsDefinedBy pointing to IfcRelDefinedByType. The IfcDoorStyle also defines the particular attributes for the lining, IfcDoorLiningProperties, and panels, IfcDoorPanelProperties.

HISTORYNew entity in IFC Release 2x.

IFC2x4 CHANGE The entity is deprecated and shall not be used. The new entity IfcDoorType shall be used instead.

Geometry use definitions

The IfcDoorStyle defines the baseline geometry, or the representation map, for all occurrences of the door style, given by the IfcDoor, pointing to this style. The representation of the door style may be given by the agreed set of minimal parameters, defined for the door lining and the door panel(s), or it may be given by a geometric representation used by the IfcRepresentationMap. The attribute ParameterTakesPrecedence decides, whether the set of parameters can be used to exactly represent the shape of the door style (TRUE), or whether the attached IfcRepresentationMap holds the exact representation (FALSE).

The IfcDoorStyleOperationTypeEnum defines the general layout of the door style. Depending on the enumerator, the appropriate instances of IfcDoorLiningProperties and IfcDoorPanelProperties are attached in the list of HasPropertySets. The IfcDoorStyleOperationTypeEnum mainly determines the hinge side (left hung, or right hung), the operation (swinging, sliding, folding, etc.)and the number of panels.

See geometry use definitions at IfcDoorStyleOperationTypeEnum for the correct usage of opening symbols for different operation types.

Public Types

typedef IfcTemplatedEntityList<IfcDoorStyle> list

Public Functions

::Ifc2x3::IfcDoorStyleOperationEnum::Value OperationType() const

Type defining the general layout and operation of the door style.

void setOperationType(::Ifc2x3::IfcDoorStyleOperationEnum::Value v)
::Ifc2x3::IfcDoorStyleConstructionEnum::Value ConstructionType() const

Type defining the basic construction and material type of the door.

void setConstructionType(::Ifc2x3::IfcDoorStyleConstructionEnum::Value v)
bool ParameterTakesPrecedence() const

The Boolean value reflects, whether the parameter given in the attached lining and panel properties exactly define the geometry (TRUE), or whether the attached style shape take precedence (FALSE). In the last case the parameter have only informative value.

void setParameterTakesPrecedence(bool v)
bool Sizeable() const

The Boolean indicates, whether the attached IfcMappedRepresentation (if given) can be sized (using scale factor of transformation), or not (FALSE). If not, the IfcMappedRepresentation should be IfcShapeRepresentation of the IfcDoor (using IfcMappedItem as the Item) with the scale factor = 1.

void setSizeable(bool v)
const IfcParse::entity &declaration() const
IfcDoorStyle(IfcEntityInstanceData *e)
IfcDoorStyle(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcDoorStyleOperationEnum::Value v9_OperationType, ::Ifc2x3::IfcDoorStyleConstructionEnum::Value v10_ConstructionType, bool v11_ParameterTakesPrecedence, bool v12_Sizeable)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDoorStyleConstructionEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the basic types of construction of doors. The construction type relates to the main material (or material combination) used for making the door.

HISTORY New Enumeration in IFC Release 2x .

Values:

enumerator IfcDoorStyleConstruction_ALUMINIUM
enumerator IfcDoorStyleConstruction_HIGH_GRADE_STEEL
enumerator IfcDoorStyleConstruction_STEEL
enumerator IfcDoorStyleConstruction_WOOD
enumerator IfcDoorStyleConstruction_ALUMINIUM_WOOD
enumerator IfcDoorStyleConstruction_ALUMINIUM_PLASTIC
enumerator IfcDoorStyleConstruction_PLASTIC
enumerator IfcDoorStyleConstruction_USERDEFINED
enumerator IfcDoorStyleConstruction_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcDoorStyleOperationEnum

Public Types

enum Value

This enumeration defines the basic ways to describe how doors operate as shown in Figure 167. HISTORY New Enumeration in Release IFC2x.

Enumerator Description Figure

SINGLE_SWING_LEFT

Door with one panel that opens (swings) to the left. The hinges are on the left side as viewed in the direction of the positive y-axis. Note: Direction of swing (whether in or out) is determined at the IfcDoor.

SINGLE_SWING_RIGHT

Door with one panel that opens (swings) to the right. The hinges are on the right side as viewed in the direction of the positive y-axis. Note: Direction of swing (whether in or out) is determined at the IfcDoor.

DOUBLE_DOOR_ SINGLE_SWING

Door with two panels, one opens (swings) to the left the other opens (swings) to the right. Note: Direction of swing (whether in or out) is determined at the IfcDoor.

DOUBLE_SWING_LEFT

Door with one panel that swings in both directions and to the left in the main trafic direction. Also called double acting door. Note: Direction of main swing (whether in or out) is determined at the IfcDoor.

DOUBLE_SWING_RIGHT

Door with one panel that swings in both directions and to the right in the main trafic direction. Also called double acting door. Note: Direction of main swing (whether in or out) is determined at the IfcDoor.

DOUBLE_DOOR_ DOUBLE_SWING

Door with two panels, one swings in both directions and to the right in the main trafic direction the other swings also in both directions and to the left in the main trafic direction. Note: Direction of main swing (whether in or out) is determined at the IfcDoor.

DOUBLE_DOOR_ SINGLE_SWING_ OPPOSITE_LEFT

Door with two panels that both open to the left, one panel swings in one direction and the other panel swings in the opposite direction. Note: Direction of main swing (whether in or out) is determined at the IfcDoor.

DOUBLE_DOOR_ SINGLE_SWING_ OPPOSITE_RIGHT Door with two panels that both open to the right, one panel swings in one direction and the other panel swings in the opposite direction. Note: Direction of main swing (whether in or out) is determined at the IfcDoor.

SLIDING_TO_LEFT

Door with one panel that is sliding to the left.

SLIDING_TO_RIGHT

Door with one panel that is sliding to the right.

DOUBLE_DOOR_SLIDING

Door with two panels, one is sliding to the left the other is sliding to the right.

FOLDING_TO_LEFT

Door with one panel that is folding to the left.

FOLDING_TO_RIGHT Door with one panel that is folding to the right.

DOUBLE_DOOR_FOLDING

Door with two panels, one is folding to the left the other is folding to the right.

REVOLVING

An entrance door consisting of four leaves set in a form of a cross and revolving around a central vertical axis (the four panels are described by a single IfcDoor panel property).

ROLLINGUP

Door that opens by rolling up. Note: Whether it rolls up to the inside or outside is determined at the IfcDoor.

USERDEFINED User defined operation type

NOTDEFINED A door with a not defined operation type is considered as a door with a lining, but no panels. It is thereby always open.

Figure 167 — Door style operations

NOTE

Figures are shown in the ground view. Figures (symbolic representation) depend on the national building code. These figures are only shown as illustrations, the actual representation in the ground view might differ. Open to the outside is declared as open into the direction of the positive y-axis, determined by the ObjectPlacement at IfcDoor The location of the panel relative to the wall thickness is defined by theObjectPlacement at IfcDoor, and the IfcDoorLiningProperties.LiningOffset parameter.

Values:

enumerator IfcDoorStyleOperation_SINGLE_SWING_LEFT
enumerator IfcDoorStyleOperation_SINGLE_SWING_RIGHT
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_SINGLE_SWING
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_LEFT
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_SINGLE_SWING_OPPOSITE_RIGHT
enumerator IfcDoorStyleOperation_DOUBLE_SWING_LEFT
enumerator IfcDoorStyleOperation_DOUBLE_SWING_RIGHT
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_DOUBLE_SWING
enumerator IfcDoorStyleOperation_SLIDING_TO_LEFT
enumerator IfcDoorStyleOperation_SLIDING_TO_RIGHT
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_SLIDING
enumerator IfcDoorStyleOperation_FOLDING_TO_LEFT
enumerator IfcDoorStyleOperation_FOLDING_TO_RIGHT
enumerator IfcDoorStyleOperation_DOUBLE_DOOR_FOLDING
enumerator IfcDoorStyleOperation_REVOLVING
enumerator IfcDoorStyleOperation_ROLLINGUP
enumerator IfcDoorStyleOperation_USERDEFINED
enumerator IfcDoorStyleOperation_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDoseEquivalentMeasure : public IfcUtil::IfcBaseType

IfcDoseEquivalentMeasure is a measure of the radioactive dose equivalent. Usually measured in Sievert (Sv, J/kg). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDoseEquivalentMeasure(IfcEntityInstanceData *e)
IfcDoseEquivalentMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcDraughtingCallout : public Ifc2x3::IfcGeometricRepresentationItem

Subclassed by Ifc2x3::IfcDimensionCurveDirectedCallout, Ifc2x3::IfcStructuredDimensionCallout

Public Types

typedef IfcTemplatedEntityList<IfcDraughtingCallout> list

Public Functions

IfcEntityList::ptr Contents() const
void setContents(IfcEntityList::ptr v)
IfcTemplatedEntityList<IfcDraughtingCalloutRelationship>::ptr IsRelatedFromCallout() const
IfcTemplatedEntityList<IfcDraughtingCalloutRelationship>::ptr IsRelatedToCallout() const
const IfcParse::entity &declaration() const
IfcDraughtingCallout(IfcEntityInstanceData *e)
IfcDraughtingCallout(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcDraughtingCalloutRelationship : public IfcUtil::IfcBaseEntity

Subclassed by Ifc2x3::IfcDimensionCalloutRelationship, Ifc2x3::IfcDimensionPair

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcDraughtingCalloutRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcDraughtingCalloutRelationship.

std::string Description() const
void setDescription(std::string v)
::Ifc2x3::IfcDraughtingCallout *RelatingDraughtingCallout() const
void setRelatingDraughtingCallout(::Ifc2x3::IfcDraughtingCallout *v)
::Ifc2x3::IfcDraughtingCallout *RelatedDraughtingCallout() const
void setRelatedDraughtingCallout(::Ifc2x3::IfcDraughtingCallout *v)
const IfcParse::entity &declaration() const
IfcDraughtingCalloutRelationship(IfcEntityInstanceData *e)
IfcDraughtingCalloutRelationship(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDraughtingCallout *v3_RelatingDraughtingCallout, ::Ifc2x3::IfcDraughtingCallout *v4_RelatedDraughtingCallout)

Public Static Functions

const IfcParse::entity &Class()
class IfcDraughtingPreDefinedColour : public Ifc2x3::IfcPreDefinedColour

The draughting pre defined colour is a pre defined colour for the purpose to identify a colour by name. Allowable names are:

‘black’, ‘red’, ‘green’, ‘blue’, ‘yellow’, ‘magenta’, ‘cyan’, ‘white’, ‘by layer’

NOTEThe IfcDraughtingPreDefinedColour is an entity that had been adopted from ISO 10303-202, Industrial automation systems and integration—Product data representation and exchange, Part 202: Application protocol: Associative draughting.

The following table states the RGB values associated with the names given by the IfcDraughtingPreDefinedColour.

Colour name Red Green Blue

black 0 0 0

red 1.0 0 0

green 0 1.0 0

blue 0 0 1.0

yellow 1.0 1.0 0

magenta 1.0 0 1.0

cyan 0 1.0 1.0

white 1.0 1.0 1.0

by layer colour values obtained from IfcPresentationLayerWithStyle.

NOTECorresponding ISO 10303 name: draughting_pre_defined_colour. Please refer to ISO/IS 10303-202:1994 page 194 for the final definition of the formal standard.

HISTORYNew entity in IFC2x2.

Informal proposition

The value ‘by layer’ shall only be inserted, if the geometric representation item using the colour definition has an association to IfcPresentationLayerWithStyle, and if that instance of IfcPresentationLayerWithStyle has a valid colour definition for IfcCurveStyle, IfcSymbolStyle, or IfcSurfaceStyle (depending on what is applicable).

Public Functions

const IfcParse::entity &declaration() const
IfcDraughtingPreDefinedColour(IfcEntityInstanceData *e)
IfcDraughtingPreDefinedColour(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcDraughtingPreDefinedCurveFont : public Ifc2x3::IfcPreDefinedCurveFont

The draughting predefined curve font type defines a selection of widely used curve fonts for draughting purposes by name.

NOTE The IfcDraughtingPreDefinedCurveFont is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46 Technical Corrigendum 2: Integrated generic resources: Visual presentation.

Figure 291 (from ISO 10303-46 TC2) illustrates predefined curve fonts.

Figure 291 — Draughting predefined curve font

NOTE If the IfcDraughtingPreDefinedCurveFont is used within an IfcCurveStyleFontAndScaling then the segment and space lengths that are given in the table are as such for the scale factor 1.0

NOTE Corresponding ISO 10303 name: pre_defined_curve_font. Please refer to ISO/IS 10303-46:1994 TC2, page 12 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcDraughtingPreDefinedCurveFont(IfcEntityInstanceData *e)
IfcDraughtingPreDefinedCurveFont(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcDraughtingPreDefinedTextFont : public Ifc2x3::IfcPreDefinedTextFont

The draughting pre defined text font is a pre defined text font for the purpose to identify a font by name. Allowable names are:

‘ISO 3098-1 font A’, ‘ISO 3098-1 font B’,

The ISO 3098-1 font A is the text font as denoted as Letterng A in clause 3 of ISO 3098-1, the ISO 3098-1 font B is the text font as denoted as Letterng B in clause 3 of ISO 3098-1.

NOTE The IfcDraughtingPreDefinedTextFont is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 202: Application protocol: Associative draughting. Corresponding ISO 10303 name: draughting_pre_defined_text_font. Please refer to ISO/IS 10303-202:1994 page 196 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcDraughtingPreDefinedTextFont(IfcEntityInstanceData *e)
IfcDraughtingPreDefinedTextFont(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcDuctFittingType : public Ifc2x3::IfcFlowFittingType

The flow fitting type IfcDuctFittingType defines commonly shared information for occurrences of duct fittings. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a duct fitting specification (i.e. the specific product information, that is common to all occurrences of that product type). Duct Fitting types may be exchanged without being already assigned to occurrences. Occurrences of IfcDuctFittingType are represented by instances of IfcDuctFitting.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowFittingType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DuctFittingTypeCommon

Material Use Definition The material of the IfcDuctFittingType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Body’: Material from which the duct fitting is constructed. ‘Coating’: The outer coating, if applicable. ‘Insulation’: The insulating wrapping, if applicable. ‘Lining’: The inner lining, if applicable.

Port Use Definition The distribution ports relating to the IfcDuctFittingType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcDuctFitting for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcDuctFittingType> list

Public Functions

::Ifc2x3::IfcDuctFittingTypeEnum::Value PredefinedType() const

The type of duct fitting.

void setPredefinedType(::Ifc2x3::IfcDuctFittingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcDuctFittingType(IfcEntityInstanceData *e)
IfcDuctFittingType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcDuctFittingTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDuctFittingTypeEnum

Public Types

enum Value

This enumeration is used to identify the primary purpose of a duct fitting. This is a very basic categorization mechanism to generically identify the duct fitting type. Subcategories of duct fittings are not enumerated. The IfcDuctFittingTypeEnum contains the following:

BEND: A fitting with typically two ports used to change the direction of flow between connected elements. CONNECTOR: Connector fitting, typically used to join two ports together within a flow distribution system (e.g., a coupling used to join two duct segments). ENTRY: Entry fitting, typically unconnected at one port and connected to a flow distribution system at the other (e.g., an outside air duct system intake opening). EXIT: Exit fitting, typically unconnected at one port and connected to a flow distribution system at the other (e.g., an exhaust air discharge opening). JUNCTION: A fitting with typically more than two ports used to redistribute flow among the ports and/or to change the direction of flow between connected elements (e.g, tee, cross, wye, etc.). OBSTRUCTION: A fitting with typically two ports used to obstruct or restrict flow between the connected elements (e.g., screen, perforated plate, etc.). TRANSITION: A fitting with typically two ports having different shapes or sizes. Can also be used to change the direction of flow between connected elements. USERDEFINED: User-defined fitting. NOTDEFINED: Undefined fitting.

HISTORY: New enumeration in IFC 2x2

Values:

enumerator IfcDuctFittingType_BEND
enumerator IfcDuctFittingType_CONNECTOR
enumerator IfcDuctFittingType_ENTRY
enumerator IfcDuctFittingType_EXIT
enumerator IfcDuctFittingType_JUNCTION
enumerator IfcDuctFittingType_OBSTRUCTION
enumerator IfcDuctFittingType_TRANSITION
enumerator IfcDuctFittingType_USERDEFINED
enumerator IfcDuctFittingType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDuctSegmentType : public Ifc2x3::IfcFlowSegmentType

The flow segment type IfcDuctSegmentType defines commonly shared information for occurrences of duct segments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a duct segment specification (i.e. the specific product information, that is common to all occurrences of that product type). Duct Segment types may be exchanged without being already assigned to occurrences. Occurrences of IfcDuctSegmentType are represented by instances of IfcDuctSegment.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowSegmentType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DuctSegmentTypeCommon

Material Use Definition The material of the IfcDuctSegmentType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Body’: Material from which the duct segment is constructed. ‘Coating’: The outer coating, if applicable. ‘Insulation’: The insulating wrapping, if applicable. ‘Lining’: The inner lining, if applicable.

Port Use Definition The distribution ports relating to the IfcDuctSegmentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcDuctSegment for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcDuctSegmentType> list

Public Functions

::Ifc2x3::IfcDuctSegmentTypeEnum::Value PredefinedType() const

The type of duct segment.

void setPredefinedType(::Ifc2x3::IfcDuctSegmentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcDuctSegmentType(IfcEntityInstanceData *e)
IfcDuctSegmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcDuctSegmentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDuctSegmentTypeEnum

Public Types

enum Value

This enumeration is used to identify the primary purpose of a duct segment. This is a very basic categorization mechanism to generically identify the duct segment type. Subcategories of duct segments are not enumerated. The IfcDuctSegmentTypeEnum contains the following:

RIGIDSEGMENT: A rigid segment is continuous linear segment of duct that cannot be deformed. FLEXIBLESEGMENT: A flexible segment is a continuous non-linear segment of duct that can be deformed and change the direction of flow. USERDEFINED: User-defined segment. NOTDEFINED: Undefined segment.

HISTORY: New enumeration in IFC 2x2

Values:

enumerator IfcDuctSegmentType_RIGIDSEGMENT
enumerator IfcDuctSegmentType_FLEXIBLESEGMENT
enumerator IfcDuctSegmentType_USERDEFINED
enumerator IfcDuctSegmentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDuctSilencerType : public Ifc2x3::IfcFlowTreatmentDeviceType

The flow treatment device type IfcDuctSilencerType defines commonly shared information for occurrences of duct silencers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a duct silencer specification (i.e. the specific product information, that is common to all occurrences of that product type). Duct Silencer types may be exchanged without being already assigned to occurrences. Occurrences of IfcDuctSilencerType are represented by instances of IfcDuctSilencer.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTreatmentDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_DuctSilencerTypeCommon

Material Use Definition The material of the IfcDuctSilencerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcDuctSilencerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcDuctSilencer for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcDuctSilencerType> list

Public Functions

::Ifc2x3::IfcDuctSilencerTypeEnum::Value PredefinedType() const

The type of duct silencer.

void setPredefinedType(::Ifc2x3::IfcDuctSilencerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcDuctSilencerType(IfcEntityInstanceData *e)
IfcDuctSilencerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcDuctSilencerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcDuctSilencerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of duct silencers. The IfcDuctSilencerTypeEnum contains the following:

FLATOVAL: Flat-oval shaped duct silencer type. RECTANGULAR: Rectangular shaped duct silencer type. ROUND: Round duct silencer type. USERDEFINED: User-defined duct silencer type. NOTDEFINED: Undefined duct silencer type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcDuctSilencerType_FLATOVAL
enumerator IfcDuctSilencerType_RECTANGULAR
enumerator IfcDuctSilencerType_ROUND
enumerator IfcDuctSilencerType_USERDEFINED
enumerator IfcDuctSilencerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcDynamicViscosityMeasure : public IfcUtil::IfcBaseType

IfcDynamicViscosityMeasure is a measure of the viscous resistance of a medium.

Usually measured in Pascal second (Pa s). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcDynamicViscosityMeasure(IfcEntityInstanceData *e)
IfcDynamicViscosityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcEdge : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: An edge is the topological construct corresponding to the connection of two vertices. More abstractly, it may stand for a logical relationship between two vertices. The domain of an edge, if present, is a finite, non-self-intersecting open curve in RM, that is, a connected 1-dimensional manifold. The bounds of an edge are two vertices, which need not be distinct. The edge is oriented by choosing its traversal direction to run from the first to the second vertex. If the two vertices are the same, the edge is a self loop. The domain of the edge does not include its bounds, and 0 ≤ Ξ ≤ ∞. Associated with an edge may be a geometric curve to locate the edge in a coordinate space; this is represented by the edge curve (IfcEdgeCurve) subtype. The curve shall be finite and non-self-intersecting within the domain of the edge. An edge is a graph, so its multiplicity M and graph genus Ge may be determined by the graph traversal algorithm. Since M = E = 1, the Euler equation (1) reduces in the case to

where V = 1 or 2, and Ge = 1 or 0. Specifically, the topological edge defining data shall satisfy:

  • an edge has two vertices

  • the vertices need not be distinct

  • Equation (2) shall hold.

The geometry between the two vertices defaults to a straight line if no curve geometry is assigned using the subtype IfcEdgeCurve. The IfcEdge can therefore be used to exchange straight edges without an associated geometry provided by IfcLine or IfcPolyline thought IfcEdgeCurve.EdgeGeometry.

Figure 333 illustrates an example where the bounds of the IfcEdge are given by the EdgeStart and EdgeEnd; this also determines the direction of the edge. The location within a coordinate space is determined by the IfcVertexPoint type for EdgeStart and EdgeEnd. Since no edge geometry is assigned, it defaults to a straight line agreeing to the direction sense.

Figure 333 — Edge representation

NOTE Corresponding ISO 10303 entity: edge. Please refer to ISO/IS 10303-42:1994, p. 130 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 2.0

Informal propositions:

The edge has dimensionality 1. The extend of an edge shall be finite and nonzero.

Subclassed by Ifc2x3::IfcEdgeCurve, Ifc2x3::IfcOrientedEdge, Ifc2x3::IfcSubedge

Public Types

typedef IfcTemplatedEntityList<IfcEdge> list

Public Functions

::Ifc2x3::IfcVertex *EdgeStart() const

Start point (vertex) of the edge.

void setEdgeStart(::Ifc2x3::IfcVertex *v)
::Ifc2x3::IfcVertex *EdgeEnd() const

End point (vertex) of the edge. The same vertex can be used for both EdgeStart and EdgeEnd.

void setEdgeEnd(::Ifc2x3::IfcVertex *v)
const IfcParse::entity &declaration() const
IfcEdge(IfcEntityInstanceData *e)
IfcEdge(::Ifc2x3::IfcVertex *v1_EdgeStart, ::Ifc2x3::IfcVertex *v2_EdgeEnd)

Public Static Functions

const IfcParse::entity &Class()
class IfcEdgeCurve : public Ifc2x3::IfcEdge

Definition from ISO/CD 10303-42:1992: An edge curve is a special subtype of edge which has its geometry fully defined. The geometry is defined by associating the edge with a curve which may be unbounded. As the topological and geometric directions may be opposed, an indicator (same sense) is used to identify whether the edge and curve directions agree or are opposed. The Boolean value indicates whether the curve direction agrees with (TRUE) or is in the opposite direction (FALSE) to the edge direction. Any geometry associated with the vertices of the edge shall be consistent with the edge geometry. Multiple edges can reference the same curve.

Figure 334 illustrates an example where the edge geometry is given by an unbounded curve, here IfcCircle. The bounds are provided by the EdgeStart and EdgeEnd, the topological direction of the IfcEdgeCurve opposes the direction of the IfcCircle by SameSense = FALSE.

Figure 334 — Edge curve

NOTE Corresponding ISO 10303 entity: edge_curve. Please refer to ISO/IS 10303-42:1994, p. 132 for the final definition of the formal standard. Due to the general IFC model specification rule not to use multiple inheritance, the subtype relationship to geometric_representation_item is not included.

<blockquote class=”history” HISTORY New Entity in IFC2x.

Informal propositions:

The domain of the edge curve is formally defined to be the domain of its edge geometry as trimmed by the vertices. This domain does not include the vertices. An edge curve has non-zero finite extent. An edge curve is a manifold. An edge curve is arcwise connected. The edge start is not a part of the edge domain. The edge end is not a part of the edge domain. Vertex geometry shall be consistent with edge geometry.

Public Types

typedef IfcTemplatedEntityList<IfcEdgeCurve> list

Public Functions

::Ifc2x3::IfcCurve *EdgeGeometry() const

The curve which defines the shape and spatial location of the edge. This curve may be unbounded and is implicitly trimmed by the vertices of the edge; this defines the edge domain. Multiple edges can reference the same curve.

void setEdgeGeometry(::Ifc2x3::IfcCurve *v)
bool SameSense() const

This logical flag indicates whether (TRUE), or not (FALSE) the senses of the edge and the curve defining the edge geometry are the same. The sense of an edge is from the edge start vertex to the edge end vertex; the sense of a curve is in the direction of increasing parameter.

void setSameSense(bool v)
const IfcParse::entity &declaration() const
IfcEdgeCurve(IfcEntityInstanceData *e)
IfcEdgeCurve(::Ifc2x3::IfcVertex *v1_EdgeStart, ::Ifc2x3::IfcVertex *v2_EdgeEnd, ::Ifc2x3::IfcCurve *v3_EdgeGeometry, bool v4_SameSense)

Public Static Functions

const IfcParse::entity &Class()
class IfcEdgeFeature : public Ifc2x3::IfcFeatureElementSubtraction

Subclassed by Ifc2x3::IfcChamferEdgeFeature, Ifc2x3::IfcRoundedEdgeFeature

Public Types

typedef IfcTemplatedEntityList<IfcEdgeFeature> list

Public Functions

bool hasFeatureLength() const

Whether the optional attribute FeatureLength is defined for this IfcEdgeFeature.

double FeatureLength() const
void setFeatureLength(double v)
const IfcParse::entity &declaration() const
IfcEdgeFeature(IfcEntityInstanceData *e)
IfcEdgeFeature(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_FeatureLength)

Public Static Functions

const IfcParse::entity &Class()
class IfcEdgeLoop : public Ifc2x3::IfcLoop

Definition from ISO/CD 10303-42:1992: An edge_loop is a loop with nonzero extent. It is a path in which the start and end vertices are the same. Its domain, if present, is a closed curve. An edge_loop may overlap itself.

Informal propositions:

The genus of the IfcEdgeLoop shall be 1 or greater. The Euler formula shall be satisfied:(number of vertices) + genus - (number of edges) = 1; No edge may be referenced more than once by the same IfcEdgeLoop with the same sense. For this purpose, an edge which is not an oriented edge is considered to be referenced with the sense TRUE.

NOTE Corresponding ISO 10303 entity: edge_loop. Please refer to ISO/IS 10303-42:1994, p. 122 for the final definition of the formal standard.

HISTORY New Entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcEdgeLoop> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr EdgeList() const

A list of oriented edge entities which are concatenated together to form this path.

void setEdgeList(IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr v)
const IfcParse::entity &declaration() const
IfcEdgeLoop(IfcEntityInstanceData *e)
IfcEdgeLoop(IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr v1_EdgeList)

Public Static Functions

const IfcParse::entity &Class()
class IfcElectricalBaseProperties : public Ifc2x3::IfcEnergyProperties

Public Functions

bool hasElectricCurrentType() const

Whether the optional attribute ElectricCurrentType is defined for this IfcElectricalBaseProperties.

::Ifc2x3::IfcElectricCurrentEnum::Value ElectricCurrentType() const
void setElectricCurrentType(::Ifc2x3::IfcElectricCurrentEnum::Value v)
double InputVoltage() const
void setInputVoltage(double v)
double InputFrequency() const
void setInputFrequency(double v)
bool hasFullLoadCurrent() const

Whether the optional attribute FullLoadCurrent is defined for this IfcElectricalBaseProperties.

double FullLoadCurrent() const
void setFullLoadCurrent(double v)
bool hasMinimumCircuitCurrent() const

Whether the optional attribute MinimumCircuitCurrent is defined for this IfcElectricalBaseProperties.

double MinimumCircuitCurrent() const
void setMinimumCircuitCurrent(double v)
bool hasMaximumPowerInput() const

Whether the optional attribute MaximumPowerInput is defined for this IfcElectricalBaseProperties.

double MaximumPowerInput() const
void setMaximumPowerInput(double v)
bool hasRatedPowerInput() const

Whether the optional attribute RatedPowerInput is defined for this IfcElectricalBaseProperties.

double RatedPowerInput() const
void setRatedPowerInput(double v)
int InputPhase() const
void setInputPhase(int v)
const IfcParse::entity &declaration() const
IfcElectricalBaseProperties(IfcEntityInstanceData *e)
IfcElectricalBaseProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<::Ifc2x3::IfcEnergySequenceEnum::Value> v5_EnergySequence, boost::optional<std::string> v6_UserDefinedEnergySequence, boost::optional<::Ifc2x3::IfcElectricCurrentEnum::Value> v7_ElectricCurrentType, double v8_InputVoltage, double v9_InputFrequency, boost::optional<double> v10_FullLoadCurrent, boost::optional<double> v11_MinimumCircuitCurrent, boost::optional<double> v12_MaximumPowerInput, boost::optional<double> v13_RatedPowerInput, int v14_InputPhase)

Public Static Functions

const IfcParse::entity &Class()
class IfcElectricalCircuit : public Ifc2x3::IfcSystem

Public Types

typedef IfcTemplatedEntityList<IfcElectricalCircuit> list

Public Functions

const IfcParse::entity &declaration() const
IfcElectricalCircuit(IfcEntityInstanceData *e)
IfcElectricalCircuit(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcElectricalElement : public Ifc2x3::IfcElement

Public Types

typedef IfcTemplatedEntityList<IfcElectricalElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcElectricalElement(IfcEntityInstanceData *e)
IfcElectricalElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcElectricApplianceType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcElectricApplianceType defines commonly shared information for occurrences of electric appliances. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a electric appliance specification (i.e. the specific product information, that is common to all occurrences of that product type). Electric Appliance types may be exchanged without being already assigned to occurrences. Occurrences of IfcElectricApplianceType are represented by instances of IfcElectricAppliance.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ElectricalDeviceCommon Pset_ElectricApplianceTypeCommon Pset_ElectricApplianceTypeDishwasher (DISHWASHER) Pset_ElectricApplianceTypeElectricCooker (ELECTRICCOOKER)

Material Use Definition The material of the IfcElectricApplianceType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcElectricApplianceType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcElectricAppliance for standard port definitions.

Public Functions

::Ifc2x3::IfcElectricApplianceTypeEnum::Value PredefinedType() const

Identifies the predefined types of electrical appliance from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcElectricApplianceTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricApplianceType(IfcEntityInstanceData *e)
IfcElectricApplianceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricApplianceTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricApplianceTypeEnum

Public Types

enum Value

The IfcElectricApplianceTypeEnum defines the range of different types of electrical appliance that can be specified.

HISTORY: New type in IFC R2.0. Renamed from IfcElectricalApplianceTypeEnum if IFC 2x2.IFC 2x2 Addendum 1: Missing enumeration values added (ELECTRICHEATER, TUMBLEDRYER and WATERHEATER) IFC 2x4: ELECTRICHEATER changed to FREESTANDINGELECTRICHEATER and noted as being for occasional use. RADIANTHEATER removed as part of general ‘heater consolidation’. WATERHEATER, DIRECTWATERHEATER and INDIRECTWATERHEATER rationalized to FREESTANDINGWATERHEATER. WATERCOOLER changed to FREESTANDINGWATERCOOLER. COMPUTER, FACSIMILE (FAX), PRINTER, SCANNER, TELEPHONE, TV (TELEVISION) moved to IfcAudioVisualApplianceTypeEnum and IfcCommunicationsApplianceTypeEnum. KITCHENMACHINE added.

Enumeration

DISHWASHER: An appliance that has the primary function of washing dishes. ELECTRICCOOKER: An electrical appliance that has the primary function of cooking food (including oven, hob, grill). FREESTANDINGELECTRICHEATER: An electrical appliance that is used occasionally to provide heat. A freestanding electric heater is a ‘plugged’ appliance whose load may be removed from an electric circuit. FREESTANDINGFAN: An electrical appliance that is used occasionally to provide ventilation. A freestanding fan is a ‘plugged’ appliance whose load may be removed from an electric circuit. FREESTANDINGWATERHEATER: A small, local electrical appliance for heating water. A freestanding water heater is a ‘plugged’ appliance whose load may be removed from an electric circuit. FREESTANDINGWATERCOOLER: A small, local electrical appliance for cooling water. A freestanding water cooler is a ‘plugged’ appliance whose load may be removed from an electric circuit. FREEZER: An electrical appliance that has the primary function of storing food at temperatures below the freezing point of water. FRIDGE_FREEZER: An electrical appliance that combines the functions of a freezer and a refrigerator through the provision of separate compartments. KITCHENMACHINE: A specialized appliance used in commercial kitchens such as a mixer. HANDDRYER: An electrical appliance that has the primary function of drying hands. MICROWAVE: An electrical appliance that has the primary function of cooking food using microwaves. PHOTOCOPIER: A machine that has the primary function of reproduction of printed matter. REFRIGERATOR: An electrical appliance that has the primary function of storing food at low temperature but above the freezing point of water. TUMBLEDRYER: An electrical appliance that has the primary function of drying clothes. VENDINGMACHINE: An appliance that stores and vends goods including food, drink and goods of various types. WASHINGMACHINE: An appliance that has the primary function of washing clothes.

USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcElectricApplianceType_COMPUTER
enumerator IfcElectricApplianceType_DIRECTWATERHEATER
enumerator IfcElectricApplianceType_DISHWASHER
enumerator IfcElectricApplianceType_ELECTRICCOOKER
enumerator IfcElectricApplianceType_ELECTRICHEATER
enumerator IfcElectricApplianceType_FACSIMILE
enumerator IfcElectricApplianceType_FREESTANDINGFAN
enumerator IfcElectricApplianceType_FREEZER
enumerator IfcElectricApplianceType_FRIDGE_FREEZER
enumerator IfcElectricApplianceType_HANDDRYER
enumerator IfcElectricApplianceType_INDIRECTWATERHEATER
enumerator IfcElectricApplianceType_MICROWAVE
enumerator IfcElectricApplianceType_PHOTOCOPIER
enumerator IfcElectricApplianceType_PRINTER
enumerator IfcElectricApplianceType_REFRIGERATOR
enumerator IfcElectricApplianceType_RADIANTHEATER
enumerator IfcElectricApplianceType_SCANNER
enumerator IfcElectricApplianceType_TELEPHONE
enumerator IfcElectricApplianceType_TUMBLEDRYER
enumerator IfcElectricApplianceType_TV
enumerator IfcElectricApplianceType_VENDINGMACHINE
enumerator IfcElectricApplianceType_WASHINGMACHINE
enumerator IfcElectricApplianceType_WATERHEATER
enumerator IfcElectricApplianceType_WATERCOOLER
enumerator IfcElectricApplianceType_USERDEFINED
enumerator IfcElectricApplianceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricCapacitanceMeasure : public IfcUtil::IfcBaseType

IfcElectricCapacitanceMeasure is a measure of the electric capacitance. Usually measured in Farad (F, C/V = A s/V). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricCapacitanceMeasure(IfcEntityInstanceData *e)
IfcElectricCapacitanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcElectricChargeMeasure : public IfcUtil::IfcBaseType

IfcElectricChargeMeasure is a measure of the electric charge. Usually measured in Coulomb (C, A s). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricChargeMeasure(IfcEntityInstanceData *e)
IfcElectricChargeMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcElectricConductanceMeasure : public IfcUtil::IfcBaseType

IfcElectricConductanceMeasure is a measure of the electric conductance. Usually measured in Siemens (S, 1/Ohm = A/V). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricConductanceMeasure(IfcEntityInstanceData *e)
IfcElectricConductanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcElectricCurrentEnum

Public Types

enum Value

Values:

enumerator IfcElectricCurrent_ALTERNATING
enumerator IfcElectricCurrent_DIRECT
enumerator IfcElectricCurrent_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricCurrentMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: The value for the movement of electrically charged particles. Usually measured in Ampere (A). Type: REAL

NOTE Corresponding ISO 10303 name: electric_current_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricCurrentMeasure(IfcEntityInstanceData *e)
IfcElectricCurrentMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcElectricDistributionPoint : public Ifc2x3::IfcFlowController

Public Functions

::Ifc2x3::IfcElectricDistributionPointFunctionEnum::Value DistributionPointFunction() const
void setDistributionPointFunction(::Ifc2x3::IfcElectricDistributionPointFunctionEnum::Value v)
bool hasUserDefinedFunction() const

Whether the optional attribute UserDefinedFunction is defined for this IfcElectricDistributionPoint.

std::string UserDefinedFunction() const
void setUserDefinedFunction(std::string v)
const IfcParse::entity &declaration() const
IfcElectricDistributionPoint(IfcEntityInstanceData *e)
IfcElectricDistributionPoint(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcElectricDistributionPointFunctionEnum::Value v9_DistributionPointFunction, boost::optional<std::string> v10_UserDefinedFunction)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricDistributionPointFunctionEnum

Public Types

enum Value

Values:

enumerator IfcElectricDistributionPointFunction_ALARMPANEL
enumerator IfcElectricDistributionPointFunction_CONSUMERUNIT
enumerator IfcElectricDistributionPointFunction_CONTROLPANEL
enumerator IfcElectricDistributionPointFunction_DISTRIBUTIONBOARD
enumerator IfcElectricDistributionPointFunction_GASDETECTORPANEL
enumerator IfcElectricDistributionPointFunction_INDICATORPANEL
enumerator IfcElectricDistributionPointFunction_MIMICPANEL
enumerator IfcElectricDistributionPointFunction_MOTORCONTROLCENTRE
enumerator IfcElectricDistributionPointFunction_SWITCHBOARD
enumerator IfcElectricDistributionPointFunction_USERDEFINED
enumerator IfcElectricDistributionPointFunction_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricFlowStorageDeviceType : public Ifc2x3::IfcFlowStorageDeviceType

The flow storage device type IfcElectricFlowStorageDeviceType defines commonly shared information for occurrences of electric flow storage devices. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a electric flow storage device specification (i.e. the specific product information, that is common to all occurrences of that product type). Electric Flow Storage Device types may be exchanged without being already assigned to occurrences. Occurrences of IfcElectricFlowStorageDeviceType are represented by instances of IfcElectricFlowStorageDevice.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowStorageDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_ElectricFlowStorageDeviceTypeCommon

Material Use Definition The material of the IfcElectricFlowStorageDeviceType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcElectricFlowStorageDeviceType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcElectricFlowStorageDevice for standard port definitions.

Public Functions

::Ifc2x3::IfcElectricFlowStorageDeviceTypeEnum::Value PredefinedType() const

Identifies the predefined types of electric flow storage devices from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcElectricFlowStorageDeviceTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricFlowStorageDeviceType(IfcEntityInstanceData *e)
IfcElectricFlowStorageDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricFlowStorageDeviceTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricFlowStorageDeviceTypeEnum

Public Types

enum Value

The IfcElectricFlowStorageDeviceTypeEnum defines the range of different types of electrical flow storage device available. HISTORY: New type in IFC 2x2

Enumeration

BATTERY: A device for storing energy in chemical form so that it can be released as electrical energy. CAPACITORBANK: A device that stores electrical energy when an external power supply is present using the electrical property of capacitance HARMONICFILTER: A device that constantly injects currents that precisely correspond to the harmonic components drawn by the load. UPS: A device that provides a time limited alternative source of power supply in the event of failure of the main supply.

USERDEFINED: User-defined type.

NOTDEFINED: Undefined type.

Values:

enumerator IfcElectricFlowStorageDeviceType_BATTERY
enumerator IfcElectricFlowStorageDeviceType_CAPACITORBANK
enumerator IfcElectricFlowStorageDeviceType_HARMONICFILTER
enumerator IfcElectricFlowStorageDeviceType_INDUCTORBANK
enumerator IfcElectricFlowStorageDeviceType_UPS
enumerator IfcElectricFlowStorageDeviceType_USERDEFINED
enumerator IfcElectricFlowStorageDeviceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricGeneratorType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcElectricGeneratorType defines commonly shared information for occurrences of electric generators. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a electric generator specification (i.e. the specific product information, that is common to all occurrences of that product type). Electric Generator types may be exchanged without being already assigned to occurrences. Occurrences of IfcElectricGeneratorType are represented by instances of IfcElectricGenerator.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_ElectricGeneratorTypeCommon

Material Use Definition The material of the IfcElectricGeneratorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Composition Use Definition The IfcElectricGeneratorType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcElectricGeneratorType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

ENGINEGENERATOR: May contain IfcEngine components. Engine-Generator sets may optionally include an engine to indicate specific detail.

Port Use Definition The distribution ports relating to the IfcElectricGeneratorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcElectricGenerator for standard port definitions.

Public Functions

::Ifc2x3::IfcElectricGeneratorTypeEnum::Value PredefinedType() const

Identifies the predefined types of electric generators from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcElectricGeneratorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricGeneratorType(IfcEntityInstanceData *e)
IfcElectricGeneratorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricGeneratorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricGeneratorTypeEnum

Public Types

enum Value

The IfcElectricGeneratorTypeEnum defines the range of types of electric generators available. HISTORY: New type in IFC 2x2. Values added in IFC 2x4.

Enumeration

CHP: Combined heat and power supply, used not only as a source of electric energy but also as a heating source for the building. It may therefore be not only part of an electrical system but also of a heating system. ENGINEGENERATOR: Electrical generator with a fuel-driven engine, for example a diesel-driven emergency power supply. STANDALONE: Electrical generator which does not include its source of kinetic energy, that is, a motor, engine, or turbine is modeled by a separate object. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcElectricGeneratorType_USERDEFINED
enumerator IfcElectricGeneratorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricHeaterType : public Ifc2x3::IfcFlowTerminalType

Public Types

typedef IfcTemplatedEntityList<IfcElectricHeaterType> list

Public Functions

::Ifc2x3::IfcElectricHeaterTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcElectricHeaterTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricHeaterType(IfcEntityInstanceData *e)
IfcElectricHeaterType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricHeaterTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricHeaterTypeEnum

Public Types

enum Value

Values:

enumerator IfcElectricHeaterType_ELECTRICPOINTHEATER
enumerator IfcElectricHeaterType_ELECTRICCABLEHEATER
enumerator IfcElectricHeaterType_ELECTRICMATHEATER
enumerator IfcElectricHeaterType_USERDEFINED
enumerator IfcElectricHeaterType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricMotorType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcElectricMotorType defines commonly shared information for occurrences of electric motors. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a electric motor specification (i.e. the specific product information, that is common to all occurrences of that product type). Electric Motor types may be exchanged without being already assigned to occurrences. Occurrences of IfcElectricMotorType are represented by instances of IfcElectricMotor.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_ElectricMotorTypeCommon

Material Use Definition The material of the IfcElectricMotorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcElectricMotorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcElectricMotor for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcElectricMotorType> list

Public Functions

::Ifc2x3::IfcElectricMotorTypeEnum::Value PredefinedType() const

Identifies the predefined types of electric motor from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcElectricMotorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricMotorType(IfcEntityInstanceData *e)
IfcElectricMotorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricMotorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricMotorTypeEnum

Public Types

enum Value

The IfcElectricMotorTypeEnum defines the range of different types of electric motor that can be specified. HISTORY: New type in IFC 2x2

Enumeration

DC: A motor using either generated or rectified D.C. power. INDUCTION: An alternating current motor in which the primary winding on one member (usually the stator) is connected to the power source and a secondary winding or a squirrel-cage secondary winding on the other member (usually the rotor) carries the induced current. There is no physical electrical connection to the secondary winding, its current is induced. POLYPHASE: A two or three-phase induction motor in which the windings, one for each phase, are evenly divided by the same number of electrical degrees.

RELUCTANCESYNCHRONOUS: A synchronous motor with a special rotor design which directly lines the rotor up with the rotating magnetic field of the stator, allowing for no slip under load.

SYNCHRONOUS: A motor that operates at a constant speed up to full load. The rotor speed is equal to the speed of the rotating magnetic field of the stator; there is no slip. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcElectricMotorType_DC
enumerator IfcElectricMotorType_INDUCTION
enumerator IfcElectricMotorType_POLYPHASE
enumerator IfcElectricMotorType_RELUCTANCESYNCHRONOUS
enumerator IfcElectricMotorType_SYNCHRONOUS
enumerator IfcElectricMotorType_USERDEFINED
enumerator IfcElectricMotorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricResistanceMeasure : public IfcUtil::IfcBaseType

IfcElectricResistanceMeasure is a measure of the electric resistance. Usually measured in Ohm (V/A). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricResistanceMeasure(IfcEntityInstanceData *e)
IfcElectricResistanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcElectricTimeControlType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcElectricTimeControlType defines commonly shared information for occurrences of electric time controls. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a electric time control specification (i.e. the specific product information, that is common to all occurrences of that product type). Electric Time Control types may be exchanged without being already assigned to occurrences. Occurrences of IfcElectricTimeControlType are represented by instances of IfcElectricTimeControl.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_ElectricTimeControlTypeCommon

Material Use Definition The material of the IfcElectricTimeControlType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcElectricTimeControlType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcElectricTimeControl for standard port definitions.

Public Functions

::Ifc2x3::IfcElectricTimeControlTypeEnum::Value PredefinedType() const

Identifies the predefined types of electrical time control from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcElectricTimeControlTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElectricTimeControlType(IfcEntityInstanceData *e)
IfcElectricTimeControlType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcElectricTimeControlTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElectricTimeControlTypeEnum

Public Types

enum Value

The IfcElectricTimeControlTypeEnum defines the range of types of electrical time control available. HISTORY: New type in IFC 2x2

Enumeration

TIMECLOCK: A control that causes action to occur at set times. TIMEDELAY: A control that causes action to occur following a set duration. RELAY: Electromagnetically operated contactor for making or breaking a control circuit. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcElectricTimeControlType_TIMECLOCK
enumerator IfcElectricTimeControlType_TIMEDELAY
enumerator IfcElectricTimeControlType_RELAY
enumerator IfcElectricTimeControlType_USERDEFINED
enumerator IfcElectricTimeControlType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElectricVoltageMeasure : public IfcUtil::IfcBaseType

IfcElectricVoltageMeasure is a measure of electromotive force. Usually measured in Volts (V, W/A). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcElectricVoltageMeasure(IfcEntityInstanceData *e)
IfcElectricVoltageMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcElement : public Ifc2x3::IfcProduct

Definition from IAI: Generalization of all components that make up an AEC product. Those elements can be logically contained by a spatial structure element that constitutes a certain level within a project structure hierarchy (e.g., site, building, storey or space). This is done by using the IfcRelContainedInSpatialStructure relationship. Elements are physically existent objects, although they might be void elements, such as holes. Elements either remain permanently in the AEC product, or only temporarily, as formwork does. Elements can be either assembled on site or pre-manufactured and built in on site. EXAMPLEs of elements in a building construction context are walls, floors, windows and recesses. An element can have material and quantity information assigned through the IfcRelAssociatesMaterial and IfcRelDefinesByProperties relationship. In addition an element can be declared to be a specific occurrence of an element type (and thereby be defined by the element type properties) using the IfcRelDefinesByType relationship. An element can also be defined as an element assembly that is a group of semantically and topologically related elements that form a higher level part of the AEC product. Those element assemblies are defined by virtue of the IfcRelAggregates relationship. EXAMPLEs for element assembly are complete Roof Structures, made by several Roof Areas, or a Stair, composed by Flights and Landings. Elements that performs the same function may be grouped by an “Element Group By Function”. It is realized by an instance of IfcGroup with the ObjectType = ‘ElementGroupByFunction”. HISTORY New entity in IFC Release 1.0 Property Set Use Definition: The property sets relating to the IfcElement are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. Quantity Use Definition: The quantities relating to the IfcElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties. A detailed specification for individual quantities is introduced at the level of subtypes of IfcElement. Geometry Use Definitions The geometric representation of any IfcElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. A detailed specification for the local placement and shape representaion is introduced at the level of subtypes of IfcElement.

Subclassed by Ifc2x3::IfcBuildingElement, Ifc2x3::IfcDistributionElement, Ifc2x3::IfcElectricalElement, Ifc2x3::IfcElementAssembly, Ifc2x3::IfcElementComponent, Ifc2x3::IfcEquipmentElement, Ifc2x3::IfcFeatureElement, Ifc2x3::IfcFurnishingElement, Ifc2x3::IfcTransportElement, Ifc2x3::IfcVirtualElement

Public Types

typedef IfcTemplatedEntityList<IfcElement> list

Public Functions

bool hasTag() const

Whether the optional attribute Tag is defined for this IfcElement.

std::string Tag() const

The tag (or label) identifier at the particular instance of a product, e.g. the serial number, or the position number. It is the identifier at the occurrence level.

void setTag(std::string v)
IfcTemplatedEntityList<IfcRelConnectsStructuralElement>::ptr HasStructuralMember() const
IfcTemplatedEntityList<IfcRelFillsElement>::ptr FillsVoids() const
IfcTemplatedEntityList<IfcRelConnectsElements>::ptr ConnectedTo() const
IfcTemplatedEntityList<IfcRelCoversBldgElements>::ptr HasCoverings() const
IfcTemplatedEntityList<IfcRelProjectsElement>::ptr HasProjections() const
IfcTemplatedEntityList<IfcRelReferencedInSpatialStructure>::ptr ReferencedInStructures() const
IfcTemplatedEntityList<IfcRelConnectsPortToElement>::ptr HasPorts() const
IfcTemplatedEntityList<IfcRelVoidsElement>::ptr HasOpenings() const
IfcTemplatedEntityList<IfcRelConnectsWithRealizingElements>::ptr IsConnectionRealization() const
IfcTemplatedEntityList<IfcRelSpaceBoundary>::ptr ProvidesBoundaries() const
IfcTemplatedEntityList<IfcRelConnectsElements>::ptr ConnectedFrom() const
IfcTemplatedEntityList<IfcRelContainedInSpatialStructure>::ptr ContainedInStructure() const
const IfcParse::entity &declaration() const
IfcElement(IfcEntityInstanceData *e)
IfcElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcElementarySurface : public Ifc2x3::IfcSurface

Definition from ISO/CD 10303-42:1992: An elementary surface (IfcElementarySurface) is a simple analytic surface with defined parametric representation.

NOTE Corresponding ISO 10303 entity: elementary_surface. Only the subtype plane is incorporated as IfcPlane. The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem). Please refer to ISO/IS 10303-42:1994, p. 69 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.5

Subclassed by Ifc2x3::IfcPlane

Public Types

typedef IfcTemplatedEntityList<IfcElementarySurface> list

Public Functions

::Ifc2x3::IfcAxis2Placement3D *Position() const

The position and orientation of the surface. This attribute is used in the definition of the parameterization of the surface.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
const IfcParse::entity &declaration() const
IfcElementarySurface(IfcEntityInstanceData *e)
IfcElementarySurface(::Ifc2x3::IfcAxis2Placement3D *v1_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcElementAssembly : public Ifc2x3::IfcElement

The IfcElementAssembly represents complex element assemblies aggregated from several elements, such as discrete elements, building elements, or other elements. EXAMPLE Steel construction assemblies, such as trusses and different kinds of frames, can be represented by the IfcElementAssembly entity. Other examples include slab fields aggregated from a number of precast concrete slabs or reinforcement units made from several reinforcement bars. Also bathroom units, staircase sections and other premanufactured or precast elements are examples of the general IfcElementAssembly entity NOTE The IfcElementAssembly is a general purpose entity that is required to be decomposed. Also other subtypes of IfcElement can be decomposed, with some dedicated entities such as IfcWallElementedCase and IfcSlabElementedCase. The assembly structure can be nested, i.e. an IfcElementAssembly could be an aggregated part within another IfcElementAssembly. NOTE View definitions and/or implementer agreements may restrict the number of allowed levels of nesting. HISTORY New Entity for Release IFC2x Edition 2.

Containment Use Definition The IfcElementAssembly should have (and in most implementation scenarios it is mandatory) a relationship for its hierachical containment in the spatial structure of the project.

The IfcElementAssembly is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes of IfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container.

The IfcElementAssembly shall represent an aggregate, i.e. it should have other elements, being subtypes of IfcElement, as contained (sub)parts.

The IfcElementAssembly is an aggregate i.e. being composed by other elements and acting as an assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.IsDecomposedBy. Components of an assembly are described by instances of subtypes of IfcElement. In this case, the containedsubtypes of IfcElement shall not be additionally contained in the project spatial hierarchy, i.e. the inverse attribute SELF\IfcElement.ContainedInStructure of those IfcElement’s shall be NIL.

Figure 27 illustrates spatial containment and element aggregation relationships.

Figure 27 — Element assembly containment

Geometry Use Definitions The geometric representation of IfcElementAssembly is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Local Placement The local placement for IfcElementAssembly is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

Geometric Representations The geometry of an IfcElementAssembly is generally formed from its components, in which case it does not need to have an explicit geometric representation. In some cases it may be useful to also expose an own explicit representation of the aggregate. NOTE View definitions or implementer agreements may further constrain the applicability of certain shape representations at the IfcElementAssembly in respect of the shape representations of its parts. Informal proposition

The IfcElementAssembly shall have an aggregation relationship to the contained parts, i.e. the (INV) IsDecomposedBy relationship shall be utilzed.

Public Types

typedef IfcTemplatedEntityList<IfcElementAssembly> list

Public Functions

bool hasAssemblyPlace() const

Whether the optional attribute AssemblyPlace is defined for this IfcElementAssembly.

::Ifc2x3::IfcAssemblyPlaceEnum::Value AssemblyPlace() const

A designation of where the assembly is intended to take place defined by an Enum.

void setAssemblyPlace(::Ifc2x3::IfcAssemblyPlaceEnum::Value v)
::Ifc2x3::IfcElementAssemblyTypeEnum::Value PredefinedType() const

Predefined generic types for a element assembly that are specified in an enumeration. There might be property sets defined specifically for each predefined type.

IFC2x4 CHANGE The attribute has been changed to be optional.

void setPredefinedType(::Ifc2x3::IfcElementAssemblyTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcElementAssembly(IfcEntityInstanceData *e)
IfcElementAssembly(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcAssemblyPlaceEnum::Value> v9_AssemblyPlace, ::Ifc2x3::IfcElementAssemblyTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElementAssemblyTypeEnum

Public Types

enum Value

Definition from IAI: An enumeration defining the basic configuration types for element assemblies.

HISTORY New enumeration type in Release IFC2x Edition 2.

Enumeration

ACCESSORY_ASSEMBLY: Assembled accessories or components ARCH: A curved structure BEAM_GRID: Interconnected beams, located in one (typically horizontal) plane BRACED_FRAME: A rigid frame with additional bracing members GIRDER: A beam-like superstructure REINFORCEMENT_UNIT: Assembled reinforcement elements RIGID_FRAME: A structure built up of beams, columns, etc. with moment-resisting joints SLAB_FIELD: Slabs, laid out in one plane TRUSS: A structure built up of members with (quasi) pinned joints USERDEFINED: User-defined element assembly NOTDEFINED: Undefined element assembly

Values:

enumerator IfcElementAssemblyType_ACCESSORY_ASSEMBLY
enumerator IfcElementAssemblyType_ARCH
enumerator IfcElementAssemblyType_BEAM_GRID
enumerator IfcElementAssemblyType_BRACED_FRAME
enumerator IfcElementAssemblyType_GIRDER
enumerator IfcElementAssemblyType_REINFORCEMENT_UNIT
enumerator IfcElementAssemblyType_RIGID_FRAME
enumerator IfcElementAssemblyType_SLAB_FIELD
enumerator IfcElementAssemblyType_TRUSS
enumerator IfcElementAssemblyType_USERDEFINED
enumerator IfcElementAssemblyType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElementComponent : public Ifc2x3::IfcElement

An element component is a representation for minor items included in, added to or connecting to or between elements, which usually are not of interest from the overall building structure viewpoint. However, these small parts may have vital and load carrying functions within the construction. These items do not provide any actual space boundaries. Typical examples of IfcElementComponents include different kinds of fasteners and various accessories.

HISTORY New entity in IFC Release 2x2

It is often desirable to model a number of same-shaped element components by means of a single occurrence object, e.g. several bolts within a connection or a row of reinforcement elements. In this IFC release, this is possible by means of multiple mapped representation as documented below.

To express the multiplicity of element components also on a higher semantic level, an IfcElementQuantity should be provided via IfcRelDefinesByProperties. The quantity should contain an IfcQuantityCount named ‘Count’ with the number of components.

Geometry Use Definition

The geometric representation of IfcElementComponent is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are:

Local Placement The local placement for IfcElementComponent is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcElement or IfcElementAssembly, which is used in the Decomposes inverse attribute, i.e. the local placement is defined relative to the local placement of the element or element assembly in which the component is contained. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Surface Model Representation

Any IfcElementComponent (if no further constraints are defined at the level of its subtypes) may be represented as a single or multiple surface models, based on either shell or face based models. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’

Brep Representation

Any IfcElementComponent (if no further constraints are defined at the level of its subtypes) may be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

Mapped Representation

The mapped item, IfcMappedItem, should be used if appropriate as it allows for reusing the geometry definition of a type at occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

Multiple Mapped Representation

A single instance of a subtype of IfcElementComponent can stand for several actual element components at once. In this case, the IfcShapeRepresentation contains as many mapped items as there are element components combined within this occurrence object:

Figure 151 illustrates multiple components modeled as a single occurrence object (here: IfcFastener)

Figure 151 — Element component mapped representation

Representation identifier and type are the same as in single mapped representation. The number of mapped items in the representation corresponds with the count of element components in the IfcElementQuantity.

Subclassed by Ifc2x3::IfcDiscreteAccessory, Ifc2x3::IfcFastener

Public Types

typedef IfcTemplatedEntityList<IfcElementComponent> list

Public Functions

const IfcParse::entity &declaration() const
IfcElementComponent(IfcEntityInstanceData *e)
IfcElementComponent(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcElementComponentType : public Ifc2x3::IfcElementType

Definition from IAI: The element type (IfcElementComponentType) represents the supertype for element types which define lists of commonly shared property set definitions of various small parts and accessories and an optional set of product representations. It is used to define a supporting element mainly within structural and building services domains (i.e. the specific type information

common to all occurrences of that type).

HISTORY New entity in IFC Release 2x2

Subclassed by Ifc2x3::IfcDiscreteAccessoryType, Ifc2x3::IfcFastenerType

Public Types

typedef IfcTemplatedEntityList<IfcElementComponentType> list

Public Functions

const IfcParse::entity &declaration() const
IfcElementComponentType(IfcEntityInstanceData *e)
IfcElementComponentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcElementCompositionEnum

Public Types

enum Value

Definition from IAI: Enumeration that provides an indication, whether the spatial structure element or proxy represents a:

COMPLEX - a group or aggregation of similar elements

ELEMENT - a (undivided) element itself

PARTIAL - a subelement or part

HISTORY New enumeration in IFC Release 2.x

Values:

enumerator IfcElementComposition_COMPLEX
enumerator IfcElementComposition_ELEMENT
enumerator IfcElementComposition_PARTIAL

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcElementQuantity : public Ifc2x3::IfcPropertySetDefinition

Definition from IAI: An IfcElementQuantity defines a set of derived measures of an element’s physical property. Elements could be spatial structure elements (like buildings, storeys, or spaces) or building elements (like walls, slabs, finishes). The IfcElementQuantity gets assigned to the element by using the IfcRelDefinesByProperties relationship. The optional MethodOfMeasurement attribute defines the code, e.g. from a standard method of measurement, which had been used to calculate the element quantity.

NOTE The recognizable values for the name and the method of measurement attributes have to be agreed upon in further agreement documents, such as implementers agreements. Some of these agreements might be limited to a certain region, to which the method of measurement applies.

The name attribute, given at the individual Quantities provides a recognizable semantic meaning of the element quantity. Both information is needed to establish a precise meaning for the measure value. An optional description may be assigned to each of the Quantities. All quantities assigned by a single instance of IfcElementQuantity are deemed to have been generated according to the same method of measurement. However several instances of IfcElementQuantity are assignable to an element, thus allowing for an element having quantities generated according to several methods of measurement.

EXAMPLE1 To exchange the net floor area of spaces in the German region (as IfcSpace), the name might be ‘Netto-Grundfläche’ (net floor area), and the method of measurement might be accordingly ‘DIN277-2’ (German industry norm no. 277 edition 2)

EXAMPLE2 The same instance of IfcSpace may have a different area measure assigned in the German region according to a housing regulation, the name would be ‘Wohnfläche’ and the method of measurement would be ‘2.BV’. It would be attached to the IfcSpace by a separate IfcRelDefinesByProperties relationship.

The IfcElementQuantity can have the following subtypes of IfcPhysicalQuantity within its SET of Quantities, which count for the basis measure types used:

count measure weight measure length measure area measure volume measure time measure

HISTORY New entity in IFC Release 2x. NOTE: It replaces the calcXxx attributes used in previous IFC Releases. IFC2x4 CHANGE Subtyped from new intermediate IfcPreDefinedPropertySet supertype.

Quantity Use Defintion Base quantities are quantity definitions that are independent of a particular method of measurement and therefore internationally applicable. Base quantities are defined as gross and net values and provided by measurement of the correct geometric shape representation of the element. The IFC specification includes a set of base quantity definition. See each subtype of IfcElement for applicable base quantities. The following general agreements apply for each base quantity set

IfcElementQuantity.Name = ‘BaseQuantities’ IfcElementQuantity.MethodOfMeasurement = NIL IfcElementQuantity.Quantities = SET of subtypes of IfcPhysicalSimpleQuantity with values for the Name attribute as published as part of the IFC specifciation.

Public Types

typedef IfcTemplatedEntityList<IfcElementQuantity> list

Public Functions

bool hasMethodOfMeasurement() const

Whether the optional attribute MethodOfMeasurement is defined for this IfcElementQuantity.

std::string MethodOfMeasurement() const

Name of the method of measurement used to calculate the element quantity. The method of measurement attribute has to be made recognizable by further agreements.

IFC2x2 Addendum 1 change: The attribute has been changed to be optional

void setMethodOfMeasurement(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr Quantities() const

The individual quantities for the element, can be a set of length, area, volume, weight or count based quantities.

void setQuantities(IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr v)
const IfcParse::entity &declaration() const
IfcElementQuantity(IfcEntityInstanceData *e)
IfcElementQuantity(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_MethodOfMeasurement, IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr v6_Quantities)

Public Static Functions

const IfcParse::entity &Class()
class IfcElementType : public Ifc2x3::IfcTypeProduct

Definition from IAI: The IfcElementType defines a list of commonly shared property set definitions of an element and an optional set of product representations. It is used to define an element specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

An element type is used to define the common properties of a certain type or style of an element that may be applied to instances of that element type to assign a specific style. Element types (the instantiable subtypes) may be exchanged without being already assigned to occurrences.

HISTORY New entity in Release IFC2x Edition 2

Subclassed by Ifc2x3::IfcBuildingElementType, Ifc2x3::IfcDistributionElementType, Ifc2x3::IfcElementComponentType, Ifc2x3::IfcFurnishingElementType, Ifc2x3::IfcSpatialStructureElementType, Ifc2x3::IfcTransportElementType

Public Types

typedef IfcTemplatedEntityList<IfcElementType> list

Public Functions

bool hasElementType() const

Whether the optional attribute ElementType is defined for this IfcElementType.

std::string ElementType() const

The type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes. In particular it holds the user defined type, if the enumeration of the attribute ‘PredefinedType’ is set to USERDEFINED.

void setElementType(std::string v)
const IfcParse::entity &declaration() const
IfcElementType(IfcEntityInstanceData *e)
IfcElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcEllipse : public Ifc2x3::IfcConic

Definition from ISO/CD 10303-42:1992: An ellipse (IfcEllipse) is a conic section defined by the lengths of the semi-major and semi-minor diameters and the position (center or mid point of the line joining the foci) and orientation of the curve. Interpretation of the data shall be as follows:

C = SELF\IfcConic.Position.Location

x = SELF\IfcConic.Position.P[1]

y = SELF\IfcConic.Position.P[2]

z = SELF\IfcConic.Position.P[3]

R1 = SemiAxis1 R2 = SemiAxis2 and the ellipse is parameterized as:

The parameterization range is 0 £ u £ 2p (or 0 £ u £ 360 degree). In the placement coordinate system defined above, the ellipse is the equation C = 0, where

The positive sense of the ellipse at any point is in the tangent direction, T, to the curve at the point, where

The inherited Position.Location from IfcConic is the center of the IfcEllipse, and the inherited Position.P[1] from IfcConic the direction of the SemiAxis1.

NOTE Corresponding ISO 10303 entity: ellipse. Please refer to ISO/IS 10303-42:1994, p. 39 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Figure 280 illustrates the definition of the IfcEllipse within the (in this case three-dimensional) position coordinate system.

Figure 280 — Ellipse geometry

Public Types

typedef IfcTemplatedEntityList<IfcEllipse> list

Public Functions

double SemiAxis1() const

The first radius of the ellipse which shall be positive. Placement.Axes[1] gives the direction of the SemiAxis1.

void setSemiAxis1(double v)
double SemiAxis2() const

The second radius of the ellipse which shall be positive.

void setSemiAxis2(double v)
const IfcParse::entity &declaration() const
IfcEllipse(IfcEntityInstanceData *e)
IfcEllipse(::Ifc2x3::IfcAxis2Placement *v1_Position, double v2_SemiAxis1, double v3_SemiAxis2)

Public Static Functions

const IfcParse::entity &Class()
class IfcEllipseProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcEllipseProfileDef defines an ellipse as the profile definition used by the swept surface geometry or the swept area solid. It is given by its semi axis attributes and placed within the 2D position coordinate system, established by the Position attribute.

HISTORY New entity in IFC2x

Figure 317 illustrates parameters for the ellipse profile definition. The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

Or in case of sectioned spines it is the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions. By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (for example, upper-left bound). The location of the position coordinate system defines the center of the ellipse. The SemiAxis1 attribute defines the first radius of the ellipse in the direction of the X axis, the SemiAxis2 attribute defines the second radius of the ellipse in the direction of the Y axis.

NOTE The semi axes of the ellipse are rectangular to each other by definition.

Figure 317 — Ellipse profile

Public Types

typedef IfcTemplatedEntityList<IfcEllipseProfileDef> list

Public Functions

double SemiAxis1() const

The first radius of the ellipse. It is measured along the direction of Position.P[1].

void setSemiAxis1(double v)
double SemiAxis2() const

The second radius of the ellipse. It is measured along the direction of Position.P[2].

void setSemiAxis2(double v)
const IfcParse::entity &declaration() const
IfcEllipseProfileDef(IfcEntityInstanceData *e)
IfcEllipseProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_SemiAxis1, double v5_SemiAxis2)

Public Static Functions

const IfcParse::entity &Class()
class IfcEnergyConversionDevice : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcEnergyConversionDevice defines the occurrence of a device used to perform energy conversion or heat transfer and typically participates in a flow distribution system. Its type is defined by IfcEnergyConversionDeviceType or its subtypes.

HISTORY: New entity in IFC R2.0.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Functions

const IfcParse::entity &declaration() const
IfcEnergyConversionDevice(IfcEntityInstanceData *e)
IfcEnergyConversionDevice(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcEnergyConversionDeviceType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcEnergyConversionType defines a list of commonly shared property set definitions of an energy conversion device and an optional set of product representations. It is used to define an energy conversion device specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A energy conversion type is used to define the common properties of a energy conversion device that may be applied to many occurrences of that type. An energy conversion device is a building systems device that converts energy from one form into another such

as a boiler (i.e., combusting gas to heat water), chiller (i.e., using a refrigeration cycle to cool a

liquid), or a cooling coil (i.e., using the phase-change characteristics of a refrigerant to cool air). Energy conversion types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcEnergyConversionType are represented by instances of IfcEnergyConversionDevice.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcAirToAirHeatRecoveryType, Ifc2x3::IfcBoilerType, Ifc2x3::IfcChillerType, Ifc2x3::IfcCoilType, Ifc2x3::IfcCondenserType, Ifc2x3::IfcCooledBeamType, Ifc2x3::IfcCoolingTowerType, Ifc2x3::IfcElectricGeneratorType, Ifc2x3::IfcElectricMotorType, Ifc2x3::IfcEvaporativeCoolerType, Ifc2x3::IfcEvaporatorType, Ifc2x3::IfcHeatExchangerType, Ifc2x3::IfcHumidifierType, Ifc2x3::IfcMotorConnectionType, Ifc2x3::IfcSpaceHeaterType, Ifc2x3::IfcTransformerType, Ifc2x3::IfcTubeBundleType, Ifc2x3::IfcUnitaryEquipmentType

Public Functions

const IfcParse::entity &declaration() const
IfcEnergyConversionDeviceType(IfcEntityInstanceData *e)
IfcEnergyConversionDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcEnergyMeasure : public IfcUtil::IfcBaseType

IfcEnergyMeasure is a measure of energy required or used. Usually measured in Joules, (J, Nm). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcEnergyMeasure(IfcEntityInstanceData *e)
IfcEnergyMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcEnergyProperties : public Ifc2x3::IfcPropertySetDefinition

Subclassed by Ifc2x3::IfcElectricalBaseProperties

Public Types

typedef IfcTemplatedEntityList<IfcEnergyProperties> list

Public Functions

bool hasEnergySequence() const

Whether the optional attribute EnergySequence is defined for this IfcEnergyProperties.

::Ifc2x3::IfcEnergySequenceEnum::Value EnergySequence() const
void setEnergySequence(::Ifc2x3::IfcEnergySequenceEnum::Value v)
bool hasUserDefinedEnergySequence() const

Whether the optional attribute UserDefinedEnergySequence is defined for this IfcEnergyProperties.

std::string UserDefinedEnergySequence() const
void setUserDefinedEnergySequence(std::string v)
const IfcParse::entity &declaration() const
IfcEnergyProperties(IfcEntityInstanceData *e)
IfcEnergyProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<::Ifc2x3::IfcEnergySequenceEnum::Value> v5_EnergySequence, boost::optional<std::string> v6_UserDefinedEnergySequence)

Public Static Functions

const IfcParse::entity &Class()
struct IfcEnergySequenceEnum

Public Types

enum Value

Values:

enumerator IfcEnergySequence_PRIMARY
enumerator IfcEnergySequence_SECONDARY
enumerator IfcEnergySequence_TERTIARY
enumerator IfcEnergySequence_AUXILIARY
enumerator IfcEnergySequence_USERDEFINED
enumerator IfcEnergySequence_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcEnvironmentalImpactCategoryEnum

Public Types

enum Value

Values:

enumerator IfcEnvironmentalImpactCategory_COMBINEDVALUE
enumerator IfcEnvironmentalImpactCategory_DISPOSAL
enumerator IfcEnvironmentalImpactCategory_EXTRACTION
enumerator IfcEnvironmentalImpactCategory_INSTALLATION
enumerator IfcEnvironmentalImpactCategory_MANUFACTURE
enumerator IfcEnvironmentalImpactCategory_TRANSPORTATION
enumerator IfcEnvironmentalImpactCategory_USERDEFINED
enumerator IfcEnvironmentalImpactCategory_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcEnvironmentalImpactValue : public Ifc2x3::IfcAppliedValue

Public Functions

std::string ImpactType() const
void setImpactType(std::string v)
::Ifc2x3::IfcEnvironmentalImpactCategoryEnum::Value Category() const
void setCategory(::Ifc2x3::IfcEnvironmentalImpactCategoryEnum::Value v)
bool hasUserDefinedCategory() const

Whether the optional attribute UserDefinedCategory is defined for this IfcEnvironmentalImpactValue.

std::string UserDefinedCategory() const
void setUserDefinedCategory(std::string v)
const IfcParse::entity &declaration() const
IfcEnvironmentalImpactValue(IfcEntityInstanceData *e)
IfcEnvironmentalImpactValue(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcAppliedValueSelect *v3_AppliedValue, ::Ifc2x3::IfcMeasureWithUnit *v4_UnitBasis, ::Ifc2x3::IfcDateTimeSelect *v5_ApplicableDate, ::Ifc2x3::IfcDateTimeSelect *v6_FixedUntilDate, std::string v7_ImpactType, ::Ifc2x3::IfcEnvironmentalImpactCategoryEnum::Value v8_Category, boost::optional<std::string> v9_UserDefinedCategory)

Public Static Functions

const IfcParse::entity &Class()
class IfcEquipmentElement : public Ifc2x3::IfcElement

Public Types

typedef IfcTemplatedEntityList<IfcEquipmentElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcEquipmentElement(IfcEntityInstanceData *e)
IfcEquipmentElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcEquipmentStandard : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcEquipmentStandard> list

Public Functions

const IfcParse::entity &declaration() const
IfcEquipmentStandard(IfcEntityInstanceData *e)
IfcEquipmentStandard(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcEvaporativeCoolerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcEvaporativeCoolerType defines commonly shared information for occurrences of evaporative coolers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a evaporative cooler specification (i.e. the specific product information, that is common to all occurrences of that product type). Evaporative Cooler types may be exchanged without being already assigned to occurrences. Occurrences of IfcEvaporativeCoolerType are represented by instances of IfcEvaporativeCooler.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_EvaporativeCoolerTypeCommon

Material Use Definition The material of the IfcEvaporativeCoolerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Media’: Heat exchanger media material.

Port Use Definition The distribution ports relating to the IfcEvaporativeCoolerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcEvaporativeCooler for standard port definitions.

Public Functions

::Ifc2x3::IfcEvaporativeCoolerTypeEnum::Value PredefinedType() const

Defines the type of evaporative cooler.

void setPredefinedType(::Ifc2x3::IfcEvaporativeCoolerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcEvaporativeCoolerType(IfcEntityInstanceData *e)
IfcEvaporativeCoolerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcEvaporativeCoolerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcEvaporativeCoolerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of evaporative coolers. The IfcEvaporativeCoolerTypeEnum contains the following:

DIRECTEVAPORATIVERANDOMMEDIAAIRCOOLER: Direct evaporative random media air cooler: Cools the air stream by evaporating water dircectly into the air stream using coolers with evaporative pads, usually of aspen wood or plastic fiber/foam. DIRECTEVAPORATIVERIGIDMEDIAAIRCOOLER: Direct evaporative rigid media air cooler: Cools the air stream by evaporating water dircectly into the air stream using coolers with sheets of rigid, corrugated material as the wetted surface. DIRECTEVAPORATIVESLINGERSPACKAGEDAIRCOOLER: Direct evaporative slingers packaged air cooler: Cools the air stream by evaporating water dircectly into the air stream using coolers with a water slinger in an evaporative cooling section and a fan section. DIRECTEVAPORATIVEPACKAGEDROTARYAIRCOOLER: Direct evaporative packaged rotary air cooler: Cools the air stream by evaporating water dircectly into the air stream using coolers that wet and wash the evaporative pad by rotating it through a water bath. DIRECTEVAPORATIVEAIRWASHER: Direct evaporative air washer: Cools the air stream by evaporating water dircectly into the air stream using coolers with spray-type air washer consist of a chamber or casing containing spray nozzles, and tank for collecting spray water, and an eliminator section for removing entrained drops of water from the air. INDIRECTEVAPORATIVEPACKAGEAIRCOOLER: Indirect evaporative package air cooler: Cools the air stream by evaporating water indirectly and without adding moisture into the air stream. On one side of the heat exchanger, the secondary air stream is cooled by evaporation, while on the other side of heat exchanger, the primary air stream (conditioned air to be supplied to the room) is sensibly cooled by the heat exchanger surfaces. INDIRECTEVAPORATIVEWETCOIL: Indirect evaporative wet coil: Cools the air stream by evaporating water indirectly and without adding moisture into the air stream. Water is sprayed directly on the tubes of the heat exchanger where latent cooling takes place and the vaporization of the water on the outside of the heat exchanger tubes allows the simultaneous heat and mass transfer which removes heat from the supply air on the tube side. INDIRECTEVAPORATIVECOOLINGTOWERORCOILCOOLER: Indirect evaporative cooling tower or coil cooler: Cools the air stream by evaporating water indirectly and without adding moisture into the air stream using a combination of a cooling tower or other evaporative water cooler with a water-to-air heat exchanger coil and water circulating pump. INDIRECTDIRECTCOMBINATION: Indirect/Direct combination: Cools the air stream by evaporating water indirectly and without adding moisture into the air stream using a two-stage cooler with a first-stage indirect evaporative cooler and second-stage direct evaporative cooler. USERDEFINED: User-defined evaporative cooler type. NOTDEFINED: Undefined evaporative cooler type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcEvaporativeCoolerType_DIRECTEVAPORATIVERANDOMMEDIAAIRCOOLER
enumerator IfcEvaporativeCoolerType_DIRECTEVAPORATIVERIGIDMEDIAAIRCOOLER
enumerator IfcEvaporativeCoolerType_DIRECTEVAPORATIVESLINGERSPACKAGEDAIRCOOLER
enumerator IfcEvaporativeCoolerType_DIRECTEVAPORATIVEPACKAGEDROTARYAIRCOOLER
enumerator IfcEvaporativeCoolerType_DIRECTEVAPORATIVEAIRWASHER
enumerator IfcEvaporativeCoolerType_INDIRECTEVAPORATIVEPACKAGEAIRCOOLER
enumerator IfcEvaporativeCoolerType_INDIRECTEVAPORATIVEWETCOIL
enumerator IfcEvaporativeCoolerType_INDIRECTEVAPORATIVECOOLINGTOWERORCOILCOOLER
enumerator IfcEvaporativeCoolerType_INDIRECTDIRECTCOMBINATION
enumerator IfcEvaporativeCoolerType_USERDEFINED
enumerator IfcEvaporativeCoolerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcEvaporatorType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcEvaporatorType defines commonly shared information for occurrences of evaporators. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a evaporator specification (i.e. the specific product information, that is common to all occurrences of that product type). Evaporator types may be exchanged without being already assigned to occurrences. Occurrences of IfcEvaporatorType are represented by instances of IfcEvaporator.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_EvaporatorTypeCommon

Material Use Definition The material of the IfcEvaporatorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Refrigerant’: Refrigerant material.

Port Use Definition The distribution ports relating to the IfcEvaporatorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcEvaporator for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcEvaporatorType> list

Public Functions

::Ifc2x3::IfcEvaporatorTypeEnum::Value PredefinedType() const

Defines the type of evaporator.

void setPredefinedType(::Ifc2x3::IfcEvaporatorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcEvaporatorType(IfcEntityInstanceData *e)
IfcEvaporatorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcEvaporatorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcEvaporatorTypeEnum

Public Types

enum Value

Enumeration defining the typical types of evaporators. The IfcEvaporatorTypeEnum contains the following:

DIRECTEXPANSION: Direct-expansion evaporator. DIRECTEXPANSIONSHELLANDTUBE: Direct-expansion evaporator where a refrigerant evaporates inside a series of baffles that channel the fluid throughout the shell side. DIRECTEXPANSIONTUBEINTUBE: Direct-expansion evaporator where a refrigerant evaporates inside one or more pairs of coaxial tubes. DIRECTEXPANSIONBRAZEDPLATE: Direct-expansion evaporator where a refrigerant evaporates inside plates brazed or welded together to make up an assembly of separate channels. FLOODEDSHELLANDTUBE: Evaporator in which refrigerant evaporates outside tubes. SHELLANDCOIL: Evaporator in which refrigerant evaporates inside a simple coiled tube immersed in the fluid to be cooled. USERDEFINED: User-defined evaporator type. NOTDEFINED: Undefined evaporator type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcEvaporatorType_DIRECTEXPANSIONSHELLANDTUBE
enumerator IfcEvaporatorType_DIRECTEXPANSIONTUBEINTUBE
enumerator IfcEvaporatorType_DIRECTEXPANSIONBRAZEDPLATE
enumerator IfcEvaporatorType_FLOODEDSHELLANDTUBE
enumerator IfcEvaporatorType_SHELLANDCOIL
enumerator IfcEvaporatorType_USERDEFINED
enumerator IfcEvaporatorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcExtendedMaterialProperties : public Ifc2x3::IfcMaterialProperties

The IfcExtendedMaterialProperties assign a set of defined material properties to associated material definitions. This provides a mechanism to assign any material properties to material. Those material properties that are defined as part of the IFC specification are provided within the use definitions below. NOTE The usage of this entity has changed in IFC2x4, it is now used to express all material properties. The IfcProperty (instantiable subtypes) is used to express the individual material properties.

HISTORY New entity in Release IFC2x.

IFC2x4 CHANGE The attributes Name and Description are promoted to supertype, attribute ExtendedProperties has been renamed to Properties.

Extended property use definitions The following sets of material property definitions are part of this IFC release:

General Material Properties General Mechanical Properties

Steel Mechanical Properties Concrete Mechanical Properties Timber and Wood-based Mechanical Properties

General Thermal Properties General Hygroscopic Properties General Optical Properties General Water Properties General Fuel Properties General Products of Combustion Properties General Energy Calculation Properties

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr ExtendedProperties() const
void setExtendedProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcExtendedMaterialProperties.

std::string Description() const
void setDescription(std::string v)
std::string Name() const
void setName(std::string v)
const IfcParse::entity &declaration() const
IfcExtendedMaterialProperties(IfcEntityInstanceData *e)
IfcExtendedMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v2_ExtendedProperties, boost::optional<std::string> v3_Description, std::string v4_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExternallyDefinedHatchStyle : public Ifc2x3::IfcExternalReference

Definition from ISO/CD 10303-46:1992: The externally defined hatch style is an entity which makes an external reference to a hatching style.

NOTE: The allowable values for the name source and item reference, by which the externally defined hatch style is identified, need to be determined by implementer agreements.

NOTE: Corresponding ISO 10303 name: fill_style_select. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcExternallyDefinedHatchStyle(IfcEntityInstanceData *e)
IfcExternallyDefinedHatchStyle(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExternallyDefinedSurfaceStyle : public Ifc2x3::IfcExternalReference

IfcExternallyDefinedSurfaceStyle is a definition of a surface style through referencing an external source, such as a material library for rendering information.

NOTE In order to achieve expected results, the externally defined surface style should normally only be given in addition to an explicitly defined surface styles.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The spelling has been corrected from IfcExternallyDefinedSufaceStyle with no upward compatibility.

Public Functions

const IfcParse::entity &declaration() const
IfcExternallyDefinedSurfaceStyle(IfcEntityInstanceData *e)
IfcExternallyDefinedSurfaceStyle(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExternallyDefinedSymbol : public Ifc2x3::IfcExternalReference

An externally defined symbol is a symbol that gets its shape information by an agreed reference to an external source.

NOTE: The allowable symbol names and sources have to be established by implementers agreements.

NOTE: The IfcExternallyDefinedSymbol is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: externally_defined_symbol. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcExternallyDefinedSymbol(IfcEntityInstanceData *e)
IfcExternallyDefinedSymbol(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExternallyDefinedTextFont : public Ifc2x3::IfcExternalReference

Definition from ISO/CD 10303-46:1992: The externally defined text font is an external reference to a text font

NOTE Restrictions of the font source and font names to be used may be exposed by implementation guidelines.

NOTE Corresponding ISO 10303 name: externally_defined_text_font. Please refer to ISO/IS 10303-46:1994, p. 137 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcExternallyDefinedTextFont(IfcEntityInstanceData *e)
IfcExternallyDefinedTextFont(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExternalReference : public IfcUtil::IfcBaseEntity

An IfcExternalReference is the identification of information that is not explicitly represented in the current model or in the project database (as an implementation of the current model). Such information may be contained in classifications, documents or libraries. The IfcExternalReference identifies a particular item, such as a dictionary entry, a classification notation, or a document reference within the external source.

Only the Location (as a URL) is given to describe the place where the information can be found. Also an optional Identification as a key to allow more specific references (as to sections or tables) is provided. The Identification defines a system interpretable method to identify the relevant part of information at the source. In addition a human interpretable Name can be assigned to identify the information subject, such as a classification code.

IfcExternalReference is an abstract supertype of all external reference entities.

HISTORY New entity in IFC2x.

Subclassed by Ifc2x3::IfcClassificationReference, Ifc2x3::IfcDocumentReference, Ifc2x3::IfcExternallyDefinedHatchStyle, Ifc2x3::IfcExternallyDefinedSurfaceStyle, Ifc2x3::IfcExternallyDefinedSymbol, Ifc2x3::IfcExternallyDefinedTextFont, Ifc2x3::IfcLibraryReference

Public Types

typedef IfcTemplatedEntityList<IfcExternalReference> list

Public Functions

bool hasLocation() const

Whether the optional attribute Location is defined for this IfcExternalReference.

std::string Location() const

Location, where the external source (classification, document or library) can be accessed by electronic means. The electronic location is provided as an URI, and would normally be given as an URL location string.

IFC2x4 CHANGE The data type has been changed from IfcLabel to IfcURIReference.

void setLocation(std::string v)
bool hasItemReference() const

Whether the optional attribute ItemReference is defined for this IfcExternalReference.

std::string ItemReference() const
void setItemReference(std::string v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcExternalReference.

std::string Name() const

Optional name to further specify the reference. It can provide a human readable identifier (which does not necessarily need to have a counterpart in the internal structure of the document).

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcExternalReference(IfcEntityInstanceData *e)
IfcExternalReference(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcExtrudedAreaSolid : public Ifc2x3::IfcSweptAreaSolid

The IfcExtrudedAreaSolid is defined by sweeping a cross section provided by a profile definition. The direction of the extrusion is given by the ExtrudedDirection attribute and the length of the extrusion is given by the Depth attribute. If the planar area has inner boundaries (holes defined), then those holes shall be swept into holes of the solid. The extruded direction can be any direction which is not perpendicular to the z axis of the position coordinate system of the profile. The following definitions from ISO 10303-42 apply:

An extruded area solid is a solid defined by sweeping a bounded planar surface. The direction of translation is defined by a direction vector, and the length of the translation is defined by a distance depth. The planar area may have holes which will sweep into holes in the solid.

The ExtrudedDirection is given within the position coordinate system as defined by IfcSweptAreaSolid.Position. Extrusions are not restricted to be perpendicular to the extruded surface of the profile.

Figure 255 illustrates geometric parameters of the extruded area solid. The extruded area solid defines the extrusion of a 2D area (given by a profile definition) by an direction and depth. The result is a solid. The swept area is given by a profile definition. This profile is defined:

as a 2D bounded curve within the xy plane of the position coordinate system, as a 2D bounded curve with holes within the xy plane of the position coordinate system, or as a 2D primitive, defined within a 2D position coordinate system, that is placed relative to the xy plane of the position coordinate system

Figure 255 — Extruded area solid geometry

NOTE Corresponding ISO 10303-42 entity: extruded_area_solid. Please refer to ISO/IS 10303-42:1994, p. 183 for the final definition of the formal standard. The data type of the inherited SweptArea attribute is different, i.e. of type IfcProfileDef. The Position attribute has been added to position the cross section used for the linear extrusion.

HISTORY New entity in IFC Release 1.5, capabilities of this entity have been enhanced in IFC Release 2x.

Texture use definition For side faces, textures are aligned facing upright continuously along the sides with origin at the first point of an arbitrary profile, and following the outer bound of the profile counter-clockwise (as seen from above). For parameterized profiles, the origin is defined at the +Y extent for rounded profiles (having no sharp edge) and the first sharp edge counter-clockwise from the +Y extent for all other profiles. Textures are stretched or repeated on each side along the outer boundary of the profile according to RepeatS. Textures are stretched or repeated on each side along the extrusion axis according to RepeatT. For top and bottom caps, textures are aligned facing front-to-back, with the origin at the minimum X and Y extent. Textures are stretched or repeated on the top and bottom to the extent of each face according to RepeatS and RepeatT. For profiles with voids, textures are aligned facing upright along the inner side with origin at the first point of an arbitrary profile, and following the inner bound of the profile clockwise (as seen from above). For parameterized profiles, the origin of inner sides is defined at the +Y extent for rounded profiles (having no sharp edge such as hollow ellipses or rounded rectangles) and the first sharp edge clockwise from the +Y extent for all other profiles.

Figure 256 illustrates default texture mapping with a repeated texture (RepeatS=True and RepeatT=True). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up. For an IfcExtrudedAreaSolid having a profile of IfcIShapeProfileDef, the side texture coordinate origin is the first corner counter-clockwise from the +Y axis, which equals (-0.5*IfcIShapeProfileDef.OverallWidth, +0.5*IfcIShapeProfileDef.OverallDepth), while the top (end cap) texture coordinates start at (-0.5*IfcIShapeProfileDef.OverallWidth, -0.5*IfcIShapeProfileDef.OverallDepth).

Figure 256 — Extruded area solid textures

Public Types

typedef IfcTemplatedEntityList<IfcExtrudedAreaSolid> list

Public Functions

::Ifc2x3::IfcDirection *ExtrudedDirection() const

The direction in which the surface, provided by SweptArea is to be swept.

void setExtrudedDirection(::Ifc2x3::IfcDirection *v)
double Depth() const

The distance the surface is to be swept along the ExtrudedDirection

void setDepth(double v)
const IfcParse::entity &declaration() const
IfcExtrudedAreaSolid(IfcEntityInstanceData *e)
IfcExtrudedAreaSolid(::Ifc2x3::IfcProfileDef *v1_SweptArea, ::Ifc2x3::IfcAxis2Placement3D *v2_Position, ::Ifc2x3::IfcDirection *v3_ExtrudedDirection, double v4_Depth)

Public Static Functions

const IfcParse::entity &Class()
class IfcFace : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A face is a topological entity of dimensionality 2 corresponding to the intuitive notion of a piece of surface bounded by loops. Its domain, if present, is an oriented, connected, finite 2-manifold in Rm. A face domain shall not have handles but it may have holes, each hole bounded by a loop. The domain of the underlying geometry of the face, if present, does not contain its bounds, and 0 < Ξ < ∞. A face is represented by its bounding loops, which are defined as face bounds. A face has a topological normal n and the tangent to a loop is t. For a loop bounding a face with defined geometry, the cross product n x t points toward the interior of the face. That is, each loop runs counter-clockwise around the face when viewed from above, if we consider the normal n to point up. With each loop is associated a BOOLEAN flag to signify whether the loop direction is oriented with respect to the face normal (TRUE) or should be reversed (FALSE).

A face shall have at least one bound, and the loops shall not intersect. One loop is optionally distinguished as the outer loop of the face. If so, it establishes a preferred way of embedding the face domain in the plane, in which the other bounding loops of the face are inside the outer bound. Because the face domain is arcwise connected, no inner loop will contain any other loop. This is true regardless of which embedding in the plane is chosen.

The edges and vertices referenced by the loops of a face form a graph, of which the individual loops are the connected components. The Euler equation (1) for this graph becomes:

where Gli is the graph genus of the i th loop.

NOTE Corresponding ISO 10303 entity: face. No subtypes of face have been incorporated into this IFC Release. Please refer to ISO/IS 10303-42:1994, p. 140 for the final definition of the formal standard. The WR1 has not been incorporated, since it is always satisfied, due to the fact that only poly loops exist for face bounds.

HISTORY New class in IFC Release 1.0

Informal propositions:

No edge shall be referenced by the face more than twice.

Distinct face bounds of the face shall have no common vertices. If geometry is present, distinct loops of the same face shall not intersect.

The face shall satisfy the Euler Equation: (number of vertices) - (number of edges) - (number of loops) + (sum of genus for loops) = 0.

Subclassed by Ifc2x3::IfcFaceSurface

Public Types

typedef IfcTemplatedEntityList<IfcFace> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcFaceBound>::ptr Bounds() const

Boundaries of the face.

void setBounds(IfcTemplatedEntityList<::Ifc2x3::IfcFaceBound>::ptr v)
const IfcParse::entity &declaration() const
IfcFace(IfcEntityInstanceData *e)
IfcFace(IfcTemplatedEntityList<::Ifc2x3::IfcFaceBound>::ptr v1_Bounds)

Public Static Functions

const IfcParse::entity &Class()
class IfcFaceBasedSurfaceModel : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A face based surface model is described by a set of connected face sets of dimensionality 2. The connected face sets shall not intersect except at edges and vertices, except that a face in one connected face set may overlap a face in another connected face set, provided the face boundaries are identical. There shall be at least one connected face set.

A connected face set may exist independently of a surface model.

NOTE Corresponding STEP entity: face_based_surface_model. Please refer to ISO/IS 10303-42:1994, p. 188 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Informal propositions:

The connected face sets shall not overlap or intersect except at common faces, edges or vertices. The fbsm faces have dimensionality 2.

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcConnectedFaceSet>::ptr FbsmFaces() const

The set of connected face sets comprising the face based surface model.

void setFbsmFaces(IfcTemplatedEntityList<::Ifc2x3::IfcConnectedFaceSet>::ptr v)
const IfcParse::entity &declaration() const
IfcFaceBasedSurfaceModel(IfcEntityInstanceData *e)
IfcFaceBasedSurfaceModel(IfcTemplatedEntityList<::Ifc2x3::IfcConnectedFaceSet>::ptr v1_FbsmFaces)

Public Static Functions

const IfcParse::entity &Class()
class IfcFaceBound : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A face bound is a loop which is intended to be used for bounding a face.

NOTE Corresponding ISO 10303 entity: face_bound. Please refer to ISO/IS 10303-42:1994, p. 139 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Subclassed by Ifc2x3::IfcFaceOuterBound

Public Types

typedef IfcTemplatedEntityList<IfcFaceBound> list

Public Functions

::Ifc2x3::IfcLoop *Bound() const

The loop which will be used as a face boundary.

void setBound(::Ifc2x3::IfcLoop *v)
bool Orientation() const

This indicated whether (TRUE) or not (FALSE) the loop has the same sense when used to bound the face as when first defined. If sense is FALSE the senses of all its component oriented edges are implicitly reversed when used in the face.

void setOrientation(bool v)
const IfcParse::entity &declaration() const
IfcFaceBound(IfcEntityInstanceData *e)
IfcFaceBound(::Ifc2x3::IfcLoop *v1_Bound, bool v2_Orientation)

Public Static Functions

const IfcParse::entity &Class()
class IfcFaceOuterBound : public Ifc2x3::IfcFaceBound

Definition from ISO/CD 10303-42:1992: A face outer bound is a special subtype of face bound which carries the additional semantics of defining an outer boundary on the face. No more than one boundary of a face shall be of this type.

NOTE Corresponding ISO 10303 entity: face_outer_bound. Please refer to ISO/IS 10303-42:1994, p. 139 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcFaceOuterBound> list

Public Functions

const IfcParse::entity &declaration() const
IfcFaceOuterBound(IfcEntityInstanceData *e)
IfcFaceOuterBound(::Ifc2x3::IfcLoop *v1_Bound, bool v2_Orientation)

Public Static Functions

const IfcParse::entity &Class()
class IfcFaceSurface : public Ifc2x3::IfcFace

Definition from ISO/CD 10303-42:1992: A face surface (IfcFaceSurface) is a subtype of face in which the geometry is defined by an associated surface. The portion of the surface used by the face shall be embeddable in the plane as an open disk, possibly with holes. However, the union of the face with the edges and vertices of its bounding loops need not be embeddable in the plane. It may, for example, cover an entire sphere or torus. As both a face and a geometric surface have defined normal directions, a BOOLEAN flag (the orientation attribute) is used to indicate whether the surface normal agrees with (TRUE) or is opposed to (FALSE) the face normal direction. The geometry associated with any component of the loops of the face shall be consistent with the surface geometry, in the sense that the domains of all the vertex points and edge curves are contained in the face geometry surface. A surface may be referenced by more than one face surface.

NOTE Corresponding ISO 10303 entity: face_surface. Please refer to ISO/IS 10303-42:1994, p. 204 for the final definition of the formal standard. Due to the general IFC model specification rule not to use multiple inheritance, the subtype relationship to geometric_representation_item is not included.

HISTORY New class in IFC2x

Informal propositions:

The domain of the face surface is formally defined to be the domain of its face geometry as trimmed by the loops, this domain does not include the bounding loops. A face surface has non zero finite extent. A face surface is a manifold. A face surface is arcwise connected. A face surface has surface genus 0. The loops are not part of the face domain. Loop geometry shall be consistent with face geometry. This implies that any edge - curves or vertex points used in defining the loops bounding the face surface shall lie on the face geometry. The loops of the face shall not intersect.

Public Types

typedef IfcTemplatedEntityList<IfcFaceSurface> list

Public Functions

::Ifc2x3::IfcSurface *FaceSurface() const

The surface which defines the internal shape of the face. This surface may be unbounded. The domain of the face is defined by this surface and the bounding loops in the inherited attribute SELF\FaceBounds.

void setFaceSurface(::Ifc2x3::IfcSurface *v)
bool SameSense() const

This flag indicates whether the sense of the surface normal agrees with (TRUE), or opposes (FALSE), the sense of the topological normal to the face.

void setSameSense(bool v)
const IfcParse::entity &declaration() const
IfcFaceSurface(IfcEntityInstanceData *e)
IfcFaceSurface(IfcTemplatedEntityList<::Ifc2x3::IfcFaceBound>::ptr v1_Bounds, ::Ifc2x3::IfcSurface *v2_FaceSurface, bool v3_SameSense)

Public Static Functions

const IfcParse::entity &Class()
class IfcFacetedBrep : public Ifc2x3::IfcManifoldSolidBrep

Definition from ISO/CD 10303-42:1992: A faceted B-rep is a simple form of boundary representation model in which all faces are planar and all edges are straight lines. Unlike the B-rep model, edges and vertices are not represented explicitly in the model but are implicitly available through the poly loop entity. A faceted B-rep has to meet the same topological constraints as the manifold solid B-rep.

NOTE The faceted B-rep has been introduced in order to support the larger number of systems that allow boundary type solid representations with planar surfaces only.

NOTE Corresponding ISO 10303-42 entity: faceted_brep. Please refer to ISO/IS 10303-42:1994, p. 173 for the final definition of the formal standard. In the current IFC Release faceted B-rep with voids is represented by an own subtype and not defined via an implicit ANDOR supertype constraint as in ISO/IS 10303-42:1994. This change has been made due to the fact, that only ONEOF supertype constraint is allowed within the IFC data schema.

HISTORY New entity in IFC Release 1.0

Informal proposition:

All the bounding loops of all the faces of all the shells in the IfcFacetedBrep shall be of type IfcPolyLoop. All vertices shall be referenced by all polyloops, sharing the vertex. That is, each Cartesian point shall be referenced by at least three polyloops.

Figure 257 illustrates use of IfcFacetedBrep for boundary representation models with planar surfaces only. The diagram shows the topological and geometric representation items that are used for faceted breps. Each IfcCartesianPoint, used within the IfcFacetedBrep shall be referenced three times by an IfcPolyLoop bounding a different IfcFace.

Figure 257 — Faceted B-rep

Public Types

typedef IfcTemplatedEntityList<IfcFacetedBrep> list

Public Functions

const IfcParse::entity &declaration() const
IfcFacetedBrep(IfcEntityInstanceData *e)
IfcFacetedBrep(::Ifc2x3::IfcClosedShell *v1_Outer)

Public Static Functions

const IfcParse::entity &Class()
class IfcFacetedBrepWithVoids : public Ifc2x3::IfcManifoldSolidBrep

The IfcFacetedBrepWithVoids is a specialization of a faceted B-rep which contains one or more voids in its interior. The voids are represented as closed shells which are defined so that the shell normal point into the void.

NOTE Corresponding ISO 10303-42 entity: brep_with_voids (see note above). Please refer to ISO/IS 10303-42:1994, p. 173 for the final definition of the formal standard. In IFC faceted B-rep with voids is represented by this subtype IfcFacetedBrepWithVoids and not defined via an implicit ANDOR supertype constraint as in ISO/IS 10303-42:1994 between an instance of faceted_brep AND brep_with_voids. This change has been made due to the fact, that only ONEOF supertype constraint is allowed within the IFC object model.

HISTORY New entity in IFC Release 1.0

IFC2x4 CHANGE Subtyping changed from IfcManifoldSolidBrep to IfcFacetedBrep with upward compatibility for file based exchange.

Informal propositions:

Each void shell shall be disjoint from the outer shell and from every other void shell Each void shell shall be enclosed within the outer shell but not within any other void shell. In particular the outer shell is not in the set of void shells Each shell in the IfcManifoldSolidBrep shall be referenced only once. All the bounding loops of all the faces of all the shells in the IfcFacetedBrep shall be of type IfcPolyLoop.

Public Types

typedef IfcTemplatedEntityList<IfcFacetedBrepWithVoids> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcClosedShell>::ptr Voids() const

Set of closed shells defining voids within the solid.

void setVoids(IfcTemplatedEntityList<::Ifc2x3::IfcClosedShell>::ptr v)
const IfcParse::entity &declaration() const
IfcFacetedBrepWithVoids(IfcEntityInstanceData *e)
IfcFacetedBrepWithVoids(::Ifc2x3::IfcClosedShell *v1_Outer, IfcTemplatedEntityList<::Ifc2x3::IfcClosedShell>::ptr v2_Voids)

Public Static Functions

const IfcParse::entity &Class()
class IfcFailureConnectionCondition : public Ifc2x3::IfcStructuralConnectionCondition

Definition from IAI: Defines forces at which a support or connection fails.

Applicability:

Point supports and connections.

HISTORY: New entity in IFC 2x2.

Public Functions

bool hasTensionFailureX() const

Whether the optional attribute TensionFailureX is defined for this IfcFailureConnectionCondition.

double TensionFailureX() const

Tension force in x-direction leading to failure of the connection.

void setTensionFailureX(double v)
bool hasTensionFailureY() const

Whether the optional attribute TensionFailureY is defined for this IfcFailureConnectionCondition.

double TensionFailureY() const

Tension force in y-direction leading to failure of the connection.

void setTensionFailureY(double v)
bool hasTensionFailureZ() const

Whether the optional attribute TensionFailureZ is defined for this IfcFailureConnectionCondition.

double TensionFailureZ() const

Tension force in z-direction leading to failure of the connection.

void setTensionFailureZ(double v)
bool hasCompressionFailureX() const

Whether the optional attribute CompressionFailureX is defined for this IfcFailureConnectionCondition.

double CompressionFailureX() const

Compression force in x-direction leading to failure of the connection.

void setCompressionFailureX(double v)
bool hasCompressionFailureY() const

Whether the optional attribute CompressionFailureY is defined for this IfcFailureConnectionCondition.

double CompressionFailureY() const

Compression force in y-direction leading to failure of the connection.

void setCompressionFailureY(double v)
bool hasCompressionFailureZ() const

Whether the optional attribute CompressionFailureZ is defined for this IfcFailureConnectionCondition.

double CompressionFailureZ() const

Compression force in z-direction leading to failure of the connection.

void setCompressionFailureZ(double v)
const IfcParse::entity &declaration() const
IfcFailureConnectionCondition(IfcEntityInstanceData *e)
IfcFailureConnectionCondition(boost::optional<std::string> v1_Name, boost::optional<double> v2_TensionFailureX, boost::optional<double> v3_TensionFailureY, boost::optional<double> v4_TensionFailureZ, boost::optional<double> v5_CompressionFailureX, boost::optional<double> v6_CompressionFailureY, boost::optional<double> v7_CompressionFailureZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcFanType : public Ifc2x3::IfcFlowMovingDeviceType

The flow moving device type IfcFanType defines commonly shared information for occurrences of fans. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a fan specification (i.e. the specific product information, that is common to all occurrences of that product type). Fan types may be exchanged without being already assigned to occurrences. Occurrences of IfcFanType are represented by instances of IfcFan.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowMovingDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FanTypeCommon Pset_FanTypeSmokeControl

Material Use Definition The material of the IfcFanType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Housing’: The material used to construct the fan housing. ‘Wheel’: The material used to construct the fan wheel.

Port Use Definition The distribution ports relating to the IfcFanType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcFan for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcFanType> list

Public Functions

::Ifc2x3::IfcFanTypeEnum::Value PredefinedType() const

Defines the type of fan typically used in building services.

void setPredefinedType(::Ifc2x3::IfcFanTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFanType(IfcEntityInstanceData *e)
IfcFanType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcFanTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFanTypeEnum

Public Types

enum Value

Enumeration defining the typical types of fans. The IfcFanTypeEnum contains the following:

CENTRIFUGALFORWARDCURVED: Air flows through the impeller radially using blades that are forward curved. CENTRIFUGALRADIAL: Air flows through the impeller radially using blades that are uncurved or slightl forward curved. CENTRIFUGALBACKWARDINCLINEDCURVED: Air flows through the impeller radially using blades that are backward curved. CENTRIFUGALAIRFOIL: Air flows through the impeller radially using blades are airfoil shaped. TUBEAXIAL: Air flows through the impeller axially with reduced tip clearance and operating at higher tip speeds. VANEAXIAL: Air flows through the impeller axially with guide vanes and reduced running blade tip clearance. PROPELLORAXIAL: Air flows through the impeller axially and small hub-to-tip ratio impeller mounted in an orifice plate or inlet ring. USERDEFINED: User-defined fan type. NOTDEFINED: Undefined fan type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcFanType_CENTRIFUGALFORWARDCURVED
enumerator IfcFanType_CENTRIFUGALRADIAL
enumerator IfcFanType_CENTRIFUGALBACKWARDINCLINEDCURVED
enumerator IfcFanType_CENTRIFUGALAIRFOIL
enumerator IfcFanType_TUBEAXIAL
enumerator IfcFanType_VANEAXIAL
enumerator IfcFanType_PROPELLORAXIAL
enumerator IfcFanType_USERDEFINED
enumerator IfcFanType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFastener : public Ifc2x3::IfcElementComponent

Definition from IAI: Representations of fixing parts which are used as fasteners to connect or join elements with other elements.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Attribute PredefinedType added.

Subclassed by Ifc2x3::IfcMechanicalFastener

Public Types

typedef IfcTemplatedEntityList<IfcFastener> list

Public Functions

const IfcParse::entity &declaration() const
IfcFastener(IfcEntityInstanceData *e)
IfcFastener(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFastenerType : public Ifc2x3::IfcElementComponentType

Definition from IAI: The element type (IfcFastenerType) defines a list of commonly shared property set definitions of a fastener and an optional set of product representations. It is used to define fasteners mainly within structural and building services domains (i.e. the specific type information

common to all occurrences of that type).

The occurrences of the IfcFastenerType are represented by instances of IfcFastener.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Attribute PredefinedType added. Subtype IfcMechanicalFastenerType redefined as direct subtype of IfcElementComponentType.

Property Set Use Definition

The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute.

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FastenerWeld (WELD)

Subclassed by Ifc2x3::IfcMechanicalFastenerType

Public Types

typedef IfcTemplatedEntityList<IfcFastenerType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFastenerType(IfcEntityInstanceData *e)
IfcFastenerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFeatureElement : public Ifc2x3::IfcElement

Definition from IAI: Generalization of all existence dependent elements which modify the shape and appearance of the associated master element. The IfcFeatureElement offers the ability to handle shape modifiers as semantic objects within the IFC object model.

NOTE The term “feature” has a predefined meaning in a context of “feature-based modeling” and within steel construction work. It is introduced here in a broader sense to cover all existence dependent, but semantically described, modifiers of an element’s shape and appearance. It is envisioned that future releases enhance the feature-based capabilities of the IFC model.

In contrary to the aggregation, as used in IfcElementAssembly, that defines the aggregate as a container element, that has equally treated parts, the feature concept introduced by IfcFeatureElement defines the master element with subordinate parts as additions, or with voids or cut-outs as subtractions.

HISTORY New entity in Release IFC2x Edition 2. NOTE The entity is introduced as an upward compatible extension of the IFC2x platform. It is an intermediate abstract supertype without defining its own explicit attributes.

Containment Use Definition As a subordinate part being fully dependent on the master element the IfcFeatureElement shall have no independent containment relationship to the spatial structure.

The SELF\IfcElement.ContainedInStructure relationship shall be NIL.

Geometry Use Definition The geometric representation of IfcFeatureElement is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Local Placement The local placement for IfcFeatureElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the master IfcElement (its relevant subtypes), which is associated to the IfcFeatureElement by the appropriate relationship object. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Any IfcFeatureElement can be represented by one or several geometric representations. A detailed specification is introduced at the level of subtypes. Only the general representation identifier ‘Box’ with representation type ‘BoundingBox’, and representation identifier ‘Body’ with representation type ‘Brep’ are defined here. Box Representation Any IfcFeatureElement may be represented as a bounding box, which shows the maximum extend of the body within the coordinated system established by the IfcLocalPlacement. The bounding box representation is the simplest geometric representation available. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Box’ RepresentationType : ‘BoundingBox’

Body Representation The body representation of any IfcFeatureElement can have the following representation types: ‘Brep’. Other representation types might be specified at the level of subtypes. Brep Representation Type Any IfcFeatureElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape.

Subclassed by Ifc2x3::IfcFeatureElementAddition, Ifc2x3::IfcFeatureElementSubtraction

Public Types

typedef IfcTemplatedEntityList<IfcFeatureElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcFeatureElement(IfcEntityInstanceData *e)
IfcFeatureElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFeatureElementAddition : public Ifc2x3::IfcFeatureElement

Definition from IAI: A specialization of the general feature element, that represents an existence dependent element which modifies the shape and appearance of the associated master element. The IfcFeatureElementAddition offers the ability to handle shape modifiers as semantic objects within the IFC object model that add to the shape of the master element.

HISTORY New entity in Release IFC2x Edition 2. NOTE The entity is introduced as an upward compatible extension of the IFC2x platform. It is an intermediate abstract supertype without defining its own explicit attributes.

The IfcFeatureElementAddition is associated to its master element by virtue of the objectified relationship IfcRelProjectsElement. This relationship implies a Boolean ‘union’ operation between the shape of the master element and the shape of the addition feature.

Containment use definition

The containment to the spatial structure is defined at the level of the supertype IfcFeatureElement

Geometry Use Definitions

The geometric representation of IfcFeatureElementAddition is given by the IfcProductDefinitionShape, allowing multiple geometric representations.

Local Placement

The local placement for IfcFeatureElementAddition is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The local placement is always defined in relation to the local placement of the element to which the feature element is added:

The PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the same IfcElement, which is used in the HasAdditionFeature.RelatingElement inverse attribute.

Shape Representation

The geometry use definitions for the shape representation of the IfcFeatureElementAddition is given at the level of its subtypes.

Subclassed by Ifc2x3::IfcProjectionElement

Public Functions

IfcTemplatedEntityList<IfcRelProjectsElement>::ptr ProjectsElements() const
const IfcParse::entity &declaration() const
IfcFeatureElementAddition(IfcEntityInstanceData *e)
IfcFeatureElementAddition(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFeatureElementSubtraction : public Ifc2x3::IfcFeatureElement

The IfcFeatureElementSubtraction is specialization of the general feature element, that represents an existence dependent elements which modifies the shape and appearance of the associated master element. The IfcFeatureElementSubtraction offers the ability to handle shape modifiers as semantic objects within the IFC object model that subtract from the shape of the master element.

A single subtraction feature such as the subtype IfcOpeningElement is assigned by a single subtraction relationship IfcRelVoidsElement to one occurrences of IfcElement. It establishes a 1:1 relationship between the opening and the element. An element may have several IfcRelVoidsElement relationships, enabling several voids.

The voiding relationship between a master element and a subtraction feature is geometrically resolved by a Boolean difference operation.

HISTORY New entity in Release IFC2x Edition 2.

Containment use definition The IfcFeatureElementSubtraction shall have no independent containment relationship to the spatial structure. See explanation at supertype IfcFeatureElement Geometry Use Definitions The geometric representation of IfcFeatureElementSubtraction is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Local Placement The local placement for IfcFeatureElementSubtraction is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The local placement is always defined in relation to the local placement of the building element from which the feature element substration is substracted:

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcElement, which is used in the VoidsElements.RelatingElement inverse attribute.

Shape Representation The geometry use definitions for the shape representation of the IfcFeatureElementSubtraction is given at the level of its subtypes.

Subclassed by Ifc2x3::IfcEdgeFeature, Ifc2x3::IfcOpeningElement

Public Functions

IfcTemplatedEntityList<IfcRelVoidsElement>::ptr VoidsElements() const
const IfcParse::entity &declaration() const
IfcFeatureElementSubtraction(IfcEntityInstanceData *e)
IfcFeatureElementSubtraction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFillAreaStyle : public Ifc2x3::IfcPresentationStyle

Definition from ISO/CD 10303-46:1992: The style for filling visible curve segments, annotation fill areas or surfaces with tiles or hatches.

An IfcFillAreaStyle provides the style table for presentation information assigned to annotation fill areas or surfaces for hatching and tiling. The IfcFillAreaStyle defines hatches as model hatches, that is, the distance between hatch lines, or the curve patterns of hatch lines are given in model space dimensions (that have to be scaled using the target plot scale). The IfcFillAreaStyle allows for the following combinations of defining the style of hatching and tiling:

Solid fill for areas and surfaces by only assigning IfcColour to the set of FillStyles. It then provides the background colour for the filled area or surface.

NOTE Color information of surfaces for rendering is assigned by using IfcSurfaceStyle, not by using IfcFillAreaStyle.

Vector based hatching for areas and surfaces based on a single row of hatch lines by assigning a single instance of IfcFillAreaStyleHatching to the set of FillStyles. If an instance of IfcColour is assigned in addition to the set of FillStyles, it provides the background colour for the hatching. Vector based hatching for areas and surfaces based on two (potentially crossing) rows of hatch lines by assigning two instances of IfcFillAreaStyleHatching to the set of FillStyles.

If an instance of IfcColour is assigned in addition to the set of FillStyles, it provides the background colour for the hatching.

NOTE Assigning more then two instances of IfcFillAreaStyleHatching to define three or more rows of hatch lines is not encouraged.

Tiling for areas and surfaces by assigning a single instance of IfcFillAreaStyleTiles to the set of FillStyles. If an instance of IfcColour is assigned in addition to the set of FillStyles, it provides the background colour for the tiling.

IFC2x3 NOTE The use of IfcFillAreaStyleTiles is discouraged., as its definition might change is future releases.

Externally defined hatch style by assigning a single instance of IfcExternallyDefinedHatchStyle to the set of FillStyles. If an instance of IfcColour is assigned in addition to the set of FillStyles, it provides the background colour for the hatching.

Measures given to a hatch or tile pattern are given in global drawing length units.

NOTE Global units are defined at the single IfcProject instance, given by UnitsInContext:IfcUnitAssignment, the same units are used for the geometric representation items and for the style definitions.

The measure values for hatch or tile pattern apply to the model space with a target plot scale provided for the correct appearance in the default plot scale. For different scale and projection dependent fill area styles a different instance of IfcFillAreaStyle needs to be used by IfcPresentationStyleAssignment for different IfcGeometricRepresentationSubContext dependent representations.

NOTE the target plot scale is given by IfcGeometricRepresentationSubContext.TargetScale.

An IfcFillAreaStyle can be assigned to IfcFillArea via the IfcPresentationStyleAssignment through an intermediate IfcStyledItem or subtype IfcAnnotationFillAreaOccurrence.

NOTE Corresponding ISO 10303 name: fill_area_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcFillAreaStyle> list

Public Functions

IfcEntityList::ptr FillStyles() const

The set of fill area styles to use in presenting visible curve segments, annotation fill areas or surfaces.

void setFillStyles(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcFillAreaStyle(IfcEntityInstanceData *e)
IfcFillAreaStyle(boost::optional<std::string> v1_Name, IfcEntityList::ptr v2_FillStyles)

Public Static Functions

const IfcParse::entity &Class()
class IfcFillAreaStyleHatching : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-46:1992: The fill area style hatching defines a styled pattern of curves for hatching an annotation fill area or a surface.

The IfcFillAreaStyleHatching is used to define simple, vector-based hatching patterns, based on styled straight lines. The curve font, color and thickness is given by the HatchLineAppearance, the angle by the HatchLineAngle and the distance to the next hatch line by StartOfNextHatchLine, being either an offset distance or a vector.

NOTE If the hatch pattern involves two (potentially crossing) rows of hatch lines, then two instances of IfcFillAreaStyleHatching should be assigned to the IfcFillAreaStyle. Both share the same (virtual) point of origin of the hatching that is used by the reference hatch line (or the PointOfReferenceHatchLine if there is an offset).

For better control of the hatching appearance, when using hatch lines with other fonts then continuous, the PatternStart allows to offset the start of the curve font pattern along the reference hatch line (if not given, the PatternStart is at zero distance from the virtual point of origin). If the reference hatch line does not go through the origin (of the virtual hatching coordinate system), it can be offset by using thePatternStartPointOfReferenceHatchLine.

NOTE The coordinates of the PatternStart and the PointOfReferenceHatchLine are given relative to the assumed 0., 0. virtual point of origin at which the hatch pattern is later positioned by the FillStyleTarget point at IfcAnnotationFillAreaOccurrence. The measure values are given in global drawing length units and apply to the target plot scale for the scale depended representation subcontext.

NOTE The use of PointOfReferenceHatchLine is deprecated.

Figure 292 illustrates hatch attributes.

Example 1 This example shows simple hatching given by using a curve font “continuous” at HatchLineAppearance.

The distance of hatch lines is given by a positive length measure. The angle (here 45’ if measures in degree) is provided by HatchLineAngle.

The PatternStart is set to NIL ($) in this example. Example 2 This shows hatching from example 1 with using a different curve font at HatchLineAppearance. The distance of hatch lines is given by a positive length measure, therefore the font pattern start is at a point at the next hatch line given by a vector being perpendicular to the point of origin at the reference hatch line. The PatternStart is set to NIL ($) in this example. Example 3 This example uses hatching from example 2 with a vector to determine the pattern start of the next hatch lines. The pattern start is the beginning of the first visual curve font pattern segment at IfcCurveFont.CurveFont. The PatternStart is set to NIL ($) in this example. Example 4 This example uses hatching from example 3 where the pattern start is offset from the point of origin at the reference hatch line. That is, the first visible curve font pattern segment now does not start at the point of origin at the reference hatch line.

Example 5 This example uses hatching from example 4 where the hatch pattern is shifted against the underlying coordinate system. The point that is mapped to the insertion point of the IfcAnnotationFillAreaOccurrence now has an X and Y offset from the start of the reference hatch line. That is, the reference hatch line now does not go through the insertion point of the hatching.

Example 6 This example shows use of

IfcFillAreaStyleHatching attributes for two IfcFillAreaStyleHatching’s within one IfcFillAreaStyle. Note that the PatternStart now displaces both the reference hatch line from the point of origin and the start of the curve pattern. This can be used in cases when more than one IfcFillAreaStyleHatching is used in an IfcFillAreaStyle in order to place rows of hatch lines with an offset from each other.

Figure 292 — Fill area style hatching

NOTE Corresponding ISO 10303 name: fill_area_style_hatching. Please refer to ISO/IS 10303-46:1994, p. 108 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The IfcFillAreaStyleHatching has been changed by making the attributes PatternStart and PointOfReferenceHatchLine OPTIONAL. The attribute StartOfNextHatchLine has changed to a SELECT with the additional choice of IfcPositiveLengthMeasure. Upward compatibility for file based exchange is guaranteed.

Public Functions

::Ifc2x3::IfcCurveStyle *HatchLineAppearance() const

The curve style of the hatching lines. Any curve style pattern shall start at the origin of each hatch line.

void setHatchLineAppearance(::Ifc2x3::IfcCurveStyle *v)
::Ifc2x3::IfcHatchLineDistanceSelect *StartOfNextHatchLine() const

A repetition factor that determines the distance between adjacent hatch lines.

IFC2x Edition 3 CHANGE The attribute type of StartOfNextHatchLine has changed to a SELECT of IfcPositiveLengthMeasure (new) and IfcOneDirectionRepeatFactor.

void setStartOfNextHatchLine(::Ifc2x3::IfcHatchLineDistanceSelect *v)
bool hasPointOfReferenceHatchLine() const

Whether the optional attribute PointOfReferenceHatchLine is defined for this IfcFillAreaStyleHatching.

::Ifc2x3::IfcCartesianPoint *PointOfReferenceHatchLine() const

A Cartesian point which defines the offset of the reference hatch line from the origin of the (virtual) hatching coordinate system. The origin is used for mapping the fill area style hatching onto an annotation fill area or surface. The reference hatch line would then appear with this offset from the fill style target point. If not given the reference hatch lines goes through the origin of the (virtual) hatching coordinate system.

IFC2x Edition 3 CHANGE The usage of the attribute PointOfReferenceHatchLine has changed to not provide the Cartesian point which is the origin for mapping, but to provide an offset to the origin for the mapping. The attribute has been made OPTIONAL.

void setPointOfReferenceHatchLine(::Ifc2x3::IfcCartesianPoint *v)
bool hasPatternStart() const

Whether the optional attribute PatternStart is defined for this IfcFillAreaStyleHatching.

::Ifc2x3::IfcCartesianPoint *PatternStart() const

A distance along the reference hatch line which is the start point for the curve style font pattern of the reference hatch line. If not given, the start point of the curve style font pattern is at the (virtual) hatching coordinate system.

IFC2x Edition 2 Addendum 2 CHANGE The attribute PatternStart has been made OPTIONAL.

void setPatternStart(::Ifc2x3::IfcCartesianPoint *v)
double HatchLineAngle() const

A plane angle measure determining the direction of the parallel hatching lines.

void setHatchLineAngle(double v)
const IfcParse::entity &declaration() const
IfcFillAreaStyleHatching(IfcEntityInstanceData *e)
IfcFillAreaStyleHatching(::Ifc2x3::IfcCurveStyle *v1_HatchLineAppearance, ::Ifc2x3::IfcHatchLineDistanceSelect *v2_StartOfNextHatchLine, ::Ifc2x3::IfcCartesianPoint *v3_PointOfReferenceHatchLine, ::Ifc2x3::IfcCartesianPoint *v4_PatternStart, double v5_HatchLineAngle)

Public Static Functions

const IfcParse::entity &Class()
class IfcFillAreaStyleTiles : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-46:1992: The fill area style tiles defines a two dimensional tile to be used for the filling of annotation fill areas or other closed regions. The content of a tile is defined by the tile set, and the placement of each tile determined by the filling pattern which indicates how to place tiles next to each other. Tiles or parts of tiles outside of the annotation fill area or closed region shall be clipped at the of the area or region.

NOTE Corresponding ISO 10303 name: fill_area_style_tiles. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcFillAreaStyleTiles> list

Public Functions

::Ifc2x3::IfcOneDirectionRepeatFactor *TilingPattern() const

A two direction repeat factor defining the shape and relative positioning of the tiles.

void setTilingPattern(::Ifc2x3::IfcOneDirectionRepeatFactor *v)
IfcEntityList::ptr Tiles() const

A set of constituents of the tile.

void setTiles(IfcEntityList::ptr v)
double TilingScale() const

The scale factor applied to each tile as it is placed in the annotation fill area.

void setTilingScale(double v)
const IfcParse::entity &declaration() const
IfcFillAreaStyleTiles(IfcEntityInstanceData *e)
IfcFillAreaStyleTiles(::Ifc2x3::IfcOneDirectionRepeatFactor *v1_TilingPattern, IfcEntityList::ptr v2_Tiles, double v3_TilingScale)

Public Static Functions

const IfcParse::entity &Class()
class IfcFillAreaStyleTileSymbolWithStyle : public Ifc2x3::IfcGeometricRepresentationItem

The fill area style tile symbol with style is a symbol that is used as a tile within an annotated tiling.

NOTE: The IfcFillAreaStyleTileSymbolWithStyle is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE: Corresponding ISO 10303 name: fill_area_style_tile_symbol_with_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Public Functions

::Ifc2x3::IfcAnnotationSymbolOccurrence *Symbol() const

A styled item that is used as the annotation symbol for tiling the filled area.

IFC2x4 CHANGE The data type has been changed to IfcStyleItem.

NOTE Only IfcStyleItem’s that refer to a compatible geometric representation item and presentation style shall be used.

void setSymbol(::Ifc2x3::IfcAnnotationSymbolOccurrence *v)
const IfcParse::entity &declaration() const
IfcFillAreaStyleTileSymbolWithStyle(IfcEntityInstanceData *e)
IfcFillAreaStyleTileSymbolWithStyle(::Ifc2x3::IfcAnnotationSymbolOccurrence *v1_Symbol)

Public Static Functions

const IfcParse::entity &Class()
class IfcFilterType : public Ifc2x3::IfcFlowTreatmentDeviceType

The flow treatment device type IfcFilterType defines commonly shared information for occurrences of filters. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a filter specification (i.e. the specific product information, that is common to all occurrences of that product type). Filter types may be exchanged without being already assigned to occurrences. Occurrences of IfcFilterType are represented by instances of IfcFilter.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTreatmentDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FilterTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FilterTypeAirParticleFilter (AIRPARTICLEFILTER)

Material Use Definition The material of the IfcFilterType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Media’: The material that is used for filtering particulates from the fluid.

Port Use Definition The distribution ports relating to the IfcFilterType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcFilter for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcFilterType> list

Public Functions

::Ifc2x3::IfcFilterTypeEnum::Value PredefinedType() const

The type of air filter.

void setPredefinedType(::Ifc2x3::IfcFilterTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFilterType(IfcEntityInstanceData *e)
IfcFilterType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcFilterTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFilterTypeEnum

Public Types

enum Value

This enumeration defines the various types of filter typically used within building services distribution systems:

AIRPARTICLEFILTER: A filter used to remove particulates from air. COMPRESSEDAIRFILTER: A filter used to remove particulates from compressed air. ODORFILTER: A filter used to remove odors from air. OILFILTER: A filter used to remove particulates from oil. STRAINER: A filter used to remove particulates from a fluid. WATERFILTER: A filter used to remove particulates from water. USERDEFINED: User-defined filter type. NOTDEFINED: Undefined filter type.

HISTORY: New enumeration in IFC R2x. COMPRESSEDAIRFILTER added in IFC2x4.

Values:

enumerator IfcFilterType_AIRPARTICLEFILTER
enumerator IfcFilterType_ODORFILTER
enumerator IfcFilterType_OILFILTER
enumerator IfcFilterType_STRAINER
enumerator IfcFilterType_WATERFILTER
enumerator IfcFilterType_USERDEFINED
enumerator IfcFilterType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFireSuppressionTerminalType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcFireSuppressionTerminalType defines commonly shared information for occurrences of fire suppression terminals. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a fire suppression terminal specification (i.e. the specific product information, that is common to all occurrences of that product type). Fire Suppression Terminal types may be exchanged without being already assigned to occurrences. Occurrences of IfcFireSuppressionTerminalType are represented by instances of IfcFireSuppressionTerminal.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FireSuppressionTerminalTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FireSuppressionTerminalTypeBreechingInlet (BREECHINGINLET) Pset_FireSuppressionTerminalTypeFireHydrant (FIREHYDRANT) Pset_FireSuppressionTerminalTypeHoseReel (HOSEREEL) Pset_FireSuppressionTerminalTypeSprinkler (SPRINKLER)

Material Use Definition The material of the IfcFireSuppressionTerminalType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed. ‘Deflector’: The material used to construct the deflector plate.

Port Use Definition The distribution ports relating to the IfcFireSuppressionTerminalType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcFireSuppressionTerminal for standard port definitions.

Public Functions

::Ifc2x3::IfcFireSuppressionTerminalTypeEnum::Value PredefinedType() const

Identifies the predefined types of fire suppression terminal from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcFireSuppressionTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFireSuppressionTerminalType(IfcEntityInstanceData *e)
IfcFireSuppressionTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcFireSuppressionTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFireSuppressionTerminalTypeEnum

Public Types

enum Value

The IfcFireSuppressionTerminalTypeEnum defines the range of different types of fire suppression terminal that can be specified.

HISTORY: New type in IFC 2x2

Enumeration

BREECHINGINLET: Symmetrical pipe fitting that unites two or more inlets into a single pipe (BS6100 330 114 adapted). A breeching inlet may be used on either a wet or dry riser. Used by fire services personnel for fast connection of fire appliance hose reels. May also be used for foam. FIREHYDRANT: Device, fitted to a pipe, through which a temporary supply of water may be provided (BS6100 330 6107). May also be termed a stand pipe. HOSEREEL: A supporting framework on which a hose may be wound (BS6100 155 8201). SPRINKLER: Device for sprinkling water from a pipe under pressure over an area (BS6100 100 3432). SPRINKLERDEFLECTOR: Device attached to a sprinkler to deflect the water flow into a spread pattern to cover the required area. USERDEFINED: User-defined type. NOTDEFINED: Underined type.

Values:

enumerator IfcFireSuppressionTerminalType_BREECHINGINLET
enumerator IfcFireSuppressionTerminalType_FIREHYDRANT
enumerator IfcFireSuppressionTerminalType_HOSEREEL
enumerator IfcFireSuppressionTerminalType_SPRINKLER
enumerator IfcFireSuppressionTerminalType_SPRINKLERDEFLECTOR
enumerator IfcFireSuppressionTerminalType_USERDEFINED
enumerator IfcFireSuppressionTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFlowController : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowController defines the occurrence of elements of a distribution system that are used to regulate flow through a distribution system. Examples include dampers, valves, switches, and relays. Its type is defined by IfcFlowControllerType or subtypes.

HISTORY: New entity in IFC R2.0.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Subclassed by Ifc2x3::IfcElectricDistributionPoint

Public Types

typedef IfcTemplatedEntityList<IfcFlowController> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowController(IfcEntityInstanceData *e)
IfcFlowController(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowControllerType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowControllerType defines a list of commonly shared property set definitions of a flow controller and an optional set of product representations. It is used to define a flow controller specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A flow controller type is used to define the common properties of a flow controller that may be applied to many occurrences of that type. A flow controller is a device that regulates flow within a distribution system, such as a valve in a piping

system, modulating damper in an air distribution system, or electrical switch in an electrical distribution

system. Flow controller types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowControllerType are represented by instances of IfcFlowController or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcAirTerminalBoxType, Ifc2x3::IfcDamperType, Ifc2x3::IfcElectricTimeControlType, Ifc2x3::IfcFlowMeterType, Ifc2x3::IfcProtectiveDeviceType, Ifc2x3::IfcSwitchingDeviceType, Ifc2x3::IfcValveType

Public Types

typedef IfcTemplatedEntityList<IfcFlowControllerType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowControllerType(IfcEntityInstanceData *e)
IfcFlowControllerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFlowDirectionEnum

Public Types

enum Value

This enumeration defines the flow direction at a port as either a SOURCE, SINK, or SOURCEANDSINK. For solids, liquids, or gas, the direction is the physical flow direction. For electric power (circuits containing hot, neutral, ground), the direction is from the origination of power (from a distribution board to protective devices to switches to fixtures). For communication signals, the direction originates from where the signal is shaped, such as a sensor. For communicaton networks, the direction originates from the up-level network host, such as a router (having SOURCE ports) hosting multiple computers (having SINK ports).

SOURCE: A flow source, where a substance flows out of the connection. SINK: A flow sink, where a substance flows into the connection. SOURCEANDSINK: Both a source and sink, where a substance flows both into and out of the connection simultaneously. NOTDEFINED: Undefined flow direction.

HISTORY: New enumeration in IFC R2.0

Values:

enumerator IfcFlowDirection_SOURCE
enumerator IfcFlowDirection_SINK
enumerator IfcFlowDirection_SOURCEANDSINK
enumerator IfcFlowDirection_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFlowFitting : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowFitting defines the occurrence of a junction or transition in a flow distribution system, such as an elbow or tee. Its type is defined by IfcFlowFittingType or its subtypes.

HISTORY: New entity in IFC R2.0.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Types

typedef IfcTemplatedEntityList<IfcFlowFitting> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowFitting(IfcEntityInstanceData *e)
IfcFlowFitting(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowFittingType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowFittingType defines a list of commonly shared property set definitions of a flow fitting and an optional set of product representations. It is used to define a flow fitting specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A flow fitting type is used to define the common properties of a flow fitting that may be applied to many occurrences of that type. A flow fitting is a device that is used to interconnect flow segments or other fittings within a distribution

system, such as a tee in a ducted system that branches flow into two directions, a junction box in an

electrical distribution system, etc. Flow fitting types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowFittingType are represented by instances of IfcFlowFitting or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcCableCarrierFittingType, Ifc2x3::IfcDuctFittingType, Ifc2x3::IfcJunctionBoxType, Ifc2x3::IfcPipeFittingType

Public Types

typedef IfcTemplatedEntityList<IfcFlowFittingType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowFittingType(IfcEntityInstanceData *e)
IfcFlowFittingType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowInstrumentType : public Ifc2x3::IfcDistributionControlElementType

The distribution control element type IfcFlowInstrumentType defines commonly shared information for occurrences of flow instruments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a flow instrument specification (i.e. the specific product information, that is common to all occurrences of that product type). Flow Instrument types may be exchanged without being already assigned to occurrences. Occurrences of IfcFlowInstrumentType are represented by instances of IfcFlowInstrument.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionControlElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FlowInstrumentTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FlowInstrumentTypePressureGauge (PRESSUREGAUGE) Pset_FlowInstrumentTypeThermometer (THERMOMETER)

Material Use Definition The material of the IfcFlowInstrumentType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcFlowInstrumentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcFlowInstrument for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcFlowInstrumentType> list

Public Functions

::Ifc2x3::IfcFlowInstrumentTypeEnum::Value PredefinedType() const

Identifies the predefined types of flow instrument from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcFlowInstrumentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFlowInstrumentType(IfcEntityInstanceData *e)
IfcFlowInstrumentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcFlowInstrumentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFlowInstrumentTypeEnum

Public Types

enum Value

The IfcFlowInstrumentTypeEnum defines the range of different types of flow instrument that can be specified.

HISTORY: New type in IFC 2x2

Enumeration

PRESSUREGAUGE: A device that reads and displays a pressure value at a point or the pressure difference between two points. THERMOMETER: A device that reads and displays a temperature value at a point. AMMETER: A device that reads and displays the current flow in a circuit. FREQUENCYMETER: A device that reads and displays the electrical frequency of an alternating current circuit. PHASEANGLEMETER: A device that reads and displays the phase angle of a phase in a polyphase electrical circuit. POWERFACTORMETER: A device that reads and displays the power factor of an electrical circuit. VOLTMETER_PEAK: A device that reads and displays the peak voltage in an electrical circuit. VOLTMETER_RMS: A device that reads and displays the RMS (mean) voltage in an electrical circuit. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcFlowInstrumentType_PRESSUREGAUGE
enumerator IfcFlowInstrumentType_THERMOMETER
enumerator IfcFlowInstrumentType_AMMETER
enumerator IfcFlowInstrumentType_FREQUENCYMETER
enumerator IfcFlowInstrumentType_POWERFACTORMETER
enumerator IfcFlowInstrumentType_PHASEANGLEMETER
enumerator IfcFlowInstrumentType_VOLTMETER_PEAK
enumerator IfcFlowInstrumentType_VOLTMETER_RMS
enumerator IfcFlowInstrumentType_USERDEFINED
enumerator IfcFlowInstrumentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFlowMeterType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcFlowMeterType defines commonly shared information for occurrences of flow meters. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a flow meter specification (i.e. the specific product information, that is common to all occurrences of that product type). Flow Meter types may be exchanged without being already assigned to occurrences. Occurrences of IfcFlowMeterType are represented by instances of IfcFlowMeter.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FlowMeterTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FlowMeterTypeEnergyMeter (ENERGYMETER) Pset_FlowMeterTypeGasMeter (GASMETER) Pset_FlowMeterTypeOilMeter (OILMETER) Pset_FlowMeterTypeWaterMeter (WATERMETER)

Material Use Definition The material of the IfcFlowMeterType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcFlowMeterType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcFlowMeter for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcFlowMeterType> list

Public Functions

::Ifc2x3::IfcFlowMeterTypeEnum::Value PredefinedType() const

Defines the type of flow meter.

void setPredefinedType(::Ifc2x3::IfcFlowMeterTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFlowMeterType(IfcEntityInstanceData *e)
IfcFlowMeterType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcFlowMeterTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFlowMeterTypeEnum

Public Types

enum Value

This enumeration defines various types of flow meter:

ENERGYMETER: An electric meter or energy meter is a device that measures the amount of electrical energy supplied to or produced by a residence, business or machine.

GASMETER: A device that measures the quantity of a gas or fuel.

OILMETER: A device that measures the quantity of oil.

WATERMETER: A device that measures the quantity of water.

USERDEFINED: User-defined meter type

NOTDEFINED: Undefined meter type

HISTORY: New enumeration in IFC 2x2

Values:

enumerator IfcFlowMeterType_ELECTRICMETER
enumerator IfcFlowMeterType_ENERGYMETER
enumerator IfcFlowMeterType_FLOWMETER
enumerator IfcFlowMeterType_GASMETER
enumerator IfcFlowMeterType_OILMETER
enumerator IfcFlowMeterType_WATERMETER
enumerator IfcFlowMeterType_USERDEFINED
enumerator IfcFlowMeterType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcFlowMovingDevice : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowMovingDevice defines the occurrence of an apparatus used to distribute, circulate or perform conveyance of fluids, including liquids and gases (such as a pump or fan), and typically participates in a flow distribution system. Its type is defined by IfcFlowMovingDeviceType or its subtypes.

HISTORY: New entity in IFC R2x.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Types

typedef IfcTemplatedEntityList<IfcFlowMovingDevice> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowMovingDevice(IfcEntityInstanceData *e)
IfcFlowMovingDevice(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowMovingDeviceType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowMovingDeviceType defines a list of commonly shared property set definitions of a flow moving device and an optional set of product representations. It is used to define a flow moving device specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A flow moving type is used to define the common properties of a flow moving device that may be applied to many occurrences of that type. A flow moving device is a device that is used to produce a pressure differential in a distribution system,

such as a pump, fan, compressor, etc. Flow moving types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowMovingDeviceType are represented by instances of IfcFlowMovingDevice.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcCompressorType, Ifc2x3::IfcFanType, Ifc2x3::IfcPumpType

Public Types

typedef IfcTemplatedEntityList<IfcFlowMovingDeviceType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowMovingDeviceType(IfcEntityInstanceData *e)
IfcFlowMovingDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowSegment : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowSegment defines the occurrence of a segment of a flow distribution system.

HISTORY: New entity in IFC R2.0. IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

The IfcFlowSegment defines a particular occurrence of a segment inserted in the spatial context of a project. The parameters defining the type of the segment and/or its shape are defined by the IfcFlowSegmentType, which is related by the inverse relationship IsDefinedBy pointing to IfcRelDefinesByType.

Material Use Definition The material of the IfcFlowSegment is defined using one of the following entities:

IfcMaterialProfileSetUsage : for parametric segments, this defines the cross section and alignment to the ‘Axis’ representation, from which the ‘Body’ representation may be generated.

IfcMaterialProfileSet : for non-parametric segments (having fixed length or path), this may define the cross section for analysis purposes, however the ‘Body’ representation is independently generated.

IfcMaterialConstituentSet : for elements containing multiple materials where profiles are not applicable, this indicates materials at named parts.

IfcMaterial : for elements comprised of a single material where profiles are not applicable, this indicates the material.

The material is attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. Material information can also be given at the IfcFlowSegmentType, defining the common attribute data for all occurrences of the same type. Standard names and material types are defined at subtypes.

Representation Use Definition

Standard representations are defined at the supertype IfcDistrubutionFlowElement. For parametric flow segments where IfcMaterialProfileSetUsage is defined and an ‘Axis’ representation is defined, then the ‘Body’ representation may be generated using the ‘SweptSolid’ or ‘AdvancedSweptSolid’ representation types by sweeping the profile(s) along the axis.

Public Types

typedef IfcTemplatedEntityList<IfcFlowSegment> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowSegment(IfcEntityInstanceData *e)
IfcFlowSegment(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowSegmentType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowSegmentType defines a list of commonly shared property set definitions of a flow segment and an optional set of product representations. It is used to define a flow segment specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A flow segment type is used to define the common properties of a flow segment that may be applied to many occurrences of that type. A flow segment is a section of a distribution system, such as a duct, pipe, conduit, etc. that typically has

only two ports. Flow segment types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowSegmentType are represented by instances of IfcFlowSegment or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Material Use Definition The material of the IfcDistributionFlowSegmentType is defined using one of the following entities:

IfcMaterialProfileSet : This defines the material cross section which may be used to generate the ‘Body’ representation at occurrences (for parametric definitions not having representation), or for analysis purposes.

IfcMaterialConstituentSet : For elements containing multiple materials where profiles are not applicable, this indicates materials at named aspects.

IfcMaterial : For elements comprised of a single material where profiles are not applicable, this indicates the material.

Subclassed by Ifc2x3::IfcCableCarrierSegmentType, Ifc2x3::IfcCableSegmentType, Ifc2x3::IfcDuctSegmentType, Ifc2x3::IfcPipeSegmentType

Public Types

typedef IfcTemplatedEntityList<IfcFlowSegmentType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowSegmentType(IfcEntityInstanceData *e)
IfcFlowSegmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowStorageDevice : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowStorageDevice defines the occurrence of a device that participates in a distribution system and is used for temporary storage of a fluid such as a liquid or a gas (e.g., tank). Its type is defined by

IfcFlowStorageDeviceType or its subtypes.

HISTORY: New entity in IFC R2x.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Types

typedef IfcTemplatedEntityList<IfcFlowStorageDevice> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowStorageDevice(IfcEntityInstanceData *e)
IfcFlowStorageDevice(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowStorageDeviceType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowStorageDeviceType defines a list of commonly shared property set definitions of a flow storage device and an optional set of product representations. It is used to define a flow storage device specification (the specific product information that is common to all occurrences of that product type).

A flow storage device is a device used for the temporary storage of a fluid (such as a tank) or the voltage potential induced by the induced electron flow (such as a battery). Flow storage types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowStorageDeviceType are represented by instances of IfcFlowStorageDevice or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcElectricFlowStorageDeviceType, Ifc2x3::IfcTankType

Public Functions

const IfcParse::entity &declaration() const
IfcFlowStorageDeviceType(IfcEntityInstanceData *e)
IfcFlowStorageDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowTerminal : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowTerminal defines the occurrence of a permanently attached element that acts as a terminus or beginning of a distribution system (e.g., air outlet, drain, water closet, sink, etc.). A terminal is typically a point at which a system interfaces with an external environment. Its type is defined by IfcFlowTerminalType or its subtypes.

HISTORY: New entity in IFC R2.0.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Types

typedef IfcTemplatedEntityList<IfcFlowTerminal> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowTerminal(IfcEntityInstanceData *e)
IfcFlowTerminal(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowTerminalType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowTerminalType defines a list of commonly shared property set definitions of a flow terminal and an optional set of product representations. It is used to define a flow terminal specification (the specific product information that is common to all occurrences of that product type).

A flow terminal type is used to define the common properties of a flow terminal that may be applied to many occurrences of that type. A flow terminal acts as a terminus or beginning element in a distribution system such as a ceiling register in a ducted air distribution system, a sink in a waste-water system, or a light fixture in an electrical lighting system. Flow terminal types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowTerminalType are represented by instances of IfcFlowTerminal or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcAirTerminalType, Ifc2x3::IfcElectricApplianceType, Ifc2x3::IfcElectricHeaterType, Ifc2x3::IfcFireSuppressionTerminalType, Ifc2x3::IfcGasTerminalType, Ifc2x3::IfcLampType, Ifc2x3::IfcLightFixtureType, Ifc2x3::IfcOutletType, Ifc2x3::IfcSanitaryTerminalType, Ifc2x3::IfcStackTerminalType, Ifc2x3::IfcWasteTerminalType

Public Types

typedef IfcTemplatedEntityList<IfcFlowTerminalType> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowTerminalType(IfcEntityInstanceData *e)
IfcFlowTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowTreatmentDevice : public Ifc2x3::IfcDistributionFlowElement

The distribution flow element IfcFlowTreatmentDevice defines the occurrence of a device typically used to remove unwanted matter from a fluid, either liquid or gas, and typically participates in a flow distribution system. Its type is defined by IfcFlowTreatmentDeviceType or its subtypes.

HISTORY: New entity in IFC R2x.

IFC 2x4 NOTE: This entity has been deprecated for instantiation and will become ABSTRACT in a future release; new subtypes should now be used instead.

Public Types

typedef IfcTemplatedEntityList<IfcFlowTreatmentDevice> list

Public Functions

const IfcParse::entity &declaration() const
IfcFlowTreatmentDevice(IfcEntityInstanceData *e)
IfcFlowTreatmentDevice(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFlowTreatmentDeviceType : public Ifc2x3::IfcDistributionFlowElementType

The element type IfcFlowTreatmentDeviceType defines a list of commonly shared property set definitions of a flow treatment device and an optional set of product representations. It is used to define a flow treatment device specification (the specific product information that is common to all occurrences of that product type).

A flow treatment device is a device used to change the physical properties of the medium, such as an air, oil

or water filter (used to remove particulates from the fluid), or a duct silencer (used to attenuate noise). Flow treatment types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences.

The occurrences of the IfcFlowTreatmentDeviceType are represented by instances of IfcFlowTreatmentDevice or its subtypes.

HISTORY: New entity in IFC Release 2x2.

Subclassed by Ifc2x3::IfcDuctSilencerType, Ifc2x3::IfcFilterType

Public Functions

const IfcParse::entity &declaration() const
IfcFlowTreatmentDeviceType(IfcEntityInstanceData *e)
IfcFlowTreatmentDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFluidFlowProperties : public Ifc2x3::IfcPropertySetDefinition

Public Types

typedef IfcTemplatedEntityList<IfcFluidFlowProperties> list

Public Functions

::Ifc2x3::IfcPropertySourceEnum::Value PropertySource() const
void setPropertySource(::Ifc2x3::IfcPropertySourceEnum::Value v)
bool hasFlowConditionTimeSeries() const

Whether the optional attribute FlowConditionTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *FlowConditionTimeSeries() const
void setFlowConditionTimeSeries(::Ifc2x3::IfcTimeSeries *v)
bool hasVelocityTimeSeries() const

Whether the optional attribute VelocityTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *VelocityTimeSeries() const
void setVelocityTimeSeries(::Ifc2x3::IfcTimeSeries *v)
bool hasFlowrateTimeSeries() const

Whether the optional attribute FlowrateTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *FlowrateTimeSeries() const
void setFlowrateTimeSeries(::Ifc2x3::IfcTimeSeries *v)
::Ifc2x3::IfcMaterial *Fluid() const
void setFluid(::Ifc2x3::IfcMaterial *v)
bool hasPressureTimeSeries() const

Whether the optional attribute PressureTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *PressureTimeSeries() const
void setPressureTimeSeries(::Ifc2x3::IfcTimeSeries *v)
bool hasUserDefinedPropertySource() const

Whether the optional attribute UserDefinedPropertySource is defined for this IfcFluidFlowProperties.

std::string UserDefinedPropertySource() const
void setUserDefinedPropertySource(std::string v)
bool hasTemperatureSingleValue() const

Whether the optional attribute TemperatureSingleValue is defined for this IfcFluidFlowProperties.

double TemperatureSingleValue() const
void setTemperatureSingleValue(double v)
bool hasWetBulbTemperatureSingleValue() const

Whether the optional attribute WetBulbTemperatureSingleValue is defined for this IfcFluidFlowProperties.

double WetBulbTemperatureSingleValue() const
void setWetBulbTemperatureSingleValue(double v)
bool hasWetBulbTemperatureTimeSeries() const

Whether the optional attribute WetBulbTemperatureTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *WetBulbTemperatureTimeSeries() const
void setWetBulbTemperatureTimeSeries(::Ifc2x3::IfcTimeSeries *v)
bool hasTemperatureTimeSeries() const

Whether the optional attribute TemperatureTimeSeries is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcTimeSeries *TemperatureTimeSeries() const
void setTemperatureTimeSeries(::Ifc2x3::IfcTimeSeries *v)
bool hasFlowrateSingleValue() const

Whether the optional attribute FlowrateSingleValue is defined for this IfcFluidFlowProperties.

::Ifc2x3::IfcDerivedMeasureValue *FlowrateSingleValue() const
void setFlowrateSingleValue(::Ifc2x3::IfcDerivedMeasureValue *v)
bool hasFlowConditionSingleValue() const

Whether the optional attribute FlowConditionSingleValue is defined for this IfcFluidFlowProperties.

double FlowConditionSingleValue() const
void setFlowConditionSingleValue(double v)
bool hasVelocitySingleValue() const

Whether the optional attribute VelocitySingleValue is defined for this IfcFluidFlowProperties.

double VelocitySingleValue() const
void setVelocitySingleValue(double v)
bool hasPressureSingleValue() const

Whether the optional attribute PressureSingleValue is defined for this IfcFluidFlowProperties.

double PressureSingleValue() const
void setPressureSingleValue(double v)
const IfcParse::entity &declaration() const
IfcFluidFlowProperties(IfcEntityInstanceData *e)
IfcFluidFlowProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcPropertySourceEnum::Value v5_PropertySource, ::Ifc2x3::IfcTimeSeries *v6_FlowConditionTimeSeries, ::Ifc2x3::IfcTimeSeries *v7_VelocityTimeSeries, ::Ifc2x3::IfcTimeSeries *v8_FlowrateTimeSeries, ::Ifc2x3::IfcMaterial *v9_Fluid, ::Ifc2x3::IfcTimeSeries *v10_PressureTimeSeries, boost::optional<std::string> v11_UserDefinedPropertySource, boost::optional<double> v12_TemperatureSingleValue, boost::optional<double> v13_WetBulbTemperatureSingleValue, ::Ifc2x3::IfcTimeSeries *v14_WetBulbTemperatureTimeSeries, ::Ifc2x3::IfcTimeSeries *v15_TemperatureTimeSeries, ::Ifc2x3::IfcDerivedMeasureValue *v16_FlowrateSingleValue, boost::optional<double> v17_FlowConditionSingleValue, boost::optional<double> v18_VelocitySingleValue, boost::optional<double> v19_PressureSingleValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcFontStyle : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): The font-style property selects between normal (sometimes referred to as “roman” or “upright”), italic and oblique faces within a font family. Values are:

normal italic oblique

A value of ‘normal’ selects a font that is classified as ‘normal’ in the user agents font database, while ‘oblique’ selects a font that is labeled ‘oblique’. A value of ‘italic’ selects a font that is labeled ‘italic’, or, if that is not available, one labeled ‘oblique’. The font that is labeled ‘oblique’ in the user agents font database may actually have been generated by electronically slanting a normal font.

Fonts with Oblique, Slanted or Incline in their names will typically be labeled ‘oblique’ in the user agents font database. Fonts with Italic, Cursive or Kursiv in their names will typically be labeled ‘italic’.

NOTE Corresponding CSS1 definitions is font-style.

HISTORY New type in IFC2x3.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcFontStyle(IfcEntityInstanceData *e)
IfcFontStyle(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcFontVariant : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): The font-style property selects between normal and small-caps within a font family. Values are:

normal small-caps

Another type of variation within a font family is the small-caps. In a small-caps font the lower case letters look similar to the uppercase ones, but in a smaller size and with slightly different proportions. The ‘font-variant’ property selects that font.

A value of ‘normal’ selects a font that is not a small-caps font, ‘small-caps’ selects a small-caps font. It is acceptable (but not required) in CSS1 if the small-caps font is a created by taking a normal font and replacing the lower case letters by scaled uppercase characters. As a last resort, uppercase letters will be used as replacement for a small-caps font.

NOTE Corresponding CSS1 definitions is font-variant.

HISTORY New type in IFC2x3.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcFontVariant(IfcEntityInstanceData *e)
IfcFontVariant(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcFontWeight : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): The ‘font-weight’ property selects the weight of the font. The values ‘100’ to ‘900’ form an ordered sequence, where each number indicates a weight that is at least as dark as its predecessor. The keyword ‘normal’ is synonymous with ‘400’, and ‘bold’ is synonymous with ‘700’. Keywords other than ‘normal’ and ‘bold’ have been shown to be often confused with font names and a numerical scale was therefore chosen for the 9-value list. Values are:

normal bold 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

Fonts (the font data) typically have one or more properties whose values are names that are descriptive of the “weight” of a font. There is no accepted, universal meaning to these weight names. Their primary role is to distinguish faces of differing darkness within a single font family. Usage across font families is quite variant; for example a font that you might think of as being bold might be described as being Regular, Roman, Book, Medium, Semi- or DemiBold, Bold, or Black, depending on how black the “normal” face of the font is within the design. Because there is no standard usage of names, the weight property values in CSS1 are given on a numerical scale in which the value ‘400’ (or ‘normal’) corresponds to the “normal” text face for that family. The weight name associated with that face will typically be Book, Regular, Roman, Normal or sometimes Medium.

The association of other weights within a family to the numerical weight values is intended only to preserve the ordering of darkness within that family. However, the following heuristics tell how the assignment is done in typical cases:

If the font family already uses a numerical scale with nine values (such as with OpenType), the font weights should be mapped directly. If there is both a face labeled Medium and one labeled Book, Regular, Roman or Normal, then the Medium is normally assigned to the ‘500’. The font labeled “Bold” will often correspond to the weight value ‘700’. If there are fewer then 9 weights in the family, the default algorithm for filling the “holes” is as follows. If ‘500’ is unassigned, it will be assigned the same font as ‘400’. If any of the values ‘600’, ‘700’, ‘800’ or ‘900’ remains unassigned, they are assigned to the same face as the next darker assigned keyword, if any, or the next lighter one otherwise. If any of ‘300’, ‘200’ or ‘100’ remains unassigned, it is assigned to the next lighter assigned keyword, if any, or the next darker otherwise.

The following two examples illustrate the process. Assume four weights in the “Example1” family, from lightest to darkest: Regular, Medium, Bold, Heavy. And assume six weights in the “Example2” family: Book, Medium, Bold, Heavy, Black, ExtraBlack. Note how in the second example it has been decided not to assign “Example2 ExtraBlack” to anything.

Available faces | Assignments | Filling the holes——————-+————+—————-“Example1 Regular” | 400 | 100, 200, 300”Example1 Medium” | 500 |”Example1 Bold” | 700 | 600”Example1 Heavy” | 800 | 900 Available faces | Assignments | Filling the holes——————-+————+—————-“Example2 Book” | 400 | 100, 200, 300”Example2 Medium” | 500 |”Example2 Bold” | 700 | 600 “Example2 Heavy” | 800 |”Example2 Black” | 900 |”Example2 ExtraBlack” | (none) |

NOTE Corresponding CSS1 definitions is font-weight.

HISTORY New type in IFC2x2 Addendum 2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcFontWeight(IfcEntityInstanceData *e)
IfcFontWeight(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcFooting : public Ifc2x3::IfcBuildingElement

A footing is a part of the foundation of a structure that spreads and transmits the load to the soil, either directly or via piles.

HISTORY New entity in IFC2x2

Note, slab foundations are not instantiated as IfcFooting but as IfcSlab or IfcSlabStandardCase with a predefined type of IfcSlabTypeEnum.BASESLAB.

Property Set Use Definition

The following property set definitions are part of this IFC release:

Pset_FootingCommon: common property set for all footing occurrences. Pset_ReinforcementBarCountOfIndependentFooting: property set for independent IfcFooting occurrences. Pset_ReinforcementBarPitchOfContinuousFooting: property set for continuous IfcFooting occurrences.

Quantity Use Definition The quantities relating to this entity are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_FootingBaseQuantities

Geometry Use Definition

Local placement and product representations are defined by the supertype IfcBuildingElement. Standard representations as defined at IfcBeamStandardCase or IfcSlabStandardCase should be used when applicable.

Public Types

typedef IfcTemplatedEntityList<IfcFooting> list

Public Functions

::Ifc2x3::IfcFootingTypeEnum::Value PredefinedType() const

The generic type of the footing.

IFC 2x4 change: Attribute made optional. Type information can be provided by IfcRelDefinesByType and IfcFootingType.

void setPredefinedType(::Ifc2x3::IfcFootingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcFooting(IfcEntityInstanceData *e)
IfcFooting(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcFootingTypeEnum::Value v9_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcFootingTypeEnum

Public Types

enum Value

Definition from IAI: Enumeration defining the generic footing type.

HISTORY New type in IFC Release 2x2 IFC 2x4 change: Item CAISSON_FOUNDATION added

ENUMERATION

CAISSON_FOUNDATION A foundation construction type used in underwater construction. FOOTING_BEAM Footing elements that are in bending and are supported clear of the ground. They will normally span between piers, piles or pile caps. They are distinguished from beams in the building superstructure since they will normally require a lower grade of finish. They are distinguished from STRIP_FOOTING since they are clear of the ground surface and hence require support to the lower face while the concrete is curing. PAD_FOOTING An element that transfers the load of a single column (possibly two) to the ground. PILE_CAP An element that transfers the load from a column or group of columns to a pier or pile or group of piers or piles. STRIP_FOOTING A linear element that transfers loads into the ground from either a continuous element, such as a wall, or from a series of elements, such as columns. USERDEFINED Special types of footings which meet specific local requirements. NOTDEFINED The type of footing is not defined.

Values:

enumerator IfcFootingType_FOOTING_BEAM
enumerator IfcFootingType_PAD_FOOTING
enumerator IfcFootingType_PILE_CAP
enumerator IfcFootingType_STRIP_FOOTING
enumerator IfcFootingType_USERDEFINED
enumerator IfcFootingType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcForceMeasure : public IfcUtil::IfcBaseType

IfcForceMeasure is a measure of the force. Usually measured in Newton (N, kg m/s2). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcForceMeasure(IfcEntityInstanceData *e)
IfcForceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcFrequencyMeasure : public IfcUtil::IfcBaseType

IfcFrequencyMeasure is a measure of the number of times that an item vibrates in unit time. Usually measured in cycles/s or Herz (Hz). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcFrequencyMeasure(IfcEntityInstanceData *e)
IfcFrequencyMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcFuelProperties : public Ifc2x3::IfcMaterialProperties

Public Types

typedef IfcTemplatedEntityList<IfcFuelProperties> list

Public Functions

bool hasCombustionTemperature() const

Whether the optional attribute CombustionTemperature is defined for this IfcFuelProperties.

double CombustionTemperature() const
void setCombustionTemperature(double v)
bool hasCarbonContent() const

Whether the optional attribute CarbonContent is defined for this IfcFuelProperties.

double CarbonContent() const
void setCarbonContent(double v)
bool hasLowerHeatingValue() const

Whether the optional attribute LowerHeatingValue is defined for this IfcFuelProperties.

double LowerHeatingValue() const
void setLowerHeatingValue(double v)
bool hasHigherHeatingValue() const

Whether the optional attribute HigherHeatingValue is defined for this IfcFuelProperties.

double HigherHeatingValue() const
void setHigherHeatingValue(double v)
const IfcParse::entity &declaration() const
IfcFuelProperties(IfcEntityInstanceData *e)
IfcFuelProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_CombustionTemperature, boost::optional<double> v3_CarbonContent, boost::optional<double> v4_LowerHeatingValue, boost::optional<double> v5_HigherHeatingValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcFurnishingElement : public Ifc2x3::IfcElement

Definition from IAI: Generalization of all furniture related objects. Furnishing objects are characterized as being

pre-manufactured and assembled on-site, or manufactured on-site (built-in)

Thus furnishing elements can either be movable, or not (as the built-ins). HISTORY New entity in IFC Release 2x. IFC2x4 CHANGE The entity is marked as deprecated for instantiation - will be made ABSTRACT after IFC2x4. Geometry Use Definitions: The geometric representation of IfcFurnishingElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representation. Local Placement The local placement for IfcFurnishingElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement , which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Any IfcFurnishingElement can be represented by one or several geometric representations. This includes the general representation types ‘BoundingBox’, ‘GeometricCurveSet’, ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’ being defined here. Bounding Box Representation Any IfcFurnishingElement may be represented as a bounding box, which shows the maximum extend of the body within the coordinated system established by the IfcLocalPlacement. The bounding box representation is the simplest geometric representation available. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Box’ RepresentationType : ‘BoundingBox’

Foot Print Representation The foot print representation of IfcFurnishingElement is given by either a single or multiple 2D points and curves. The representation identifier and type of this geometric representation are:

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’ IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’

SurfaceModel Representation Any IfcFurnishingElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple surface models, based on either shell or face based models. In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape. The representation identifier and type of this geometric representation are:

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’ IfcShapeRepresentation.RepresentationType = ‘SurfaceModel’

Brep Representation Any IfcFurnishingElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). The Brep representation allows for the representation of complex element shape. In some cases it may be useful to also expose a simple representation as a bounding box representation of the same complex shape. The representation identifier and type of this geometric representation are:

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’ IfcShapeRepresentation.RepresentationType = ‘Brep’

MappedRepresentation The IfcMappedItem should always be used in appropriate cases as it allows for reusing the geometry definition of the furnishing type for all occurrences of the same type. The representation identifier and type of this geometric representation are:

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’, or ‘Body’ (depending of the representation map) IfcShapeRepresentation.RepresentationType = ‘MappedRepresentation’

Public Types

typedef IfcTemplatedEntityList<IfcFurnishingElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcFurnishingElement(IfcEntityInstanceData *e)
IfcFurnishingElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcFurnishingElementType : public Ifc2x3::IfcElementType

Definition from IAI: The IfcFurnishingElementType defines a list of commonly shared property set definitions of an element and an optional set of product representations. It is used to define an element specification (i.e. the specific product information, that is common to all occurrences of that product type). NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. A furnishing element type is used to define the common properties of a certain type of a furnishing element that may be applied to many instances of that feature type to assign a specific style. Furnishing element types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences. The occurrences of the IfcFurnishingElementType are represented by instances of IfcFurnishingElement (or its subtypes). HISTORYNew entity in Release IFC2x Edition 2. IFC2x3 CHANGE The entity has been made non-abstract IFC2x4 CHANGE The entity is marked as deprecated for instantiation - will be made ABSTRACT after IFC2x4.

Subclassed by Ifc2x3::IfcFurnitureType, Ifc2x3::IfcSystemFurnitureElementType

Public Functions

const IfcParse::entity &declaration() const
IfcFurnishingElementType(IfcEntityInstanceData *e)
IfcFurnishingElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFurnitureStandard : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcFurnitureStandard> list

Public Functions

const IfcParse::entity &declaration() const
IfcFurnitureStandard(IfcEntityInstanceData *e)
IfcFurnitureStandard(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcFurnitureType : public Ifc2x3::IfcFurnishingElementType

The furnishing element type IfcFurnitureType defines commonly shared information for occurrences of furnitures. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements applicable assignment of process types

It is used to define a furniture specification (i.e. the specific product information, that is common to all occurrences of that product type). Furniture types may be exchanged without being already assigned to occurrences. Occurrences of IfcFurnitureType are represented by instances of IfcFurniture.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFurnishingElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_FurnitureTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_FurnitureTypeChair (CHAIR) Pset_FurnitureTypeDesk (DESK) Pset_FurnitureTypeFileCabinet (FILECABINET) Pset_FurnitureTypeTable (TABLE)

Material Use Definition The material of the IfcFurnitureType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Finish’: The finish, typically at visible aspects of the furniture. ‘Frame’: The frame from which the object is constructed. ‘Hardware’: Finish hardware such as knobs or handles. ‘Padding’: Padding such as cushions. ‘Panel’: Panels such as glass.

Composition Use Definition The IfcFurnitureType may be decomposed into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcFurnitureType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Composition use is defined for the following predefined types:

(All Types): May contain IfcSystemFurnitureElement components. Modular furniture may be aggregated into components.

Public Types

typedef IfcTemplatedEntityList<IfcFurnitureType> list

Public Functions

::Ifc2x3::IfcAssemblyPlaceEnum::Value AssemblyPlace() const

A designation of where the assembly is intended to take place. A selection of alternatives s provided in an enumerated list.

void setAssemblyPlace(::Ifc2x3::IfcAssemblyPlaceEnum::Value v)
const IfcParse::entity &declaration() const
IfcFurnitureType(IfcEntityInstanceData *e)
IfcFurnitureType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcAssemblyPlaceEnum::Value v10_AssemblyPlace)

Public Static Functions

const IfcParse::entity &Class()
class IfcGasTerminalType : public Ifc2x3::IfcFlowTerminalType

Public Types

typedef IfcTemplatedEntityList<IfcGasTerminalType> list

Public Functions

::Ifc2x3::IfcGasTerminalTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcGasTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcGasTerminalType(IfcEntityInstanceData *e)
IfcGasTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcGasTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcGasTerminalTypeEnum

Public Types

enum Value

Values:

enumerator IfcGasTerminalType_GASAPPLIANCE
enumerator IfcGasTerminalType_GASBOOSTER
enumerator IfcGasTerminalType_GASBURNER
enumerator IfcGasTerminalType_USERDEFINED
enumerator IfcGasTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcGeneralMaterialProperties : public Ifc2x3::IfcMaterialProperties

Public Functions

bool hasMolecularWeight() const

Whether the optional attribute MolecularWeight is defined for this IfcGeneralMaterialProperties.

double MolecularWeight() const
void setMolecularWeight(double v)
bool hasPorosity() const

Whether the optional attribute Porosity is defined for this IfcGeneralMaterialProperties.

double Porosity() const
void setPorosity(double v)
bool hasMassDensity() const

Whether the optional attribute MassDensity is defined for this IfcGeneralMaterialProperties.

double MassDensity() const
void setMassDensity(double v)
const IfcParse::entity &declaration() const
IfcGeneralMaterialProperties(IfcEntityInstanceData *e)
IfcGeneralMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_MolecularWeight, boost::optional<double> v3_Porosity, boost::optional<double> v4_MassDensity)

Public Static Functions

const IfcParse::entity &Class()
class IfcGeneralProfileProperties : public Ifc2x3::IfcProfileProperties

Subclassed by Ifc2x3::IfcStructuralProfileProperties

Public Functions

bool hasPhysicalWeight() const

Whether the optional attribute PhysicalWeight is defined for this IfcGeneralProfileProperties.

double PhysicalWeight() const
void setPhysicalWeight(double v)
bool hasPerimeter() const

Whether the optional attribute Perimeter is defined for this IfcGeneralProfileProperties.

double Perimeter() const
void setPerimeter(double v)
bool hasMinimumPlateThickness() const

Whether the optional attribute MinimumPlateThickness is defined for this IfcGeneralProfileProperties.

double MinimumPlateThickness() const
void setMinimumPlateThickness(double v)
bool hasMaximumPlateThickness() const

Whether the optional attribute MaximumPlateThickness is defined for this IfcGeneralProfileProperties.

double MaximumPlateThickness() const
void setMaximumPlateThickness(double v)
bool hasCrossSectionArea() const

Whether the optional attribute CrossSectionArea is defined for this IfcGeneralProfileProperties.

double CrossSectionArea() const
void setCrossSectionArea(double v)
const IfcParse::entity &declaration() const
IfcGeneralProfileProperties(IfcEntityInstanceData *e)
IfcGeneralProfileProperties(boost::optional<std::string> v1_ProfileName, ::Ifc2x3::IfcProfileDef *v2_ProfileDefinition, boost::optional<double> v3_PhysicalWeight, boost::optional<double> v4_Perimeter, boost::optional<double> v5_MinimumPlateThickness, boost::optional<double> v6_MaximumPlateThickness, boost::optional<double> v7_CrossSectionArea)

Public Static Functions

const IfcParse::entity &Class()
class IfcGeometricCurveSet : public Ifc2x3::IfcGeometricSet

Definition from ISO/CD 10303-42:1992: A geometric curve set is a collection of two or three dimensional points and curves.

The IfcGeometricCurveSet is used for the exchange of shape representations consisting of (2D or 3D) points and curves only.

NOTE: Corresponding ISO 10303-42 entity: geometric_set. Please refer to ISO/IS 10303-42:1994, p. 190 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcGeometricCurveSet> list

Public Functions

const IfcParse::entity &declaration() const
IfcGeometricCurveSet(IfcEntityInstanceData *e)
IfcGeometricCurveSet(IfcEntityList::ptr v1_Elements)

Public Static Functions

const IfcParse::entity &Class()
struct IfcGeometricProjectionEnum

Public Types

enum Value

IfcGeometricProjectionEnum defines the various representation types that can be semantically distinguished. Often different levels of detail of the shape representation are controlled by the representation type.

GRAPH_VIEW: Geometric display representation that shows an abstract, often 1D element representation, e.g. representing a wall by its axis line. SKETCH_VIEW: Geometric display representation that shows an abstract, often 2D element representation, e.g. representing a wall by its two foot print edges, surpressing any inner layer representation. MODEL_VIEW: Geometric display representation that shows a full 3D element representation, e.g. representing a wall by its volumetric body. PLAN_VIEW: Geometric display representation that shows a full 2D element representation, the level of detail often depends on the target scale, e.g. representing a wall by its two foot print edges and the edges of all inner layers. The projection is shown in ground view as seen from above. REFLECTED_PLAN_VIEW: Geometric display representation that shows a full 2D element representation, the level of detail often depends on the target scale, e.g. representing a wall by its two foot print edges and the edges of all inner layers. The projection is shown in ground view as seen from below. SECTION_VIEW: Geometric display representation that shows a full 2D element representation, the level of detail often depends on the target scale, e.g. representing a wall by its two inner/outer edges and the edges of all inner layers, if the element is cut by the section line. ELEVATION_VIEW: Geometric display representation that shows a full 2D element representation, the level of detail often depends on the target scale, e.g. representing a wall by its bounding edges if the element is within an elevation view. USERDEFINED: A user defined specification is given by the value of the UserDefinedTargetView attribute. NOTDEFINED: No specification given.

HISTORY: New Type in Release IFC2x2.

Values:

enumerator IfcGeometricProjection_GRAPH_VIEW
enumerator IfcGeometricProjection_SKETCH_VIEW
enumerator IfcGeometricProjection_MODEL_VIEW
enumerator IfcGeometricProjection_PLAN_VIEW
enumerator IfcGeometricProjection_REFLECTED_PLAN_VIEW
enumerator IfcGeometricProjection_SECTION_VIEW
enumerator IfcGeometricProjection_ELEVATION_VIEW
enumerator IfcGeometricProjection_USERDEFINED
enumerator IfcGeometricProjection_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcGeometricRepresentationContext : public Ifc2x3::IfcRepresentationContext

Definition from ISO/CD 10303-42:1992: A geometric representation context is a representation context in which the geometric representation items are geometrically founded. A geometric representation context is a distinct coordinate space, spatially unrelated to other coordinate spaces.

IfcGeometricRepresentationContext defines the context that applies to several shape representations of products within a project. It defines the type of the context in which the shape representation is defined, and the numeric precision applicable to the geometric representation items defined in this context. In addition it can be used to offset the project coordinate system from a global point of origin, using the WorldCoordinateSystem attribute.

As shown in Figure 329, the TrueNorth attribute should be provided if the y axis of the WorldCoordinateSystem does not point to the global northing. Direction of the true north, or geographic northing direction, relative to the underlying project coordinate system as established by the attribute WorldCoordinateSystem. It is given by a 2 dimensional direction within the xy-plane of the project coordinate system. If not resent, it defaults to [0.,1.] - i.e. the positive Y axis of the project coordinate system equals the geographic northing direction. The direction is provided within project coordinate system and identifies the true north direction (see figure).

Figure 329 — Geometric representation context true north

NOTEThe inherited attribute ContextType shall have one of the following recognized values: ‘Sketch’, ‘Outline’, ‘Design’, ‘Detail’, ‘Model’, ‘Plan’, ‘NotDefined’.

The use of one instance of IfcGeometricRepresentationContext to represent the model (3D) view is mandatory, the use of a second instance of IfcGeometricRepresentationContext to represent the plan (2D) view is optional (but needs to be given, if there are scale dependent plan views), the additional scale or view dependent contexts need to be handled by using the subtype IfcGeometricRepresentationSubContext pointing to the model view (or the plan view) as the ParentContext.

Figure 330 illustrates use of representation contexts defined at IfcProject for 3D model and 2D plan context, including sub context definitions for different target scales.

Figure 330 — Geometric representation context use

NOTE The definition of this class relates to the ISO 10303 entity geometric_representation_context. Please refer to ISO/IS 10303-42:1994 for the final definition of the formal standard.

HISTORYNew Entity in IFC Release 2.0

IFC2x3 CHANGEApplicable values for ContextType are only ‘Model’, ‘Plan’, and’NotDefined’. All other sub contexts are now handled by the new subtype in IFC2x Edition 2 IfcGeometricRepresentationSubContext. Upward compatibility for file based exchange is guaranteed.

Subclassed by Ifc2x3::IfcGeometricRepresentationSubContext

Public Functions

int CoordinateSpaceDimension() const

The integer dimension count of the coordinate space modeled in a geometric representation context.

void setCoordinateSpaceDimension(int v)
bool hasPrecision() const

Whether the optional attribute Precision is defined for this IfcGeometricRepresentationContext.

double Precision() const

Value of the model precision for geometric models. It is a double value (REAL), typically in 1E-5 to 1E-8 range, that indicates the tolerance under which two given points are still assumed to be identical. The value can be used e.g. to sets the maximum distance from an edge curve to the underlying face surface in brep models.

void setPrecision(double v)
::Ifc2x3::IfcAxis2Placement *WorldCoordinateSystem() const

Establishment of the engineering coordinate system (often referred to as the world coordinate system in CAD) for all representation contexts used by the project.

Note it can be used to provide better numeric stability if the placement of the building(s) is far away from the origin. In most cases however it would be set to origin: (0.,0.,0.) and directions x(1.,0.,0.), y(0.,1.,0.), z(0.,0.,1.).

void setWorldCoordinateSystem(::Ifc2x3::IfcAxis2Placement *v)
bool hasTrueNorth() const

Whether the optional attribute TrueNorth is defined for this IfcGeometricRepresentationContext.

::Ifc2x3::IfcDirection *TrueNorth() const

Direction of the true north, or geographic northing direction, relative to the underlying project coordinate system. It is given by a 2 dimensional direction within the xy-plane of the project coordinate system. If not resent, it defaults to 0. 1. - i.e. the positive Y axis of the project coordinate system equals the geographic northing direction.

void setTrueNorth(::Ifc2x3::IfcDirection *v)
IfcTemplatedEntityList<IfcGeometricRepresentationSubContext>::ptr HasSubContexts() const
const IfcParse::entity &declaration() const
IfcGeometricRepresentationContext(IfcEntityInstanceData *e)
IfcGeometricRepresentationContext(boost::optional<std::string> v1_ContextIdentifier, boost::optional<std::string> v2_ContextType, int v3_CoordinateSpaceDimension, boost::optional<double> v4_Precision, ::Ifc2x3::IfcAxis2Placement *v5_WorldCoordinateSystem, ::Ifc2x3::IfcDirection *v6_TrueNorth)

Public Static Functions

const IfcParse::entity &Class()
class IfcGeometricRepresentationItem : public Ifc2x3::IfcRepresentationItem

Definition from ISO/CD 10303-43:1992: An geometric representation item is a representation item that has the additional meaning of having geometric position or orientation or both. This meaning is present by virtue of:

being a Cartesian point or a direction

referencing directly a Cartesian point or direction

referencing indirectly a Cartesian point or direction

An indirect reference to a Cartesian point or direction means that a given geometric item references the Cartesian point or direction through one or more intervening geometry or topology items.

EXAMPLE: Consider a circle. It gains its geometric position and orientation by virtue of a reference to axis2_placement (IfcAxis2Placement) that is turn references a cartesian_point (IfcCartesianPoint) and several directions (IfcDirection).

EXAMPLE: Consider a manifold brep. A manifold_solid_brep (IfcManifoldSolidBrep) is a geometric_representation_item (IfcGeometricRepresentationItem) that through several layers of topological_representation_item’s (IfcTopologicalRepresentationItem) references poly loops (IfcPolyLoop). Through additional intervening entities poly loops reference cartesian_point’s (IfcCartesianPoint).

The derivation of the dimensionality of the IfcGeometricRepresentationItem is different to ISO 10303; there is a specific derived attribute at each class that defines the dimensionality, whereas ISO 10303 does it for the representation_context and requires all geometric_representation_item’s to have the same dimensionality therein.

The definition of swept area solids as geometric representation items is different to ISO 10303; it is based on a set of predefined profiles (or cross sections), that is, a set of parameterized geometric primitives widely supported in the industry. Those profiles are used to create volumes through extrusion, revolution and cross section based sweep operations.

NOTE: Corresponding ISO 10303 entity: geometric_representation_item. Please refer to ISO/IS 10303-42:1994, p. 22 for the final definition of the formal standard. The following changes have been made: It does not inherit from ISO/IS 10303-43:1994 entity representation_item. The derived attribute Dim is demoted to the appropriate subtypes. The WR1 has not been incorporated. Not all subtypes that are in ISO/IS 10303-42:1994 have been added to the current IFC Release.

HISTORY: New entity in IFC Release 1.5

Subclassed by Ifc2x3::IfcAnnotationFillArea, Ifc2x3::IfcAnnotationSurface, Ifc2x3::IfcBooleanResult, Ifc2x3::IfcBoundingBox, Ifc2x3::IfcCartesianTransformationOperator, Ifc2x3::IfcCompositeCurveSegment, Ifc2x3::IfcCsgPrimitive3D, Ifc2x3::IfcCurve, Ifc2x3::IfcDefinedSymbol, Ifc2x3::IfcDirection, Ifc2x3::IfcDraughtingCallout, Ifc2x3::IfcFaceBasedSurfaceModel, Ifc2x3::IfcFillAreaStyleHatching, Ifc2x3::IfcFillAreaStyleTiles, Ifc2x3::IfcFillAreaStyleTileSymbolWithStyle, Ifc2x3::IfcGeometricSet, Ifc2x3::IfcHalfSpaceSolid, Ifc2x3::IfcLightSource, Ifc2x3::IfcOneDirectionRepeatFactor, Ifc2x3::IfcPlacement, Ifc2x3::IfcPlanarExtent, Ifc2x3::IfcPoint, Ifc2x3::IfcSectionedSpine, Ifc2x3::IfcShellBasedSurfaceModel, Ifc2x3::IfcSolidModel, Ifc2x3::IfcSurface, Ifc2x3::IfcTextLiteral, Ifc2x3::IfcVector

Public Functions

const IfcParse::entity &declaration() const
IfcGeometricRepresentationItem(IfcEntityInstanceData *e)
IfcGeometricRepresentationItem()

Public Static Functions

const IfcParse::entity &Class()
class IfcGeometricRepresentationSubContext : public Ifc2x3::IfcGeometricRepresentationContext

IfcGeometricRepresentationSubContext defines the context that applies to several shape representations of a product being a sub context, sharing the WorldCoordinateSystem, CoordinateSpaceDimension, Precision and TrueNorth attributes with the parent IfcGeometricRepresentationContext.

The IfcGeometricRepresentationSubContext is used to define semantically distinguished representation types for different information content, dependent on the representation view and the target scale. It can be used to control the level of detail of the shape representation that is most applicable to this geometric representation context. addition the sub context is used to control the later appearance of the IfcShapeRepresentation within a plot view.

NOTE If the IfcShapeRepresentation using this sub context has IfcStyledItem’s assigned to the Items, the presentation style information (e.g. IfcCurveStyle, IfcTextStyle) associated with the IfcStyledItem is given in target plot dimensions. For example, a line thickness (IfcCurveStyle.CurveWidth) is given by a thickness measure relating to the thickness for a plot within the (range of) target scale.

Each IfcProduct can then have several instances of subtypes of IfcRepresentation, each being assigned to a different geometric representation context (IfcGeometricRepresentationContext or IfcGeometricRepresentationSubContext). The application can then choose the most appropriate representation for showing the geometric shape of the product, depending on the target view and scale.

NOTE The provision of a model view (IfcGeometricRepresentationContext.ContextType = ‘Model’) is mandatory. Instances of IfcGeometricRepresentationSubContext relate to it as its ParentContext.

EXAMPLE Instances of IfcGeometricRepresentationSubContext can be used to handle the multi-view blocks or macros, which are used in CAD programs to store several scale and/or view dependent geometric representations of the same object.

HISTORY New entity in Release IFC 2x2.

Public Functions

::Ifc2x3::IfcGeometricRepresentationContext *ParentContext() const

Parent context from which the sub context derives its world coordinate system, precision, space coordinate dimension and true north.

void setParentContext(::Ifc2x3::IfcGeometricRepresentationContext *v)
bool hasTargetScale() const

Whether the optional attribute TargetScale is defined for this IfcGeometricRepresentationSubContext.

double TargetScale() const

The target plot scale of the representation to which this representation context applies. Scale indicates the target plot scale for the representation sub context, all annotation styles are given in plot dimensions according to this target plot scale. If multiple instances of IfcGeometricRepresentationSubContext are given having the same TargetView value, the target plot scale applies up to the next smaller scale, or up to unlimited small scale.

Note: Scale 1:100 (given as 0.01 within TargetScale) is bigger then 1:200 (given as 0.005 within TargetScale).

void setTargetScale(double v)
::Ifc2x3::IfcGeometricProjectionEnum::Value TargetView() const

Target view of the representation to which this representation context applies.

void setTargetView(::Ifc2x3::IfcGeometricProjectionEnum::Value v)
bool hasUserDefinedTargetView() const

Whether the optional attribute UserDefinedTargetView is defined for this IfcGeometricRepresentationSubContext.

std::string UserDefinedTargetView() const

User defined target view, this attribute value shall be given, if the TargetView attribute is set to USERDEFINED.

void setUserDefinedTargetView(std::string v)
const IfcParse::entity &declaration() const
IfcGeometricRepresentationSubContext(IfcEntityInstanceData *e)
IfcGeometricRepresentationSubContext(boost::optional<std::string> v1_ContextIdentifier, boost::optional<std::string> v2_ContextType, ::Ifc2x3::IfcGeometricRepresentationContext *v7_ParentContext, boost::optional<double> v8_TargetScale, ::Ifc2x3::IfcGeometricProjectionEnum::Value v9_TargetView, boost::optional<std::string> v10_UserDefinedTargetView)

Public Static Functions

const IfcParse::entity &Class()
class IfcGeometricSet : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: This entity is intended for the transfer of models when a topological structure is not available.

The IfcGeometricSet is used for the exchange of shape representations consisting of (2D or 3D) points, curves, and/or surfaces, which do not have a topological structure (such as connected face sets or shells) and are not solid models (such as swept solids, CSG or Brep)

NOTE: Corresponding ISO 10303-42 entity: geometric_set. The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item. Please refer to ISO/IS 10303-42:1994, p. 190 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcGeometricCurveSet

Public Types

typedef IfcTemplatedEntityList<IfcGeometricSet> list

Public Functions

IfcEntityList::ptr Elements() const

The geometric elements which make up the geometric set, these may be points, curves or surfaces; but are required to be of the same coordinate space dimensionality.

void setElements(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcGeometricSet(IfcEntityInstanceData *e)
IfcGeometricSet(IfcEntityList::ptr v1_Elements)

Public Static Functions

const IfcParse::entity &Class()
class IfcGloballyUniqueId : public IfcUtil::IfcBaseType

An IfcGloballyUniqueId holds an encoded string identifier that is used to uniquely identify an IFC object. An IfcGloballyUniqueId is a Globally Unique Identifier (GUID) which is an auto-generated 128-bit number. Since this identifier is required for all IFC object instances, it is desirable to compress it to reduce overhead. The encoding of the base 64 character set is shown below:

123456

0123456789012345678901234567890123456789012345678901234567890123

“0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_$”;

The resulting string is a fixed 22 character length string to be exchanged within the IFC exchange file structure.

Refer to the BuildingSMART website (www.buildingsmart-tech.org) for more information and sample encoding algorithms.

HISTORY New type in IFC R1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcGloballyUniqueId(IfcEntityInstanceData *e)
IfcGloballyUniqueId(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcGlobalOrLocalEnum

Public Types

enum Value

This enumeration type defines if the local object coordinate system or the global world coordinate system for the project is used to describe the measure values of entities which have a reference to this type.

NOTE The world coordinate system is given by the IfcGeometricRepresentationContext.WorldCoordinateSystem and is unique within the project. The local (or object) coordinate system is given by IfcProduct.ObjectPlacement and is used by all IfcRepresentation’s within the IfcProduct.Representation.

HISTORY: New type in IFC2x2.

Values:

enumerator IfcGlobalOrLocal_GLOBAL_COORDS
enumerator IfcGlobalOrLocal_LOCAL_COORDS

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcGrid : public Ifc2x3::IfcProduct

IfcGrid ia a planar design grid defined in 3D space used as an aid in locating structural and design elements. The position of the grid (ObjectPlacement) is defined by a 3D coordinate system (and thereby the design grid can be used in plan, section or in any position relative to the world coordinate system). The position can be relative to the object placement of other products or grids. The XY plane of the 3D coordinate system is used to place the grid axes, which are 2D curves (for example, line, circle, trimmed curve, polyline, or composite curve). The inherited attributes Name and Description can be used to define a descriptive name of the grid and to indicate the grid’s purpose.A grid is defined by (normally) two, or (in case of a triangular grid) three lists of grid axes. The following table shows some examples. A grid may support a rectangular layout (Figure 28), a radial layout (Figure 29), or a triangular layout (Figure 30).

Figure 28 — Grid rectangular layout Figure 29 — Grid radial layout Figure 30 — Grid triangular layout

The grid axes, defined within the design grid, are those elements to which project objects will be placed relatively using the IfcGridPlacement.

HISTORY New entity in IFC Release 1.0. Informal Proposition

Grid axes, which are referenced in different lists of axes (UAxes, VAxes, WAxes) shall not be parallel. Grid axes should be defined such as there are no two grid axes which intersect twice (see Figure 31).

left side: ambiguous intersections A1 and A2, a grid containing such grid axes is not a valid design grid. right side: the conflict can be resolved by splitting one grid axis in a way, such as no ambiguous intersections exist.

Figure 31 — Grid intersections

Geometry Use Definitions The geometric representation of IfcGrid is given by the IfcProductDefinitionShape, allowing geometric representations. Included are: Local Placement The local placement for IfcGrid is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Currently, the use of a 2D ‘FootPrint’ representation of type ‘GeometricCurveSet’ is supported. GeometricCurveSet representation The 2D geometric representation of IfcGrid is defined using the ‘GeometricCurveSet’ geometry. The following attribute values should be inserted

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’. IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’ .

The following constraints apply to the 2D representation:

The IfcGeometricCurveSet shall be an (and the only) Item of the IfcShapeRepresentation. It should contain an IfcGeometricCurveSet containing subtypes of IfcCurve, each representing a grid axis. Applicable subtypes of IfcCurve are: IfcPolyline, IfcCircle, IfcTrimmedCurve (based on BaseCurve referencing IfcLine or IfcCircle). Each subtype of IfcCurve may have a curve style assigned, using IfcAnnotationCurveOccurrence referencing IfcCurveStyle. Optionally the grid axis labels may be added as IfcTextLiteral, and they may have text styles assigned, using IfcAnnotationTextOccurrence referencing IfcTextStyle.

As shown in Figure 32, the IfcGrid defines a placement coordinate system using the ObjectPlacement. The XY plane of the coordinate system is used to place the 2D grid axes. The Representation of IfcGrid is defined using IfcProductRepresentation, referencing an IfcShapeRepresentation, that includesIfcGeometricCurveSet as Items. All grid axes are added as IfcPolyline to the IfcGeometricCurveSet.

Figure 32 — Grid layout

As shown in Figure 33, the attributes UAxes and VAxes define lists of IfcGridAxis within the context of thegrid. Each instance of IfcGridAxis refers to the same instance of IfcCurve (here the subtype IfcPolyline) that is contained within the IfcGeometricCurveSet that represents the IfcGrid.

Figure 33 — Grid representation

Public Types

typedef IfcTemplatedEntityList<IfcGrid> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr UAxes() const

List of grid axes defining the first row of grid lines.

void setUAxes(IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v)
IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr VAxes() const

List of grid axes defining the second row of grid lines.

void setVAxes(IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v)
bool hasWAxes() const

Whether the optional attribute WAxes is defined for this IfcGrid.

IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr WAxes() const

List of grid axes defining the third row of grid lines. It may be given in the case of a triangular grid.

void setWAxes(IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v)
IfcTemplatedEntityList<IfcRelContainedInSpatialStructure>::ptr ContainedInStructure() const
const IfcParse::entity &declaration() const
IfcGrid(IfcEntityInstanceData *e)
IfcGrid(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v8_UAxes, IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v9_VAxes, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr> v10_WAxes)

Public Static Functions

const IfcParse::entity &Class()
class IfcGridAxis : public IfcUtil::IfcBaseEntity

An individual axis, IfcGridAxis, is defined in the context of a design grid. The axis definition is based on a curve of dimensionality 2. The grid axis is positioned within the XY plane of the position coordinate system defined by the IfcDesignGrid.

HISTORY New entity in IFC Release 1.0

Geometry use definitions The standard geometric representation of IfcGridAxis is defined using a 2D curve entity. Grid axes are normally defined by an offset to another axis. The IfcOffsetCurve2D supports this concept. Each grid axis has a sense given by the parameterization of the curve. The attribute SameSense is an indicator of whether or not the sense of the grid axis agrees with, or opposes, that of the underlying curve. As shown in Figure 242, the grid axis is defined as a 2D curve within the xy plane of the position coordinate system. Any curve can be used to define a grid axis, most common is the use of IfcLine for linear grids and IfcCircle for radial grids. Most grids are defined by a pair of axis lists, each defined by a base grid axis and axes given by an offset to the base axis. The use of IfcOffsetCurve2D as underlying AxisCurve supports this concept.

Figure 242 — Grid axis

Public Types

typedef IfcTemplatedEntityList<IfcGridAxis> list

Public Functions

bool hasAxisTag() const

Whether the optional attribute AxisTag is defined for this IfcGridAxis.

std::string AxisTag() const

The tag or name for this grid axis.

void setAxisTag(std::string v)
::Ifc2x3::IfcCurve *AxisCurve() const

Underlying curve which provides the geometry for this grid axis.

void setAxisCurve(::Ifc2x3::IfcCurve *v)
bool SameSense() const

Defines whether the original sense of curve is used or whether it is reversed in the context of the grid axis.

void setSameSense(bool v)
IfcTemplatedEntityList<IfcGrid>::ptr PartOfW() const
IfcTemplatedEntityList<IfcGrid>::ptr PartOfV() const
IfcTemplatedEntityList<IfcGrid>::ptr PartOfU() const
IfcTemplatedEntityList<IfcVirtualGridIntersection>::ptr HasIntersections() const
const IfcParse::entity &declaration() const
IfcGridAxis(IfcEntityInstanceData *e)
IfcGridAxis(boost::optional<std::string> v1_AxisTag, ::Ifc2x3::IfcCurve *v2_AxisCurve, bool v3_SameSense)

Public Static Functions

const IfcParse::entity &Class()
class IfcGridPlacement : public Ifc2x3::IfcObjectPlacement

IfcGridPlacement provides a specialization of IfcObjectPlacement in which the placement and axis direction of the object coordinate system is defined by a reference to the design grid as defined in IfcGrid. The location of the object coordinate system is given by the attribute PlacementLocation. It is defined as an IfcVirtualGridIntersection, that is, an intersection between two grid axes with optional offsets. The axis direction of the x-axis of the object coordinate system is given either:

PlacementRefDirection = NIL: by the tangent of the first grid axis (PlacementLocation.IntersectingAxes[1]) at the virtual intersection (maybe using the offset curve, if PlacementLocation.OffsetDistances is given); PlacementRefDirection = IfcDirection: by the explicitly provided direction information; PlacementRefDirection = IfcVirtualGridIntersection: by the tangent between the virtual grid intersection of PlacementLocation and the virtual grid intersection of PlacementRefDirection. Offsets as potentially provided in the IfcVirtualGridIntersection’s of PlacementLocation and PlacementRefDirection have to be taken into account.

The direction of the y-axis of the IfcGridPlacement is the orthogonal complement to the x-axis. The plane defined by the x and y axis shall be co-planar to the xy plane of the local placement of the IfcGrid. The direction of the z-axis is the orientation of the cross product of the x-axis and the y-axis, i.e. the z-axis of the IfcGridPlacement shall be co-linear to the z-axis of the local placement of the IfcGrid.

NOTE The IfcGrid local placement, that can be provided relative to the local placement of another spatial structure element, has to be taken into account for calculating the absolute placement of the virtual grid intersection.

NOTE The PlacementLocation.OffsetDistances[3] and the PlacementRefDirection.OffsetDistances[3] shall either not be assigned or should have the same z offset value.

HISTORY New entity in IFC Release 1.5. The entity name was changed from IfcConstrainedPlacement in IFC Release 2x.

IFC2x4 CHANGE Attribute data type of PlacementRefDirection has been changed to IfcGridPlacementDirectionSelect.

Geometry use definitions The following examples show the usage of placement location and direction for an IfcGridPlacement.

Figure 243 illustrates the case where PlacementRefDirection is not given - the object coordinate system is defined by:

its location: given by the virtual grid intersection of PlacementLocation its x-axis direction: given by the tangent of the first intersecting axis in the offset location of the virtual grid intersection

Figure 243 — Grid placement

Figure 244 illustrates the case where PlacementRefDirection is given as an IfcDirection- the object coordinate system is defined by:

its location: given by the virtual grid intersection of PlacementLocation its x-axis direction: given by the DirectionRatios of the IfcDirection, only the ratios for x and y are taken into account,

Figure 244 — Grid placement with direction

Figure 245 illustrates the case where PlacementRefDirection is given as an IfcVirtualGridIntersection- the object coordinate system is defined by:

its location: given by the virtual grid intersection of PlacementLocation its x-axis direction: given by the tangent of the line between the virtual grid intersection of the PlacementLocation and the virtual grid intersection of the PlacementRefDirection.

Figure 245 — Grid placement with intersection

Public Types

typedef IfcTemplatedEntityList<IfcGridPlacement> list

Public Functions

::Ifc2x3::IfcVirtualGridIntersection *PlacementLocation() const

Placement of the object coordinate system defined by the intersection of two grid axes.

void setPlacementLocation(::Ifc2x3::IfcVirtualGridIntersection *v)
bool hasPlacementRefDirection() const

Whether the optional attribute PlacementRefDirection is defined for this IfcGridPlacement.

::Ifc2x3::IfcVirtualGridIntersection *PlacementRefDirection() const

Reference to either an explicit direction, or a second grid axis intersection, which defines the orientation of the grid placement.

IFC2x4 CHANGE The select of an explict direction has been added.

void setPlacementRefDirection(::Ifc2x3::IfcVirtualGridIntersection *v)
const IfcParse::entity &declaration() const
IfcGridPlacement(IfcEntityInstanceData *e)
IfcGridPlacement(::Ifc2x3::IfcVirtualGridIntersection *v1_PlacementLocation, ::Ifc2x3::IfcVirtualGridIntersection *v2_PlacementRefDirection)

Public Static Functions

const IfcParse::entity &Class()
class IfcGroup : public Ifc2x3::IfcObject

IfcGroup is an generalization of any arbitrary group. A group is a logical collection of objects. It does not have its own position, nor can it hold its own shape representation. Therefore a group is an aggregation under some non-geometrical / topological grouping aspects.

NOTE Use IfcRelDecomposes together with the appropriate subtypes of IfcProduct to define an aggregation of products that may have its own position and shape representation.

EXAMPLE An example for a group is a system, since it groups elements under the aspect of their role, regardless of their position in a building.

A group can hold any collection of objects (beingproducts, processes, controls, resources, actors or other groups). Thus groups can be nested. An object can be part of zero, one, or many groups. Grouping relationships are not required to be hierarchical nor do they imply a dependency.

NOTE Use IfcRelDecomposes together with the appropriate subtypes of IfcProduct to define an hierarchical aggregation of products.

A group can be exchanged without having already objects within the group collection.

HISTORY New entity in IFC Release 1.0.

IFC2x4 CHANGE The inverse IsGroupedBy relationship is set to 0..n

Relationship use definition The group collection is handled by an instance of IfcRelAssignsToGroup, which assigns all group members to the IfcGroup.

Objects: included in group using IfcRelAssignsToGroup

Groups are assigned to other objects (such as a process or a resource) by the relationship object that refers to the corresponding object:

Process: assigned using IfcRelAssignsToProcess Resource: assigned using IfcRelAssignsToResource

Groups can be subjected to a control. The control information is then assigned:

Controls: affecting the group using IfcRelAssignsToControl

Subclassed by Ifc2x3::IfcAsset, Ifc2x3::IfcCondition, Ifc2x3::IfcInventory, Ifc2x3::IfcStructuralLoadGroup, Ifc2x3::IfcStructuralResultGroup, Ifc2x3::IfcSystem, Ifc2x3::IfcZone

Public Types

typedef IfcTemplatedEntityList<IfcGroup> list

Public Functions

IfcTemplatedEntityList<IfcRelAssignsToGroup>::ptr IsGroupedBy() const
const IfcParse::entity &declaration() const
IfcGroup(IfcEntityInstanceData *e)
IfcGroup(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcHalfSpaceSolid : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A half space solid is defined by the half space which is the regular subset of the domain which lies on one side of an unbounded surface. The side of the surface which is in the half space is determined by the surface normal and the agreement flag. If the agreement flag is TRUE, then the subset is the one the normal points away from. If the agreement flag is FALSE, then the subset is the one the normal points into. For a valid half space solid the surface shall divide the domain into exactly two subsets. Also, within the domain the surface shall be manifold and all surface normals shall point into the same subset.

NOTE A half space is not a subtype of solid model (IfcSolidModel), half space solids are only useful as operands in Boolean expressions.

NOTE Corresponding STEP entity: half_space_solid. Please refer to ISO/IS 10303-42:1994, p. 185 for the final definition of the formal standard. The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item.

HISTORY New class in IFC Release 1.5

Informal propositions:

The base surface shall divide the domain into exactly two subsets. If the half space solid is of subtype boxed half space (IfcBoxedHalfSpace), the domain in question is that of the attribute enclosure. In all other cases the domain is all of space and the base surface shall be unbounded. The base surface shall be an unbounded surface (subtype of IfcElementarySurface).

Figure 258 illustrates the definition of the IfcHalfSpaceSolid within a given coordinate system. The base surface is given by an unbounded plane, the red boundary is shown for visualization purposes only.

Figure 258 — Half space solid geometry

Subclassed by Ifc2x3::IfcBoxedHalfSpace, Ifc2x3::IfcPolygonalBoundedHalfSpace

Public Types

typedef IfcTemplatedEntityList<IfcHalfSpaceSolid> list

Public Functions

::Ifc2x3::IfcSurface *BaseSurface() const

Surface defining side of half space.

void setBaseSurface(::Ifc2x3::IfcSurface *v)
bool AgreementFlag() const

The agreement flag is TRUE if the normal to the BaseSurface points away from the material of the IfcHalfSpaceSolid. Otherwise it is FALSE.

void setAgreementFlag(bool v)
const IfcParse::entity &declaration() const
IfcHalfSpaceSolid(IfcEntityInstanceData *e)
IfcHalfSpaceSolid(::Ifc2x3::IfcSurface *v1_BaseSurface, bool v2_AgreementFlag)

Public Static Functions

const IfcParse::entity &Class()
class IfcHeatExchangerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcHeatExchangerType defines commonly shared information for occurrences of heat exchangers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a heat exchanger specification (i.e. the specific product information, that is common to all occurrences of that product type). Heat Exchanger types may be exchanged without being already assigned to occurrences. Occurrences of IfcHeatExchangerType are represented by instances of IfcHeatExchanger.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_HeatExchangerTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_HeatExchangerTypePlate (PLATE)

Material Use Definition The material of the IfcHeatExchangerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Shell’: Material used to construct the shell of the heat exchanger.

Port Use Definition The distribution ports relating to the IfcHeatExchangerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcHeatExchanger for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcHeatExchangerType> list

Public Functions

::Ifc2x3::IfcHeatExchangerTypeEnum::Value PredefinedType() const

Defines the basic types of heat exchanger (e.g., plate, shell and tube, etc.).

void setPredefinedType(::Ifc2x3::IfcHeatExchangerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcHeatExchangerType(IfcEntityInstanceData *e)
IfcHeatExchangerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcHeatExchangerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcHeatExchangerTypeEnum

Public Types

enum Value

Enumeration defining the typical types of heat exchangers. The IfcHeatExchangerTypeEnum contains the following:

PLATE: Plate heat exchanger. SHELLANDTUBE: Shell and Tube heat exchanger. USERDEFINED: User-defined heat exchanger type. NOTDEFINED: Undefined heat exchanger type.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcHeatExchangerType_PLATE
enumerator IfcHeatExchangerType_SHELLANDTUBE
enumerator IfcHeatExchangerType_USERDEFINED
enumerator IfcHeatExchangerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcHeatFluxDensityMeasure : public IfcUtil::IfcBaseType

IfcHeatFluxDensityMeasure is a measure of the density of heat flux within a body. Usually measured in W/m2 (J/s m2). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcHeatFluxDensityMeasure(IfcEntityInstanceData *e)
IfcHeatFluxDensityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcHeatingValueMeasure : public IfcUtil::IfcBaseType

IfcHeatingValueMeasure defines the amount of energy released (usually in MJ/kg) when a fuel is burned.

HISTORY: This is new type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcHeatingValueMeasure(IfcEntityInstanceData *e)
IfcHeatingValueMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcHourInDay : public IfcUtil::IfcBaseType

Public Functions

const IfcParse::type_declaration &declaration() const
IfcHourInDay(IfcEntityInstanceData *e)
IfcHourInDay(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcHumidifierType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcHumidifierType defines commonly shared information for occurrences of humidifiers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a humidifier specification (i.e. the specific product information, that is common to all occurrences of that product type). Humidifier types may be exchanged without being already assigned to occurrences. Occurrences of IfcHumidifierType are represented by instances of IfcHumidifier.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_HumidifierTypeCommon

Material Use Definition The material of the IfcHumidifierType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcHumidifierType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcHumidifier for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcHumidifierType> list

Public Functions

::Ifc2x3::IfcHumidifierTypeEnum::Value PredefinedType() const

Defines the type of humidifier.

void setPredefinedType(::Ifc2x3::IfcHumidifierTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcHumidifierType(IfcEntityInstanceData *e)
IfcHumidifierType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcHumidifierTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcHumidifierTypeEnum

Public Types

enum Value

Enumeration defining the typical types of humidifiers. The IfcHumidifierTypeEnum contains the following:

STEAMINJECTION: Water vapor is added into the airstream through direction steam injection. ADIABATICAIRWASHER: Water vapor is added into the airstream through adiabatic evaporation using an air washing element. ADIABATICPAN: Water vapor is added into the airstream through adiabatic evaporation using a pan. ADIABATICWETTEDELEMENT: Water vapor is added into the airstream through adiabatic evaporation using a wetted element. ADIABATICATOMIZING: Water vapor is added into the airstream through adiabatic evaporation using an atomizing element. ADIABATICULTRASONIC: Water vapor is added into the airstream through adiabatic evaporation using an ultrasonic element. ADIABATICRIGIDMEDIA: Water vapor is added into the airstream through adiabatic evaporation using a rigid media. ADIABATICCOMPRESSEDAIRNOZZLE: Water vapor is added into the airstream through adiabatic evaporation using a compressed air nozzle. ASSISTEDELECTRIC: Water vapor is added into the airstream through water heated evaporation using an electric heater. ASSISTEDNATURALGAS: Water vapor is added into the airstream through water heated evaporation using a natural gas heater. ASSISTEDPROPANE: Water vapor is added into the airstream through water heated evaporation using a propane heater. ASSISTEDBUTANE: Water vapor is added into the airstream through water heated evaporation using a butane heater. ASSISTEDSTEAM: Water vapor is added into the airstream through water heated evaporation using a steam heater. USERDEFINED: User-defined humidifier type. NOTDEFINED: Undefined humidifier type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcHumidifierType_STEAMINJECTION
enumerator IfcHumidifierType_ADIABATICAIRWASHER
enumerator IfcHumidifierType_ADIABATICPAN
enumerator IfcHumidifierType_ADIABATICWETTEDELEMENT
enumerator IfcHumidifierType_ADIABATICATOMIZING
enumerator IfcHumidifierType_ADIABATICULTRASONIC
enumerator IfcHumidifierType_ADIABATICRIGIDMEDIA
enumerator IfcHumidifierType_ADIABATICCOMPRESSEDAIRNOZZLE
enumerator IfcHumidifierType_ASSISTEDELECTRIC
enumerator IfcHumidifierType_ASSISTEDNATURALGAS
enumerator IfcHumidifierType_ASSISTEDPROPANE
enumerator IfcHumidifierType_ASSISTEDBUTANE
enumerator IfcHumidifierType_ASSISTEDSTEAM
enumerator IfcHumidifierType_USERDEFINED
enumerator IfcHumidifierType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcHygroscopicMaterialProperties : public Ifc2x3::IfcMaterialProperties

Public Functions

bool hasUpperVaporResistanceFactor() const

Whether the optional attribute UpperVaporResistanceFactor is defined for this IfcHygroscopicMaterialProperties.

double UpperVaporResistanceFactor() const
void setUpperVaporResistanceFactor(double v)
bool hasLowerVaporResistanceFactor() const

Whether the optional attribute LowerVaporResistanceFactor is defined for this IfcHygroscopicMaterialProperties.

double LowerVaporResistanceFactor() const
void setLowerVaporResistanceFactor(double v)
bool hasIsothermalMoistureCapacity() const

Whether the optional attribute IsothermalMoistureCapacity is defined for this IfcHygroscopicMaterialProperties.

double IsothermalMoistureCapacity() const
void setIsothermalMoistureCapacity(double v)
bool hasVaporPermeability() const

Whether the optional attribute VaporPermeability is defined for this IfcHygroscopicMaterialProperties.

double VaporPermeability() const
void setVaporPermeability(double v)
bool hasMoistureDiffusivity() const

Whether the optional attribute MoistureDiffusivity is defined for this IfcHygroscopicMaterialProperties.

double MoistureDiffusivity() const
void setMoistureDiffusivity(double v)
const IfcParse::entity &declaration() const
IfcHygroscopicMaterialProperties(IfcEntityInstanceData *e)
IfcHygroscopicMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_UpperVaporResistanceFactor, boost::optional<double> v3_LowerVaporResistanceFactor, boost::optional<double> v4_IsothermalMoistureCapacity, boost::optional<double> v5_VaporPermeability, boost::optional<double> v6_MoistureDiffusivity)

Public Static Functions

const IfcParse::entity &Class()
class IfcIdentifier : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: An identifier is an alphanumeric string which allows an individual thing to be identified. It may not provide natural-language meaning.

Type: STRING of up to 255 characters

NOTE Corresponding STEP name: identifier, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 2x. IFC 2x4 CHANGE: Previously recommended size restriction of 255 characters is now mandatory.

As a merely machine-readable string for identification purposes, an identifier is usually machine-generated and locale-independent (in contrast to human-readable labels, IfcLabel).

Per ISO 10303-11, the set of characters that may appear in STRINGs is defined in ISO 10646. The encoding of characters in case of file-based exchange is defined in ISO 10303-21 (STEP physical files) and ISO 10303-28 (XML files). Among else, these specifications define the encoding of 8-bit characters from ISO 8859-1…-16 and of 2-byte Unicode characters.

Note that while IfcIdentifier is restricted to 255 characters, the size in exchange files after encoding may be considerably larger than 255 octets, depending on the particular encoding and on the contents of the identifier.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcIdentifier(IfcEntityInstanceData *e)
IfcIdentifier(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcIlluminanceMeasure : public IfcUtil::IfcBaseType

IfcIlluminanceMeasure is a measure of the illuminance. Usually measured in Lux (lx, Lumen/m2 = Candela Steradian/m2). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcIlluminanceMeasure(IfcEntityInstanceData *e)
IfcIlluminanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcImageTexture : public Ifc2x3::IfcSurfaceTexture

An IfcImageTexture provides a 2-dimensional texture that can be applied to a surface of an geometric item and that provides lighting parameters of a surface onto which it is mapped. The texture is provided as an image file at an external location for which an URL is provided.

The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

The ImageTexture node defines a texture map by specifying an image file and general parameters for mapping to geometry. The texture is read from the URL specified by the url field. When the url field contains no [resolvable] values, texturing is disabled. Browsers shall support the JPEG and PNG (see ISO/IEC 15948) image file formats. Texture nodes that require support for the PNG image format shall interpret the PNG pixel formats in the following way:

Greyscale pixels without alpha or simple transparency are treated as intensity textures. >Greyscale pixels with alpha or simple transparency are treated as intensity plus alpha textures. RGB pixels without alpha channel or simple transparency are treated as full RGB textures. RGB pixels with alpha channel or simple transparency are treated as full RGB plus alpha textures.

If the image specifies colours as indexed-colour (that is, palettes or colourmaps), the following semantics should be used (note that greyscale refers to a palette entry with equal red, green, and blue values):

If all the colours in the palette are greyscale and there is no transparency chunk, it is treated as an intensity texture. If all the colours in the palette are greyscale and there is a transparency chunk, it is treated as an intensity plus opacity texture. >If any colour in the palette is not grey and there is no transparency chunk, it is treated as a full RGB texture. If any colour in the palette is not grey and there is a transparency chunk, it is treated as a full RGB plus alpha texture.

Texture nodes that require support for JPEG files shall interpret JPEG files as follows:

Greyscale files (number of components equals 1) are treated as intensity textures. YCbCr files are treated as full RGB textures. No other JPEG file types are required. It is recommended that other JPEG files are treated as a full RGB textures.

Texture nodes that recommend support for GIF files shall follow the applicable semantics described above for the PNG format.

The Uniform Resource Locator (URL) is a form of an URI and specified in RFC1738 by IETF. It supports resources located on a particular server being accessed by a particular protocol (usually http), and resources located at a local machine.

NOTE Exchange files following the ifcZIP convention may include a sub directory structure for image resources to be stored together with the product data set.

NOTE The definitions of texturing within this standard have been developed in dependence on the texture component of X3D. See ISO/IEC 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1, 18 Texturing component for the definitions in the international standard.

HISTORY New entity in Release IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcImageTexture> list

Public Functions

std::string UrlReference() const

Location, provided as an URI, at which the image texture is electronically published.

void setUrlReference(std::string v)
const IfcParse::entity &declaration() const
IfcImageTexture(IfcEntityInstanceData *e)
IfcImageTexture(bool v1_RepeatS, bool v2_RepeatT, ::Ifc2x3::IfcSurfaceTextureEnum::Value v3_TextureType, ::Ifc2x3::IfcCartesianTransformationOperator2D *v4_TextureTransform, std::string v5_UrlReference)

Public Static Functions

const IfcParse::entity &Class()
class IfcInductanceMeasure : public IfcUtil::IfcBaseType

IfcInductanceMeasure is a measure of the inductance. Usually measure in Henry (H, Weber/A = V s/A). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcInductanceMeasure(IfcEntityInstanceData *e)
IfcInductanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcInteger : public IfcUtil::IfcBaseType

IfcInteger is a defined type of simple data type Integer. It is required since a select type (IfcSimpleValue) cannot include directly simple types in its select list.

In principle, the domain of IfcInteger (being an Integer) is all integer numbers. Here the number of bits used for the IfcInteger representation is unconstrained, but in practice it is implementation specific.

Type: INTEGER

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcInteger(IfcEntityInstanceData *e)
IfcInteger(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcIntegerCountRateMeasure : public IfcUtil::IfcBaseType

IfcIntegerCountRateMeasure is a measure of the integer number of units flowing per unit time.

EXAMPLE: This measure may be used for measuring integer units per second or per hour. For example, it may be used to measure the number of books per hour passing along a part of a mechanical book handling system, the number of people per hour travelling along a moving walkway or the number of vehicles per hour travelling along a section of road.

Type: INTEGER

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcIntegerCountRateMeasure(IfcEntityInstanceData *e)
IfcIntegerCountRateMeasure(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcInternalOrExternalEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of space boundaries in terms of either being inside the building or outside the building. Enumeration:

INTERNAL

IfcSpaceBoundary The space boundary faces a physical or virtual element where there is an internal space on the other side.

EXTERNAL

IfcSpaceBoundary The space boundary faces a physical or virtual element where there is an external space on the other side (i.e. air). Or it is the space boundary of that external space against the building.

EXTERNAL_EARTH

IfcSpaceBoundary The space boundary faces a physical or virtual element where there is earth (or terrain) on the other side. Or it is the space boundary of that earth (or terrain object) external space against the building.

EXTERNAL_WATER

IfcSpaceBoundary The space boundary faces a physical or virtual element where there is water (water component of terrain) on the other side. Or it is the space boundary of that object representing water external space against the building.

EXTERNAL_FIRE

IfcSpaceBoundary The space boundary faces a physical or virtual element where there is another building on the other side. Or it is the space boundary of that other neighbor building against the building in question.

NOTDEFINED

No information available.

HISTORY: New enumeration in IFC Release 2.0 IFC2x4 CHANGE: Enumeration no longer applicable to IfcSpace. The following enumerators are added: EXTERNAL_EARTH, EXTERNAL_WATER, EXTERNAL_FIRE.

Values:

enumerator IfcInternalOrExternal_INTERNAL
enumerator IfcInternalOrExternal_EXTERNAL
enumerator IfcInternalOrExternal_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcInventory : public Ifc2x3::IfcGroup

An inventory is a list of items within an enterprise.

Various types of inventory can be included. These are identified by the range of values within the inventory type enumeration which includes space, asset, and furniture. User defined inventories can also be defined for lists of particular types of element such as may be required in operating and maintenance instructions. Such inventories should be constrained to contain a list of elements of a restricted type.There are a number of actors that can be associated with an inventory, each actor having a role. Actors within the scope of the project are indicated using the IfcRelAssignsToActor relationship in which case roles should be defined through the IfcActorRole class; otherwise principal actors are identified as attributes of the class. In the existence of both, direct attributes take precedence.There are a number of costs that can be associated with an inventory, each cost having a role. These are specified through the CurrentValue and OriginalValue attributes.HISTORY: New entity in IFC2.0. Modified in IFC2x4 to make all attributes optional and remove Where Rule.

Assignment Use Definition The IfcInventory may have assignments of its own using the IfcRelAssignsToGroup relationship where RelatingGroup refers to the IfcInventory and RelatedObjects contains one or more objects of the following types: IfcAsset: Assets included in the inventory.

IfcElement: Elements such as furniture included in the inventory.

IfcSpace: Spaces included in the inventory.

Public Types

typedef IfcTemplatedEntityList<IfcInventory> list

Public Functions

::Ifc2x3::IfcInventoryTypeEnum::Value InventoryType() const
void setInventoryType(::Ifc2x3::IfcInventoryTypeEnum::Value v)
::Ifc2x3::IfcActorSelect *Jurisdiction() const

The organizational unit to which the inventory is applicable.

void setJurisdiction(::Ifc2x3::IfcActorSelect *v)
IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr ResponsiblePersons() const

Persons who are responsible for the inventory.

void setResponsiblePersons(IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr v)
::Ifc2x3::IfcCalendarDate *LastUpdateDate() const

The date on which the last update of the inventory was carried out.

IFC2x4 CHANGE Type changed from IfcDateTimeSelect.

void setLastUpdateDate(::Ifc2x3::IfcCalendarDate *v)
bool hasCurrentValue() const

Whether the optional attribute CurrentValue is defined for this IfcInventory.

::Ifc2x3::IfcCostValue *CurrentValue() const

An estimate of the current cost value of the inventory.

void setCurrentValue(::Ifc2x3::IfcCostValue *v)
bool hasOriginalValue() const

Whether the optional attribute OriginalValue is defined for this IfcInventory.

::Ifc2x3::IfcCostValue *OriginalValue() const

An estimate of the original cost value of the inventory.

void setOriginalValue(::Ifc2x3::IfcCostValue *v)
const IfcParse::entity &declaration() const
IfcInventory(IfcEntityInstanceData *e)
IfcInventory(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcInventoryTypeEnum::Value v6_InventoryType, ::Ifc2x3::IfcActorSelect *v7_Jurisdiction, IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr v8_ResponsiblePersons, ::Ifc2x3::IfcCalendarDate *v9_LastUpdateDate, ::Ifc2x3::IfcCostValue *v10_CurrentValue, ::Ifc2x3::IfcCostValue *v11_OriginalValue)

Public Static Functions

const IfcParse::entity &Class()
struct IfcInventoryTypeEnum

Public Types

enum Value

IfcInventoryTypeEnum defines the types of inventory that can be defined. HISTORY: New Enumeration in IFC Release 2.0

Enumeration:

ASSETINVENTORY: A collection of asset instances of type IfcAsset SPACEINVENTORY: A collection of space instances of type IfcSpace FURNITUREINVENTORY: A collection of furniture instances of type IfcFurnishingElement USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcInventoryType_ASSETINVENTORY
enumerator IfcInventoryType_SPACEINVENTORY
enumerator IfcInventoryType_FURNITUREINVENTORY
enumerator IfcInventoryType_USERDEFINED
enumerator IfcInventoryType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcIonConcentrationMeasure : public IfcUtil::IfcBaseType

IfcIonConcentrationMeasure is a measure of particular ion concentration in a liquid, given in mg/L.

HISTORY: New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcIonConcentrationMeasure(IfcEntityInstanceData *e)
IfcIonConcentrationMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcIrregularTimeSeries : public Ifc2x3::IfcTimeSeries

In an irregular time series, unpredictable bursts of data arrive at unspecified points in time, or most time stamps cannot be characterized by a repeating pattern.

EXAMPLE: A circulating pump cycles on and off at unpredictable times as dictated by the demands on the piping system; the amount of light in a classroom varies depending on when the lights are manually switched on and off and and how many lamps are controlled by each switch.

HISTORY: New entity in IFC 2x2.

Public Types

typedef IfcTemplatedEntityList<IfcIrregularTimeSeries> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcIrregularTimeSeriesValue>::ptr Values() const

The collection of time series values.

void setValues(IfcTemplatedEntityList<::Ifc2x3::IfcIrregularTimeSeriesValue>::ptr v)
const IfcParse::entity &declaration() const
IfcIrregularTimeSeries(IfcEntityInstanceData *e)
IfcIrregularTimeSeries(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDateTimeSelect *v3_StartTime, ::Ifc2x3::IfcDateTimeSelect *v4_EndTime, ::Ifc2x3::IfcTimeSeriesDataTypeEnum::Value v5_TimeSeriesDataType, ::Ifc2x3::IfcDataOriginEnum::Value v6_DataOrigin, boost::optional<std::string> v7_UserDefinedDataOrigin, ::Ifc2x3::IfcUnit *v8_Unit, IfcTemplatedEntityList<::Ifc2x3::IfcIrregularTimeSeriesValue>::ptr v9_Values)

Public Static Functions

const IfcParse::entity &Class()
class IfcIrregularTimeSeriesValue : public IfcUtil::IfcBaseEntity

The IfcIrregularTimeSeriesValue describes a value (or set of values) at a particular time point.

HISTORY: New entity in IFC 2x2.

Public Functions

::Ifc2x3::IfcDateTimeSelect *TimeStamp() const

The specification of the time point.

void setTimeStamp(::Ifc2x3::IfcDateTimeSelect *v)
IfcEntityList::ptr ListValues() const

A list of time-series values. At least one value is required.

void setListValues(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcIrregularTimeSeriesValue(IfcEntityInstanceData *e)
IfcIrregularTimeSeriesValue(::Ifc2x3::IfcDateTimeSelect *v1_TimeStamp, IfcEntityList::ptr v2_ListValues)

Public Static Functions

const IfcParse::entity &Class()
class IfcIShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcIShapeProfileDef defines a section profile that provides the defining parameters of a symmetrical ‘I’ section to be used by the swept surface geometry or the swept area solid. The I-shape profile has values for its overall depth, width and its web and flange thickness. Additionally a fillet radius may be given. It represents a I-section that is symmetrical about its major and minor axes; and that has both top and bottom flanges being equal and centred on the web.

IfcIShapeProfileDef can also be used to model I sections with sloped or rounded flanges. The slope and radius cannot be expressed in explicit attributes, but they may be retrieved by reference to an external document or library. See IfcProfileDef for guidance on external references for profile definitions.

HISTORY New entity in IFC2x.

IFC2x4 CHANGE Type of FilletRadius relaxed to allow for zero radius.

Figure 318 illustrates parameters of the I-shape profile definition.

Position

The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

by using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (e.g. upper-left bound). Parameter

The parameterized profile is defined by a set of parameter attributes, see attribute definition below.

Note: The black coordinate axes show the underlying coordinate system of the swept surface or swept area solid

Position

The profile is inserted into the underlying coordinate system of the swept area solid by using the Position attribute. In this example (cardinal point of lower left corner) the attribute values of IfcAxis2Placement2D are:

Location = IfcCartesianPoint(,) RefDirection = NIL (defaults to 1.,0.)

Parameter If the FilletRadius is given, it is equally applied to all four corners created by the web and flanges.

Figure 318 — I-shape profile

Subclassed by Ifc2x3::IfcAsymmetricIShapeProfileDef

Public Types

typedef IfcTemplatedEntityList<IfcIShapeProfileDef> list

Public Functions

double OverallWidth() const

Total extent of the width, defined parallel to the x axis of the position coordinate system.

void setOverallWidth(double v)
double OverallDepth() const

Total extent of the depth, defined parallel to the y axis of the position coordinate system.

void setOverallDepth(double v)
double WebThickness() const

Thickness of the web of the I-shape. The web is centred on the x-axis and the y-axis of the position coordinate system.

void setWebThickness(double v)
double FlangeThickness() const

Flange thickness of the I-shape. Both, the upper and the lower flanges have the same thickness and they are centred on the y-axis of the position coordinate system.

void setFlangeThickness(double v)
bool hasFilletRadius() const

Whether the optional attribute FilletRadius is defined for this IfcIShapeProfileDef.

double FilletRadius() const

The fillet between the web and the flange.

void setFilletRadius(double v)
const IfcParse::entity &declaration() const
IfcIShapeProfileDef(IfcEntityInstanceData *e)
IfcIShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_OverallWidth, double v5_OverallDepth, double v6_WebThickness, double v7_FlangeThickness, boost::optional<double> v8_FilletRadius)

Public Static Functions

const IfcParse::entity &Class()
class IfcIsothermalMoistureCapacityMeasure : public IfcUtil::IfcBaseType

IfcIsothermalMoistureCapacityMeasure is a measure of isothermal moisture capacity. Usually measured in m3/kg. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcIsothermalMoistureCapacityMeasure(IfcEntityInstanceData *e)
IfcIsothermalMoistureCapacityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcJunctionBoxType : public Ifc2x3::IfcFlowFittingType

The flow fitting type IfcJunctionBoxType defines commonly shared information for occurrences of junction boxs. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a junction box specification (i.e. the specific product information, that is common to all occurrences of that product type). Junction Box types may be exchanged without being already assigned to occurrences. Occurrences of IfcJunctionBoxType are represented by instances of IfcJunctionBox.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowFittingType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_JunctionBoxTypeCommon

Material Use Definition The material of the IfcJunctionBoxType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcJunctionBoxType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcJunctionBox for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcJunctionBoxType> list

Public Functions

::Ifc2x3::IfcJunctionBoxTypeEnum::Value PredefinedType() const

Identifies the predefined types of junction boxes from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcJunctionBoxTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcJunctionBoxType(IfcEntityInstanceData *e)
IfcJunctionBoxType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcJunctionBoxTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcJunctionBoxTypeEnum

Public Types

enum Value

The IfcJunctionBoxTypeEnum defines the range of types of junction boxes available. HISTORY: New type in IFC 2x2. Values added in IFC 2x4.

POWER: Contains cables, outlets, and/or switches for electrical power. DATA: Contains cables, outlets, and/or switches for communications use. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcJunctionBoxType_USERDEFINED
enumerator IfcJunctionBoxType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcKinematicViscosityMeasure : public IfcUtil::IfcBaseType

IfcKinematicViscosityMeasure is a measure of the viscous resistance of a medium to a moving body. Usually measured in m2/s. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcKinematicViscosityMeasure(IfcEntityInstanceData *e)
IfcKinematicViscosityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLabel : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A label is the term by which something may be referred to. It is a string which represents the human-interpretable name of something and shall have a natural-language meaning.

Type: STRING of up to 255 characters

NOTE Corresponding STEP name: label, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 2x. IFC 2x4 CHANGE: Previously recommended size restriction of 255 characters is now mandatory.

As a human-readable string for naming purposes, a label is usually human-specified and locale-dependent (in contrast to purely machine-readable identifiers, IfcIdentifier).

Per ISO 10303-11, the set of characters that may appear in STRINGs is defined in ISO 10646. The encoding of characters in case of file-based exchange is defined in ISO 10303-21 (STEP physical files) and ISO 10303-28 (XML files). Among else, these specifications define the encoding of 8-bit characters from ISO 8859-1…-16 and of 2-byte Unicode characters.

Note that while IfcLabel is restricted to 255 characters, the size in exchange files after encoding may be considerably larger than 255 octets, depending on the particular encoding and on the contents of the label.

Subclassed by Ifc2x3::IfcBoxAlignment

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLabel(IfcEntityInstanceData *e)
IfcLabel(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLaborResource : public Ifc2x3::IfcConstructionResource

An IfcLaborResource is used in construction with particular skills or crafts required to perform certain types of construction or management related work.

HISTORY: New Entity in IFC Release 2.0. Base type and documentation extended in IFC 2x4.

IFC2x4 CHANGE: The attribute Skillset has been deleted; use LongDescription to describe the skillset.

The purpose of an IfcLaborResource is to identify a skillset that may be required or used. The skillset identified may be (for instance) chargehand, foreman, labourer, plumbers mate etc. and provides a designation of a particular level of skill. It can be used to identify the generic type of labor resource that is required for a purpose without having to be specific about the actor (person or organization) providing the resource occurrence. It may be particularly useful when creating an overall plan for a process or processes. For instance, within maintenance or work planning there may be a known task that needs to be done which is planned to require a ‘chargehand pipe fitter’. There may be several such labor resources available and so the need to identify which will be used is not necessary at the planning stage.

At a later stage, individual actors can be determined for the labor resources. This is achieved through specifiying the actor through IfcActor. The actor is then identified as the labour resource occurrence through the IfcRelAssignsToResource.RelatedResource attribute. The IfcLaborResource provides the IfcRelAssignsToResource.RelatingResource attribute.

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcLaborResource defines the occurrence of any labor resource; common information about labor resource types is handled by IfcLaborResourceType. The IfcLaborResourceType (if present) may establish the common type name, common properties, common productivities for various task types using IfcRelAssignsToProcess. The IfcLaborResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Quantity use definition The quantities relating to the IfcLaborResource are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement.

Qto_LaborResourceBaseQuantities: base quantities for all labor resources.

Assignment use definition In addition to assignments specified at the base class IfcConstructionResource, a labor resource may have assignments of its own using IfcRelAssignsToResource where RelatingResource refers to the IfcLaborResource and RelatedObjects contains one or more IfcActor subtypes as shown in Figure 194. Such relationship indicates the specific people used as input for the resource. Such actors are nested according to organizational structure with the root organization assigned to the IfcProject. The IfcActor entity is used to represent the people or organizations.

Figure 194 — Labor resource assignment use

Public Types

typedef IfcTemplatedEntityList<IfcLaborResource> list

Public Functions

bool hasSkillSet() const

Whether the optional attribute SkillSet is defined for this IfcLaborResource.

std::string SkillSet() const
void setSkillSet(std::string v)
const IfcParse::entity &declaration() const
IfcLaborResource(IfcEntityInstanceData *e)
IfcLaborResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity, boost::optional<std::string> v10_SkillSet)

Public Static Functions

const IfcParse::entity &Class()
class IfcLampType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcLampType defines commonly shared information for occurrences of lamps. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a lamp specification (i.e. the specific product information, that is common to all occurrences of that product type). Lamp types may be exchanged without being already assigned to occurrences. Occurrences of IfcLampType are represented by instances of IfcLamp.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_LampTypeCommon

Material Use Definition The material of the IfcLampType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Bulb’: Material from which the bulb is constructed (e.g. glass). ‘Conductor’: Material from which the conductor is constructed. ‘Filament’: Material from which the filament is constructed.

Port Use Definition The distribution ports relating to the IfcLampType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcLamp for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcLampType> list

Public Functions

::Ifc2x3::IfcLampTypeEnum::Value PredefinedType() const

Identifies the predefined types of lamp from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcLampTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcLampType(IfcEntityInstanceData *e)
IfcLampType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcLampTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcLampTypeEnum

Public Types

enum Value

The IfcLampTypeEnum defines the range of different types of lamp available.

HISTORY: New type in IFC 2x2 Addendum 1

Enumeration

COMPACTFLUORESCENT: A fluorescent lamp having a compact form factor produced by shaping the tube. FLUORESCENT: A typically tubular discharge lamp in which most of the light is emitted by one or several layers of phosphors excited by ultraviolet radiation from the discharge. HALOGEN: an incandescent lamp in which a tungsten filament is sealed into a compact transport envelope filled with an inert gas and a small amount of halogen such as iodine or bromine. HIGHPRESSUREMERCURY: A discharge lamp in which most of the light is emitted by exciting mercury at high pressure. HIGHPRESSURESODIUM: A discharge lamp in which most of the light is emitted by exciting sodium at high pressure. LED: a solid state lamp that uses light-emitting diodes as the source of light. METALHALIDE: A discharge lamp in which most of the light is emitted by exciting a metal halide. OLED: a solid state lamp that uses light-emitting diodes as the source of light whose emissive electroluminescent layer is composed of a film of organic compounds. TUNGSTENFILAMENT: A lamp that emits light by passing an electrical current through a tungsten wire filament in a near vacuum. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcLampType_COMPACTFLUORESCENT
enumerator IfcLampType_FLUORESCENT
enumerator IfcLampType_HIGHPRESSUREMERCURY
enumerator IfcLampType_HIGHPRESSURESODIUM
enumerator IfcLampType_METALHALIDE
enumerator IfcLampType_TUNGSTENFILAMENT
enumerator IfcLampType_USERDEFINED
enumerator IfcLampType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcLayerSetDirectionEnum

Public Types

enum Value

IfcLayerSetDirectionEnum provides identification of the axis of element geometry, denoting the layer set thickness direction, or direction of layer offsets.

ENUMERATION

AXIS1: Usually x-axis. AXIS2: Usually y-axis. AXIS3: Usually z-axis.

HISTORY: New Type in IFC2x.

Values:

enumerator IfcLayerSetDirection_AXIS1
enumerator IfcLayerSetDirection_AXIS2
enumerator IfcLayerSetDirection_AXIS3

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLengthMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A length measure is the value of a distance. Usually measured in millimeters (mm). Type: REAL

NOTE Corresponding ISO 10303 name: length_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcPositiveLengthMeasure

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLengthMeasure(IfcEntityInstanceData *e)
IfcLengthMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLibraryInformation : public IfcUtil::IfcBaseEntity

An IfcLibraryInformation describes a library where a library is a structured store of information, normally organized in a manner which allows information lookup through an index or reference value. IfcLibraryInformation provides the library Name and optional Version, VersionDate and Publisher attributes. A Location may be added for electronic access to the library.

NOTE The complete definition of the information in an external library is out of scope in this IFC release.

HISTORY New Entity in IFC2x.

IFC2x4 CHANGE Location attribute added, HasLibraryReferences inverse attribute added (previous LibraryReference changed to inverse).

Public Types

typedef IfcTemplatedEntityList<IfcLibraryInformation> list

Public Functions

std::string Name() const

The name which is used to identify the library.

void setName(std::string v)
bool hasVersion() const

Whether the optional attribute Version is defined for this IfcLibraryInformation.

std::string Version() const

Identifier for the library version used for reference.

void setVersion(std::string v)
bool hasPublisher() const

Whether the optional attribute Publisher is defined for this IfcLibraryInformation.

::Ifc2x3::IfcOrganization *Publisher() const

Information of the organization that acts as the library publisher.

void setPublisher(::Ifc2x3::IfcOrganization *v)
bool hasVersionDate() const

Whether the optional attribute VersionDate is defined for this IfcLibraryInformation.

::Ifc2x3::IfcCalendarDate *VersionDate() const

Date of the referenced version of the library.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setVersionDate(::Ifc2x3::IfcCalendarDate *v)
bool hasLibraryReference() const

Whether the optional attribute LibraryReference is defined for this IfcLibraryInformation.

IfcTemplatedEntityList<::Ifc2x3::IfcLibraryReference>::ptr LibraryReference() const
void setLibraryReference(IfcTemplatedEntityList<::Ifc2x3::IfcLibraryReference>::ptr v)
const IfcParse::entity &declaration() const
IfcLibraryInformation(IfcEntityInstanceData *e)
IfcLibraryInformation(std::string v1_Name, boost::optional<std::string> v2_Version, ::Ifc2x3::IfcOrganization *v3_Publisher, ::Ifc2x3::IfcCalendarDate *v4_VersionDate, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcLibraryReference>::ptr> v5_LibraryReference)

Public Static Functions

const IfcParse::entity &Class()
class IfcLibraryReference : public Ifc2x3::IfcExternalReference

An IfcLibraryReference is a reference into a library of information by Location (provided as a URI). It also provides an optional inherited Identification key to allow more specific references to library sections or tables. The inherited Name attribute allows for a human interpretable identification of the library item. Also, general information on the library from which the reference is taken, is given by the ReferencedLibrary relation which identifies the relevant occurrence of IfcLibraryInformation.

The ifcLibraryReference additionally provides the capability to handle multilingual library entries. The Language attribute then holds the language tag for the language used by the strings kept in the Name and the Description attribute.

HISTORY New Entity in IFC2.0.

IFC2x4 CHANGE Description and Language attribute added; ReferencedLibrary attribute added (reversing previous ReferenceIntoLibrary inverse relationship).

Public Types

typedef IfcTemplatedEntityList<IfcLibraryReference> list

Public Functions

IfcTemplatedEntityList<IfcLibraryInformation>::ptr ReferenceIntoLibrary() const
const IfcParse::entity &declaration() const
IfcLibraryReference(IfcEntityInstanceData *e)
IfcLibraryReference(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_ItemReference, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
struct IfcLightDistributionCurveEnum

Public Types

enum Value

There are three kinds of light distribution curves, according to Standard CEN TC 169, prEN 13032-1, CIE 121:

TYPE_A: Type A is basically not used. For completeness the Type A Photometry equals the Type B rotated 90° around the Z-Axis counter clockwise. TYPE_B: Type B is sometimes used for floodlights. The B-Plane System has a horizontal axis. B-Angles are valid from -180° to +180° with B 0° at the bottom and B180°/B-180° at the top, &#946;-Angles are valid from -90° to +90°. (See Figure 302.) TYPE_C: Type C is the recommended standard system. The C-Plane system equals a globe with a vertical axis. C-Angles are valid from 0° to 360°, &#947;-Angles are valid from 0° (south pole) to 180° (north pole). (See Figure 302.)

<table

B-Type System C-Type System

Figure 302 — Light distribution curves

HISTORY This is a new enumeration in IFC2x2.

Values:

enumerator IfcLightDistributionCurve_TYPE_A
enumerator IfcLightDistributionCurve_TYPE_B
enumerator IfcLightDistributionCurve_TYPE_C
enumerator IfcLightDistributionCurve_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLightDistributionData : public IfcUtil::IfcBaseEntity

IfcLightDistributionData defines the luminous intensity of a light source given at a particular main plane angle. It is based on some standardized light distribution curves; the MainPlaneAngle is either the

A angle; if the IfcLightDistributionCurveEnum is set to TYPE_A B angle; if the IfcLightDistributionCurveEnum is set to TYPE_B C angle; if the IfcLightDistributionCurveEnum is set to TYPE_C

For each MainPlaneAngle (considered as being the row of a table) a list of SecondaryPlaneAngle’s are given (considered to be the columns of a table). They are either the:

&#945; angle; if the IfcLightDistributionCurveEnum is set to TYPE_A &#946; angle; if the IfcLightDistributionCurveEnum is set to TYPE_B &#947; angle; if the IfcLightDistributionCurveEnum is set to TYPE_C

For each pair of MainPlaneAngle and SecondaryPlaneAngle the LuminousIntensity is provided (the unit is given by the IfcUnitAssignment referring to the LuminousIntensityDistributionUnit, normally cd/klm).

HISTORY: New entity in IFC2x2.

Public Functions

double MainPlaneAngle() const

The main plane angle (A, B or C angles, according to the light distribution curve chosen).

void setMainPlaneAngle(double v)
std::vector<double> SecondaryPlaneAngle() const

The list of secondary plane angles (the &#945;, &#946; or &#947; angles) according to the light distribution curve chosen.

NOTE: The SecondaryPlaneAngle and LuminousIntensity lists are corresponding lists.

void setSecondaryPlaneAngle(std::vector<double> v)
std::vector<double> LuminousIntensity() const

The luminous intensity distribution measure for this pair of main and secondary plane angles according to the light distribution curve chosen.

void setLuminousIntensity(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcLightDistributionData(IfcEntityInstanceData *e)
IfcLightDistributionData(double v1_MainPlaneAngle, std::vector<double> v2_SecondaryPlaneAngle, std::vector<double> v3_LuminousIntensity)

Public Static Functions

const IfcParse::entity &Class()
struct IfcLightEmissionSourceEnum

Public Types

enum Value

IfcLightEmissionSourceEnum defines the range of different types of light emitter available.

HISTORY: New type in IFC2x2.

Enumeration

COMPACTFLUORESCENT FLUORESCENT HIGHPRESSUREMERCURY HIGHPRESSURESODIUM LIGHTEMITTINGDIODE LOWPRESSURESODIUM LOWVOLTAGEHALOGEN MAINVOLTAGEHALOGEN METALHALIDE TUNGSTENFILAMENT NOTDEFINED

Values:

enumerator IfcLightEmissionSource_COMPACTFLUORESCENT
enumerator IfcLightEmissionSource_FLUORESCENT
enumerator IfcLightEmissionSource_HIGHPRESSUREMERCURY
enumerator IfcLightEmissionSource_HIGHPRESSURESODIUM
enumerator IfcLightEmissionSource_LIGHTEMITTINGDIODE
enumerator IfcLightEmissionSource_LOWPRESSURESODIUM
enumerator IfcLightEmissionSource_LOWVOLTAGEHALOGEN
enumerator IfcLightEmissionSource_MAINVOLTAGEHALOGEN
enumerator IfcLightEmissionSource_METALHALIDE
enumerator IfcLightEmissionSource_TUNGSTENFILAMENT
enumerator IfcLightEmissionSource_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLightFixtureType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcLightFixtureType defines commonly shared information for occurrences of light fixtures. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a light fixture specification (i.e. the specific product information, that is common to all occurrences of that product type). Light Fixture types may be exchanged without being already assigned to occurrences. Occurrences of IfcLightFixtureType are represented by instances of IfcLightFixture.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_LightFixtureTypeCommon Pset_LightFixtureTypeThermal

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_LightFixtureTypeSecurityLighting (SECURITYLIGHTING)

Material Use Definition The material of the IfcLightFixtureType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcLightFixtureType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcLightFixture for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcLightFixtureType> list

Public Functions

::Ifc2x3::IfcLightFixtureTypeEnum::Value PredefinedType() const

Identifies the predefined types of light fixture from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcLightFixtureTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcLightFixtureType(IfcEntityInstanceData *e)
IfcLightFixtureType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcLightFixtureTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcLightFixtureTypeEnum

Public Types

enum Value

The IfcLightFixtureTypeEnum defines the range of different types of light fixture available.

HISTORY: New type in IFC 2x Edition 2IFC 2x4: SECURITYLIGHTING added

Enumeration

POINTSOURCE: A light fixture that is considered to have negligible area and that emit light with approximately equal intensity in all directions. A light fixture containing a tungsten, halogen or similar bulb is an example of a point source. DIRECTIONSOURCE: A light fixture that is considered to have a length or surface area from which it emits light in a direction. A light fixture containing one or more fluorescent lamps is an example of a direction source. SECURITYLIGHTING: A light fixture having specific purpose of directing occupants in an emergency, such as an illuminated exit sign or emergency flood light. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcLightFixtureType_POINTSOURCE
enumerator IfcLightFixtureType_DIRECTIONSOURCE
enumerator IfcLightFixtureType_USERDEFINED
enumerator IfcLightFixtureType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLightIntensityDistribution : public IfcUtil::IfcBaseEntity

IfcLightIntensityDistribution defines the the luminous intensity of a light source that changes according to the direction of the ray. It is based on some standardized light distribution curves, which are defined by the LightDistributionCurve attribute.

New entity in IFC2x2.

Public Functions

::Ifc2x3::IfcLightDistributionCurveEnum::Value LightDistributionCurve() const

Standardized light distribution curve used to define the luminous intensity of the light in all directions.

void setLightDistributionCurve(::Ifc2x3::IfcLightDistributionCurveEnum::Value v)
IfcTemplatedEntityList<::Ifc2x3::IfcLightDistributionData>::ptr DistributionData() const

Light distribution data applied to the light source. It is defined by a list of main plane angles (B or C according to the light distribution curve chosen) that includes (for each B or C angle) a second list of secondary plane angles (the &#946; or &#947; angles) and the according luminous intensity distribution measures.

void setDistributionData(IfcTemplatedEntityList<::Ifc2x3::IfcLightDistributionData>::ptr v)
const IfcParse::entity &declaration() const
IfcLightIntensityDistribution(IfcEntityInstanceData *e)
IfcLightIntensityDistribution(::Ifc2x3::IfcLightDistributionCurveEnum::Value v1_LightDistributionCurve, IfcTemplatedEntityList<::Ifc2x3::IfcLightDistributionData>::ptr v2_DistributionData)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSource : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-46:1992: The light source entity is determined by the reflectance specified in the surface style rendering. Lighting is applied on a surface by surface basis: no interactions between surfaces such as shadows or reflections are defined.

NOTE: Corresponding STEP entity: light_source. Please refer to ISO/IS 10303-46:1994, p. 31 for the final definition of the formal standard.

NOTE: In addition to the attributes as defined in ISO10303-46 the following additional properties from ISO/IEC 14772-1:1997 (VRML) are added: ambientIntensity and Intensity. The attribute Name has been added as well (as it is not inherited via representation_item).

HISTORY: This is a new Entity in IFC 2x, renamed and enhanced in IFC2x2.

Subclassed by Ifc2x3::IfcLightSourceAmbient, Ifc2x3::IfcLightSourceDirectional, Ifc2x3::IfcLightSourceGoniometric, Ifc2x3::IfcLightSourcePositional

Public Types

typedef IfcTemplatedEntityList<IfcLightSource> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcLightSource.

std::string Name() const

The name given to the light source in presentation.

void setName(std::string v)
::Ifc2x3::IfcColourRgb *LightColour() const

Definition from ISO/CD 10303-46:1992: Based on the current lighting model, the colour of the light to be used for shading. Definition from VRML97 - ISO/IEC 14772-1:1997: The color field specifies the spectral color properties of both the direct and ambient light emission as an RGB value.

void setLightColour(::Ifc2x3::IfcColourRgb *v)
bool hasAmbientIntensity() const

Whether the optional attribute AmbientIntensity is defined for this IfcLightSource.

double AmbientIntensity() const

Definition from VRML97 - ISO/IEC 14772-1:1997: The ambientIntensity specifies the intensity of the ambient emission from the light. Light intensity may range from 0.0 (no light emission) to 1.0 (full intensity).

void setAmbientIntensity(double v)
bool hasIntensity() const

Whether the optional attribute Intensity is defined for this IfcLightSource.

double Intensity() const

Definition from VRML97 - ISO/IEC 14772-1:1997: The intensity field specifies the brightness of the direct emission from the ligth. Light intensity may range from 0.0 (no light emission) to 1.0 (full intensity).

void setIntensity(double v)
const IfcParse::entity &declaration() const
IfcLightSource(IfcEntityInstanceData *e)
IfcLightSource(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSourceAmbient : public Ifc2x3::IfcLightSource

Definition from ISO/CD 10303-46:1992: The light source ambient entity is a subtype of light source. It lights a surface independent of the surface’s orientation and position.

NOTE: Corresponding ISO 10303 entity: light_source_ambient. Please refer to ISO/IS 10303-46:1994, p. 31 for the final definition of the formal standard.

NOTE: In addition to the attributes as defined in ISO 10303-46 the additional property from ISO/IEC 14772-1:1997 (VRML) AmbientIntensity is inherited from the supertype.

HISTORY: This is a new entity in IFC 2x, renamed and enhanced in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcLightSourceAmbient> list

Public Functions

const IfcParse::entity &declaration() const
IfcLightSourceAmbient(IfcEntityInstanceData *e)
IfcLightSourceAmbient(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSourceDirectional : public Ifc2x3::IfcLightSource

Definition from ISO/CD 10303-46:1992: The light source directional is a subtype of light source. This entity has a light source direction. With a conceptual origin at infinity, all the rays of the light are parallel to this direction. This kind of light source lights a surface based on the surface’s orientation, but not position.

Definition from ISO/IEC 14772-1:1997: The directional light node defines a directional light source that illuminates along rays parallel to a given 3-dimensional vector. Directional light nodes do not attenuate with distance. Directional light nodes are specified in the local coordinate system and are affected by ancestor transformations.

NOTE: Corresponding ISO 10303 entity: light_source_directional. Please refer to ISO/IS 10303-46:1994, p. 32 for the final definition of the formal standard.

NOTE: In addition to the attributes as defined in ISO 10303-46 the additional property from ISO/IEC 14772-1:1997 (VRML) AmbientIntensity and Intensity are inherited from the supertype.

HISTORY: This is a new entity in IFC 2x, renamed and enhanced in IFC2x2.

Public Functions

::Ifc2x3::IfcDirection *Orientation() const

Definition from ISO/CD 10303-46:1992: This direction is the direction of the light source. Definition from VRML97 - ISO/IEC 14772-1:1997: The direction field specifies the direction vector of the illumination emanating from the light source in the local coordinate system. Light is emitted along parallel rays from an infinite distance away.

void setOrientation(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcLightSourceDirectional(IfcEntityInstanceData *e)
IfcLightSourceDirectional(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity, ::Ifc2x3::IfcDirection *v5_Orientation)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSourceGoniometric : public Ifc2x3::IfcLightSource

IfcLightSourceGoniometric defines a light source for which exact lighting data is available. It specifies the type of a light emitter, defines the position and orientation of a light distribution curve and the data concerning lamp and photometric information.

Figure 303 shows an example of a light emitter having two light sources (of type IfcLightSourceGoniometric).

Figure 303 — Light source goniometric

HISTORY: New entity in IFC2x2.

Public Functions

::Ifc2x3::IfcAxis2Placement3D *Position() const

The position of the light source. It is used to orientate the light distribution curves.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
bool hasColourAppearance() const

Whether the optional attribute ColourAppearance is defined for this IfcLightSourceGoniometric.

::Ifc2x3::IfcColourRgb *ColourAppearance() const

Artificial light sources are classified in terms of their color appearance. To the human eye they all appear to be white; the difference can only be detected by direct comparison. Visual performance is not directly affected by differences in color appearance.

void setColourAppearance(::Ifc2x3::IfcColourRgb *v)
double ColourTemperature() const

The color temperature of any source of radiation is defined as the temperature (in Kelvin) of a black-body or Planckian radiator whose radiation has the same chromaticity as the source of radiation. Often the values are only approximate color temperatures as the black-body radiator cannot emit radiation of every chromaticity value. The color temperatures of the commonest artificial light sources range from less than 3000K (warm white) to 4000K (intermediate) and over 5000K (daylight).

void setColourTemperature(double v)
double LuminousFlux() const

Luminous flux is a photometric measure of radiant flux, i.e. the volume of light emitted from a light source. Luminous flux is measured either for the interior as a whole or for a part of the interior (partial luminous flux for a solid angle). All other photometric parameters are derivatives of luminous flux. Luminous flux is measured in lumens (lm). The luminous flux is given as a nominal value for each lamp.

void setLuminousFlux(double v)
::Ifc2x3::IfcLightEmissionSourceEnum::Value LightEmissionSource() const

Identifies the types of light emitter from which the type required may be set.

void setLightEmissionSource(::Ifc2x3::IfcLightEmissionSourceEnum::Value v)
::Ifc2x3::IfcLightDistributionDataSourceSelect *LightDistributionDataSource() const

The data source from which light distribution data is obtained.

void setLightDistributionDataSource(::Ifc2x3::IfcLightDistributionDataSourceSelect *v)
const IfcParse::entity &declaration() const
IfcLightSourceGoniometric(IfcEntityInstanceData *e)
IfcLightSourceGoniometric(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity, ::Ifc2x3::IfcAxis2Placement3D *v5_Position, ::Ifc2x3::IfcColourRgb *v6_ColourAppearance, double v7_ColourTemperature, double v8_LuminousFlux, ::Ifc2x3::IfcLightEmissionSourceEnum::Value v9_LightEmissionSource, ::Ifc2x3::IfcLightDistributionDataSourceSelect *v10_LightDistributionDataSource)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSourcePositional : public Ifc2x3::IfcLightSource

Definition from ISO/CD 10303-46:1992: The light source positional entity is a subtype of light source. This entity has a light source position and attenuation coefficients. A positional light source affects a surface based on the surface’s orientation and position.

Definition from ISO/IEC 14772-1:1997: The Point light node specifies a point light source at a 3D location in the local coordinate system. A point light source emits light equally in all directions; that is, it is omnidirectional. Point light nodes are specified in the local coordinate system and are affected by ancestor transformations.

Point light node’s illumination falls off with distance as specified by three attenuation coefficients. The attenuation factor is

1/max(attenuation[0] + attenuation[1] × r + attenuation[2] × r 2 , 1),

where r is the distance from the light to the surface being illuminated. The default is no attenuation. An attenuation value of (0, 0, 0) is identical to (1, 0, 0). Attenuation values shall be greater than or equal to zero.

NOTE: Corresponding ISO 10303 entity: light_source_positional. Please refer to ISO/IS 10303-46:1994, p. 32 for the final definition of the formal standard.

NOTE: In addition to the attributes as defined in ISO10303-46 the additional property from ISO/IEC 14772-1:1997 (VRML) Radius and QuadricAttenuation are added to this subtype and the AmbientIntensity and Intensity are inherited from the supertype.

HISTORY: This is a new entity in IFC 2x, renamed and enhanced in IFC2x2.

Subclassed by Ifc2x3::IfcLightSourceSpot

Public Functions

::Ifc2x3::IfcCartesianPoint *Position() const

Definition from ISO/CD 10303-46:1992: The Cartesian point indicates the position of the light source. Definition from VRML97 - ISO/IEC 14772-1:1997: A Point light node illuminates geometry within radius of its location.

void setPosition(::Ifc2x3::IfcCartesianPoint *v)
double Radius() const

Definition from IAI: The maximum distance from the light source for a surface still to be illuminated. Definition from VRML97 - ISO/IEC 14772-1:1997: A Point light node illuminates geometry within radius of its location.

void setRadius(double v)
double ConstantAttenuation() const

Definition from ISO/CD 10303-46:1992: This real indicates the value of the attenuation in the lighting equation that is constant.

void setConstantAttenuation(double v)
double DistanceAttenuation() const

Definition from ISO/CD 10303-46:1992: This real indicates the value of the attenuation in the lighting equation that proportional to the distance from the light source.

void setDistanceAttenuation(double v)
double QuadricAttenuation() const

Definition from the IAI: This real indicates the value of the attenuation in the lighting equation that proportional to the square value of the distance from the light source.

void setQuadricAttenuation(double v)
const IfcParse::entity &declaration() const
IfcLightSourcePositional(IfcEntityInstanceData *e)
IfcLightSourcePositional(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity, ::Ifc2x3::IfcCartesianPoint *v5_Position, double v6_Radius, double v7_ConstantAttenuation, double v8_DistanceAttenuation, double v9_QuadricAttenuation)

Public Static Functions

const IfcParse::entity &Class()
class IfcLightSourceSpot : public Ifc2x3::IfcLightSourcePositional

Definition from ISO/CD 10303-46:1992: The light source spot entity is a subtype of light source. Spot light source entities have a light source colour, position, direction, attenuation coefficients, concentration exponent, and spread angle. If a point lies outside the cone of influence of a light source of this type as determined by the light source position, direction and spread angle its colour is not affected by that light source.

NOTE The IfcLightSourceSpot adds the BeamWidthAngle which defines the inner cone in which the light source emits light at uniform full intensity. The light source’s emission intensity drops off from the inner solid angle (BeamWidthAngle) to the outer solid angle (SpreadAngle).

Definition from ISO/IEC 14772-1:1997: The Spot light node defines a light source that emits light from a specific point along a specific direction vector and constrained within a solid angle. Spot lights may illuminate geometry nodes that respond to light sources and intersect the solid angle defined by the Spot light. Spot light nodes are specified in the local coordinate system and are affected by ancestors’ transformations.

Figure 304 (from VRML97) shows the definition of spot light.

Figure 304 — Light source spot

NOTE Corresponding ISO 10303 entity: light_source_spot. Please refer to ISO/IS 10303-46:1994, p. 33 for the final definition of the formal standard.

NOTE In addition to the attributes as defined in ISO10303-46 the additional property from ISO/IEC 14772-1:1997 (VRML) Radius, BeamWidth, and QuadricAttenuation are added to this subtype and the AmbientIntensity and Intensity are inherited from the supertype.

HISTORY This is a new entity in IFC 2x, renamed and enhanced in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcLightSourceSpot> list

Public Functions

::Ifc2x3::IfcDirection *Orientation() const

Definition from ISO/CD 10303-46:1992: This is the direction of the axis of the cone of the light source specified in the coordinate space of the representation being projected.. Definition from VRML97 - ISO/IEC 14772-1:1997: The direction field specifies the direction vector of the light’s central axis defined in the local coordinate system.

void setOrientation(::Ifc2x3::IfcDirection *v)
bool hasConcentrationExponent() const

Whether the optional attribute ConcentrationExponent is defined for this IfcLightSourceSpot.

double ConcentrationExponent() const

Definition from ISO/CD 10303-46:1992: This real is the exponent on the cosine of the angle between the line that starts at the position of the spot light source and is in the direction of the orientation of the spot light source and a line that starts at the position of the spot light source and goes through a point on the surface being shaded. NOTE: This attribute does not exists in ISO/IEC 14772-1:1997.

void setConcentrationExponent(double v)
double SpreadAngle() const

Definition from ISO/CD 10303-46:1992: This planar angle measure is the angle between the line that starts at the position of the spot light source and is in the direction of the spot light source and any line on the boundary of the cone of influence. Definition from VRML97 - ISO/IEC 14772-1:1997: The cutOffAngle (name of spread angle in VRML) field specifies the outer bound of the solid angle. The light source does not emit light outside of this solid angle.

void setSpreadAngle(double v)
double BeamWidthAngle() const

Definition from VRML97 - ISO/IEC 14772-1:1997: The beamWidth field specifies an inner solid angle in which the light source emits light at uniform full intensity. The light source’s emission intensity drops off from the inner solid angle (beamWidthAngle) to the outer solid angle (spreadAngle).

void setBeamWidthAngle(double v)
const IfcParse::entity &declaration() const
IfcLightSourceSpot(IfcEntityInstanceData *e)
IfcLightSourceSpot(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcColourRgb *v2_LightColour, boost::optional<double> v3_AmbientIntensity, boost::optional<double> v4_Intensity, ::Ifc2x3::IfcCartesianPoint *v5_Position, double v6_Radius, double v7_ConstantAttenuation, double v8_DistanceAttenuation, double v9_QuadricAttenuation, ::Ifc2x3::IfcDirection *v10_Orientation, boost::optional<double> v11_ConcentrationExponent, double v12_SpreadAngle, double v13_BeamWidthAngle)

Public Static Functions

const IfcParse::entity &Class()
class IfcLine : public Ifc2x3::IfcCurve

Definition from ISO/CD 10303-42:1992: A line is an unbounded curve with constant tangent direction. A line is defined by a point and a direction. The positive direction of the line is in the direction of the Dir vector. The line is parameterized as follows:

P = Pnt V = Dir λ(u) = P + uV

and the parametric range is:

∞ < u < ∞

NOTE Corresponding ISO 10303 entity: line. Please refer to ISO/IS 10303-42:1994, p.37 for the final definition of the formal standard. The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item.

HISTORY New class in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcLine> list

Public Functions

::Ifc2x3::IfcCartesianPoint *Pnt() const

The location of the line.

void setPnt(::Ifc2x3::IfcCartesianPoint *v)
::Ifc2x3::IfcVector *Dir() const

The direction of the line, the magnitude and units of Dir affect the parameterization of the line.

void setDir(::Ifc2x3::IfcVector *v)
const IfcParse::entity &declaration() const
IfcLine(IfcEntityInstanceData *e)
IfcLine(::Ifc2x3::IfcCartesianPoint *v1_Pnt, ::Ifc2x3::IfcVector *v2_Dir)

Public Static Functions

const IfcParse::entity &Class()
class IfcLinearDimension : public Ifc2x3::IfcDimensionCurveDirectedCallout

Public Types

typedef IfcTemplatedEntityList<IfcLinearDimension> list

Public Functions

const IfcParse::entity &declaration() const
IfcLinearDimension(IfcEntityInstanceData *e)
IfcLinearDimension(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcLinearForceMeasure : public IfcUtil::IfcBaseType

IfcLinearForceMeasure is a measure of linear force. Usually measured in N/m. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLinearForceMeasure(IfcEntityInstanceData *e)
IfcLinearForceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLinearMomentMeasure : public IfcUtil::IfcBaseType

IfcLinearMomentMeasure is a measure of linear moment. Usually measured in Nm/m. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLinearMomentMeasure(IfcEntityInstanceData *e)
IfcLinearMomentMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLinearStiffnessMeasure : public IfcUtil::IfcBaseType

IfcLinearStiffnessMeasureA measure of linear stiffness. Usually measured in N/m. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLinearStiffnessMeasure(IfcEntityInstanceData *e)
IfcLinearStiffnessMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLinearVelocityMeasure : public IfcUtil::IfcBaseType

IfcLinearVelocityMeasure is a measure of the velocity of a body measured in terms of distance moved per unit time. Usually measured in m/s. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLinearVelocityMeasure(IfcEntityInstanceData *e)
IfcLinearVelocityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcLoadGroupTypeEnum

Public Types

enum Value

Definition from IAI: This type definition is used to distinguish between different levels of load grouping. It allows to differentiate between load groups, load cases, and load combinations. Normally, these enumeration types shall be used in the following context:

LOAD_GROUP groups instances of subtypes of IfcStructuralAction. It shall be used as a container for loads grouped together for specific purposes, e.g. loads which are part of a special load pattern. LOAD_CASE groups LOAD_GROUPs and instances of subtypes of IfcStructuralAction. It should be used as a container for loads with the same origin. LOAD_COMBINATION_GROUP is an intermediate level between LOAD_CASE and LOAD_COMBINATION. The purpose of this level is to provide a factor with which one or more LOAD_CASEs occur in a LOAD_COMBINATION. This factor cannot be specified directly at the load case if the load case is meant to occur in more than one combination with different factors. This intermediate level is obsolete. Instead, LOAD_COMBINATION is used to group load cases which act together into a load combination. USERDEFINED: A grouping level which does not follow the standard hierarchy of load group types. NOTDEFINED: The grouping level is not yet known.

HISTORY: New type in IFC 2x2.

IFC 2x4 change: Obsolete item LOAD_COMBINATION_GROUP removed. Load cases are directly assigned to load combinations with different factors for each load case—load combination pair by means of IfcRelAssignsToGroupByFactor.

Values:

enumerator IfcLoadGroupType_LOAD_GROUP
enumerator IfcLoadGroupType_LOAD_CASE
enumerator IfcLoadGroupType_LOAD_COMBINATION_GROUP
enumerator IfcLoadGroupType_LOAD_COMBINATION
enumerator IfcLoadGroupType_USERDEFINED
enumerator IfcLoadGroupType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLocalPlacement : public Ifc2x3::IfcObjectPlacement

IfcLocalPlacement defines the relative placement of a product in relation to the placement of another product or the absolute placement of a product within the geometric representation context of the project. IfcLocalPlacement allows that an IfcProduct can be placed by this IfcLocalPlacement (through the attributeObjectPlacement) within the local coordinate system of the object placement of another IfcProduct, which is referenced by the PlacementRelTo. Rules to prevent cyclic relative placements have to be introduced on the application level. If the PlacementRelTo is not given, then the IfcProduct is placed absolutely within the world coordinate system.

HISTORY: New entity in IFC Release 1.0.

Geometry use definitions The following conventions shall apply as default relative positions if the relative placement is used. The conventions are given for all five direct subtypes of IfcProduct, the IfcSpatialStructureElement, IfcElement, IfcAnnotation, IfcGrid, IfcPort. More detailed placement information is given at the level of subtypes of those five types mentioned.

For the subtypes of IfcSpatialStructureElement the following conventions apply

IfcSite shall be placed absolutely within the world coordinate system established by the geometric representation context of the IfcProject IfcBuilding shall be placed relative to the local placement of IfcSite IfcBuildingStorey shall be placed relative to the local placement of IfcBuilding

For IfcGrid and IfcAnnotation the convention applies that it shall be placed relative

to the local placement of its container (IfcSite, IfcBuilding, IfcBuildingStorey)

it should be the same container element that is referenced by the IfcRelContainedInSpatialStructure containment relationship,

For IfcPort the convention applies that it shall be placed relative

to the local placement of the element it belongs to (IfcElement)

it should be the same element that is referenced by the IfcRelConnectsPortToElement connection relationship,

For IfcElement the convention applies that it shall be placed relative:

to the local placement of its container (IfcSite, IfcBuilding, IfcBuildingStorey)

it should be the same container element that is referenced by the IfcRelContainedInSpatialStructure containment relationship,

to the local placement of the IfcElement to which it is tied by an element composition relationship

for features that are located relative to the main component (such as openings), as expressed by IfcRelVoidsElement and IfcRelProjectsElement, for elements that fill an opening (such as doors or windows), as expressed byIfcRelFillsElement, for coverings that cover the element, as expressed byIfcRelCoversBldgElements, for sub components that are aggregated to the main component, as expressed by IIfcRelAggregates and IfcRelNests)

If the PlacementRelTo relationship is not given, then it defaults to an absolute placement within the world coordinate system established by the referenced geometric representation context within the project.

Public Types

typedef IfcTemplatedEntityList<IfcLocalPlacement> list

Public Functions

bool hasPlacementRelTo() const

Whether the optional attribute PlacementRelTo is defined for this IfcLocalPlacement.

::Ifc2x3::IfcObjectPlacement *PlacementRelTo() const

Reference to Object that provides the relative placement by its local coordinate system. If it is omitted, then the local placement is given to the WCS, established by the geometric representation context.

void setPlacementRelTo(::Ifc2x3::IfcObjectPlacement *v)
::Ifc2x3::IfcAxis2Placement *RelativePlacement() const

Geometric placement that defines the transformation from the related coordinate system into the relating. The placement can be either 2D or 3D, depending on the dimension count of the coordinate system.

void setRelativePlacement(::Ifc2x3::IfcAxis2Placement *v)
const IfcParse::entity &declaration() const
IfcLocalPlacement(IfcEntityInstanceData *e)
IfcLocalPlacement(::Ifc2x3::IfcObjectPlacement *v1_PlacementRelTo, ::Ifc2x3::IfcAxis2Placement *v2_RelativePlacement)

Public Static Functions

const IfcParse::entity &Class()
class IfcLocalTime : public IfcUtil::IfcBaseEntity

Public Types

typedef IfcTemplatedEntityList<IfcLocalTime> list

Public Functions

int HourComponent() const
void setHourComponent(int v)
bool hasMinuteComponent() const

Whether the optional attribute MinuteComponent is defined for this IfcLocalTime.

int MinuteComponent() const
void setMinuteComponent(int v)
bool hasSecondComponent() const

Whether the optional attribute SecondComponent is defined for this IfcLocalTime.

double SecondComponent() const
void setSecondComponent(double v)
bool hasZone() const

Whether the optional attribute Zone is defined for this IfcLocalTime.

::Ifc2x3::IfcCoordinatedUniversalTimeOffset *Zone() const
void setZone(::Ifc2x3::IfcCoordinatedUniversalTimeOffset *v)
bool hasDaylightSavingOffset() const

Whether the optional attribute DaylightSavingOffset is defined for this IfcLocalTime.

int DaylightSavingOffset() const
void setDaylightSavingOffset(int v)
const IfcParse::entity &declaration() const
IfcLocalTime(IfcEntityInstanceData *e)
IfcLocalTime(int v1_HourComponent, boost::optional<int> v2_MinuteComponent, boost::optional<double> v3_SecondComponent, ::Ifc2x3::IfcCoordinatedUniversalTimeOffset *v4_Zone, boost::optional<int> v5_DaylightSavingOffset)

Public Static Functions

const IfcParse::entity &Class()
class IfcLogical : public IfcUtil::IfcBaseType

IfcLogical</iL is a defined type of simple type Logical. It is required since a select type (IfcSimpleValue) cannot directly include simple types in its select list). Logical datatype can have values TRUE, FALSE or UNKNOWN.

Type: LOGICAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLogical(IfcEntityInstanceData *e)
IfcLogical(bool v)
operator bool() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcLogicalOperatorEnum

Public Types

enum Value

Definition: IfcLogicalOperatorEnum is an enumeration that defines the logical operators that may be applied for the satisfaction of one or more operands (IfcConstraint) at a time.

HISTORY New type in IFC Release 2.0. Renamed from IfcConstraintAggregatorEnum in IFC 2x2

IFC2x4 CHANGE: Extended to include LOGICALXOR, LOGICALNOTAND and LOGICALNOTOR.

Enumeration

Value Definition

LOGICALAND Defines a relationship between operands whereby the result is true if all operands are true, i.e. false if at least

one operand is false.

LOGICALOR Defines a relationship between operands whereby the result is true if at least one operand is true, i.e false if

all operands are false.

LOGICALXOR Defines a relationship between operands whereby the result is true if exactly one operand is true (exclusive or).

LOGICALNOTAND Defines a relationship between operands whereby the result is true if at least one operand is false, i.e false if

all operands are true.

LOGICALNOTOR Defines a relationship between operands whereby the result is true if all operands are false, i.e false if at least

one operand is true.

Use Definition

The IfcLogicalOperatorEnum, when applied in a case of three operands, A, B and C, evaluates for each operator as

follows:

TRUTH TABLE: LOGICALAND(A,B,C)

A F F F T F T T T

B F F T F T F T T

C F T F F T T F T

AND F F F F F F F T

TRUTH TABLE: LOGICALOR(A,B,C)

A F F F T F T T T

B F F T F T F T T

C F T F F T T F T

OR F T T T T T T T

TRUTH TABLE: LOGICALXOR(A,B,C)

A F F F T F T T T

B F F T F T F T T

C F T F F T T F T

XOR F T T T F F F F

TRUTH TABLE: LOGICALNOTAND(A,B,C)

A F F F T F T T T

B F F T F T F T T

C F T F F T T F T

NOTAND T T T T T T T F

TRUTH TABLE: LOGICALNOTOR(A,B,C)

A F F F T F T T T

B F F T F T F T T

C F T F F T T F T

NOTOR T F F F F F F F

Values:

enumerator IfcLogicalOperator_LOGICALAND
enumerator IfcLogicalOperator_LOGICALOR

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcLoop : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A loop is a topological entity constructed from a single vertex, or by stringing together connected (oriented) edges, or linear segments beginning and ending at the same vertex. It is typically used to bound a face lying on a surface. A loop has dimensionality of 0 or 1. The domain of a 0-dimensional loop is a single point. The domain of a 1-dimensional loop is a connected, oriented curve, but need not to be manifold. As the loop is a circle, the location of its beginning/ending point is arbitrary. The domain of the loop includes its bounds, an 0 ≤ Ξ < ∞.

A loop is represented by a single vertex, or by an ordered collection of oriented edges, or by an ordered collection of points. A loop is a graph, so M and the graph genus Gl may be determined by the graph traversal algorithm. Since M = 1, the Euler equation (1) reduces in this case to

where V and El are the number of unique vertices and oriented edges in the loop and Gl is the genus of the loop.

NOTE

Corresponding ISO 10303 entity: loop, the following subtypes have been incorporated into IFC: poly_loop as IfcPolyLoop, vertex_loop as IfcVertexLoop, edge_loop as IfcEdgeLoop. Please refer to ISO/IS 10303-42:1994, p. 136 for the final definition of the formal standard.

HISTORY New Entity in IFC2x. Informal propositions:

A loop has a finite extent. A loop describes a closed (topological) curve with coincident start and end vertices.

Subclassed by Ifc2x3::IfcEdgeLoop, Ifc2x3::IfcPolyLoop, Ifc2x3::IfcVertexLoop

Public Types

typedef IfcTemplatedEntityList<IfcLoop> list

Public Functions

const IfcParse::entity &declaration() const
IfcLoop(IfcEntityInstanceData *e)
IfcLoop()

Public Static Functions

const IfcParse::entity &Class()
class IfcLShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcLShapeProfileDef defines a section profile that provides the defining parameters of an L-shaped section (equilateral L profiles are also covered by this entity) to be used by the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The shorter leg has the same direction as the positive Position.P[1]-axis, the longer or equal leg the same as the positive Position.P[2]-axis. The centre of the position coordinate system is in the profiles centre of the bounding box.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE All profile origins are now in the center of the bounding box.

IFC2x4 CHANGE Width changed from OPTIONAL to mandatory. The previously informal rule that the longer leg is the Depth has been formalized. Types of FilletRadius and EdgeRadius were relaxed to allow for zero values. Trailing attributes CentreOfGravityInX and CentreOfGravityInY deleted, use respective properties in IfcExtendedProfileProperties instead. WHERE rule which required Width <= Depth removed.

Figure 319 illustrates parameters of equal-sided and non-equal sided L-shaped section definitions.

Position The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

by using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile.

In the illustrated example, the ‘CentreOfGravityInX’ and ‘CentreOfGravityInY’ properties in IfcExtendedProfileProperties, if provided, are both negative.

Note: The black coordinate axes show the underlying coordinate system of the swept surface or swept area solid

Position The profile is inserted into the underlying coordinate system of the swept area solid by using the Position attribute. In this example (cardinal point of gravity) the attribute values of IfcAxis2Placement2D are:

Location = IfcCartesianPoint( +|CentreOfGravityInX|, +|CentreOfGravityInY|) RefDirection = NIL (defaults to 1.,0.)

In the illustrated example, the x and y value of Position.Location, i.e. the measures |CentreOfGravityInX| and |CentreOfGravityInY| are both positive. On the other hand, the properties named ‘CentreOfGravityInX’ and ‘CentreOfGravityInY’ in IfcExtendedProfileProperties, if provided, must both be set to 0 now because the centre of gravity of the resulting profile definition is located in the coordinate origin.

Figure 319 — L-shape profile

Public Types

typedef IfcTemplatedEntityList<IfcLShapeProfileDef> list

Public Functions

double Depth() const

Leg length, see illustration above (= h). Same as the overall depth.

void setDepth(double v)
bool hasWidth() const

Whether the optional attribute Width is defined for this IfcLShapeProfileDef.

double Width() const

Leg length, see illustration above (= b). Same as the overall width.

void setWidth(double v)
double Thickness() const

Constant wall thickness of profile, see illustration above (= ts).

void setThickness(double v)
bool hasFilletRadius() const

Whether the optional attribute FilletRadius is defined for this IfcLShapeProfileDef.

double FilletRadius() const

Fillet radius according the above illustration (= r1).

void setFilletRadius(double v)
bool hasEdgeRadius() const

Whether the optional attribute EdgeRadius is defined for this IfcLShapeProfileDef.

double EdgeRadius() const

Edge radius according the above illustration (= r2).

void setEdgeRadius(double v)
bool hasLegSlope() const

Whether the optional attribute LegSlope is defined for this IfcLShapeProfileDef.

double LegSlope() const

Slope of the inner face of each leg of the profile.

void setLegSlope(double v)
bool hasCentreOfGravityInX() const

Whether the optional attribute CentreOfGravityInX is defined for this IfcLShapeProfileDef.

double CentreOfGravityInX() const
void setCentreOfGravityInX(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcLShapeProfileDef.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcLShapeProfileDef(IfcEntityInstanceData *e)
IfcLShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Depth, boost::optional<double> v5_Width, double v6_Thickness, boost::optional<double> v7_FilletRadius, boost::optional<double> v8_EdgeRadius, boost::optional<double> v9_LegSlope, boost::optional<double> v10_CentreOfGravityInX, boost::optional<double> v11_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcLuminousFluxMeasure : public IfcUtil::IfcBaseType

IfcLuminousFluxMeasure is a measure of the luminous flux. Usually measured in Lumen (lm, Candela Steradian). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLuminousFluxMeasure(IfcEntityInstanceData *e)
IfcLuminousFluxMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLuminousIntensityDistributionMeasure : public IfcUtil::IfcBaseType

IfcLuminousIntensityDistributionMeasure is a measure of the luminous intensity of a light source that changes according to the direction of the ray. It is normally based on some standardized distribution light distribution curves.

Usually measured in Candela/Lumen (cd/lm) or (cd/klm).

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLuminousIntensityDistributionMeasure(IfcEntityInstanceData *e)
IfcLuminousIntensityDistributionMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcLuminousIntensityMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A luminous intensity measure is the value for the brightness of a body. Usually measured in candela (cd). Type: REAL

NOTE Corresponding ISO 10303 name: luminous_intensity_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcLuminousIntensityMeasure(IfcEntityInstanceData *e)
IfcLuminousIntensityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMagneticFluxDensityMeasure : public IfcUtil::IfcBaseType

IfcMagneticFluxDensityMeasure is a measure of the magnetic flux density. Usually measured in Tesla (T, Weber/m2 = V s/m2). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMagneticFluxDensityMeasure(IfcEntityInstanceData *e)
IfcMagneticFluxDensityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMagneticFluxMeasure : public IfcUtil::IfcBaseType

IfcMagneticFluxMeasure is a measure of the magnetic flux. Usually measured in Weber (Wb, V s). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMagneticFluxMeasure(IfcEntityInstanceData *e)
IfcMagneticFluxMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcManifoldSolidBrep : public Ifc2x3::IfcSolidModel

Definition from ISO/CD 10303-42:1992: A manifold solid B-rep is a finite, arcwise connected volume bounded by one or more surfaces, each of which is a connected, oriented, finite, closed 2-manifold. There is no restriction on the genus of the volume, nor on the number of voids within the volume. The Boundary Representation (B-rep) of a manifold solid utilizes a graph of edges and vertices embedded in a connected, oriented, finite, closed two manifold surface. The embedded graph divides the surface into arcwise connected areas known as faces. The edges and vertices, therefore, form the boundaries of the face and the domain of a face does not include its boundaries. The embedded graph may be disconnected and may be a pseudo graph. The graph is labeled; that is, each entity in the graph has a unique identity. The geometric surface definition used to specify the geometry of a face shall be 2-manifold embeddable in the plane within the domain of the face. In other words, it shall be connected, oriented, finite, non-self-intersecting, and of surface genus 0. Faces do not intersect except along their boundaries. Each edge along the boundary of a face is shared by at most one other face in the assemblage. The assemblage of edges in the B-rep do not intersect except at their boundaries (i.e., vertices). The geometry curve definition used to specify the geometry of an edge shall be arcwise connected and shall not self intersect or overlap within the domain of the edge. The geometry of an edge shall be consistent with the geometry of the faces of which it forms a partial bound. The geometry used to define a vertex shall be consistent with the geometry of the faces and edges of which it forms a partial bound. A B-rep is represented by one or more closed shells which shall be disjoint. One shell, the outer, shall completely enclose all the other shells and no other shell may enclose a shell. The facility to define a B-rep with one or more internal voids is provided by a subtype. The following version of the Euler formula shall be satisfied, where V, E, F, Ll and S are the numbers of unique vertices, edges, faces, loop uses and shells in the model and Gs is the sum of the genus of the shells.

Instances of type IfcManifoldSolidBrep shall be of type IfcFacetedBrep, using only IfcPolyLoop for the bounds of IfcFaceBound, or of type IfcAdvancedBrep, using only IfcAdvancedFace for the face geometry, and IfcEdgeCurve for the edges.

NOTE: Corresponding ISO 10303-42 entity: manifold_solid_brep. Please refer to ISO/IS 10303-42:1994, p. 170 for the final definition of the formal standard. IfcManifoldSolidBrep is defined as ABSTRACT supertype to prevent it from direct instantiation.

HISTORY: New entity in IFC Release 1.0

Informal proposition:

The dimensionality of a manifold solid brep shall be 3. The extent of the manifold solid brep shall be finite and non-zero. All elements of the manifold solid brep shall have defined associated geometry. The shell normals shall agree with the B-rep normal and point away from the solid represented by the B-rep. Each face shall be referenced only once by the shells of the manifold solid brep. The Euler equation shall be satisfied for the boundary representation, where the genus term “shell term” us the sum of the genus values for the shells of the brep.

Subclassed by Ifc2x3::IfcFacetedBrep, Ifc2x3::IfcFacetedBrepWithVoids

Public Types

typedef IfcTemplatedEntityList<IfcManifoldSolidBrep> list

Public Functions

::Ifc2x3::IfcClosedShell *Outer() const

A closed shell defining the exterior boundary of the solid. The shell normal shall point away from the interior of the solid.

void setOuter(::Ifc2x3::IfcClosedShell *v)
const IfcParse::entity &declaration() const
IfcManifoldSolidBrep(IfcEntityInstanceData *e)
IfcManifoldSolidBrep(::Ifc2x3::IfcClosedShell *v1_Outer)

Public Static Functions

const IfcParse::entity &Class()
class IfcMappedItem : public Ifc2x3::IfcRepresentationItem

Definition from ISO/CD 10303-43:1992: A mapped item is the use of an existing representation (the mapping source - mapped representation) as a representation item in a second representation.

NOTE: A mapped item is a subtype of representation item. It enables a representation to be used as a representation item in one or more other representations. The mapped item allows for the definition of a representation using other representations.

The IfcMappedItem is the inserted instance of a source definition (to be compared with a block / shared cell / macro definition). The instance is inserted by applying a Cartesian transformation operator as the MappingTarget.

EXAMPLE An IfcMappedItem can reuse other mapped items (ako nested blocks), doing so the IfcRepresentationMap is based on an IfcShapeRepresentation including one or more IfcMappedItem’s.

NOTE Corresponding ISO 10303 entity: mapped_item. Please refer to ISO/IS 10303-43:1994, for the final definition of the formal standard. The definition of mapping_target (MappingTarget) has been restricted to be of the type cartesian_transformation_operator (IfcCartesianTransformationOperator).

HISTORY New entity in IFC Release 2x.

Informal Propositions

A mapped item shall not be self-defining by participating in the definition of the representation being mapped. The dimensionality of the mapping source and the mapping target has to be the same, if the mapping source is a geometric representation item.

Public Types

typedef IfcTemplatedEntityList<IfcMappedItem> list

Public Functions

::Ifc2x3::IfcRepresentationMap *MappingSource() const

A representation map that is the source of the mapped item. It can be seen as a block (or cell or marco) definition.

void setMappingSource(::Ifc2x3::IfcRepresentationMap *v)
::Ifc2x3::IfcCartesianTransformationOperator *MappingTarget() const

A representation item that is the target onto which the mapping source is mapped. It is constraint to be a Cartesian transformation operator.

void setMappingTarget(::Ifc2x3::IfcCartesianTransformationOperator *v)
const IfcParse::entity &declaration() const
IfcMappedItem(IfcEntityInstanceData *e)
IfcMappedItem(::Ifc2x3::IfcRepresentationMap *v1_MappingSource, ::Ifc2x3::IfcCartesianTransformationOperator *v2_MappingTarget)

Public Static Functions

const IfcParse::entity &Class()
class IfcMassDensityMeasure : public IfcUtil::IfcBaseType

IfcMassDensityMeasure is a measure of the density of a medium. Usually measured in kg/m3. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMassDensityMeasure(IfcEntityInstanceData *e)
IfcMassDensityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMassFlowRateMeasure : public IfcUtil::IfcBaseType

IfcMassFlowRateMeasure is a measure of the mass of a medium flowing per unit time. Usually measured in kg/s. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMassFlowRateMeasure(IfcEntityInstanceData *e)
IfcMassFlowRateMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMassMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A mass measure is the value of the amount of matter that a body contains. Usually measured in kilograms (kg) or grams (g). Type: REAL

NOTE Corresponding ISO 10303 name: mass_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMassMeasure(IfcEntityInstanceData *e)
IfcMassMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMassPerLengthMeasure : public IfcUtil::IfcBaseType

IfcMassPerLengthMeasure is a measure for mass per length. For example for rolled steel profiles the weight of an imaginary beam is usually expressed by kg/m length for cost calculation and structural analysis purposes.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMassPerLengthMeasure(IfcEntityInstanceData *e)
IfcMassPerLengthMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMaterial : public IfcUtil::IfcBaseEntity

IfcMaterial is a homogeneous or inhomogeneous substance that can be used to form elements (physical products or their components). IfcMaterial is the basic entity for material designation and definition; this includes identification by name and classification (via reference to an external classification), as well as association of material properties (isotropic or anisotropic) defined by (subtypes of) IfcMaterialProperties. An instance of IfcMaterial may be associated to an element or element type using the IfcRelAssociatesMaterial relationship. The assignment might either be direct as a single material information, or via

a material layer set a material profile set a material constituent set

An IfcMaterial may also have presentation information associated. Such presentation information is provided by IfcMaterialDefinitionRepresentation, associating line styles, hatching definitions or surface coloring/rendering information to a material.

HISTORYNew entity in IFC2x4

IFC2x4 CHANGE The attributes Description and Category have been added.

Public Types

typedef IfcTemplatedEntityList<IfcMaterial> list

Public Functions

std::string Name() const

Name of the material.

EXAMPLE A view definition may require Material.Name to uniquely specify e.g. concrete or steel grade, in which case the attribute Material.Category could take the value ‘Concrete’ or ‘Steel’.

NOTE Material grade may have diffenrent meaning in different view definitions, e.g. strength grade for structural design and analysis, or visible appearance grade in architectural application. Also, more elaborate material grade definition may be associated as classification via inverse attribute HasExternalReferences.

void setName(std::string v)
IfcTemplatedEntityList<IfcMaterialDefinitionRepresentation>::ptr HasRepresentation() const
IfcTemplatedEntityList<IfcMaterialClassificationRelationship>::ptr ClassifiedAs() const
const IfcParse::entity &declaration() const
IfcMaterial(IfcEntityInstanceData *e)
IfcMaterial(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialClassificationRelationship : public IfcUtil::IfcBaseEntity

IfcMaterialClassificationRelationship is a relationship assigning classifications to materials.

HISTORY New entity in IFC2x.

IFC2x4 CHANGE The entity IfcMaterialClassificationRelationship is deprecated since IFC2x4 and shall no longer be used. Use IfcExternalReferenceRelationship instead.

Public Functions

IfcEntityList::ptr MaterialClassifications() const

The material classifications identifying the type of material.

void setMaterialClassifications(IfcEntityList::ptr v)
::Ifc2x3::IfcMaterial *ClassifiedMaterial() const

Material being classified.

void setClassifiedMaterial(::Ifc2x3::IfcMaterial *v)
const IfcParse::entity &declaration() const
IfcMaterialClassificationRelationship(IfcEntityInstanceData *e)
IfcMaterialClassificationRelationship(IfcEntityList::ptr v1_MaterialClassifications, ::Ifc2x3::IfcMaterial *v2_ClassifiedMaterial)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialDefinitionRepresentation : public Ifc2x3::IfcProductRepresentation

IfcMaterialDefinitionRepresentation defines presentation information relating to IfcMaterial. It allows for multiple presentations of the same material for different geometric representation contexts.

NOTE The IfcMaterialDefinitionRepresentation is currently only used to define presentation information to material used at element occurrences, defined as subtypes of IfcElement, or at element types, defined as subtypes of IfcElementType. The IfcMaterial is assigned to the subtype of IfcElement, or IfcElementType using the IfcRelAssociatesMaterial relationship (eventually via other material related entities IfcMaterialLayerSetUsage, IfcMaterialLayerSet, IfcMaterialLayer, or IfcMaterialProfileSetUsage, IfcMaterialProfileSet, IfcMaterialProfile).

The IfcMaterialDefinitionRepresentation can apply

different presentation styles for different representation contexts, for example, a different style for sketch view, model view or plan view, or for different target scales, for each representation context is can apply curve style, fill area style (hatching), symbol, text and surface style.

HISTORY New entity in IFC2x3.

IFC2x3 CHANGE The entity IfcMaterialDefinitionRepresentation has been added. Upward compatibility for file based exchange is guaranteed.

IFC2x4 CHANGE The assignment of curve, surface and other styles to an IfcStyledItem has been simplified by IfcStyleAssignmentSelect. The use of intermediate IfcPresentationStyleAssignment is deprecated.

Use definition

As shown in Figure 331, the presentation assignment can be specific to a representation context by adding one and more IfcStyledRepresentation’s. Each of them includes a single IfcStyledItem with exactly zero or one style for either curve, fill area, surface, text or symbol style that is applicable.

Figure 331 — Material definition representation

Public Functions

::Ifc2x3::IfcMaterial *RepresentedMaterial() const

Reference to the material to which the representation applies.

void setRepresentedMaterial(::Ifc2x3::IfcMaterial *v)
const IfcParse::entity &declaration() const
IfcMaterialDefinitionRepresentation(IfcEntityInstanceData *e)
IfcMaterialDefinitionRepresentation(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentation>::ptr v3_Representations, ::Ifc2x3::IfcMaterial *v4_RepresentedMaterial)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialLayer : public IfcUtil::IfcBaseEntity

IfcMaterialLayer is a single and identifiable part of an element which is constructed of a number of layers (one or more). Each IfcMaterialLayer has a constant thickness and is located relative to the referencing IfcMaterialLayerSet along the MlsBase.

EXAMPLE A cavity wall with brick masonry used with an air gap in between would be modeled using three IfcMaterialLayer’s: [1] Brick, [2] Air gap, [3] Brick. The inner layer “Brick” would have a Name = “Brick”, an individual LayerThickness, and potentially a Category indicating it as “load bearing”, and a Priority that controls how this material layer interacts with other material layers in wall connections.

The IfcMaterialLayer may have a material layer name, that might be different to the IfcMaterial name referenced.

EXAMPLE The IfcMaterialLayer name of an insulation layer can be “Insulation”, whereas the IfcMaterial

name is “polystyrene insulating

boards”.

HISTORY New entity in IFC 1.5

IFC2x4 CHANGE The attributes Name, Description, Category, Priority have been added at the end of attribute list. Data type of LayerThickness relaxed to IfcNonNegativeLengthMeasure.

Public Types

typedef IfcTemplatedEntityList<IfcMaterialLayer> list

Public Functions

bool hasMaterial() const

Whether the optional attribute Material is defined for this IfcMaterialLayer.

::Ifc2x3::IfcMaterial *Material() const

Optional reference to the material from which the layer is constructed. Note that if this value is not given, it does not denote a layer with no material (an air gap), it only means that the material is not specified at that point.

void setMaterial(::Ifc2x3::IfcMaterial *v)
double LayerThickness() const

The thickness of the material layer. The dimension is measured along the positive MlsDirection as specified in IfcMaterialLayerSet (that is mapped to AXIS-2, as specified in IfcMaterialLayerSetUsage for element occurrences supporting IfcMaterialLayerSetUsage.

NOTE The attribute value can be 0. for material thicknesses very close to zero, such as for a membrane. Material layers with thickess 0. shall not be rendered in the geometric representation.

IFC2x4 CHANGE The attribute datatype has been changed to IfcNonNegativeLengthMeasure allowing for 0. as thickness.

void setLayerThickness(double v)
bool hasIsVentilated() const

Whether the optional attribute IsVentilated is defined for this IfcMaterialLayer.

bool IsVentilated() const

Indication of whether the material layer represents an air layer (or cavity).

set to TRUE if the material layer is an air gap and provides air exchange from the layer to the outside air. set to UNKNOWN if the material layer is an air gap and does not provide air exchange (or when this information about air exchange of the air gap is not available). set to FALSE if the material layer is a solid material layer (the default).

void setIsVentilated(bool v)
IfcTemplatedEntityList<IfcMaterialLayerSet>::ptr ToMaterialLayerSet() const
const IfcParse::entity &declaration() const
IfcMaterialLayer(IfcEntityInstanceData *e)
IfcMaterialLayer(::Ifc2x3::IfcMaterial *v1_Material, double v2_LayerThickness, boost::optional<bool> v3_IsVentilated)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialLayerSet : public IfcUtil::IfcBaseEntity

IfcMaterialLayerSet is a designation by which materials of an element constructed of a number of material layers is known and through which the relative positioning of individual layers can be expressed.

The Material Layer Set Base (MlsBase) describes the axis along which the material layers are positioned. The MlsBase is positioned along the reference axis or reference plane of the element supporting the IfcMaterialLayerSetUsage concept with a potential offset (see here). The positive Material Layer Set Direction (MlsDirection) describes the direction by which the individual material layers, with their material layer thicknesses are stacked. IfcMaterialLayer’s are stacked with no gap, gaps within a material layer set are expresses as layers by themselves.

EXAMPLE A cavity brick wall would be modeled as IfcMaterialLayerSet consisting of three IfcMaterialLayer’s: brick, air cavity and brick. The air gap is identified, using the IsVentilated flag at IfcMaterialLayer.

HISTORY New entity in IFC 1.0

IFC2x4 CHANGE Subtyped from IfcMaterialDefinition, the attribute Description has been added at the end of attribute list.

Attribute use definition As shown in Figure 285, each IfcMaterialLayerSet implicitly defines a material layer set base line (MlsBase), to which the start of the first IfcMaterialLayer is aligned. The total thickness of a layer set is calculated from the individual layer thicknesses, the first layer starting from the MlsBase and following layers being placed on top of the previous (no gaps or overlaps).

Figure 285 — Material layer set

Public Types

typedef IfcTemplatedEntityList<IfcMaterialLayerSet> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcMaterialLayer>::ptr MaterialLayers() const

Identification of the layers from which the material layer set is composed.

void setMaterialLayers(IfcTemplatedEntityList<::Ifc2x3::IfcMaterialLayer>::ptr v)
bool hasLayerSetName() const

Whether the optional attribute LayerSetName is defined for this IfcMaterialLayerSet.

std::string LayerSetName() const

The name by which the material layer set is known.

void setLayerSetName(std::string v)
const IfcParse::entity &declaration() const
IfcMaterialLayerSet(IfcEntityInstanceData *e)
IfcMaterialLayerSet(IfcTemplatedEntityList<::Ifc2x3::IfcMaterialLayer>::ptr v1_MaterialLayers, boost::optional<std::string> v2_LayerSetName)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialLayerSetUsage : public IfcUtil::IfcBaseEntity

IfcMaterialLayerSetUsage determines the usage of IfcMaterialLayerSet in terms of its location and orientation relative to the associated element geometry. The location of material layer set shall be compatible with the building element geometry (that is, material layers shall fit inside the element geometry). The rules to ensure the compatibility depend on the type of the building element.

EXAMPLE For a cavity brick wall with shape representation SweptSolid, the IfcMaterialLayerSet.TotalThickness shall be equal to the wall thickness. Also the OffsetFromReferenceLine shall match the exact positions between the two shape representations of IfcWallStandardCase, i.e. the IfcShapeRepresentation’s with RepresentationIdentifier=”Axis” and RepresentationIdentifier=”Body”.

NOTE Refer to the implementation guide and agreements for more information on matching between building element geometry and material layer set usage.

The IfcMaterialLayerSetUsage is always assigned to an individual occurrence object only (i.e. to relevant subtypes of IfcElement). The IfcMaterialLayerSet, referenced by ForLayerSet can however be shared among several occurrence objects. If the element type is available (i.e. the relevant subtype of IfcElementType, then the IfcMaterialLayerSet can be assigned to the type object. The assignment between asubtype of IfcElement and the IfcMaterialLayerSetUsage is handled by IfcRelAssociatesMaterial.

Use definition The IfcMaterialLayerSetUsage is primarily intended to be associated with planar building elements having a constant thickness. With further agreements on the interpretation of LayerSetDirection, the usage can be extended also to other cases, e.g. to curved building elements, provided that the material layer thicknesses are constant. Generally, an element may be layered in any of its primary directions, denoted by its x, y or z axis. The geometry use definitions at eachspecific types of building element will determine the applicableLayerSetDirection.

The following examples illustrate how the IfcMaterialLayerSetUsage attributes (LayerSetDirection, DirectionSense, OffsetFromReferenceLine) can be used in different cases. The normative material use definitions are documented at each element (how these shall be used).

Figure 286 shows an example of the use of IfcMaterialLayerSetUsage aligned to the axis of a wall.

EXAMPLE For a standard wall with extruded geometric representation (vertical extrusion), the layer set direction will be perpendicular to extrusion direction, andcan be derived from the direction of the wall axis. With the DirectionSense(positive in this example) the individual IfcMaterialLayers are assigned consecutively right-to-left or left-to-right. For a curved wall, “direction denoting the wall thickness” can be derived from the direction of the wall axis, and it will remain perpendicular to the wall path. The DirectionSenseapplies as well.

NOTE According to the IfcWallStandardCase material use definition the LayerSetDirection for IfcWallStandardCase is always AXIS2 (i.e. along the y-axis), as shown in this example.

Figure 286 — Material layer set usage for wall

Figure 287 shows an example of the use of IfcMaterialLayerSetUsage aligned to a slab.

EXAMPLEFor a slab with perpendicular extruded geometric representation, the LayerSetDirection will coincide with the extrusion direction (in positive or negative sense). In this example, the material layer set base is the extruded profile and consistent with the IfcExtrudedAreaSolid.Position,with the DirectionSensebeing positive, the individual IfcMaterialLayers are built up from the base towards positive z direction in this case.

NOTE According to the IfcSlabStandardCase material use definition the LayerSetDirection for IfcSlabStandardCase is always AXIS3 (i.e. along the z-axis).

Figure 287 — Material layer set usage for slab

Figure 288 shows an example of the use of IfcMaterialLayerSetUsage aligned to a roof slab with non-perpendicular extrusion.

EXAMPLEFor a slab with non-perpendicular extruded geometric representation, the guidelines above apply as well. The material layer thickness and the OffsetFromReferenceLine is always measured perpendicularly, even if the extrusion direction is not perpendicular. Therefore the total material layer thickness is not equal to the extrusion depth of the geometry.

Figure 288 — Material layer set usage for roof slab

Public Functions

::Ifc2x3::IfcMaterialLayerSet *ForLayerSet() const

The IfcMaterialLayerSet set to which the usage is applied.

void setForLayerSet(::Ifc2x3::IfcMaterialLayerSet *v)
::Ifc2x3::IfcLayerSetDirectionEnum::Value LayerSetDirection() const

Orientation of the material layer set relative to element reference geometry. The meaning of the value of this attribute shall be specified in the geometry use section for each element. For extruded shape representation, direction can be given along the extrusion path (e.g. for slabs) or perpendicular to it (e.g. for walls).

NOTE the LayerSetDirection for IfcWallStandardCase shall be AXIS2 (i.e. the y-axis) and for IfcSlabStandardCase and IfcPlateStandardCase it shall be AXIS3 (i.e. the z-axis).

Whether the material layers of the set being used shall ‘grow’ into the positive or negative direction of the given axis, shall be deifned by DirectionSense attribute.

void setLayerSetDirection(::Ifc2x3::IfcLayerSetDirectionEnum::Value v)
::Ifc2x3::IfcDirectionSenseEnum::Value DirectionSense() const

Denotion whether the material layer set is oriented in positive or negative sense along the specified axis (defined by LayerSetDirection). “Positive” means that the consecutive layers (the IfcMaterialLayer instances in the list of IfcMaterialLayerSet.MaterialLayers) are placed face-by-face in the direction of the positive axis as established by LayerSetDirection: for AXIS2 it would be in +y, for AXIS3 it would be +z. “Negative” means that the layers are placed face-by-face in the direction of the negative LayerSetDirection. In both cases, starting at the material layer set base line. NOTE the material layer set base line (MlsBase) is located by OffsetFromReferenceLine, and may be on the positive or negative side of the element reference line (or plane); positive or negative for MlsBase placement does not depend on the DirectionSense attribute, but on the relevant element axis.

void setDirectionSense(::Ifc2x3::IfcDirectionSenseEnum::Value v)
double OffsetFromReferenceLine() const

Offset of the material layer set base line (MlsBase) from reference geometry (line or plane) of element. The offset can be positive or negative, unless restricted for a particular building element type in its use definition or by implementer agreement. A positive value means, that the MlsBase is placed on the positive side of the reference line or plane, on the axis established by LayerSetDirection (in case of AXIS2 into the direction of +y, or in case of AXIS2 into the direction of +z). A negative value means that the MlsBase is placed on the negative side, as established by LayerSetDirection (in case of AXIS2 into the direction of -y). NOTE the positive or negative sign in the offset only affects the MlsBase placement, it does not have any effect on the application of DirectionSense for orientation of the material layers; also DirectionSense does not change the MlsBase placement.

void setOffsetFromReferenceLine(double v)
const IfcParse::entity &declaration() const
IfcMaterialLayerSetUsage(IfcEntityInstanceData *e)
IfcMaterialLayerSetUsage(::Ifc2x3::IfcMaterialLayerSet *v1_ForLayerSet, ::Ifc2x3::IfcLayerSetDirectionEnum::Value v2_LayerSetDirection, ::Ifc2x3::IfcDirectionSenseEnum::Value v3_DirectionSense, double v4_OffsetFromReferenceLine)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialList : public IfcUtil::IfcBaseEntity

IfcMaterialList is a list of the different materials that are used in an element.

NOTE: The class IfcMaterialList will normally be used where an element is described at a more abstract level. For example, for an architectural specification writer, the only information that may be needed about a concrete column is that it contains concrete, reinforcing steel and mild steel ligatures. It shall not be used for elements consisting of material layers when the different layers can be defined and the class IfcMaterialLayerSet can be used. Also, IfcMaterialList shall not be used for elements consisting of a single identifiable material (for example, to represent anisotropic material).

IFC2x4 CHANGE The entity IfcMaterialList is deprecated and shall no longer be used. Use IfcMaterialConstituentSet instead.

Public Types

typedef IfcTemplatedEntityList<IfcMaterialList> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcMaterial>::ptr Materials() const

Materials used in a composition of substances.

void setMaterials(IfcTemplatedEntityList<::Ifc2x3::IfcMaterial>::ptr v)
const IfcParse::entity &declaration() const
IfcMaterialList(IfcEntityInstanceData *e)
IfcMaterialList(IfcTemplatedEntityList<::Ifc2x3::IfcMaterial>::ptr v1_Materials)

Public Static Functions

const IfcParse::entity &Class()
class IfcMaterialProperties : public IfcUtil::IfcBaseEntity

IfcMaterialProperties is defined as an abstract supertype for entities that apply material properties to material definitions. A set of material properties that are assigned to an individual material definiton may be identified by a Name and a Description.

NOTE The set of material properties can be assigned to an individual IfcMaterial, a set or composite of materials (IfcMaterialConstituent, IfcMaterialConstituentSet), or set or individual material layer (IfcMaterialLayer, IfcMaterialLayerSet), or a set or individual material profile (IfcMaterialProfile, IfcMaterialProfileSet)

The applicable set of material properties is defined at the subtype IfcExtendedMaterialProperties. It includes material properties defined in this IFC specification and those defined as user-defined extended material properties.

HISTORY New Entity in IFC 2x.

IFC2x4 CHANGE The subtypes that represented a fixed list of statically defined material properties, IfcMechanicalMaterialProperties, IfcThermalMaterialProperties, IfcHygroscopicMaterialProperties, IfcGeneralMaterialProperties, IfcOpticalMaterialProperties, IfcWaterProperties, IfcFuelProperties, IfcProductsOfCombustionProperties have been deleted, use the generic IfcExtendedMaterialProperties instead.

Subclassed by Ifc2x3::IfcExtendedMaterialProperties, Ifc2x3::IfcFuelProperties, Ifc2x3::IfcGeneralMaterialProperties, Ifc2x3::IfcHygroscopicMaterialProperties, Ifc2x3::IfcMechanicalMaterialProperties, Ifc2x3::IfcOpticalMaterialProperties, Ifc2x3::IfcProductsOfCombustionProperties, Ifc2x3::IfcThermalMaterialProperties, Ifc2x3::IfcWaterProperties

Public Types

typedef IfcTemplatedEntityList<IfcMaterialProperties> list

Public Functions

::Ifc2x3::IfcMaterial *Material() const

Reference to the material definition to which the set of properties is assigned.

IFC2x4 CHANGE The datatype has been changed to supertype IfcMaterialDefinition.

void setMaterial(::Ifc2x3::IfcMaterial *v)
const IfcParse::entity &declaration() const
IfcMaterialProperties(IfcEntityInstanceData *e)
IfcMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material)

Public Static Functions

const IfcParse::entity &Class()
class IfcMeasureWithUnit : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: A measure with unit is the specification of a physical quantity as defined in ISO 31 (clause 2).

IfcMeasureWithUnit has two usages:

  1. For representing measure value together with its unit on the entity type attribute level; thus overriding the IFC model global unit assignments.

  2. For conversion based unit to give the conversion rate and its base.

NOTE Corresponding ISO 10303 name: measure_with_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcMeasureWithUnit> list

Public Functions

::Ifc2x3::IfcValue *ValueComponent() const

The value of the physical quantity when expressed in the specified units.

void setValueComponent(::Ifc2x3::IfcValue *v)
::Ifc2x3::IfcUnit *UnitComponent() const

The unit in which the physical quantity is expressed.

void setUnitComponent(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcMeasureWithUnit(IfcEntityInstanceData *e)
IfcMeasureWithUnit(::Ifc2x3::IfcValue *v1_ValueComponent, ::Ifc2x3::IfcUnit *v2_UnitComponent)

Public Static Functions

const IfcParse::entity &Class()
class IfcMechanicalConcreteMaterialProperties : public Ifc2x3::IfcMechanicalMaterialProperties

Public Functions

bool hasCompressiveStrength() const

Whether the optional attribute CompressiveStrength is defined for this IfcMechanicalConcreteMaterialProperties.

double CompressiveStrength() const
void setCompressiveStrength(double v)
bool hasMaxAggregateSize() const

Whether the optional attribute MaxAggregateSize is defined for this IfcMechanicalConcreteMaterialProperties.

double MaxAggregateSize() const
void setMaxAggregateSize(double v)
bool hasAdmixturesDescription() const

Whether the optional attribute AdmixturesDescription is defined for this IfcMechanicalConcreteMaterialProperties.

std::string AdmixturesDescription() const
void setAdmixturesDescription(std::string v)
bool hasWorkability() const

Whether the optional attribute Workability is defined for this IfcMechanicalConcreteMaterialProperties.

std::string Workability() const
void setWorkability(std::string v)
bool hasProtectivePoreRatio() const

Whether the optional attribute ProtectivePoreRatio is defined for this IfcMechanicalConcreteMaterialProperties.

double ProtectivePoreRatio() const
void setProtectivePoreRatio(double v)
bool hasWaterImpermeability() const

Whether the optional attribute WaterImpermeability is defined for this IfcMechanicalConcreteMaterialProperties.

std::string WaterImpermeability() const
void setWaterImpermeability(std::string v)
const IfcParse::entity &declaration() const
IfcMechanicalConcreteMaterialProperties(IfcEntityInstanceData *e)
IfcMechanicalConcreteMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_DynamicViscosity, boost::optional<double> v3_YoungModulus, boost::optional<double> v4_ShearModulus, boost::optional<double> v5_PoissonRatio, boost::optional<double> v6_ThermalExpansionCoefficient, boost::optional<double> v7_CompressiveStrength, boost::optional<double> v8_MaxAggregateSize, boost::optional<std::string> v9_AdmixturesDescription, boost::optional<std::string> v10_Workability, boost::optional<double> v11_ProtectivePoreRatio, boost::optional<std::string> v12_WaterImpermeability)

Public Static Functions

const IfcParse::entity &Class()
class IfcMechanicalFastener : public Ifc2x3::IfcFastener

Definition from IAI: Fasteners connecting building elements mechanically. A single instance of this class may represent one or many of actual mechanical fasteners, for example an array of bolts or a row of nails.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Supertype changed from IfcFastener to IfcElementComponent. Attribute PredefinedType added. Attributes NominalDiameter and NominalLength moved to IfcMechanicalFastenerType.

Geometry Use Definition

See definitions at the supertype IfcElementComponent.

In addition, a symbolic representation is defined for a row of fasteners or several rows of fasteners within a single instance of IfcMechanicalFastener. Such rows or arrays may contain possibly large numbers of individual pieces. The product definition shape consists of an IfcShapeRepresentation with the attribute values

RepresentationIdentifier : ‘Row’ RepresentationType : ‘GeometricCurveSet’

and one or several curves as geometric items. The curves represent where the heads of the fasteners are located. The local placement of the IfcMechanicalFastener shall be located and oriented such that the local z axis is parallel with the axes of the fasteners (bolts, nails, staples or similar).

In case of such a symbolic ‘Row’ representation, an IfcElementQuantity should be attached to the IfcMechanicalFastener via IfcRelDefinesByProperties. The quantity should contain an IfcQuantityCount named ‘Count’ with the number of fasteners and an IfcQuantityLength named ‘Spacing’ which expresses the center-to-center distances of fasteners.

Public Types

typedef IfcTemplatedEntityList<IfcMechanicalFastener> list

Public Functions

bool hasNominalDiameter() const

Whether the optional attribute NominalDiameter is defined for this IfcMechanicalFastener.

double NominalDiameter() const
void setNominalDiameter(double v)
bool hasNominalLength() const

Whether the optional attribute NominalLength is defined for this IfcMechanicalFastener.

double NominalLength() const
void setNominalLength(double v)
const IfcParse::entity &declaration() const
IfcMechanicalFastener(IfcEntityInstanceData *e)
IfcMechanicalFastener(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_NominalDiameter, boost::optional<double> v10_NominalLength)

Public Static Functions

const IfcParse::entity &Class()
class IfcMechanicalFastenerType : public Ifc2x3::IfcFastenerType

Definition from IAI: The element type (IfcMechanicalFastenerType) defines a list of commonly shared property set definitions of a fastener and an optional set of product representations. It is used to define mechanical fasteners mainly within structural and building services domains (i.e. the specific type information common to all occurrences of that type).

The occurrences of the IfcMechanicalFastenerType are represented by instances of IfcMechanicalFastener.

HISTORY New entity in IFC Release 2x2

IFC 2x4 change: Supertype changed from IfcFastenerType to IfcElementComponentType. Attributes PredefinedType, NominalDiameter, NominalLength added.

Mechanical fasteners, especially bolts, are often standardized. To refer to a formal fastener designation according to a standard (a product norm), IfcRelAssociatesClassification together with IfcClassificationReference should be used.

IfcClassificationReference.ItemReference contains a machine-readable form of the formal fastener designation from the norm. Example: ‘M16X80-10.9-HV’ for a high-strength structural bolting assembly for preloading with hexagon bolt and nut. (On the other hand, IfcMechanicalFastenerType.Name contains a displayable name which may not necessarily be the same as the formal designation.) IfcClassificationReference.Name carries the short name of the fastener norm. Example: ‘EN 14399-4’ as the respective European standard for high-strength hexagon bolts. Optionally, the norm can be further described by IfcClassificationReference.ReferencedSource, including information like publisher and date of issue of the norm.

Furthermore, IfcRelAssociatesLibrary together with IfcLibraryReference may be used to refer to a library which contains fastener definitions.

Property Set Use Definition

The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute.

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_MechanicalFastenerBolt (BOLT)

Public Functions

const IfcParse::entity &declaration() const
IfcMechanicalFastenerType(IfcEntityInstanceData *e)
IfcMechanicalFastenerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcMechanicalMaterialProperties : public Ifc2x3::IfcMaterialProperties

Subclassed by Ifc2x3::IfcMechanicalConcreteMaterialProperties, Ifc2x3::IfcMechanicalSteelMaterialProperties

Public Functions

bool hasDynamicViscosity() const

Whether the optional attribute DynamicViscosity is defined for this IfcMechanicalMaterialProperties.

double DynamicViscosity() const
void setDynamicViscosity(double v)
bool hasYoungModulus() const

Whether the optional attribute YoungModulus is defined for this IfcMechanicalMaterialProperties.

double YoungModulus() const
void setYoungModulus(double v)
bool hasShearModulus() const

Whether the optional attribute ShearModulus is defined for this IfcMechanicalMaterialProperties.

double ShearModulus() const
void setShearModulus(double v)
bool hasPoissonRatio() const

Whether the optional attribute PoissonRatio is defined for this IfcMechanicalMaterialProperties.

double PoissonRatio() const
void setPoissonRatio(double v)
bool hasThermalExpansionCoefficient() const

Whether the optional attribute ThermalExpansionCoefficient is defined for this IfcMechanicalMaterialProperties.

double ThermalExpansionCoefficient() const
void setThermalExpansionCoefficient(double v)
const IfcParse::entity &declaration() const
IfcMechanicalMaterialProperties(IfcEntityInstanceData *e)
IfcMechanicalMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_DynamicViscosity, boost::optional<double> v3_YoungModulus, boost::optional<double> v4_ShearModulus, boost::optional<double> v5_PoissonRatio, boost::optional<double> v6_ThermalExpansionCoefficient)

Public Static Functions

const IfcParse::entity &Class()
class IfcMechanicalSteelMaterialProperties : public Ifc2x3::IfcMechanicalMaterialProperties

Public Functions

bool hasYieldStress() const

Whether the optional attribute YieldStress is defined for this IfcMechanicalSteelMaterialProperties.

double YieldStress() const
void setYieldStress(double v)
bool hasUltimateStress() const

Whether the optional attribute UltimateStress is defined for this IfcMechanicalSteelMaterialProperties.

double UltimateStress() const
void setUltimateStress(double v)
bool hasUltimateStrain() const

Whether the optional attribute UltimateStrain is defined for this IfcMechanicalSteelMaterialProperties.

double UltimateStrain() const
void setUltimateStrain(double v)
bool hasHardeningModule() const

Whether the optional attribute HardeningModule is defined for this IfcMechanicalSteelMaterialProperties.

double HardeningModule() const
void setHardeningModule(double v)
bool hasProportionalStress() const

Whether the optional attribute ProportionalStress is defined for this IfcMechanicalSteelMaterialProperties.

double ProportionalStress() const
void setProportionalStress(double v)
bool hasPlasticStrain() const

Whether the optional attribute PlasticStrain is defined for this IfcMechanicalSteelMaterialProperties.

double PlasticStrain() const
void setPlasticStrain(double v)
bool hasRelaxations() const

Whether the optional attribute Relaxations is defined for this IfcMechanicalSteelMaterialProperties.

IfcTemplatedEntityList<::Ifc2x3::IfcRelaxation>::ptr Relaxations() const
void setRelaxations(IfcTemplatedEntityList<::Ifc2x3::IfcRelaxation>::ptr v)
const IfcParse::entity &declaration() const
IfcMechanicalSteelMaterialProperties(IfcEntityInstanceData *e)
IfcMechanicalSteelMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_DynamicViscosity, boost::optional<double> v3_YoungModulus, boost::optional<double> v4_ShearModulus, boost::optional<double> v5_PoissonRatio, boost::optional<double> v6_ThermalExpansionCoefficient, boost::optional<double> v7_YieldStress, boost::optional<double> v8_UltimateStress, boost::optional<double> v9_UltimateStrain, boost::optional<double> v10_HardeningModule, boost::optional<double> v11_ProportionalStress, boost::optional<double> v12_PlasticStrain, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRelaxation>::ptr> v13_Relaxations)

Public Static Functions

const IfcParse::entity &Class()
class IfcMember : public Ifc2x3::IfcBuildingElement

An IfcMember is a structural member designed to carry loads between or beyond points of support. It is not required to be load bearing. The orientation of the member (being horizontal, vertical or sloped) is not relevant to its definition (in contrary to IfcBeam and IfcColumn). An IfcMember represents a linear structural element from an architectural or structural modeling point of view and shall be used if it cannot be expressed more specifically as either an IfcBeam or an IfcColumn. NOTE The representation of a member in a structural analysis model is provided by IfcStructuralCurveMember being part of an IfcStructuralAnalysisModel. The IFC specification provides two entities for member occurrences:

IfcMemberStandardCase used for all occurrences of members, that have a profile defined that is swept along a directrix. The profile might be changed uniformly by a taper definition along the directrix. The profile parameter and its cardinal point of insertion can be fully described by the IfcMaterialProfileSetUsage. These beams are always represented geometricly by an ‘Axis’ and a ‘SweptSolid’ or ‘AdvancedSweptSolid’ shape representation (or by a ‘Clipping’ geometry based on the swept solid), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialProfileSetUsage assigned. NOTE View definitions and implementer agreements may further constrain the applicable geometry types, e.g. by excluding tapering from an IfcMemberStandardCase implementation.

IfcMember used for all other occurrences of members, particularly for members with changing profile sizes along the extrusion, or members defined by non-linear extrusion, or members having only ‘Brep’, or ‘SurfaceModel’ geometry.

HISTORY New entity in IFC Release 2x2 Addendum. Type Use Definition IfcMember defines the occuurence of any member, common information about member types (or styles) is handled by IfcMemberType. The IfcMemberType (if present) may establish the commontype name, usage (or predefined) type, common material profile set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcMemberType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcMemberType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcMember is defined by the IfcMaterialProfileSet or as fallback by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be given at theIfcMemberType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse <IsTypedBy relationship pointing to IfcMemberType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterialProfileSet or IfcMaterial. If both are given, then the material directly assigned to IfcMember overrides the material assigned toIfcMemberType. Property Set Use Definition The property sets relating to the IfcMember are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcMember are part of this IFC release:

Pset_MemberCommon: common property set for all member occurrences

Quantity Use Definition The quantities relating to the IfcMember and IfcMemberStandardCase are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quanties shall be never assigned to the IfcMemberType.

Qto_MemberBaseQuantities: base quantities for all member occurrences.

Containment Use Definition The IfcMember, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcMember is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcMember may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e. SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcMember is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local Placement The local placement for IfcMember is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Axis’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Axis Representation The axis geometric representation of IfcMember is defined using the ‘Axis’ representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’, ‘Curve3D’

The axis representation can be used to represent the system length of a member that may extent the body length of the member. Body Representation The body representation of IfcBeam can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘MappedRepresentation’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation:

Solid: IfcExtrudedAreaSolid, IfcRevolvedAreaSolid shall be supported Profile: all subtypes of IfcProfileDef (with exception of IfcArbitraryOpenProfileDef) Extrusion: All extrusion directions shall be supported.

Figure 99 illustrates a ‘SweptSolid’ geometric representation. There are no restrictions or conventions on how to use the local placement (black), solid of extrusion placement (red) and profile placement (green).

Figure 99 — Member swept solid

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The following constraints apply to the advanced representation:

Solid: see ‘SweptSolid’ geometric representation Profile: see ‘SweptSolid’ geometric representation Extrusion:see ‘SweptSolid’ geometric representation Boolean result: The IfcBooleanClippingResult shall be supported, allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid (or its subtypes).

Figure 100 illustrates a ‘Clipping’ geometric representation with use of IfcBooleanClippingResult between an IfcExtrudedAreaSolid and an IfcHalfSpaceSolid to create a clipped body.

Figure 100 — Member clipping

AdvancedSweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘AdvancedSweptSolid’

The following additional constraints apply to the ‘AdvancedSweptSolid’ representation type:

Solid: IfcSurfaceCurveSweptAreaSolid, IfcFixedReferenceSweptAreaSolid, IfcExtrudedAreaSolidTapered, IfcRevolvedAreaSolidTapered shall be supported. NOTE View definitions and implementer agreements can further constrain the allowed swept solid types.

Profile: see ‘SweptSolid’ geometric representation Extrusion:not applicable

MappedRepresentation Representation Type The ‘MappedRepresentation’ representation type is supported as it allows for reusing the geometry definition of the beam type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘SweptSolid’, ‘Clipping’, ‘AdvancedSweptSolid’, ‘SurfaceModel’ and ‘Bre’ geometric representation, shall apply to the MappedRepresentation of the IfcRepresentationMap.

Public Types

typedef IfcTemplatedEntityList<IfcMember> list

Public Functions

const IfcParse::entity &declaration() const
IfcMember(IfcEntityInstanceData *e)
IfcMember(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcMemberType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type IfcMemberType defines commonly shared information for occurrences of members. Members are predominately linear building elements, often forming part of a structural system. The orientation of the member (being horizontal, vertical or sloped) is not relevant to its definition (in contrary to beam and column). The set of shared information may include:

common properties within shared property sets common material information common profile definitions common shape representations

It is used to define a member specification, or member style (i.e. the specific product information that is common to all occurrences of that member type). Member types may be exchanged without being already assigned to occurrences. Occurrences of the IfcMemberType within building models are represented by instances of IfcMemberStandardCase if the IfcMemberType has a single associated IfcMaterialProfileSet; otherwise they are represented by instances of IfcMember. Occurrences of the IfcMemberType within structural analysis models are represented by instances of IfcStructuralCurveMember, or its applicable subtypes. HISTORY New entity in Release IFC2x2 Addendum 1. Material Use Definition The material of the IfcMemberType is defined by the IfcMaterialProfileSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcMemberType, if there is at least one occurrences of IfcMemberStandardCase for this type. Property Set Use Definition: The shared property sets relating to the IfcMemberType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcMemberType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcMemberType and those that are only assignable to IfcMember. If the same property is assigned to the IfcMemberType and the IfcMember being an occurrence of the IfcMemberType, then the occurrence property overrides the type property.

Pset_MemberCommon: common property set for all member types.

Profile Use Definition: The shared profile definition is defined by assigning an IfcMaterialProfileSet (see material use definition above). The IfcMaterialProfile refers to the subtype of IfcProfileDef that is the common profile for all member occurrence, if used. It is only applicable if the IfcMemberType has only occurrences of type IfcMemberStandardCase (see definition of IfcMemberStandardCase for further information). NOTE The attribute ProfileName of the IfcProfileDef subtype, referenced in IfcMaterialProfile should contain a standardized profile name according to local standards. However, an additional geometric representation of the profile is necessary (e.g. as IfcExtrudedAreaSolid). An importing application is allowed to check for the existence of the profile name: in case of identifying it as a standardized name, the corresponding profile geometry and possibly other cross sectional properties can be read from a library. Otherwise the geometric representation and possible non geometric IfcProfileProperties have to be used. Geometry Use Definition: The IfcMemberType may define the shared geometric representation for all member occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘Axis’, or ‘Body’). It is only applicable if the IfcMemberType has only occurrences of type IfcMember (See geometric use definition of IfcMember for further information). NOTE If the IfcMemberType has an associated IfcMaterialProfileSet, then no shared geometric representation shall be provided. NOTE The product shape representations are defined as RepresentationMaps (attribute of the supertype IfcTypeProduct), which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[n] being an IfcMappedItem. See IfcTypeProduct for further information. NOTE The values of attributes RepresentationIdentifier and RepresentationType of IfcShapeRepresentation are restricted in the same way as those for IfcMember and IfcMemberStandardCase

Public Types

typedef IfcTemplatedEntityList<IfcMemberType> list

Public Functions

::Ifc2x3::IfcMemberTypeEnum::Value PredefinedType() const

Identifies the predefined types of a linear structural member element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcMemberTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcMemberType(IfcEntityInstanceData *e)
IfcMemberType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcMemberTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcMemberTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of linear elements an IfcMemberType object can fulfill:

BRACE: A linear element (usually sloped) often used for bracing of a girder or truss. CHORD: Upper or lower longitudinal member of a truss, used horizontally or sloped. COLLAR: A linear element (usually used horizontally) within a roof structure to connect rafters and posts. MEMBER: A linear element within a girder or truss with no further meaning. MULLION: A linear element within a curtain wall system to connect two (or more) panels. PLATE: Alinear continuous horizontal element in wall framing, e.g. a head piece or a sole plate.

NOTE This head piece or sole plate shall not be mixed up with planar elements, such as sheets and panels, that are handled as IfcPlate (and IfcPlateType).

POST: A linear member (usually used vertically) within a roof structure to support purlins. PURLIN: A linear element (usually used horizontally) within a roof structure to support rafters RAFTER: A linear elements used to support roof slabs or roof covering, usually used with slope. STRINGER: A linear element used to support stair or ramp flights, usually used with slope. STRUT: A linear element often used within a girder or truss. STUD: Vertical element in wall framing. USERDEFINED: User-defined linear element. NOTDEFINED: Undefined linear element

HISTORY: New Enumeration in Release IFC2x Edition 2. IFC2x Edition 2 Addendum 1 CHANGE The additional identifiers CHORD, PLATE, STUD are added. IFC2x Edition 3 CHANGE The additional identifier MULLION has been added.

Values:

enumerator IfcMemberType_BRACE
enumerator IfcMemberType_CHORD
enumerator IfcMemberType_COLLAR
enumerator IfcMemberType_MEMBER
enumerator IfcMemberType_MULLION
enumerator IfcMemberType_PLATE
enumerator IfcMemberType_POST
enumerator IfcMemberType_PURLIN
enumerator IfcMemberType_RAFTER
enumerator IfcMemberType_STRINGER
enumerator IfcMemberType_STRUT
enumerator IfcMemberType_STUD
enumerator IfcMemberType_USERDEFINED
enumerator IfcMemberType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcMetric : public Ifc2x3::IfcConstraint

An IfcMetric is used to capture quantitative resultant metrics that can be applied to objectives.

HISTORY: New Entity in IFC Release 2.0

Use Definition IfcMetric is a subtype of IfcConstraint and may be associated with any subtype of IfcRoot through the IfcRelAssociatesConstraint relationship in the IfcControlExtension schema, or may be associated with IfcProperty by IfcPropertyConstraintRelationship.

The aim of IfcMetric is to capture the quantitative aspects of a constraint.

For instance, when undertaking a move (instantiated through the IfcTask class), a constraint is instantiated as the class IfcMetric and may be named as a ‘Move Start Constraint’ or ‘Move End Constraint’ and described using one of a possible range of move constraints as shown in the table below.

Constraint Description Benchmark Grade

ASSOONASPOSSIBLE Action should commence at the earliest possible opportunity. GREATERTHANOREQUALTO SOFT

MUSTSTARTON Action must start at a prescribed date/time. EQUALTO HARD

MUSTSTARTBEFORE Action must start before a prescribed date/time. LESSTHANOREQUALTO HARD

MUSTSTARTAFTER Action must not start before a prescribed date/time. GREATERTHANOREQUALTO HARD

MAYSTARTAFTER Action may start at any time following a prescribed date/time. GREATERTHANOREQUALTO SOFT

MUSTFINISHON Action must be complete at or by a prescribed date/time. EQUALTO HARD

MUSTFINISHBEFORE Action must be complete before a prescribed date/time. LESSTHANOREQUALTO HARD

This constraint (instantiated as IfcMetric) uses a Date/Time value in IfcMetric.DataValue through IfcMetricValueSelect. An appropriate benchmark is applied according to the requirement of the constraint (as indicated) by IfcMetric.Benchmark. The grade of the constraint (hard, soft, advisory) must be specified through IfcConstraint.ConstraintGrade whilst the time at which the constraint is created may be optionally asserted through IfcConstraint.CreationTime.

Public Types

typedef IfcTemplatedEntityList<IfcMetric> list

Public Functions

::Ifc2x3::IfcBenchmarkEnum::Value Benchmark() const

Enumeration that identifies the type of benchmark data.

void setBenchmark(::Ifc2x3::IfcBenchmarkEnum::Value v)
bool hasValueSource() const

Whether the optional attribute ValueSource is defined for this IfcMetric.

std::string ValueSource() const

Reference source for data values.

void setValueSource(std::string v)
::Ifc2x3::IfcMetricValueSelect *DataValue() const

The value with data type defined by the underlying type accesses via IfcMetricValueSelect.

void setDataValue(::Ifc2x3::IfcMetricValueSelect *v)
const IfcParse::entity &declaration() const
IfcMetric(IfcEntityInstanceData *e)
IfcMetric(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcConstraintEnum::Value v3_ConstraintGrade, boost::optional<std::string> v4_ConstraintSource, ::Ifc2x3::IfcActorSelect *v5_CreatingActor, ::Ifc2x3::IfcDateTimeSelect *v6_CreationTime, boost::optional<std::string> v7_UserDefinedGrade, ::Ifc2x3::IfcBenchmarkEnum::Value v8_Benchmark, boost::optional<std::string> v9_ValueSource, ::Ifc2x3::IfcMetricValueSelect *v10_DataValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcMinuteInHour : public IfcUtil::IfcBaseType

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMinuteInHour(IfcEntityInstanceData *e)
IfcMinuteInHour(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcModulusOfElasticityMeasure : public IfcUtil::IfcBaseType

IfcModulusOfElasticityMeasure is a measure of modulus of elasticity. Usually measured in N/m2. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcModulusOfElasticityMeasure(IfcEntityInstanceData *e)
IfcModulusOfElasticityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcModulusOfLinearSubgradeReactionMeasure : public IfcUtil::IfcBaseType

IfcModulusOfLinearSubgradeReactionMeasure is a measure for modulus of linear subgrade reaction, which expresses the elastic bedding of a linear structural element per length, such as for a beam. It is typically measured in N/m^2.

Type: REAL

HISTORY New type in IFC Release 2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcModulusOfLinearSubgradeReactionMeasure(IfcEntityInstanceData *e)
IfcModulusOfLinearSubgradeReactionMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcModulusOfRotationalSubgradeReactionMeasure : public IfcUtil::IfcBaseType

IfcModulusOfRotationalSubgradeReactionMeasure is a measure for modulus of rotational subgrade reaction, which expresses the rotational elastic bedding of a linear structural element per length, such as for a beam. It is typically measured in Nm/(m*rad).

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcModulusOfRotationalSubgradeReactionMeasure(IfcEntityInstanceData *e)
IfcModulusOfRotationalSubgradeReactionMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcModulusOfSubgradeReactionMeasure : public IfcUtil::IfcBaseType

IfcModulusOfSubgradeReactionMeasure is a geotechnical measure describing interaction between foundation structures and the soil. May also be known as bedding measure. Usually measured in N/m3.

Type: REAL

HISTORY New type in IFC Release 2x.

Figure 290 illustrates elastic support of a planar member.

Figure 290 — Modulus of subgrade reaction measure

Public Functions

const IfcParse::type_declaration &declaration() const
IfcModulusOfSubgradeReactionMeasure(IfcEntityInstanceData *e)
IfcModulusOfSubgradeReactionMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMoistureDiffusivityMeasure : public IfcUtil::IfcBaseType

IfcMoistureDiffusivityMeasure is a measure of moisture diffusivity. Usually measured in m3/s. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMoistureDiffusivityMeasure(IfcEntityInstanceData *e)
IfcMoistureDiffusivityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMolecularWeightMeasure : public IfcUtil::IfcBaseType

IfcMolecularWeightMeasure is a measure of molecular weight of material (typically gas). Usually measured in g/mole. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMolecularWeightMeasure(IfcEntityInstanceData *e)
IfcMolecularWeightMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMomentOfInertiaMeasure : public IfcUtil::IfcBaseType

IfcMomentOfInertiaMeasure is a measure of moment of inertia. Usually measured in m4. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMomentOfInertiaMeasure(IfcEntityInstanceData *e)
IfcMomentOfInertiaMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMonetaryMeasure : public IfcUtil::IfcBaseType

A monetary measure is the value of an amount of money without regard to its currency. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMonetaryMeasure(IfcEntityInstanceData *e)
IfcMonetaryMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMonetaryUnit : public IfcUtil::IfcBaseEntity

IfcMonetaryUnit is a unit to define currency for money.

HISTORY: New entity in IFC Release 2x.

IFC2x4 CHANGE: Type of the attribute Currency changed.

Public Types

typedef IfcTemplatedEntityList<IfcMonetaryUnit> list

Public Functions

::Ifc2x3::IfcCurrencyEnum::Value Currency() const

Code or name of the currency. Permissible values are the three-letter alphabetic currency codes as per ISO 4217, for example CNY, EUR, GBP, JPY, USD.

void setCurrency(::Ifc2x3::IfcCurrencyEnum::Value v)
const IfcParse::entity &declaration() const
IfcMonetaryUnit(IfcEntityInstanceData *e)
IfcMonetaryUnit(::Ifc2x3::IfcCurrencyEnum::Value v1_Currency)

Public Static Functions

const IfcParse::entity &Class()
class IfcMonthInYearNumber : public IfcUtil::IfcBaseType

Definition from IAI: The IfcDayInMonthNumber is an integer that defines the position of the specified month in a year. The positions have the following meaning (according to ISO8601 “calendar month”) that assigns the Calendar month number to the Calender month name. NOTE Refer to ISO 8601 for the definitions for using the Gregorian calendar as the standard for the identification of calendar days.

Calendar month number Calendar month name

01 January

02 February

03 March

04 April

05 May

06 June

07 July

08 August

09 September

10 October

11 November

12 December

Type: INTEGER NOTE Corresponding STEP name: month_in_year_number, please refer to ISO/IS 10303-41:1994 for the final definition of the formal standard. HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcMonthInYearNumber(IfcEntityInstanceData *e)
IfcMonthInYearNumber(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcMotorConnectionType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcMotorConnectionType defines commonly shared information for occurrences of motor connections. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a motor connection specification (i.e. the specific product information, that is common to all occurrences of that product type). Motor Connection types may be exchanged without being already assigned to occurrences. Occurrences of IfcMotorConnectionType are represented by instances of IfcMotorConnection.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_MotorConnectionTypeCommon

Material Use Definition The material of the IfcMotorConnectionType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcMotorConnectionType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcMotorConnection for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcMotorConnectionType> list

Public Functions

::Ifc2x3::IfcMotorConnectionTypeEnum::Value PredefinedType() const

Identifies the predefined types of motor connection from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcMotorConnectionTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcMotorConnectionType(IfcEntityInstanceData *e)
IfcMotorConnectionType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcMotorConnectionTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcMotorConnectionTypeEnum

Public Types

enum Value

The IfcMotorConnectionTypeEnum defines the range of different types of motor connection that can be specified. HISTORY: New type in IFC 2x.

Enumeration

BELTDRIVE: An indirect connection made through the medium of a shaped, flexible continuous loop. COUPLING: An indirect connection made through the medium of the viscosity of a fluid. DIRECTDRIVE: A direct, physical connection made between the motor and the driven device. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcMotorConnectionType_BELTDRIVE
enumerator IfcMotorConnectionType_COUPLING
enumerator IfcMotorConnectionType_DIRECTDRIVE
enumerator IfcMotorConnectionType_USERDEFINED
enumerator IfcMotorConnectionType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcMove : public Ifc2x3::IfcTask

Public Types

typedef IfcTemplatedEntityList<IfcMove> list

Public Functions

::Ifc2x3::IfcSpatialStructureElement *MoveFrom() const
void setMoveFrom(::Ifc2x3::IfcSpatialStructureElement *v)
::Ifc2x3::IfcSpatialStructureElement *MoveTo() const
void setMoveTo(::Ifc2x3::IfcSpatialStructureElement *v)
bool hasPunchList() const

Whether the optional attribute PunchList is defined for this IfcMove.

std::vector<std::string> PunchList() const
void setPunchList(std::vector<std::string> v)
const IfcParse::entity &declaration() const
IfcMove(IfcEntityInstanceData *e)
IfcMove(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_TaskId, boost::optional<std::string> v7_Status, boost::optional<std::string> v8_WorkMethod, bool v9_IsMilestone, boost::optional<int> v10_Priority, ::Ifc2x3::IfcSpatialStructureElement *v11_MoveFrom, ::Ifc2x3::IfcSpatialStructureElement *v12_MoveTo, boost::optional<std::vector<std::string>> v13_PunchList)

Public Static Functions

const IfcParse::entity &Class()
class IfcNamedUnit : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: A named unit is a unit quantity associated with the word, or group of words, by which the unit is identified.

NOTE Corresponding ISO 10303 name: named_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcContextDependentUnit, Ifc2x3::IfcConversionBasedUnit, Ifc2x3::IfcSIUnit

Public Types

typedef IfcTemplatedEntityList<IfcNamedUnit> list

Public Functions

::Ifc2x3::IfcDimensionalExponents *Dimensions() const

The dimensional exponents of the SI base units by which the named unit is defined.

void setDimensions(::Ifc2x3::IfcDimensionalExponents *v)
::Ifc2x3::IfcUnitEnum::Value UnitType() const

The type of the unit.

void setUnitType(::Ifc2x3::IfcUnitEnum::Value v)
const IfcParse::entity &declaration() const
IfcNamedUnit(IfcEntityInstanceData *e)
IfcNamedUnit(::Ifc2x3::IfcDimensionalExponents *v1_Dimensions, ::Ifc2x3::IfcUnitEnum::Value v2_UnitType)

Public Static Functions

const IfcParse::entity &Class()
class IfcNormalisedRatioMeasure : public Ifc2x3::IfcRatioMeasure

IfcNormalisedRatioMeasure is a dimensionless measure to express ratio values ranging from 0.0 to 1.0.

Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcNormalisedRatioMeasure(IfcEntityInstanceData *e)
IfcNormalisedRatioMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcNullStyle

Public Types

enum Value

Definition from ISO/CD 10303-46:1992: The null style type specifies, that a representation item is not styled.

NOTE Corresponding ISO 10303 name: null_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New enumeration in IFC2x2.

IFC2x4 CHANGE The enumeration is deprecated.

Values:

enumerator IfcNullStyle_NULL

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcNumericMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A numeric measure is the numeric value of a physical quantity. Type: NUMBER

NOTE Corresponding ISO 10303 name: numeric_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcNumericMeasure(IfcEntityInstanceData *e)
IfcNumericMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcObject : public Ifc2x3::IfcObjectDefinition

An IfcObject is the generalization of any semantically treated thing or process. Objects are things as they appear - i.e. occurrences. NOTE Examples of IfcObject include physically tangible items, such as wall, beam or covering, physically existing items, such as spaces, or conceptual items, such as grids or virtual boundaries. It also stands for processes, such as work tasks, for controls, such as cost items, for actors, such as persons involved in the design process, etc. Objects can be named, using the inherited Name attribute, which should be a user recognizable label for the object occurrance. Further explanations to the object can be given using the inherited Description attribute. The ObjectType attribute is used:

to store the user defined value for all subtypes of IfcObject, where a PredefinedType attribute is given, and its value is set to USERDEFINED. to provide a type information (could be seen as a very lightweight classifier) of the subtype of IfcObject, if no PredefinedType attribute is given. This is often the case, if no comprehensive list of predefined types is available.

Objects are independent pieces of information that might contain or reference other pieces of information. There are several relationships in which objects can be involved:

Association to external/internal resource information

  • an association relationship that refers to external/internal sources of information. See supertype IfcObjectDefinition for more information. Assignment of other objects - an assignment relationship that refers to other types of objects. See supertype IfcObjectDefinition for more information. Aggregation of other objects - an aggregation relationship that establishes a whole/part relation. Objects can either be a whole, or a part, or both. See supertype IfcObjectDefinition for more information.

Assignment of a type : IsTypedBy - a definition relationship IfcRelDefinesByType that uses a type definition to define the common characteristics of this occurrences, potentially including the common shape representation and common properties of all object occurrences assigned to this type. It is a specific - occurrence relationship with implied dependencies (as the occurrence properties depend on the properties of the type, but may override them).

NOTE See IfcRelDefinesByType for an explanatory figure. Also see for how to override type properties by occurrence properties

Assignment of a partial type : IsDeclaredBy, Declares - a definition relationship IfcRelDefinesByObject that uses a component of a type definition (a part of a type, called the “declaring part”) to define a component of an occurence (part of occurrence, called the “reflected part”). This is also refered to as a “deep copy”. The common characteristics of all parts in the occurrence are defined by parts in the type. It is a specific - occurrence relationship with implied dependencies (as the occurrence properties depend on the properties of the type, but may override them).

NOTE See IfcRelDefinesByObject for an explanatory figure.

Assignment of property sets : IsDefinedBy - a definition relationship IfcRelDefinesByProperties that assignes property set definitions to the object occurrence.

HISTORY New Entity in IFC Release 1.0

IFC2x4 CHANGE The inverse relationships Declares, IsDeclaredBy, and IsTypedBy have been added, types are not longer included in the IsDefinesBy relationship. IfcProject has been promoted to be a subtype of IfcObjectDefinition -> IfcContext.

Informal Proposition

A partial type assignment, i.e. the inverse attribute IsDeclaredBy, or Declares shall only be used, if the object is part of a decomposition, i.e. if either IsDecomposedBy, or Decomposes is exerted.

Subclassed by Ifc2x3::IfcActor, Ifc2x3::IfcControl, Ifc2x3::IfcGroup, Ifc2x3::IfcProcess, Ifc2x3::IfcProduct, Ifc2x3::IfcProject, Ifc2x3::IfcResource

Public Types

typedef IfcTemplatedEntityList<IfcObject> list

Public Functions

bool hasObjectType() const

Whether the optional attribute ObjectType is defined for this IfcObject.

std::string ObjectType() const

The type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes. In particular it holds the user defined type, if the enumeration of the attribute PredefinedType is set to USERDEFINED.

void setObjectType(std::string v)
IfcTemplatedEntityList<IfcRelDefines>::ptr IsDefinedBy() const
const IfcParse::entity &declaration() const
IfcObject(IfcEntityInstanceData *e)
IfcObject(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcObjectDefinition : public Ifc2x3::IfcRoot

An IfcObjectDefinition is the generalization of any semantically treated thing or process, either being a type or an occurrences. Object defintions can be named, using the inherited Name attribute, which should be a user recognizable label for the object occurrance. Further explanations to the object can be given using the inherited Description attribute. A context is a specific kind of object definition as it provides the project or library context in which object types and object occurrences are defined. Objects are independent pieces of information that might contain or reference other pieces of information. There are four essential kinds of relationships in which object definitons (by their instantiable subtypes) can be involved:

Assignment of other objects - an assignment relationship (IfcRelAssigns) that refers to other types of objects and creates a bi-directional association. The semantic of the assignment is established at the level of the subtypes of the general IfcRelAssigns relationship. There is no dependency implied a priori by the assignment. Association to external resources - an association relationship (IfcRelAssociates) that refers to external sources of information (most notably a classification or document) and creates a uni-directional association. There is no dependency implied by the association. Aggregation of other objects - an aggregation relationship (IfcRelAggregates) that establishes an unordered, spatial whole/part relation and creates a bi-directional relation. There is an implied dependency established. Nesting of other objects - a nesting relationship (IfcRelNests) that establishes an ordered, non-spatial whole/part relation and creates a bi-directional relation. There is an implied dependency established. Declaration within a context - a relationship (IfcRelDeclares) of the uppermost object definition within the object definition tree (e.g. the summary object within an object nesting tree) to the context (a project or project library). It applies the units, representation context and other context information to this object definition and all dependent ones.

EXCEPTION The link between the uppermost object in the spatial structure tree, that is IfcSite or ifcBuilding, and the context provided by IfcProject is created using the IfcRelAggregates relationship. See IfcProject for more information.

HISTORY New abstract entity in IFC2x3.

IFC2x4 CHANGE The new subtype IfcContext and the relationship to context HasContext has been added . The decomposition relationship is split into ordered nesting (Nests, IsNestedBy) and un-ordered aggregating (Decomposes, IsDecomposedBy).

Subclassed by Ifc2x3::IfcObject, Ifc2x3::IfcTypeObject

Public Types

typedef IfcTemplatedEntityList<IfcObjectDefinition> list

Public Functions

IfcTemplatedEntityList<IfcRelAssigns>::ptr HasAssignments() const
IfcTemplatedEntityList<IfcRelDecomposes>::ptr IsDecomposedBy() const
IfcTemplatedEntityList<IfcRelDecomposes>::ptr Decomposes() const
IfcTemplatedEntityList<IfcRelAssociates>::ptr HasAssociations() const
const IfcParse::entity &declaration() const
IfcObjectDefinition(IfcEntityInstanceData *e)
IfcObjectDefinition(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcObjective : public Ifc2x3::IfcConstraint

An IfcObjective captures qualitative information for an objective-based constraint.

HISTORY: New Entity in IFC Release 2.0

Use definition

IfcObjective is a subtype of IfcConstraint and may be associated with any subtype of IfcRoot through the IfcRelAssociatesConstraint relationship in the IfcControlExtension schema, or may be associated with IfcProperty by IfcPropertyConstraintRelationship.

The aim of IfcObjective is to specify the purpose for which the constraint is applied and to capture the values of the constraint. These may be both the benchmark values that are intended to indicate the constraint extent and the resulting values in use that enable performance comparisons to be applied.

Public Types

typedef IfcTemplatedEntityList<IfcObjective> list

Public Functions

bool hasBenchmarkValues() const

Whether the optional attribute BenchmarkValues is defined for this IfcObjective.

::Ifc2x3::IfcMetric *BenchmarkValues() const

A list of any benchmark values used for comparison purposes.

void setBenchmarkValues(::Ifc2x3::IfcMetric *v)
bool hasResultValues() const

Whether the optional attribute ResultValues is defined for this IfcObjective.

::Ifc2x3::IfcMetric *ResultValues() const

A list of any resultant values used for comparison purposes.

void setResultValues(::Ifc2x3::IfcMetric *v)
::Ifc2x3::IfcObjectiveEnum::Value ObjectiveQualifier() const

Enumeration that qualifies the type of objective constraint.

void setObjectiveQualifier(::Ifc2x3::IfcObjectiveEnum::Value v)
bool hasUserDefinedQualifier() const

Whether the optional attribute UserDefinedQualifier is defined for this IfcObjective.

std::string UserDefinedQualifier() const

A user defined value that qualifies the type of objective constraint when ObjectiveQualifier attribute of type IfcObjectiveEnum has value USERDEFINED.

void setUserDefinedQualifier(std::string v)
const IfcParse::entity &declaration() const
IfcObjective(IfcEntityInstanceData *e)
IfcObjective(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcConstraintEnum::Value v3_ConstraintGrade, boost::optional<std::string> v4_ConstraintSource, ::Ifc2x3::IfcActorSelect *v5_CreatingActor, ::Ifc2x3::IfcDateTimeSelect *v6_CreationTime, boost::optional<std::string> v7_UserDefinedGrade, ::Ifc2x3::IfcMetric *v8_BenchmarkValues, ::Ifc2x3::IfcMetric *v9_ResultValues, ::Ifc2x3::IfcObjectiveEnum::Value v10_ObjectiveQualifier, boost::optional<std::string> v11_UserDefinedQualifier)

Public Static Functions

const IfcParse::entity &Class()
struct IfcObjectiveEnum

Public Types

enum Value

IfcObjectiveEnum is an enumeration used to determine the objective for which purpose the constraint needs to be satisfied.

HISTORY: IFC2x4 CHANGE: Extended to include CODEWAIVER.

Enumeration

Value Definition

CODECOMPLIANCE A constraint whose objective is to ensure satisfaction of a code compliance provision.

CODEWAIVER A constraint whose objective is to identify an agreement that code compliance requirements (the waiver) will not be enforced.

DESIGNINTENT A constraint whose objective is to ensure satisfaction of a design intent provision.

HEALTHANDSAFETY A constraint whose objective is to ensure satisfaction of a health and safety provision.

REQUIREMENT A constraint whose objective is to ensure satisfaction of a project requirement provision.

SPECIFICATION A constraint whose objective is to ensure satisfaction of a specification provision.

TRIGGERCONDITION A constraint whose objective is to indicate a limiting value beyond which the condition of an object requires a particular form of attention.

Values:

enumerator IfcObjective_CODECOMPLIANCE
enumerator IfcObjective_DESIGNINTENT
enumerator IfcObjective_HEALTHANDSAFETY
enumerator IfcObjective_REQUIREMENT
enumerator IfcObjective_SPECIFICATION
enumerator IfcObjective_TRIGGERCONDITION
enumerator IfcObjective_USERDEFINED
enumerator IfcObjective_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcObjectPlacement : public IfcUtil::IfcBaseEntity

IfcObjectPlacement is an abstract supertype for the special types defining the object coordinate system. The IfcObjectPlacement has to be provided for each product that has a shape representation. The object placement can be given:

absolute: by an axis2 placement, relative to the world coordinate system, relative: by an axis2 placement, relative to the object placement of another product, by grid reference: by the virtual intersection and reference direction given by two axes of a design grid.

In any case the object placement has to unambiguously define the object coordinate system as either two-dimensional axis placement (IfcAxis2Placement2D) or three-dimensional axis placement (IfcAxis2Placement3D). The axis placement may have to be calculated.

HISTORY New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcGridPlacement, Ifc2x3::IfcLocalPlacement

Public Types

typedef IfcTemplatedEntityList<IfcObjectPlacement> list

Public Functions

IfcTemplatedEntityList<IfcProduct>::ptr PlacesObject() const
IfcTemplatedEntityList<IfcLocalPlacement>::ptr ReferencedByPlacements() const
const IfcParse::entity &declaration() const
IfcObjectPlacement(IfcEntityInstanceData *e)
IfcObjectPlacement()

Public Static Functions

const IfcParse::entity &Class()
struct IfcObjectTypeEnum

Public Types

enum Value

This enumeration defines the applicable object categories, that is, the subtypes at the 2nd level of the IFC inheritance tree. Attached to an object, it indicates to which subtype of IfcObject the entity referencing it would otherwise comply with.

HISTORY New entity in IFC Release 1.0, has been renamed from IfcProxyEnum in IFC 2x.

Values:

enumerator IfcObjectType_PRODUCT
enumerator IfcObjectType_PROCESS
enumerator IfcObjectType_CONTROL
enumerator IfcObjectType_RESOURCE
enumerator IfcObjectType_ACTOR
enumerator IfcObjectType_GROUP
enumerator IfcObjectType_PROJECT
enumerator IfcObjectType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcOccupant : public Ifc2x3::IfcActor

An occupant is a type of actor that defines the form of occupancy of a property.

The principal purpose of IfcOccupant is to determine the nature of occupancy of a property for a particular actor. All characteristics relating to the actor (name and organization details) are inherited from the IfcActor class.HISTORY: New entity in IFC2x

Assignment Use Definition The IfcOccupant may have assignments of its own using the IfcRelAssignsToActor relationship where RelatingActor refers to the IfcOccupant and RelatedObjects contains one or more objects of the following types: IfcSpatialStructureElement: Indicates the property to be occupied. Particular details of the agreement relating to the occupancy of a property are dealt within the Pset_PropertyAgreement that is defined for the instance of IfcSpatialStructureElement. This means that an occupant may be related to a site, building, building storey or space through the IfcSpatialStructureElement.ElementComposition attribute. For instance, if the property concerned is several office spaces on a building storey, it might be appropriate to reference IfcBuildingStorey.ElementComposition=PARTIAL. Occupants of a property may be considered to be the parties to an agreement. The roles that the occupant may play in respect to an agreement are defined in the IfcOccupantTypeEnum enumeration. If the role is not specified by the predefined contents of this enumeration, the value USERDEFINED may be set and the ObjectType attribute asserted.

Public Types

typedef IfcTemplatedEntityList<IfcOccupant> list

Public Functions

::Ifc2x3::IfcOccupantTypeEnum::Value PredefinedType() const

Predefined occupant types from which that required may be set.

IFC2x4 CHANGE Attribute made optional.

void setPredefinedType(::Ifc2x3::IfcOccupantTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcOccupant(IfcEntityInstanceData *e)
IfcOccupant(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcActorSelect *v6_TheActor, ::Ifc2x3::IfcOccupantTypeEnum::Value v7_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcOccupantTypeEnum

Public Types

enum Value

IfcOccupantTypeEnum defines the types of occupant from which the type required can be selected. HISTORY: New Enumeration in IFC Release 2.0 Modified in IFC 2x2 Enumeration:

ASSIGNEE: Actor receiving the assignment of a property agreement from an assignor

ASSIGNOR: Actor assigning a property agreement to an assignor

LESSEE: Actor receiving the lease of a property from a lessor

LESSOR: Actor leasing a property to a lessee

LETTINGAGENT: Actor participating in a property agreement on behalf of an owner, lessor or assignor

OWNER: Actor that owns a property

TENANT: Actor renting the use of a property fro a period of time

USERDEFINED: User-defined type.

NOTDEFINED: Undefined type.

Values:

enumerator IfcOccupantType_ASSIGNEE
enumerator IfcOccupantType_ASSIGNOR
enumerator IfcOccupantType_LESSEE
enumerator IfcOccupantType_LESSOR
enumerator IfcOccupantType_LETTINGAGENT
enumerator IfcOccupantType_OWNER
enumerator IfcOccupantType_TENANT
enumerator IfcOccupantType_USERDEFINED
enumerator IfcOccupantType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcOffsetCurve2D : public Ifc2x3::IfcCurve

Definition from ISO/CD 10303-42:1992: An offset curve 2d (IfcOffsetCurve2d) is a curve at a constant distance from a basis curve in two-dimensional space. This entity defines a simple plane-offset curve by offsetting by distance along the normal to basis curve in the plane of basis curve. The underlying curve shall have a well-defined tangent direction at every point. In the case of a composite curve, the transition code between each segment shall be cont same gradient or cont same gradient same curvature.

NOTE: The offset curve 2d may differ in nature from the basis curve; the offset of a non self- intersecting curve can be self-intersecting. Care should be taken to ensure that the offset to a continuous curve does not become discontinuous.

The offset curve 2d takes its parameterization from the basis curve. The offset curve 2d is parameterized as

where T is the unit tangent vector to the basis curve C(u) at parameter value u, and d is distance. The underlying curve shall be two-dimensional.

NOTE Corresponding ISO 10303 entity: offset_curve_2d, Please refer to ISO/IS 10303-42:1994, p.65 for the final definition of the formal standard.

HISTORY New entity in IFC Release 2.x

Public Types

typedef IfcTemplatedEntityList<IfcOffsetCurve2D> list

Public Functions

::Ifc2x3::IfcCurve *BasisCurve() const

The curve that is being offset.

void setBasisCurve(::Ifc2x3::IfcCurve *v)
double Distance() const

The distance of the offset curve from the basis curve. distance may be positive, negative or zero. A positive value of distance defines an offset in the direction which is normal to the curve in the sense of an anti-clockwise rotation through 90 degrees from the tangent vector T at the given point. (This is in the direction of orthogonal complement(T).)

void setDistance(double v)
bool SelfIntersect() const

An indication of whether the offset curve self-intersects; this is for information only.

void setSelfIntersect(bool v)
const IfcParse::entity &declaration() const
IfcOffsetCurve2D(IfcEntityInstanceData *e)
IfcOffsetCurve2D(::Ifc2x3::IfcCurve *v1_BasisCurve, double v2_Distance, bool v3_SelfIntersect)

Public Static Functions

const IfcParse::entity &Class()
class IfcOffsetCurve3D : public Ifc2x3::IfcCurve

Definition from ISO/CD 10303-42:1992: An offset curve 3d is a curve at a constant distance from a basis curve in three-dimensional space. The underlying curve shall have a well-defined tangent direction at every point. In the case of a composite curve the transition code between each segment shall be cont same gradient or cont same gradient same curvature. The offset curve at any point (parameter) on the basis curve is in the direction V x T where V is the fixed reference direction and T is the unit tangent to the basis curve. For the offset direction to be well defined, T shall not at any point of the curve be in the same, or opposite, direction as V.

NOTE: The offset curve 3d may differ in nature from the basis curve; the offset of a non self- intersecting curve can be self-intersecting. Care should be taken to ensure that the offset to a continuous curve does not become discontinuous.

The offset curve 3d takes its parameterization from the basis curve. The offset curve 3d is parameterized as

where T is the unit tangent vector to the basis curve C(u) at parameter value u, and d is distance. The underlying curve shall be three-dimensional.

NOTE Corresponding ISO 10303 entity: offset_curve_3d, Please refer to ISO/IS 10303-42:1994, p.66 for the final definition of the formal standard.

HISTORY New entity in IFC Release 2.x

Informal propositions:

At no point on the curve shall ref direction be parallel, or opposite to, the direction of the tangent vector.

Public Types

typedef IfcTemplatedEntityList<IfcOffsetCurve3D> list

Public Functions

::Ifc2x3::IfcCurve *BasisCurve() const

The curve that is being offset.

void setBasisCurve(::Ifc2x3::IfcCurve *v)
double Distance() const

The distance of the offset curve from the basis curve. The distance may be positive, negative or zero.

void setDistance(double v)
bool SelfIntersect() const

An indication of whether the offset curve self-intersects, this is for information only.

void setSelfIntersect(bool v)
::Ifc2x3::IfcDirection *RefDirection() const

The direction used to define the direction of the offset curve 3d from the basis curve.

void setRefDirection(::Ifc2x3::IfcDirection *v)
const IfcParse::entity &declaration() const
IfcOffsetCurve3D(IfcEntityInstanceData *e)
IfcOffsetCurve3D(::Ifc2x3::IfcCurve *v1_BasisCurve, double v2_Distance, bool v3_SelfIntersect, ::Ifc2x3::IfcDirection *v4_RefDirection)

Public Static Functions

const IfcParse::entity &Class()
class IfcOneDirectionRepeatFactor : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-46:1992: A one time repeat factor is a vector used in the fill area style hatching and fill area style tiles entities for determining the origin of the repeated hatch line relative to the origin of the previous hatch line, Given the initial position of any hatch line, the one direction repeat factor determines two new positions according to the equation:

I + k * R k X{-1,1}

NOTE: Corresponding ISO 10303 name: one_direction_repeat_factor. Please refer to ISO/IS 10303-46:1994, p. 112 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Subclassed by Ifc2x3::IfcTwoDirectionRepeatFactor

Public Functions

::Ifc2x3::IfcVector *RepeatFactor() const

A vector which specifies the relative positioning of hatch lines.

void setRepeatFactor(::Ifc2x3::IfcVector *v)
const IfcParse::entity &declaration() const
IfcOneDirectionRepeatFactor(IfcEntityInstanceData *e)
IfcOneDirectionRepeatFactor(::Ifc2x3::IfcVector *v1_RepeatFactor)

Public Static Functions

const IfcParse::entity &Class()
class IfcOpeningElement : public Ifc2x3::IfcFeatureElementSubtraction

The opening element stands for opening, recess or chase, all reflecting voids. It represents a void within any element that has physical manifestation. Openings can be inserted into walls, slabs, beams, columns, or other elements. The IFC specification provides two entities for opening elements:

IfcOpeningStandardCase is used for all openings that have a constant profile along a linear extrusion. They are placed relative to the voided elements and the extrusion direction is perpendicular to the plane of the element (horizontally for walls, vertically for slabs). Only a single extrusion body is allowed. It cuts through the whole thickness of the voided element, i.e. it reflects a true opening. IfcOpeningElement is used for all other occurrences of openings and in particular also for niches or recesses.

NOTE View definitions or implementer agreements may restrict the types of elements which can be voided by an IfcOpeningElement or IfcOpeningStandardCase There are two different types of opening elements:

an opening, where the thickness of the opening is greater or equal to the thickness of the element; a recess or niche, where the thickness of the recess is smaller than the thickness of the element.

The attribute PredefinedType should be used to capture the differences,

the attribute is set to OPENING for an opening or the attribute is set to RECESS for a recess or niche. If the value for PredefinedType is omitted, or the value is set to NOTDEFINED, no specific information of whether it is an opening or recess shall be assumed.

NOTE Until IFC2x3 the information had been provided by the inherited attribute ObjectType. An IfcOpeningElement has to be inserted into an IfcElement by using the IfcRelVoidsElement relationship. The relationship implies a Boolean subtraction operation between the volume of the voided element and the volume of the opening. It may be filled by an IfcDoor, IfcWindow, or another filling element by using the relationship IfcRelFillsElements. HISTORY New entity in IFC Release 1.0 IFC2x CHANGE The intermediate ABSTRACT supertypes IfcFeatureElement and IfcFeatureSubtraction have been added. IFC2x4 CHANGE The attribute PredefinedType has been added at the end of attribute list. Property Set Use Definition: The property sets relating to the IfcOpeningElement are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcOpeningElement are part of this IFC release:

Pset_OpeningElementCommon: common property set for all opening occurrences

Quantity Use Definition: The quantities relating to the IfcOpeningElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_OpeningElementBaseQuantities: base quantities for all opening occurrences.

Containment Use Definition The IfcOpeningElement shall not participate in the containment relationship, i.e. it is not linked directly to the spatial structure of the project. It has a mandatory VoidsElements inverse relationship pointing to the IfcElement that is contained in the spatial structure.

The inverse relationship ContainedInStructure shall be NIL.

NOTE See IfcRelVoidsElement for a diagram on how to apply spatial containment and the voiding relationship. Geometry Use Definitions The geometric representation of IfcOpeningElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. Local Placement The local placement for IfcOpeningElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement should point to the local placement of the same element, which is voided by the opening, i.e. referred to by VoidsElement.RelatingBuildingElement.

Geometric Representation Currently, the ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcFeatureElement. Body Representation The ‘Body’ representation of IfcOpeningElement can be represented using the representation types ‘SweptSolid’, and ‘Brep’. The representation type ‘Brep’ is explained at IfcFeatureElement Swept Solid Representation Type with Horizontal Extrusion The ‘SweptSolid’ geometric representation of IfcOpeningElement, using horizontal extrusion direction (for walls), is defined using the swept area solid geometry. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the swept solid representation:

Solid: IfcExtrudedAreaSolid is required, the set of IfcShapeRepresentation.Items may include a single, or multiple, instances of IfcExtrudedAreaSolid. Profile: IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef shall be supported. Extrusion: The profile shall be extruded horizontally (i.e. perpendicular to the extrusion direction of the voided element), e.g. for wall openings, or vertically (i.e. in the extrusion direction of the voided element), e.g., for floor openings. If multiple instances of IfcExtrudedAreaSolid are used, the extrusion direction of each extrusion should be equal.

NOTE In case of non-parallel jambs, the shape representation shall be a ‘SweptSolid’ representation with vertical extrusion.

Figure 34 illustrates an opening with horizontal extrusion. NOTE The local placement directions for the IfcOpeningElement are only given as an example, other directions are valid as well.

Figure 34 — Opening with full extrusion

Figure 35 illustrates an opening for a recess. NOTE The local placement directions for the IfcOpeningElement are only given as an example, other directions are valid as well. NOTE Rectangles are now defined centric, the placement location has to be set:

IfcCartesianPoint(XDim/2,YDim/2)

Figure 35 — Opening with recess extrusion

Swept Solid Representation with Vertical Extrusion The ‘SweptSolid’ geometric representation of IfcOpeningElement, using vertical extrusion direction (for walls), is defined using the swept area solid geometry, however the extrusion direction may be vertical, i.e. in case of a wall opening, the extrusion would be in the direction of the wall height. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the swept solid representation:

Solid: IfcExtrudedAreaSolid is required, the set of IfcShapeRepresentation.Items may include a single, or multiple, instances of IfcExtrudedAreaSolid. Profile: IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef shall be supported. Extrusion: The profile shall be extruded vertically, i.e. for wall openings along the extrusion direction of the voided element. If multiple instances of IfcExtrudedAreaSolid are used, the extrusion direction should be equal.

Vertical extrusions shall be used when an opening or recess has a non rectangular foot print geometry that does not change along the height of the opening or recess. Figure 36 shows a vertical extrusion with multiple extrusion bodies for the opening. Each extrusion body has a different extrusion lenght. NOTE The local placement directions for the IfcOpeningElement are only given as an example, other directions are valid as well.

Figure 36 — Opening with multiple extrusions

Public Types

typedef IfcTemplatedEntityList<IfcOpeningElement> list

Public Functions

IfcTemplatedEntityList<IfcRelFillsElement>::ptr HasFillings() const
const IfcParse::entity &declaration() const
IfcOpeningElement(IfcEntityInstanceData *e)
IfcOpeningElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcOpenShell : public Ifc2x3::IfcConnectedFaceSet

Definition from ISO/CD 10303-42:1992: An open shell is a shell of the dimensionality 2. Its domain, if present, is a finite, connected, oriented, 2-manifold with boundary, but is not a closed surface. It can be thought of as a closed shell with one or more holes punched in it. The domain of an open shell satisfies 0 < Ξ < 1. An open shell is functionally more general than a face because its domain can have handles. The shell is defined by a collection of faces, which may be oriented faces. The sense of each face, after taking account of the orientation, shall agree with the shell normal as defined below. The orientation can be supplied directly as a BOOLEAN attribute of an oriented face, or be defaulted to TRUE if the shell member is a face without the orientation attribute. The following combinatorial restrictions on open shells and geometrical restrictions on their domains are designed, together with the informal propositions, to ensure that any domain associated with an open shell is an orientable manifold.

Each face reference shall be unique.

An open shell shall have at least one face.

A given face may exist in more than one open shell.

The boundary of an open shell consists of the edges that are referenced only once by the face - bounds (loops) of its faces, together with all of their vertices. The domain of an open shell, if present, contains all edges and vertices of its faces.

NOTE Note that this is slightly different from the definition of a face domain, which includes none of its bounds. For example, a face domain may exclude an isolated point or line segment. An open shell domain may not. (See the algorithm for computing below.) In the current IFC Release only poly loops (IfcPolyLoop) are defined for bounds of face bound (IfcFaceBound.Bound). This will allow for faceted B-rep only. For further specification, including the Euler formulas to be satisfied, please refer to ISO 10303-42:1994.

NOTE Corresponding ISO 10303 entity: open_shell, please refer to ISO/IS 10303-42:1994, p.148 for the final definition of the formal standard.

HISTORY New class in IFC2x.

Informal propositions:

Every edge shall be referenced exactly twice by the face bounds of the face.

Each oriented edge shall be unique.

No edge shall be referenced by more than two faces.

Distinct faces of the shell do not intersect, but may share edges or vertices.

Distinct edges do not intersect but may share vertices.

Each face reference shall be unique.

The loops of the shell shall not be a mixture of poly loop and other loop types. Note: this is given, since only poly loop is defined as face bound definition.

The closed shell shall be an oriented arcwise connected 2-manifold.

The Euler equation shall be satisfied. Note: Please refer to ISO/IS 10303-42:1994, p.148 for the equation.

Public Types

typedef IfcTemplatedEntityList<IfcOpenShell> list

Public Functions

const IfcParse::entity &declaration() const
IfcOpenShell(IfcEntityInstanceData *e)
IfcOpenShell(IfcTemplatedEntityList<::Ifc2x3::IfcFace>::ptr v1_CfsFaces)

Public Static Functions

const IfcParse::entity &Class()
class IfcOpticalMaterialProperties : public Ifc2x3::IfcMaterialProperties

Public Functions

bool hasVisibleTransmittance() const

Whether the optional attribute VisibleTransmittance is defined for this IfcOpticalMaterialProperties.

double VisibleTransmittance() const
void setVisibleTransmittance(double v)
bool hasSolarTransmittance() const

Whether the optional attribute SolarTransmittance is defined for this IfcOpticalMaterialProperties.

double SolarTransmittance() const
void setSolarTransmittance(double v)
bool hasThermalIrTransmittance() const

Whether the optional attribute ThermalIrTransmittance is defined for this IfcOpticalMaterialProperties.

double ThermalIrTransmittance() const
void setThermalIrTransmittance(double v)
bool hasThermalIrEmissivityBack() const

Whether the optional attribute ThermalIrEmissivityBack is defined for this IfcOpticalMaterialProperties.

double ThermalIrEmissivityBack() const
void setThermalIrEmissivityBack(double v)
bool hasThermalIrEmissivityFront() const

Whether the optional attribute ThermalIrEmissivityFront is defined for this IfcOpticalMaterialProperties.

double ThermalIrEmissivityFront() const
void setThermalIrEmissivityFront(double v)
bool hasVisibleReflectanceBack() const

Whether the optional attribute VisibleReflectanceBack is defined for this IfcOpticalMaterialProperties.

double VisibleReflectanceBack() const
void setVisibleReflectanceBack(double v)
bool hasVisibleReflectanceFront() const

Whether the optional attribute VisibleReflectanceFront is defined for this IfcOpticalMaterialProperties.

double VisibleReflectanceFront() const
void setVisibleReflectanceFront(double v)
bool hasSolarReflectanceFront() const

Whether the optional attribute SolarReflectanceFront is defined for this IfcOpticalMaterialProperties.

double SolarReflectanceFront() const
void setSolarReflectanceFront(double v)
bool hasSolarReflectanceBack() const

Whether the optional attribute SolarReflectanceBack is defined for this IfcOpticalMaterialProperties.

double SolarReflectanceBack() const
void setSolarReflectanceBack(double v)
const IfcParse::entity &declaration() const
IfcOpticalMaterialProperties(IfcEntityInstanceData *e)
IfcOpticalMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_VisibleTransmittance, boost::optional<double> v3_SolarTransmittance, boost::optional<double> v4_ThermalIrTransmittance, boost::optional<double> v5_ThermalIrEmissivityBack, boost::optional<double> v6_ThermalIrEmissivityFront, boost::optional<double> v7_VisibleReflectanceBack, boost::optional<double> v8_VisibleReflectanceFront, boost::optional<double> v9_SolarReflectanceFront, boost::optional<double> v10_SolarReflectanceBack)

Public Static Functions

const IfcParse::entity &Class()
class IfcOrderAction : public Ifc2x3::IfcTask

Public Types

typedef IfcTemplatedEntityList<IfcOrderAction> list

Public Functions

std::string ActionID() const
void setActionID(std::string v)
const IfcParse::entity &declaration() const
IfcOrderAction(IfcEntityInstanceData *e)
IfcOrderAction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_TaskId, boost::optional<std::string> v7_Status, boost::optional<std::string> v8_WorkMethod, bool v9_IsMilestone, boost::optional<int> v10_Priority, std::string v11_ActionID)

Public Static Functions

const IfcParse::entity &Class()
class IfcOrganization : public IfcUtil::IfcBaseEntity

A named and structured grouping with a corporate identity.

NOTE: The relationships between IfcOrganizations, like a Department within a Company, can be expressed using IfcOrganizationRelationship.

NOTE Corresponds to the following entity in ISO-10303-41: organization.

HISTORY New entity in IFC Release 1.5.1. IFC 2x4 change: attribute Id renamed to Identification.

Public Types

typedef IfcTemplatedEntityList<IfcOrganization> list

Public Functions

bool hasId() const

Whether the optional attribute Id is defined for this IfcOrganization.

std::string Id() const
void setId(std::string v)
std::string Name() const

The word, or group of words, by which the organization is referred to.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcOrganization.

std::string Description() const

Text that relates the nature of the organization.

void setDescription(std::string v)
bool hasRoles() const

Whether the optional attribute Roles is defined for this IfcOrganization.

IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr Roles() const

Roles played by the organization.

void setRoles(IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr v)
bool hasAddresses() const

Whether the optional attribute Addresses is defined for this IfcOrganization.

IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr Addresses() const

Postal and telecom addresses of an organization. NOTE: There may be several addresses related to an organization.

void setAddresses(IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr v)
IfcTemplatedEntityList<IfcOrganizationRelationship>::ptr IsRelatedBy() const
IfcTemplatedEntityList<IfcOrganizationRelationship>::ptr Relates() const
IfcTemplatedEntityList<IfcPersonAndOrganization>::ptr Engages() const
const IfcParse::entity &declaration() const
IfcOrganization(IfcEntityInstanceData *e)
IfcOrganization(boost::optional<std::string> v1_Id, std::string v2_Name, boost::optional<std::string> v3_Description, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr> v4_Roles, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr> v5_Addresses)

Public Static Functions

const IfcParse::entity &Class()
class IfcOrganizationRelationship : public IfcUtil::IfcBaseEntity

Definition: establishes an association between one relating organization and one or more related organizations.

NOTE Corresponds to the following entity in ISO-10303-41: organization_relationship.

HISTORY New entity in IFC Release 2x. IFC 2x4 change: attribute Name made optional.

Public Functions

std::string Name() const

The word or group of words by which the relationship is referred to.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcOrganizationRelationship.

std::string Description() const

Text that relates the nature of the relationship.

void setDescription(std::string v)
::Ifc2x3::IfcOrganization *RelatingOrganization() const

Organization which is the relating part of the relationship between organizations.

void setRelatingOrganization(::Ifc2x3::IfcOrganization *v)
IfcTemplatedEntityList<::Ifc2x3::IfcOrganization>::ptr RelatedOrganizations() const

The other, possibly dependent, organizations which are the related parts of the relationship between organizations.

void setRelatedOrganizations(IfcTemplatedEntityList<::Ifc2x3::IfcOrganization>::ptr v)
const IfcParse::entity &declaration() const
IfcOrganizationRelationship(IfcEntityInstanceData *e)
IfcOrganizationRelationship(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcOrganization *v3_RelatingOrganization, IfcTemplatedEntityList<::Ifc2x3::IfcOrganization>::ptr v4_RelatedOrganizations)

Public Static Functions

const IfcParse::entity &Class()
class IfcOrientedEdge : public Ifc2x3::IfcEdge

Definition from ISO/CD 10303-42:1992: An oriented edge is an edge constructed from another edge and contains a BOOLEAN direction flag to indicate whether or not the orientation of the constructed edge agrees with the orientation of the original edge. Except for perhaps orientation, the oriented edge is equivalent to the original edge.

NOTE A common practice is solid modelling systems is to have an entity that represents the “use” or “traversal” of an edge. This “use” entity explicitly represents the requirement in a manifold solid that each edge must be traversed exactly twice, once in each direction. The “use” functionality is provided by the edge subtype oriented edge.

NOTE Corresponding ISO 10303 entity: oriented_edge. Please refer to ISO/IS 10303-42:1994, p. 133 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 2.0.

Public Types

typedef IfcTemplatedEntityList<IfcOrientedEdge> list

Public Functions

::Ifc2x3::IfcEdge *EdgeElement() const

Edge entity used to construct this oriented edge.

void setEdgeElement(::Ifc2x3::IfcEdge *v)
bool Orientation() const

BOOLEAN, If TRUE the topological orientation as used coincides with the orientation from start vertex to end vertex of the edge element. If FALSE otherwise.

void setOrientation(bool v)
const IfcParse::entity &declaration() const
IfcOrientedEdge(IfcEntityInstanceData *e)
IfcOrientedEdge(::Ifc2x3::IfcEdge *v3_EdgeElement, bool v4_Orientation)

Public Static Functions

const IfcParse::entity &Class()
class IfcOutletType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcOutletType defines commonly shared information for occurrences of outlets. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a outlet specification (i.e. the specific product information, that is common to all occurrences of that product type). Outlet types may be exchanged without being already assigned to occurrences. Occurrences of IfcOutletType are represented by instances of IfcOutlet.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_OutletTypeCommon

Material Use Definition The material of the IfcOutletType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Conductor’: Material from which the conductors are constructed. ‘Surface’: Material from which the outlet plate is constructed.

Port Use Definition The distribution ports relating to the IfcOutletType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcOutlet for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcOutletType> list

Public Functions

::Ifc2x3::IfcOutletTypeEnum::Value PredefinedType() const

Identifies the predefined types of outlet from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcOutletTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcOutletType(IfcEntityInstanceData *e)
IfcOutletType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcOutletTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcOutletTypeEnum

Public Types

enum Value

The IfcOutletTypeEnum defines the range of different types of outlet that can be specified.

HISTORY: New type in IFC 2x. Telephone and Data outlets added in IFC 2x4

Enumeration

AUDIOVISUALOUTLET: An outlet used for an audio or visual device. COMMUNICATIONSOUTLET: An outlet used for connecting communications equipment. POWEROUTLET: An outlet used for connecting electrical devices requiring power.

DATAOUTLET: An outlet used for connecting data communications equipment. TELEPHONEOUTLET: An outlet used for connecting telephone communications equipment.

USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcOutletType_AUDIOVISUALOUTLET
enumerator IfcOutletType_COMMUNICATIONSOUTLET
enumerator IfcOutletType_POWEROUTLET
enumerator IfcOutletType_USERDEFINED
enumerator IfcOutletType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcOwnerHistory : public IfcUtil::IfcBaseEntity

IfcOwnerHistory defines all history and identification related information. In order to provide fast access it is directly attached to all independent objects, relationships and properties.

IfcOwnerHistory is used to identify the creating and owning application and user for the associated object, as well as capture the last modifying application and user.

HISTORY New entity in IFC R1.0. Modified in IFC R2x4.

Informal propositions

If LastModifiedDate is defined but ChangeAction is not asserted, then the state of ChangeAction is assumed to be UNDEFINED.

If both LastModifiedDate and ChangeAction are asserted, then the state of ChangeAction applies to the value asserted in LastModifiedDate.

Public Types

typedef IfcTemplatedEntityList<IfcOwnerHistory> list

Public Functions

::Ifc2x3::IfcPersonAndOrganization *OwningUser() const

Direct reference to the end user who currently “owns” this object. Note that IFC includes the concept of ownership transfer from one user to another and therefore distinguishes between the Owning User and Creating User.

void setOwningUser(::Ifc2x3::IfcPersonAndOrganization *v)
::Ifc2x3::IfcApplication *OwningApplication() const

Direct reference to the application which currently “Owns” this object on behalf of the owning user, who uses this application. Note that IFC includes the concept of ownership transfer from one application to another and therefore distinguishes between the Owning Application and Creating Application.

void setOwningApplication(::Ifc2x3::IfcApplication *v)
bool hasState() const

Whether the optional attribute State is defined for this IfcOwnerHistory.

::Ifc2x3::IfcStateEnum::Value State() const

Enumeration that defines the current access state of the object.

void setState(::Ifc2x3::IfcStateEnum::Value v)
::Ifc2x3::IfcChangeActionEnum::Value ChangeAction() const

Enumeration that defines the actions associated with changes made to the object.

void setChangeAction(::Ifc2x3::IfcChangeActionEnum::Value v)
bool hasLastModifiedDate() const

Whether the optional attribute LastModifiedDate is defined for this IfcOwnerHistory.

int LastModifiedDate() const

Date and Time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) at which the last modification was made by LastModifyingUser and LastModifyingApplication.

void setLastModifiedDate(int v)
bool hasLastModifyingUser() const

Whether the optional attribute LastModifyingUser is defined for this IfcOwnerHistory.

::Ifc2x3::IfcPersonAndOrganization *LastModifyingUser() const

User who carried out the last modification using LastModifyingApplication.

void setLastModifyingUser(::Ifc2x3::IfcPersonAndOrganization *v)
bool hasLastModifyingApplication() const

Whether the optional attribute LastModifyingApplication is defined for this IfcOwnerHistory.

::Ifc2x3::IfcApplication *LastModifyingApplication() const

Application used to make the last modification.

void setLastModifyingApplication(::Ifc2x3::IfcApplication *v)
int CreationDate() const

The date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) when first created by the original OwningApplication. Once defined this value remains unchanged through the lifetime of the entity.

void setCreationDate(int v)
const IfcParse::entity &declaration() const
IfcOwnerHistory(IfcEntityInstanceData *e)
IfcOwnerHistory(::Ifc2x3::IfcPersonAndOrganization *v1_OwningUser, ::Ifc2x3::IfcApplication *v2_OwningApplication, boost::optional<::Ifc2x3::IfcStateEnum::Value> v3_State, ::Ifc2x3::IfcChangeActionEnum::Value v4_ChangeAction, boost::optional<int> v5_LastModifiedDate, ::Ifc2x3::IfcPersonAndOrganization *v6_LastModifyingUser, ::Ifc2x3::IfcApplication *v7_LastModifyingApplication, int v8_CreationDate)

Public Static Functions

const IfcParse::entity &Class()
class IfcParameterizedProfileDef : public Ifc2x3::IfcProfileDef

The parameterized profile definition defines a 2D position coordinate system to which the parameters of the different profiles relate to. All profiles are defined centric to the origin of the position coordinate system, or more specific, the origin [0.,0.] shall be in the center of the bounding box of the profile.

The Position attribute of IfcParameterizedProfileDef is used to position the profile within the XY plane of the underlying coordinate system of the swept surface geometry, the swept area solid or the sectioned spine. It can be used to position the profile at any point which becomes the origin [0.,0.,0.] of the extruded or rotated surface or solid.

The Position attribute should not be used if the transformation can be specified in a containing object instead. In particular, this applies if the IfcParameterizedProfileDef is referenced as SweptArea in subtypes of IfcSweptAreaSolid or as CrossSections in IfcSectionedSpine.

Several subtypes of IfcParameterizedProfileDef provide shape parameters which are optional. Sending systems should always provide values for these parameters if possible. If these parameters are left unspecified, receiving systems may retrieve values for them by external reference (if a reference to an external document or library is given; see guidance at IfcProfileDef), or estimate them, or simply assume zero values.

HISTORY New entity in IFC2x2.

IFC2x Platform CHANGE The IfcParameterizedProfileDef is introduced as an intermediate new abstract entity that unifies the definition and usage of the position coordinate system for all parameterized profiles. The Position attribute has been removed at all subtypes (like IfcRectangleProfileDef, IfcCircleProfileDef, etc.).

IFC2x3 CHANGE All profile origins are now in the center of the bounding box.

IFC2x4 CHANGE Position attribute made optional (default: identity transformation). Several radius parameters in subtypes have been changed from optional IfcPositiveLengthMeasure (assumed default: 0.) to optional IfcNonNegativeLengthMeasure (default: unspecified). This change allows to explicitly specify zero radius. Sending systems shall export 0. values if parameters are known to be 0. Subtypes IfcCraneRailAShapeProfileDef and IfcCraneRailFShapeProfileDef deleted. Rail profiles shall be modeled as IfcArbitraryClosedProfileDef or as IfcAsymmetricIShapeProfileDef together with appropriate external reference.

Subclassed by Ifc2x3::IfcCircleProfileDef, Ifc2x3::IfcCraneRailAShapeProfileDef, Ifc2x3::IfcCraneRailFShapeProfileDef, Ifc2x3::IfcCShapeProfileDef, Ifc2x3::IfcEllipseProfileDef, Ifc2x3::IfcIShapeProfileDef, Ifc2x3::IfcLShapeProfileDef, Ifc2x3::IfcRectangleProfileDef, Ifc2x3::IfcTrapeziumProfileDef, Ifc2x3::IfcTShapeProfileDef, Ifc2x3::IfcUShapeProfileDef, Ifc2x3::IfcZShapeProfileDef

Public Functions

::Ifc2x3::IfcAxis2Placement2D *Position() const

Position coordinate system of the parameterized profile definition. If unspecified, no translation and no rotation is applied.

void setPosition(::Ifc2x3::IfcAxis2Placement2D *v)
const IfcParse::entity &declaration() const
IfcParameterizedProfileDef(IfcEntityInstanceData *e)
IfcParameterizedProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcParameterValue : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A parameter value is the value which specifies the amount of a parameter in some parameter space. Type: REAL

NOTE Corresponding STEP name: parameter_value, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcParameterValue(IfcEntityInstanceData *e)
IfcParameterValue(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPath : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A path is a topological entity consisting of an ordered collection of oriented edges, such that the edge start vertex of each edge coincides with the edge end of its predecessor. The path is ordered from the edge start of the first oriented edge to the edge end of the last edge. The BOOLEAN value sense in the oriented edge indicates whether the edge direction agrees with the direction of the path (TRUE) or is the opposite direction (FALSE).

An individual edge can only be referenced once by an individual path. An edge can be referenced by multiple paths. An edge can exist independently of a path.

NOTE Corresponding ISO 10303 entity: path. Please refer to ISO/IS 10303-42:1994, p. 133 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 2.0

Informal proposition:

A path has dimensionality 1. A path is arcwise connected. The edges of the path do not intersect except at common vertices. A path has a finite, non-zero extent.

Public Types

typedef IfcTemplatedEntityList<IfcPath> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr EdgeList() const

The list of oriented edges which are concatenated together to form this path.

void setEdgeList(IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr v)
const IfcParse::entity &declaration() const
IfcPath(IfcEntityInstanceData *e)
IfcPath(IfcTemplatedEntityList<::Ifc2x3::IfcOrientedEdge>::ptr v1_EdgeList)

Public Static Functions

const IfcParse::entity &Class()
class IfcPerformanceHistory : public Ifc2x3::IfcControl

IfcPerformanceHistory is used to document the actual performance of an occurrence instance over time. In practice, performance-related data are generally not easy to obtain as they can originate from different sources (predicted, simulated, or measured) and occur during different stages of the building life-cycle. Such time-related data cover a large spectrum, including meteorological data, schedules, operational status measurements, trend reports, etc.

IfcPerformanceHistory is assigned to other objects (represented by subtypes of IfcObjectDefinition, excluding subtypes of IfcControl), by the objectified relationship IfcRelAssignsToControl.

HISTORY: New entity in Release IFC2x Edition 2.

Public Types

typedef IfcTemplatedEntityList<IfcPerformanceHistory> list

Public Functions

std::string LifeCyclePhase() const

Describes the applicable building life-cycle phase. Typical values should be DESIGNDEVELOPMENT, SCHEMATICDEVELOPMENT, CONSTRUCTIONDOCUMENT, CONSTRUCTION, ASBUILT, COMMISSIONING, OPERATION, etc.

void setLifeCyclePhase(std::string v)
const IfcParse::entity &declaration() const
IfcPerformanceHistory(IfcEntityInstanceData *e)
IfcPerformanceHistory(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_LifeCyclePhase)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPermeableCoveringOperationEnum

Public Types

enum Value

Definition: Enumeration defining the valid types of permeable coverings.

Enumeration:

GRILL protective screen of metal bars or wires

LOUVER set of fixed or movable strips of wood, metal, etc. arranged to let air in while keeping light or rain out

SCREEN upright, fixed or movable, sometimes folding framework used for protection against heat, light, access or similar

USERDEFINED user defined permeable covering type

NOTDEFINED no information available

HISTORY: New Enumeration in IFC Release 2.0

Values:

enumerator IfcPermeableCoveringOperation_GRILL
enumerator IfcPermeableCoveringOperation_LOUVER
enumerator IfcPermeableCoveringOperation_SCREEN
enumerator IfcPermeableCoveringOperation_USERDEFINED
enumerator IfcPermeableCoveringOperation_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPermeableCoveringProperties : public Ifc2x3::IfcPropertySetDefinition

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. 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

HISTORY New entity in IFC Release 2.0, it had been renamed from IfcPermeableCovering in IFC Release 2x.

IFC2x4 CHANGE Supertype changed to new IfcPreDefinedPropertySet.

Geometry use definitions The IfcPermeableCoveringProperties does not hold a geometric representation. However it defines parameters which can be used to create the shape of the IfcWindowStyle (which is inserted by the IfcWindow into the spatial context of the project), or of the IfcDoorStyle (which is inserted by the IfcDoor). The parameters at the IfcPermeableCoveringProperties define a standard permeable covering. The outer boundary of the panel is determined by the occurrence parameter assigned to the IfcWindow or IfcDoor. It has to take the lining parameter into account as well. The position of the permeable covering within the overall window or door is determined by the PanelPosition attribute.

As shown in Figure 174, the panel is applied to the position within the lining, as defined by the panel position attribute. The following parameters apply to that panel: FrameDepth, FrameThickness.

Figure 174 — Permeable covering properties

Public Functions

::Ifc2x3::IfcPermeableCoveringOperationEnum::Value OperationType() const

Types of permeable covering operations. Also used to assign standard symbolic presentations according to national building standards.

void setOperationType(::Ifc2x3::IfcPermeableCoveringOperationEnum::Value v)
::Ifc2x3::IfcWindowPanelPositionEnum::Value PanelPosition() const

Position of this permeable covering panel within the overall window or door type.

void setPanelPosition(::Ifc2x3::IfcWindowPanelPositionEnum::Value v)
bool hasFrameDepth() const

Whether the optional attribute FrameDepth is defined for this IfcPermeableCoveringProperties.

double FrameDepth() const

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.

void setFrameDepth(double v)
bool hasFrameThickness() const

Whether the optional attribute FrameThickness is defined for this IfcPermeableCoveringProperties.

double FrameThickness() const

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.

void setFrameThickness(double v)
bool hasShapeAspectStyle() const

Whether the optional attribute ShapeAspectStyle is defined for this IfcPermeableCoveringProperties.

::Ifc2x3::IfcShapeAspect *ShapeAspectStyle() const

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.

void setShapeAspectStyle(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcPermeableCoveringProperties(IfcEntityInstanceData *e)
IfcPermeableCoveringProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcPermeableCoveringOperationEnum::Value v5_OperationType, ::Ifc2x3::IfcWindowPanelPositionEnum::Value v6_PanelPosition, boost::optional<double> v7_FrameDepth, boost::optional<double> v8_FrameThickness, ::Ifc2x3::IfcShapeAspect *v9_ShapeAspectStyle)

Public Static Functions

const IfcParse::entity &Class()
class IfcPermit : public Ifc2x3::IfcControl

A permit is a permission to perform work in places and on artifacts where regulatory, security or other access restrictions apply.

HISTORY New entity in IFC2x2 IFC2x4 CHANGE PermitID renamed to Identification and promoted to supertype IfcControl, Attributes PredefinedType, Status, and LongDescription added.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Refer to the documentation at the supertype IfcControl and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_Permit

Declaration Use Definition The IfcPermit may be declared within the project using the IfcRelDeclares relationship where RelatingContext refers to the single IfcProject and RelatedDefinitions contains the IfcPermit. Alternatively, if the IfcPermit is aggregated within an IfcWorkPlan, then it shall not have a direct declaration relationship (whereas the containing work plan may have a declaration relationship).

Composition Use Definition The IfcPermit may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcPermit and RelatedObjects contains one or more components. Aggregation use is defined for the following predefined types:

ACCESS: May contain IfcWorkCalendar components. A work calendar may indicate the time period of the permit and allowed times when work may be performed. Such work calendar may have assigned resources indicating equipment or labor permitted at various times. WORK: May contain IfcWorkSchedule components. A work schedule may indicate tasks and scheduled times where the work schedule type may designate whether tasks and/or times are planned or actual. Such work schedule may have assigned tasks indicating detail, where tasks may be assigned to products and may have assigned resources.

As shown in Figure 159, an IfcPermit may be nested into sub-items using IfcRelNests where RelatingObject refers to the enclosing IfcPermit and RelatedObjects contains one or more sub-items. Nesting use is defined for the following predefined types:

(All Types): May contain IfcPermit sub-items. A permit may be nested to indicate permit ammendments, in order of issue.

Figure 159 — Permit composition

Assignment Use Definition As shown in Figure 160, an IfcPermit may be assigned to the following entities using relationships as indicated:

IfcActor (IfcRelAssignsToActor): Organization issuing the permit such as a local government agency or security organization.

The IfcPermit may have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcPermit and RelatedObjects contains one or more objects of the following types: IfcActor: Organization(s) bound to the permit, typically a single contractor.

Figure 160 — Permit assignment

Approval Use Definition Approvals may be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcPermit. Approvals may be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.

Public Types

typedef IfcTemplatedEntityList<IfcPermit> list

Public Functions

std::string PermitID() const
void setPermitID(std::string v)
const IfcParse::entity &declaration() const
IfcPermit(IfcEntityInstanceData *e)
IfcPermit(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_PermitID)

Public Static Functions

const IfcParse::entity &Class()
class IfcPerson : public IfcUtil::IfcBaseEntity

Definition: an individual human being.

NOTE Many countries have legislation concerning the identification of individual persons within databases. Although the intent of the IFC Model is to act as a specification for data exchange and sharing, an IFC file might in some situations be considered to be a database that enables identification of a particular person under the terms of such legislation. Users should be aware of the constraints of legislation that might apply in the places where IFC files are used.

NOTE Corresponds to the following entity in ISO-10303-41: person.

HISTORY New entity in IFC Release 1.5.1. IFC 2x4 change: attribute Id renamed to Identification. WHERE rule relaxed to allow omission of names if Identification is provided.

Public Types

typedef IfcTemplatedEntityList<IfcPerson> list

Public Functions

bool hasId() const

Whether the optional attribute Id is defined for this IfcPerson.

std::string Id() const
void setId(std::string v)
bool hasFamilyName() const

Whether the optional attribute FamilyName is defined for this IfcPerson.

std::string FamilyName() const

The name by which the family identity of the person may be recognized. NOTE: Depending on geographical location and culture, family name may appear either as the first or last component of a name.

void setFamilyName(std::string v)
bool hasGivenName() const

Whether the optional attribute GivenName is defined for this IfcPerson.

std::string GivenName() const

The name by which a person is known within a family and by which he or she may be familiarly recognized. NOTE: Depending on geographical location and culture, given name may appear either as the first or last component of a name.

void setGivenName(std::string v)
bool hasMiddleNames() const

Whether the optional attribute MiddleNames is defined for this IfcPerson.

std::vector<std::string> MiddleNames() const

Additional names given to a person that enable their identification apart from others who may have the same or similar family and given names. NOTE: Middle names are not normally used in familiar communication but may be asserted to provide additional identification of a particular person if necessary. They may be particularly useful in situations where the person concerned has a family name that occurs commonly in the geographical region.

void setMiddleNames(std::vector<std::string> v)
bool hasPrefixTitles() const

Whether the optional attribute PrefixTitles is defined for this IfcPerson.

std::vector<std::string> PrefixTitles() const

The word, or group of words, which specify the person’s social and/or professional standing and appear before his/her names.

void setPrefixTitles(std::vector<std::string> v)
bool hasSuffixTitles() const

Whether the optional attribute SuffixTitles is defined for this IfcPerson.

std::vector<std::string> SuffixTitles() const

The word, or group of words, which specify the person’s social and/or professional standing and appear after his/her names.

void setSuffixTitles(std::vector<std::string> v)
bool hasRoles() const

Whether the optional attribute Roles is defined for this IfcPerson.

IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr Roles() const

Roles played by the person.

void setRoles(IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr v)
bool hasAddresses() const

Whether the optional attribute Addresses is defined for this IfcPerson.

IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr Addresses() const

Postal and telecommunication addresses of a person. NOTE - A person may have several addresses.

void setAddresses(IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr v)
IfcTemplatedEntityList<IfcPersonAndOrganization>::ptr EngagedIn() const
const IfcParse::entity &declaration() const
IfcPerson(IfcEntityInstanceData *e)
IfcPerson(boost::optional<std::string> v1_Id, boost::optional<std::string> v2_FamilyName, boost::optional<std::string> v3_GivenName, boost::optional<std::vector<std::string>> v4_MiddleNames, boost::optional<std::vector<std::string>> v5_PrefixTitles, boost::optional<std::vector<std::string>> v6_SuffixTitles, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr> v7_Roles, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcAddress>::ptr> v8_Addresses)

Public Static Functions

const IfcParse::entity &Class()
class IfcPersonAndOrganization : public IfcUtil::IfcBaseEntity

Definition: Identification of a person within an organization.

NOTE Corresponds to the following entity in ISO-10303-41: person_and_organization.

HISTORY New entity in IFC Release 1.5.1

Public Functions

::Ifc2x3::IfcPerson *ThePerson() const

The person who is related to the organization.

void setThePerson(::Ifc2x3::IfcPerson *v)
::Ifc2x3::IfcOrganization *TheOrganization() const

The organization to which the person is related.

void setTheOrganization(::Ifc2x3::IfcOrganization *v)
bool hasRoles() const

Whether the optional attribute Roles is defined for this IfcPersonAndOrganization.

IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr Roles() const

Roles played by the person within the context of an organization. These may differ from the roles in ThePerson.Roles which may be asserted without organizational context.

void setRoles(IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr v)
const IfcParse::entity &declaration() const
IfcPersonAndOrganization(IfcEntityInstanceData *e)
IfcPersonAndOrganization(::Ifc2x3::IfcPerson *v1_ThePerson, ::Ifc2x3::IfcOrganization *v2_TheOrganization, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcActorRole>::ptr> v3_Roles)

Public Static Functions

const IfcParse::entity &Class()
class IfcPHMeasure : public IfcUtil::IfcBaseType

IfcPHMeasure is a measure of the molar hydrogen ion concentration in a liquid (usually defined as the measure of acidity) in a range from 0 to 14.

HISTORY: New type in IFC 2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPHMeasure(IfcEntityInstanceData *e)
IfcPHMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPhysicalComplexQuantity : public Ifc2x3::IfcPhysicalQuantity

The complex physical quantity, IfcPhysicalComplexQuantity, is an entity that holds a set of single quantity measure value (as defined at the subtypes of IfcPhysicalSimpleQuantity), that all apply to a given component or aspect of the element.

EXAMPLE: A layered element, like a wall, may have several material layers, each having individual quantities, like footprint area, side area and volume. An instance of IfcPhysicalComplexQuantity would group these individual quantities (given by a subtype of IfcPhysicalSimpleQuantity) and name them according to the material layer name by using the Name attribute. The Discrimination attribute would then be ‘layer’.

A section “Quantity Use Definition” at individual entities as subtypes of IfcBuildingElement gives guidance to the usage of the Name and Discrimination attribute to characterize the complex quantities.

HISTORY New entity in IFC2x2 Addendum 1.

IFC2x2 ADDENDUM 1 CHANGE The entity IfcPhysicalComplexQuantity has been added. Upward compatibility for file based exchange is guaranteed.

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr HasQuantities() const

Set of physical quantities that are grouped by this complex physical quantity according to a given discrimination.

void setHasQuantities(IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr v)
std::string Discrimination() const

Identification of the discrimination by which this physical complex property is distinguished. Examples of discriminations are ‘layer’, ‘steel bar diameter’, etc.

void setDiscrimination(std::string v)
bool hasQuality() const

Whether the optional attribute Quality is defined for this IfcPhysicalComplexQuantity.

std::string Quality() const

Additional indication of a quality of the quantities that are grouped under this physical complex quantity.

void setQuality(std::string v)
bool hasUsage() const

Whether the optional attribute Usage is defined for this IfcPhysicalComplexQuantity.

std::string Usage() const

Additional indication of a usage type of the quantities that are grouped under this physical complex quantity.

void setUsage(std::string v)
const IfcParse::entity &declaration() const
IfcPhysicalComplexQuantity(IfcEntityInstanceData *e)
IfcPhysicalComplexQuantity(std::string v1_Name, boost::optional<std::string> v2_Description, IfcTemplatedEntityList<::Ifc2x3::IfcPhysicalQuantity>::ptr v3_HasQuantities, std::string v4_Discrimination, boost::optional<std::string> v5_Quality, boost::optional<std::string> v6_Usage)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPhysicalOrVirtualEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of space boundaries in terms of its physical manifestation. A space boundary can either be physically dividing or can be a virtual divider.

Enumeration:

PHYSICAL

The space boundary is provided physically, i.e. by an physical element.

VIRTUAL

The space boundary is provided virtually, i.e. by a logical divider that has no physical manifestation.

NOTDEFINED

No information available.

HISTORY: New enumeration in IFC Release 2.0

Values:

enumerator IfcPhysicalOrVirtual_PHYSICAL
enumerator IfcPhysicalOrVirtual_VIRTUAL
enumerator IfcPhysicalOrVirtual_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPhysicalQuantity : public IfcUtil::IfcBaseEntity

The physical quantity, IfcPhysicalQuantity, is an abstract entity that holds a complex or simple quantity measure together with a semantic definition of the usage for the single or several measure value.

The Name attribute defines the actual usage or kind of measure. The interpretation of the name label has to be established within the actual exchange context. In addition an informative text may be associated to each quantity by the Description attribute.

HISTORY New entity in IFC2x. It replaces the calcXxx attributes used in previous IFC Releases.

Subclassed by Ifc2x3::IfcPhysicalComplexQuantity, Ifc2x3::IfcPhysicalSimpleQuantity

Public Types

typedef IfcTemplatedEntityList<IfcPhysicalQuantity> list

Public Functions

std::string Name() const

Name of the element quantity or measure. The name attribute has to be made recognizable by further agreements.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcPhysicalQuantity.

std::string Description() const

Further explanation that might be given to the quantity.

void setDescription(std::string v)
IfcTemplatedEntityList<IfcPhysicalComplexQuantity>::ptr PartOfComplex() const
const IfcParse::entity &declaration() const
IfcPhysicalQuantity(IfcEntityInstanceData *e)
IfcPhysicalQuantity(std::string v1_Name, boost::optional<std::string> v2_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcPhysicalSimpleQuantity : public Ifc2x3::IfcPhysicalQuantity

The physical quantity, IfcPhysicalSimpleQuantity, is an entity that holds a single quantity measure value (as defined at the subtypes of IfcPhysicalSimpleQuantity) together with a semantic definition of the usage for the measure value.

EXAMPLE An element, like a wall, may have several area measures, like footprint area, left wall face area, right wall face area. These areas would be given by three instances of the area quantity subtype, with different Name string values.

A section “Quantity Use Definition” at individual entities as subtypes of IfcBuildingElement gives guidance to the usage of the Name attribute to characterize the individual quantities. If the Unit attribute is given, the value attribute (introduced at the level of subtypes of IfcPhysicalSimpleQuantity) are given as quantities of this unit, otherwise the global unit definitions (given by IfcUnitAssignment) are used.

HISTORY New entity in IFC2x2 Addendum 1.

IFC2x2 ADDENDUM 1 CHANGE The abstract entity IfcPhysicalSimpleQuantity has been added. Upward compatibility for file based exchange is guaranteed.

Subclassed by Ifc2x3::IfcQuantityArea, Ifc2x3::IfcQuantityCount, Ifc2x3::IfcQuantityLength, Ifc2x3::IfcQuantityTime, Ifc2x3::IfcQuantityVolume, Ifc2x3::IfcQuantityWeight

Public Functions

bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcPhysicalSimpleQuantity.

::Ifc2x3::IfcNamedUnit *Unit() const

Optional assignment of a unit. If no unit is given, then the global unit assignment, as established at the IfcProject, applies to the quantity measures.

void setUnit(::Ifc2x3::IfcNamedUnit *v)
const IfcParse::entity &declaration() const
IfcPhysicalSimpleQuantity(IfcEntityInstanceData *e)
IfcPhysicalSimpleQuantity(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit)

Public Static Functions

const IfcParse::entity &Class()
class IfcPile : public Ifc2x3::IfcBuildingElement

A pile is a slender timber, concrete, or steel structural element, driven, jetted, or otherwise embedded on end in the ground for the purpose of supporting a load.

HISTORY New entity in IFC2x2

Property Set Use Definition

The following property set definitions are part of this IFC release:

Pset_PileCommon: common property set for all pile occurrences.

Quantity Use Definition The quantities relating to this entity are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_PileBaseQuantities

Geometry Use Definition

Local placement and product representations are defined by the supertype IfcBuildingElement. Standard representations as defined at IfcColumnStandardCase should be used when applicable.

Public Types

typedef IfcTemplatedEntityList<IfcPile> list

Public Functions

::Ifc2x3::IfcPileTypeEnum::Value PredefinedType() const

The predefined generic type of the pile according to function.

IFC 2x4 change: Attribute made optional. Type information can be provided by IfcRelDefinesByType and IfcPileType.

void setPredefinedType(::Ifc2x3::IfcPileTypeEnum::Value v)
bool hasConstructionType() const

Whether the optional attribute ConstructionType is defined for this IfcPile.

::Ifc2x3::IfcPileConstructionEnum::Value ConstructionType() const

General designator for how the pile is constructed.

IFC 2x4 change: Material profile association capability by means of IfcRelAssociatesMaterial has been added. The attribute ConstructionType should not be used whenever its information can be provided by a material profile set, either associated with the IfcPile object or, if present, with a corresponding instance of IfcPileType.

void setConstructionType(::Ifc2x3::IfcPileConstructionEnum::Value v)
const IfcParse::entity &declaration() const
IfcPile(IfcEntityInstanceData *e)
IfcPile(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcPileTypeEnum::Value v9_PredefinedType, boost::optional<::Ifc2x3::IfcPileConstructionEnum::Value> v10_ConstructionType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPileConstructionEnum

Public Types

enum Value

Definition from IAI: Enumeration defining the construction type for piles. The type is mainly based on how the piles are used and manufactured. Some material information is mixed in because this affects the way the piles are used.

HISTORY New type in IFC Release 2x2

ENUMERATION

CAST_IN_PLACE Piles and piers that are excavated and poured in place. COMPOSITE Piles that are a mix of components, such as a steel outer casing which is driven into the ground with a cast-in-place concrete core. PRECAST_CONCRETE Piles that are entirely of precast concrete (possibly with some steel or other fixtures). PREFAB_STEEL Prefabricated piles made entirely out of steel. It will also include steel sheet piles where these are not part of another construction element. USERDEFINED Special types of pile construction which meet specific local requirements. NOTDEFINED The type of pile construction is not defined.

Values:

enumerator IfcPileConstruction_CAST_IN_PLACE
enumerator IfcPileConstruction_COMPOSITE
enumerator IfcPileConstruction_PRECAST_CONCRETE
enumerator IfcPileConstruction_PREFAB_STEEL
enumerator IfcPileConstruction_USERDEFINED
enumerator IfcPileConstruction_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcPileTypeEnum

Public Types

enum Value

Definition from IAI: Enumeration defining the pile type.

HISTORY New type in IFC Release 2x2 IFC 2x4 change: Items BORED, DRIVEN, JETGROUTING added

BORED A bore pile. DRIVEN A rammed, vibrated, or otherwise driven pile. JETGROUTING An injected pile-like construction. COHESION A cohesion pile. FRICTION A friction pile. SUPPORT A support pile. USERDEFINED The type of pile function is user defined. NOTDEFINED The type of pile function is not defined.

Values:

enumerator IfcPileType_COHESION
enumerator IfcPileType_FRICTION
enumerator IfcPileType_SUPPORT
enumerator IfcPileType_USERDEFINED
enumerator IfcPileType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPipeFittingType : public Ifc2x3::IfcFlowFittingType

The flow fitting type IfcPipeFittingType defines commonly shared information for occurrences of pipe fittings. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a pipe fitting specification (i.e. the specific product information, that is common to all occurrences of that product type). Pipe Fitting types may be exchanged without being already assigned to occurrences. Occurrences of IfcPipeFittingType are represented by instances of IfcPipeFitting.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowFittingType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_PipeFittingTypeCommon

Material Use Definition The material of the IfcPipeFittingType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Body’: Material from which the pipe fitting is constructed. ‘Coating’: The outer coating, if applicable. ‘Insulation’: The insulating wrapping, if applicable. ‘Lining’: The inner lining, if applicable.

Port Use Definition The distribution ports relating to the IfcPipeFittingType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcPipeFitting for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcPipeFittingType> list

Public Functions

::Ifc2x3::IfcPipeFittingTypeEnum::Value PredefinedType() const

The type of pipe fitting.

void setPredefinedType(::Ifc2x3::IfcPipeFittingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcPipeFittingType(IfcEntityInstanceData *e)
IfcPipeFittingType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcPipeFittingTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPipeFittingTypeEnum

Public Types

enum Value

This enumeration is used to identify the primary purpose of a pipe fitting. This is a very basic categorization mechanism to generically identify the pipe fitting type. Subcategories of pipe fittings are not enumerated. The IfcpipeFittingTypeEnum contains the following:

BEND: A fitting with typically two ports used to change the direction of flow between connected elements. CONNECTOR: Connector fitting, typically used to join two ports together within a flow distribution system (e.g., a coupling used to join two pipe segments). ENTRY: Entry fitting, typically unconnected at one port and connected to a flow distribution system at the other (e.g., a breeching inlet). EXIT: Exit fitting, typically unconnected at one port and connected to a flow distribution system at the other (e.g., a hose bibb). JUNCTION: A fitting with typically more than two ports used to redistribute flow among the ports and/or to change the direction of flow between connected elements (e.g, tee, cross, wye, etc.). OBSTRUCTION: A fitting with typically two ports used to obstruct or restrict flow between the connected elements (e.g., screen, perforated plate, etc.). TRANSITION: A fitting with typically two ports having different shapes or sizes. Can also be used to change the direction of flow between connected elements. USERDEFINED: User-defined fitting. NOTDEFINED: Undefined fitting.

HISTORY: New enumeration in IFC 2x2

Values:

enumerator IfcPipeFittingType_BEND
enumerator IfcPipeFittingType_CONNECTOR
enumerator IfcPipeFittingType_ENTRY
enumerator IfcPipeFittingType_EXIT
enumerator IfcPipeFittingType_JUNCTION
enumerator IfcPipeFittingType_OBSTRUCTION
enumerator IfcPipeFittingType_TRANSITION
enumerator IfcPipeFittingType_USERDEFINED
enumerator IfcPipeFittingType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPipeSegmentType : public Ifc2x3::IfcFlowSegmentType

The flow segment type IfcPipeSegmentType defines commonly shared information for occurrences of pipe segments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a pipe segment specification (i.e. the specific product information, that is common to all occurrences of that product type). Pipe Segment types may be exchanged without being already assigned to occurrences. Occurrences of IfcPipeSegmentType are represented by instances of IfcPipeSegment.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowSegmentType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_PipeSegmentTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_PipeSegmentTypeCulvert (CULVERT) Pset_PipeSegmentTypeGutter (GUTTER)

Material Use Definition The material of the IfcPipeSegmentType is defined by IfcMaterialProfileSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialProfileSet.MaterialProfiles[n].Name shall be used:

‘Body’: Material from which the pipe segment is constructed. ‘Coating’: The outer coating, if applicable. ‘Insulation’: The insulating wrapping, if applicable. ‘Lining’: The inner lining, if applicable.

Port Use Definition The distribution ports relating to the IfcPipeSegmentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcPipeSegment for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcPipeSegmentType> list

Public Functions

::Ifc2x3::IfcPipeSegmentTypeEnum::Value PredefinedType() const

The type of pipe segment.

void setPredefinedType(::Ifc2x3::IfcPipeSegmentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcPipeSegmentType(IfcEntityInstanceData *e)
IfcPipeSegmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcPipeSegmentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPipeSegmentTypeEnum

Public Types

enum Value

This enumeration is used to identify the primary purpose of a pipe segment. This is a very basic categorization mechanism to generically identify the pipe segment type. Subcategories of pipe segments are not enumerated. The IfcPipeSegmentTypeEnum contains the following:

CULVERT: A covered channel or large pipe that forms a watercourse below ground level, usually under a road or railway. RIGIDSEGMENT: A rigid segment is continuous linear segment of pipe that cannot be deformed. FLEXIBLESEGMENT: A flexible segment is a continuous non-linear segment of pipe that can be deformed and change the direction of flow. GUTTER: A gutter segment is a continuous open-channel segment of pipe. SPOOL: A type of rigid segment that is typically shorter and used for providing connectivity within a piping network. USERDEFINED: User-defined segment. NOTDEFINED: Undefined segment.

HISTORY: New enumeration in IFC 2x2

Values:

enumerator IfcPipeSegmentType_FLEXIBLESEGMENT
enumerator IfcPipeSegmentType_RIGIDSEGMENT
enumerator IfcPipeSegmentType_GUTTER
enumerator IfcPipeSegmentType_SPOOL
enumerator IfcPipeSegmentType_USERDEFINED
enumerator IfcPipeSegmentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPixelTexture : public Ifc2x3::IfcSurfaceTexture

An IfcPixelTexture provides a 2D image-based texture map as an explicit array of pixel values (list of Pixel binary attributes). In contrary to the IfcImageTexture the IfcPixelTexture holds a 2 dimensional list of pixel color (and opacity) directly, instead of referencing to an URL.

The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

The PixelTexture node defines a 2D image-based texture map as an explicit array of pixel values (image field) and parameters controlling tiling repetition of the texture onto geometry. Texture maps are defined in a 2D coordinate system (s, t) that ranges from 0.0 to 1.0 in both directions. The bottom edge of the pixel image corresponds to the S-axis of the texture map, and left edge of the pixel image corresponds to the T-axis of the texture map. The lower-left pixel of the pixel image corresponds to s=0.0, t=0.0, and the top-right pixel of the image corresponds to s = 1.0, t = 1.0. The Image field specifies a single uncompressed 2-dimensional pixel image. Image fields contain three integers representing the width, height and number of components in the image, followed by width×height hexadecimal values representing the pixels in the image. Pixel values are limited to 256 levels of intensity (that is, 0x00-0xFF hexadecimal).

A one-component image specifies one-byte hexadecimal value representing the intensity of the image. For example, 0xFF is full intensity in hexadecimal (255 in decimal), 0x00 is no intensity (0 in decimal). A two-component image specifies the intensity in the first (high) byte and the alpha opacity in the second (low) byte. Pixels in a three-component image specify the red component in the first (high) byte, followed by the green and blue components (for example, 0xFF0000 is red, 0x00FF00 is green, 0x0000FF is blue). Four-component images specify the alpha opacity byte after red/green/blue (e.g., 0x0000FF80 is semi-transparent blue). A value of 00 is completely transparent, FF is completely opaque, 80 is semi-transparent.

Note that alpha equals (1.0 -transparency), if alpha and transparency each range from 0.0 to 1.0.

HISTORY: New class in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcPixelTexture> list

Public Functions

int Width() const

The number of pixels in width (S) direction.

void setWidth(int v)
int Height() const

The number of pixels in height (T) direction.

void setHeight(int v)
int ColourComponents() const

Indication whether the pixel values contain a 1, 2, 3, or 4 colour component.

void setColourComponents(int v)
std::vector<boost::dynamic_bitset<>> Pixel() const

Flat list of hexadecimal values, each describing one pixel by 1, 2, 3, or 4 components.

IFC2x Edition 3 CHANGE The data type has been changed from STRING to BINARY.

void setPixel(std::vector<boost::dynamic_bitset<>> v)
const IfcParse::entity &declaration() const
IfcPixelTexture(IfcEntityInstanceData *e)
IfcPixelTexture(bool v1_RepeatS, bool v2_RepeatT, ::Ifc2x3::IfcSurfaceTextureEnum::Value v3_TextureType, ::Ifc2x3::IfcCartesianTransformationOperator2D *v4_TextureTransform, int v5_Width, int v6_Height, int v7_ColourComponents, std::vector<boost::dynamic_bitset<>> v8_Pixel)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlacement : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A placement entity defines the local environment for the definition of a geometry item. It locates the item to be defined and, in the case of the axis placement subtypes, gives its orientation.

Additional definition from ISO/WD SC4/WG12/N071 Part42.2 geometry_schema: A placement locates a geometric item with respect to the coordinate system of its geometric context.

IfcPlacement is an abstract supertype not to be directly instantiated, whereas the ISO 10303-42 entity placement can be instantiated to define a placement without orientation. The derived attribute Dim has been added, see also note at IfcGeometricRepresentationItem.

NOTE: Corresponding ISO 10303 entity: placement. Please refer to ISO/IS 10303-42:1994, p. 27 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.0

Subclassed by Ifc2x3::IfcAxis1Placement, Ifc2x3::IfcAxis2Placement2D, Ifc2x3::IfcAxis2Placement3D

Public Types

typedef IfcTemplatedEntityList<IfcPlacement> list

Public Functions

::Ifc2x3::IfcCartesianPoint *Location() const

The geometric position of a reference point, such as the center of a circle, of the item to be located.

void setLocation(::Ifc2x3::IfcCartesianPoint *v)
const IfcParse::entity &declaration() const
IfcPlacement(IfcEntityInstanceData *e)
IfcPlacement(::Ifc2x3::IfcCartesianPoint *v1_Location)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlanarBox : public Ifc2x3::IfcPlanarExtent

Definition from ISO/CD 10303-46:1992: A planar box specifies an arbitrary rectangular box and its location in a two dimensional Cartesian coordinate system.

NOTE Corresponding ISO 10303 name: planar_box. Please refer to ISO/IS 10303-46:1994, p. 141 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcPlanarBox> list

Public Functions

::Ifc2x3::IfcAxis2Placement *Placement() const

The IfcAxis2Placement positions a local coordinate system for the definition of the rectangle. The origin of this local coordinate system serves as the lower left corner of the rectangular box. NOTE In case of a 3D placement by IfcAxisPlacement3D the IfcPlanarBox is defined within the xy plane of the definition coordinate system.

void setPlacement(::Ifc2x3::IfcAxis2Placement *v)
const IfcParse::entity &declaration() const
IfcPlanarBox(IfcEntityInstanceData *e)
IfcPlanarBox(double v1_SizeInX, double v2_SizeInY, ::Ifc2x3::IfcAxis2Placement *v3_Placement)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlanarExtent : public Ifc2x3::IfcGeometricRepresentationItem

The planar extent defines the extent along the two axes of the two-dimensional coordinate system, independently of its position.

NOTE Corresponding ISO 10303 name: planar_extent. Please refer to ISO/IS 10303-46:1994, p. 141 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Subclassed by Ifc2x3::IfcPlanarBox

Public Types

typedef IfcTemplatedEntityList<IfcPlanarExtent> list

Public Functions

double SizeInX() const

The extent in the direction of the x-axis.

void setSizeInX(double v)
double SizeInY() const

The extent in the direction of the y-axis.

void setSizeInY(double v)
const IfcParse::entity &declaration() const
IfcPlanarExtent(IfcEntityInstanceData *e)
IfcPlanarExtent(double v1_SizeInX, double v2_SizeInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlanarForceMeasure : public IfcUtil::IfcBaseType

IfcPlanarForceMeasure is a measure of force on an area. Usually measured in N/m2. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPlanarForceMeasure(IfcEntityInstanceData *e)
IfcPlanarForceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPlane : public Ifc2x3::IfcElementarySurface

Definition from ISO/CD 10303-42:1992: A plane is an unbounded surface with a constant normal. A plane is defined by a point on the plane and the normal direction to the plane. The data is to be interpreted as follows:

C = Position.Location x = Position.P[1] y = Position.P[2] z = Position.P[3] => normal to plane

and the surface is parameterized as:

where the parametric range is -∞ < u,v < ∞. In the above parameterization the length unit for the unit vectors x and y is derived from the context of the plane.

The planar surface is an unbounded surface in the direction of x and y. Bounded planar surfaces are defined by using a subtype of IfcBoundedSurface with BasisSurface being a plane.

NOTE A rectangular bounded planar surface can be defined by an IfcRectangularTrimmedSurface with BasisSurface being the plane and U1 = left bound in x, U2 = right bound in x, V1 = lower bound in y, V2 = upper bound in y if viewed into the direction of the negative normal. (assuming the Usense and Vsense agree to the sense of the basis surface). The inherited attributes are interpreted as

SELF\IfcElementarySurface.Position defines the location and orientation of the planar surface. SELF\IfcElementarySurface.Position.Location defines a point on the planar surface. SELF\IfcElementarySurface.Position.P[3] defines the normal of the planar surface.

NOTE Corresponding ISO 10303 entity: plane. Please refer to ISO/IS 10303-42:1994, p.69 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.5

Public Types

typedef IfcTemplatedEntityList<IfcPlane> list

Public Functions

const IfcParse::entity &declaration() const
IfcPlane(IfcEntityInstanceData *e)
IfcPlane(::Ifc2x3::IfcAxis2Placement3D *v1_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlaneAngleMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A plane angle measure is the value of an angle in a plane.

Usually measured in radian (rad, m/m = 1), but also grads may be used. The grad unit may be declared as a conversion based unit based on radian unit.

NOTE IfcPlaneAngleMeasure is used where angles need to be described to an accuracy of less than one degree and expressed as decimal parts of an angle. It is widely used for angular measurement except for situations where accuracy needs to be defined using arc measurement; for which purpose the IfcCompoundPlaneAngleMeasure is provided.

Type: REAL

NOTE Corresponding ISO 10303 name: plane_angle_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcPositivePlaneAngleMeasure

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPlaneAngleMeasure(IfcEntityInstanceData *e)
IfcPlaneAngleMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPlate : public Ifc2x3::IfcBuildingElement

Definition from IAI: An IfcPlate is a planar and often flat part with constant thickness. A plate can be a structural part carrying loads between or beyond points of support, however it is not required to be load bearing.The location of the plate (being horizontal, vertical or sloped) is not relevant to its definition (in contrary to IfcWall and IfcSlab (as floor slab)). NOTE Plates arenormally made of steel, other metallic material, or by glass panels. However the definition of IfcPlate is material independent and specific material information shall be handled by using IfcAssociatesMaterial to assign a material specification to the IfcPlate.

NOTE Although not necessarily, plates are often add-on parts. This is represented by the IfcRelAggregates decomposition mechanism used to aggregate parts, such as IfcPlate, into a container element, e.g. IfcElementAssembly, or IfcCurtainWall.

NOTE The representation of a plate in a structural analysis model is provided by IfcStructuralSurfaceMember being part of an IfcStructuralAnalysisModel. An instance IfcPlate should preferably get its geometric representation and material assignment through the type definition by IfcPlateType assigned using the IfcRelDefinesByType relationship. This allows identical plates in a construction to be represented by the same instance of IfcPlateType. A plate may have openings, such as voids or recesses. They are defined by an IfcOpeningElement attached to the plate using the inverse relationship HasOpenings pointing to IfcRelVoidsElement. The position number of a plate as often used in steel construction is assigned through the attribute IfcElement.Tag The IFC specification provides two entities for plate occurrences:

IfcPlateStandardCase used for all occurrences of plates, that are prismatic and where the thickness parameter can be fully described by the IfcMaterialLayerSetUsage. These plates are always represented geometrically by a ‘SweptSolid’ geometry (or by a ‘Clipping’ geometry based on ‘SweptSolid’), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialLayerSetUsage assigned. IfcPlate used for all other occurrences of plates, particularly for plates with changing thickness, or plates with non planar surfaces, and plates having only ‘SurfaceModel’ or ‘Brep’ geometry.

HISTORY New entity in IFC Release 2x2 Type Use Definition The IfcPlate defines the occuurence of any plate, common information about plate types (or styles) is handled by IfcPlateType. The IfcPlateType (if present) may establish the commontype name, usage (or predefined) type, common set of properties, common material layer set, and common shape representations (using IfcRepresentationMap). The IfcPlateType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcPlateType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcPlate is defined by IfcMaterialLayerSet, or IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. NOTE It is illegal to assign an IfcMaterialLayerSetUsage to an IfcPlate. Only the subtype IfcPlateStandardCase supports this concept. Material information can also be given at the IfcPlateType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcPlateType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial. Property Set Use Definition The property sets relating to the IfcPlate are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcPlate are part of this IFC release:

Pset_PlateCommon: common property set for all plate occurrences

Quantity Use Definition The quantities relating to the IfcPlate and IfcPlateStandardCase are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quanties shall be never assigned to the IfcPlateType.

Qto_PlateBaseQuantities: base quantities for all plate occurrences.

Containment Use Definitions The IfcPlate, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second relationship is the aggregation within anelement assembly.

TheIfcPlate is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. TheIfcPlate may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case, no additional relationship to the spatial hierarchy shall be given (i.e.SELF\IfcElement.ContainedInStructure = NIL), the relationship to the spatial container is handled by the element assembly.

Geometry Use Definition The geometric representation of IfcPlate is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local Placement The local placement for IfcPlate is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement, which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that.

If the IfcPlate is part of an assembly, the PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the container element, e.g. IfcElementAssembly,

If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Surface’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Surface Representation The surfacic geometric representation of IfcPlate is defined using the ‘Surface’ representation.

RepresentationIdentifier : ‘Surface’ RepresentationType : ‘Surface3D’

NOTE The ‘Surface’ can be used to define a surfacic model of the building (e.g. for analytical purposes, or for reduced Level of Detail representation). Body Representation The body representation of IfcPlate can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘MappedRepresentation’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used: If a corresponding material definition using IfcMaterialLayerSetUsage can be assigned, the subtype IfcPlateStandardCase shall be used.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the swept solid representation:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcArbitraryClosedProfileDef, IfcArbitraryProfileDefWithVoids, IfcRectangleProfileDef, IfcCircleProfileDef, IfcEllipseProfileDef shall be supported. Extrusion: The profile can be extruded perpendicularly or non-perpendicularly to the plane of the swept profile.

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

MappedRepresentation Representation Type The ‘MappedRepresentation’ shall be supported as it allows for reusing the geometry definition of the member type at all occurrences of the same type. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘SweptSolid’, ‘Clipping’, ‘SurfaceModel’, and ‘Brep’ geometric representation, shall apply to the MappedRepresentation of the IfcRepresentationMap.

Public Types

typedef IfcTemplatedEntityList<IfcPlate> list

Public Functions

const IfcParse::entity &declaration() const
IfcPlate(IfcEntityInstanceData *e)
IfcPlate(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcPlateType : public Ifc2x3::IfcBuildingElementType

The element type IfcPlateType defines commonly shared information for occurrences of plates. The set of shared information may include:

common properties within shared property sets common material information common material layer definitions common shape representations

NOTE It is illegal to share shape representations as representation maps for occurrences of IfcPlateStandardCase.

It is used to define a plate specification (i.e. the specific product information, that is common to all occurrences of that product type). Plate types may be exchanged without being already assigned to occurrences. NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. The occurrences of the IfcPlateType within building models are represented by instances of IfcPlateStandardCase if the IfcPlateType has a single associated IfcMaterialLayerSet; otherwise they are represented by instances of IfcPlate.

HISTORY New entity in Release IFC2x2.

Informal proposition:

The material assignment, if provided using the IfcRelAssociatesMaterial relationship, shall not reference the IfcMaterialLayerSetUsage.

Material Use Definition The material of the IfcPlateType is defined by the IfcMaterialLayerSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcPlateType, if there is at least one occurrences of IfcPlateStandardCase for this type. Layer Set Use Definition: The shared material layer set definition is defined by assigning an IfcMaterialLayerSet (see material use definition above). The IfcMaterialLayer refers to one or several of IfcMaterial that is the common for all plate occurrence, if used. It is only applicable if the IfcPlateType has only occurrences of type IfcPlateStandardCase (see definition of IfcPlateStandardCase for further information). NOTE Since each individual instance of IfcPlateStandardCase defines its own IfcMaterialLayerSetUsage including the offset from the reference plane, the same IfcPlateType can be used independently of the reference plane alignment of its occurrences. Property Set Use Definition: The shared property sets relating to the IfcPlateType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcWallType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcPlateType and those that are only assignable to IfcPlate. If the same property is assigned to the IfcPlateType and the IfcPlate being an occurrence of the IfcPlateType, then the occurrence property overrides the type property.

Pset_PlateCommon: common property set for all plate types.

Public Types

typedef IfcTemplatedEntityList<IfcPlateType> list

Public Functions

::Ifc2x3::IfcPlateTypeEnum::Value PredefinedType() const

Identifies the predefined types of a planar member element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcPlateTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcPlateType(IfcEntityInstanceData *e)
IfcPlateType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcPlateTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPlateTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of planar elements an IfcPlateType object can fulfill:

CURTAIN_PANEL: A planar element within a curtain wall,often consisting of a frame with fixed glazing. SHEET: A planar, flat and thin element, comes usually as metal sheet, and is often used as an additonal part within an assembly. USERDEFINED: User-defined linear element. NOTDEFINED: Undefined linear element

HISTORY New Enumeration in Release IFC2x Edition 2. IFC2x Edition 3 CHANGE The additional identifiers CURTAIN_PANEL, SHEET have been added.

Values:

enumerator IfcPlateType_CURTAIN_PANEL
enumerator IfcPlateType_SHEET
enumerator IfcPlateType_USERDEFINED
enumerator IfcPlateType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPoint : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A point is a location in some real Cartesian coordinate space Rm, for m = 1, 2 or 3.

NOTE: Corresponding ISO 10303 entity: point. Only the subtypes cartesian_point, point_on_curve, point_on_surface have been incorporated in the current release of IFC. Please refer to ISO/IS 10303-42:1994, p. 22 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.5

Subclassed by Ifc2x3::IfcCartesianPoint, Ifc2x3::IfcPointOnCurve, Ifc2x3::IfcPointOnSurface

Public Types

typedef IfcTemplatedEntityList<IfcPoint> list

Public Functions

const IfcParse::entity &declaration() const
IfcPoint(IfcEntityInstanceData *e)
IfcPoint()

Public Static Functions

const IfcParse::entity &Class()
class IfcPointOnCurve : public Ifc2x3::IfcPoint

Definition from ISO/CD 10303-42:1992: A point on curve is a point which lies on a curve. The point is determined by evaluating the curve at a specific parameter value. The coordinate space dimensionality of the point is that of the basis curve.

NOTE: Corresponding STEP entity: point_on_curve. Please refer to ISO/IS 10303-42:1994, p. 23 for the final definition of the formal standard.

HISTORY: New entity in Release IFC2x Edition 2.

Informal Propositions:

The value of the point parameter shall not be outside the parametric range of the curve.

Public Types

typedef IfcTemplatedEntityList<IfcPointOnCurve> list

Public Functions

::Ifc2x3::IfcCurve *BasisCurve() const

The curve to which point parameter relates.

void setBasisCurve(::Ifc2x3::IfcCurve *v)
double PointParameter() const

The parameter value of the point location.

void setPointParameter(double v)
const IfcParse::entity &declaration() const
IfcPointOnCurve(IfcEntityInstanceData *e)
IfcPointOnCurve(::Ifc2x3::IfcCurve *v1_BasisCurve, double v2_PointParameter)

Public Static Functions

const IfcParse::entity &Class()
class IfcPointOnSurface : public Ifc2x3::IfcPoint

Definition from ISO/CD 10303-42:1992: A point on surface is a point which lies on a parametric surface. The point is determined by evaluating the surface at a particular pair of parameter values.

NOTE: Corresponding ISO 10303 entity: point_on_surface. Please refer to ISO/IS 10303-42:1994, p. 24 for the final definition of the formal standard.

HISTORY: New entity in Release IFC2x Edition 2.

Informal Propositions:

The parametric values specified for u and v shall not be outside the parametric range of the basis surface.

Public Types

typedef IfcTemplatedEntityList<IfcPointOnSurface> list

Public Functions

::Ifc2x3::IfcSurface *BasisSurface() const

The surface to which the parameter values relate.

void setBasisSurface(::Ifc2x3::IfcSurface *v)
double PointParameterU() const

The first parameter value of the point location.

void setPointParameterU(double v)
double PointParameterV() const

The second parameter value of the point location.

void setPointParameterV(double v)
const IfcParse::entity &declaration() const
IfcPointOnSurface(IfcEntityInstanceData *e)
IfcPointOnSurface(::Ifc2x3::IfcSurface *v1_BasisSurface, double v2_PointParameterU, double v3_PointParameterV)

Public Static Functions

const IfcParse::entity &Class()
class IfcPolygonalBoundedHalfSpace : public Ifc2x3::IfcHalfSpaceSolid

The polygonal bounded half space is a special subtype of a half space solid, where the material of the half space used in Boolean expressions is bounded by a polygonal boundary. The base surface of the half space is positioned by its normal relativeto the object coordinate system (as defined at the supertype IfcHalfSpaceSolid),and its polygonal (with or without arc segments) boundary is defined in the XY plane of the position coordinate system established by the Position attribute, the subtraction body is extruded perpendicular to the XY plane of the position coordinate system, that is, into the direction of the positive Z axis defined by the Position attribute. The boundary is defined by a 2 dimensional polyline (or 2 dimensional composite curve, consisting of straight segments and circular arc segments) within the XY plane of the position coordinate system. The side of the surface which is in the half space is determined by the surface normal and the agreement flag. If the agreement flag is TRUE, then the subset is the one the normal points away from. If the agreement flag is FALSE, then the subset is the one the normal points into.

NOTE A polygonal bounded half space is not a subtype of IfcSolidModel, half space solids are only useful as operands in Boolean expressions.

HISTORY New class in IFC Release 2x.

Informal propositions:

The IfcPolyline or the IfcCompositeCurve providing the PolygonalBoundary shall be closed. If the PolygonalBoundary is given by an IfcCompositeCurve, it shall only haveIfcCompositeCurveSegment’s of type IfcPolyline, or IfcTrimmedCurve (having a BasisCurve of type IfcLine, or IfcCircle)

Figure 259 illustrates a polygonal bounded half space.

Black coordinates indicate the object coordinate system (usually provided by IfcLocalPlacement). Green coordinates indicate the position coordinate system; the PolygonalBoundary is given within this coordinate system. It is provided by IfcPolygonalBoundedHalfSpace.Position. This coordinate system is relative to the object coordinate system. The extrusion direction of the subtraction body is the positive Z axis. Red coordinates indicate the normal of the plane. It is provided by the BaseSurface (IfcSurface.Position). This normal is also relative to the object coordinate system.

Figure 259 — Polygonal half space geometry

Purpose The polygonal bounded half space is used to limit the volume of the half space in Boolean difference expressions. Only the part that is defined by a theoretical intersection between the half space solid and an extruded area solid, defined by extruding the polygonal boundary, is used for Boolean expressions. Parameter The PolygonalBoundary defines the 2D polyline which bounds the effectiveness of the half space in Boolean expressions. The BaseSurface is defined by a plane, and the normal of the plane together with the AgreementFlag defines the side of the material of the half space.

Public Functions

::Ifc2x3::IfcAxis2Placement3D *Position() const

Definition of the position coordinate system for the bounding polyline and the base surface.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
::Ifc2x3::IfcBoundedCurve *PolygonalBoundary() const

Two-dimensional polyline bounded curve, defined in the xy plane of the position coordinate system.

IFC2x Edition 3 CHANGE The attribute type has been changed from IfcPolyline to its supertype IfcBoundedCurve with upward compatibility for file based exchange.

void setPolygonalBoundary(::Ifc2x3::IfcBoundedCurve *v)
const IfcParse::entity &declaration() const
IfcPolygonalBoundedHalfSpace(IfcEntityInstanceData *e)
IfcPolygonalBoundedHalfSpace(::Ifc2x3::IfcSurface *v1_BaseSurface, bool v2_AgreementFlag, ::Ifc2x3::IfcAxis2Placement3D *v3_Position, ::Ifc2x3::IfcBoundedCurve *v4_PolygonalBoundary)

Public Static Functions

const IfcParse::entity &Class()
class IfcPolyline : public Ifc2x3::IfcBoundedCurve

Definition from ISO/CD 10303-42:1992: A polyline is a bounded curve of n - 1 linear segments, defined by a list of n points, P1, P2 … Pn. The ith segment of the curve is parameterized as follows:

for 1 ≤ i ≤ n - 1

where i - 1 ≤ u ≤ i and with parametric range of 0 <≤ u ≤ n - 1.

NOTE Corresponding ISO 10303 entity: polyline. Please refer to ISO/IS 10303-42:1994, p. 45 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcPolyline> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr Points() const

The points defining the polyline.

void setPoints(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v)
const IfcParse::entity &declaration() const
IfcPolyline(IfcEntityInstanceData *e)
IfcPolyline(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v1_Points)

Public Static Functions

const IfcParse::entity &Class()
class IfcPolyLoop : public Ifc2x3::IfcLoop

Definition from ISO/CD 10303-42:1992: A poly loop is a loop with straight edges bounding a planar region in space. A poly loop is a loop of genus 1 where the loop is represented by an ordered coplanar collection of points forming the vertices of the loop. The loop is composed of straight line segments joining a point in the collection to the succeeding point in the collection. The closing segment is from the last to the first point in the collection. The direction of the loop is in the direction of the line segments.

NOTE This entity exists primarily to facilitate the efficient communication of faceted B-rep models.

A poly loop shall conform to the following topological constraints:

  • the loop has the genus of one.

    • the following equation shall be satisfied

The IfcPolyLoop is always closed and the last segment is from the last IfcCartesianPoint in the list of Polygon’s to the first IfcCartesianPoint. Therefore the first point shall not be repeated at the end of the list, neither by referencing the same instance, nor by using an additional instance ofIfcCartesianPoint having the coordinates as the first point.

NOTE Corresponding ISO 10303 entity: poly_loop. Please refer to ISO/IS 10303-42:1994, p. 138 for the final definition of the formal standard. Due to the general IFC model specification rule not to use multiple inheritance, the subtype relationship to geometric_representation_item is not included. The derived attribute Dim has been added at this level.

HISTORY New class in IFC Release 1.0

Informal propositions:

All the points in the polygon defining the poly loop shall be coplanar. The first and the last Polygon shall be different by value.

Public Types

typedef IfcTemplatedEntityList<IfcPolyLoop> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr Polygon() const

List of points defining the loop. There are no repeated points in the list.

void setPolygon(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v)
const IfcParse::entity &declaration() const
IfcPolyLoop(IfcEntityInstanceData *e)
IfcPolyLoop(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v1_Polygon)

Public Static Functions

const IfcParse::entity &Class()
class IfcPort : public Ifc2x3::IfcProduct

Definition from IAI: An IfcPort provides the means for an element to connect to other elements.

An IfcPort is associated with an IfcElement, it belongs to, through the objectified relationship IfcRelConnectsPortToElement. Exactly two ports, belonging to two different elements, are connected with each other through the objectified relationship IfcRelConnectsPorts.

An instance of IfcElement may have one or more points at which it connects to other instances of IfcElement. An instance of IfcPort is located at a point where a connection can occur. The location of the port is determined in the context of the local coordinate system of the element to which it belongs.

HISTORY New entity in Release IFC2x Edition 2.

Containment Use Definitions

As a subordinate part being fully dependent on the master element the IfcPort shall have no independent containment relationship to the spatial structure.

Geometry Use Definition

The geometric representation of IfcPort is given by the IfcProductDefinitionShape, allowing multiple geometric representation.

Local Placement

The local placement for IfcPort is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the master IfcElement (its relevant subtypes), which is associated to the IfcPort by the relationship object IfcRelConnectsPortToElement.

Shape Representation

The geometry use definitions for the shape representation of the IfcPort is given at the level of its subtypes.

Subclassed by Ifc2x3::IfcDistributionPort

Public Types

typedef IfcTemplatedEntityList<IfcPort> list

Public Functions

IfcTemplatedEntityList<IfcRelConnectsPortToElement>::ptr ContainedIn() const
IfcTemplatedEntityList<IfcRelConnectsPorts>::ptr ConnectedFrom() const
IfcTemplatedEntityList<IfcRelConnectsPorts>::ptr ConnectedTo() const
const IfcParse::entity &declaration() const
IfcPort(IfcEntityInstanceData *e)
IfcPort(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation)

Public Static Functions

const IfcParse::entity &Class()
class IfcPositiveLengthMeasure : public Ifc2x3::IfcLengthMeasure

Definition from ISO/CD 10303-41:1992: A positive length measure is a length measure that is greater than zero. Type: IfcLengthMeasure

NOTE Corresponding ISO 10303 name: positive_length_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPositiveLengthMeasure(IfcEntityInstanceData *e)
IfcPositiveLengthMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPositivePlaneAngleMeasure : public Ifc2x3::IfcPlaneAngleMeasure

Definition from ISO/CD 10303-41:1992: Positive plane angle measure is a plane angle measure that is greater than zero. Type: IfcPlaneAngleMeasure

NOTE Corresponding STEP name: positive_plane_angle_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPositivePlaneAngleMeasure(IfcEntityInstanceData *e)
IfcPositivePlaneAngleMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPositiveRatioMeasure : public Ifc2x3::IfcRatioMeasure

Definition from ISO/CD 10303-41:1992: A positive ratio measure is a ratio measure that is greater than zero. Type: IfcRatioMeasure

NOTE Corresponding ISO 10303 name: positive_ratio_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPositiveRatioMeasure(IfcEntityInstanceData *e)
IfcPositiveRatioMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPostalAddress : public Ifc2x3::IfcAddress

Definition: The address for delivery of paper based mail.

HISTORY New entity in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcPostalAddress> list

Public Functions

bool hasInternalLocation() const

Whether the optional attribute InternalLocation is defined for this IfcPostalAddress.

std::string InternalLocation() const

An organization defined address for internal mail delivery.

void setInternalLocation(std::string v)
bool hasAddressLines() const

Whether the optional attribute AddressLines is defined for this IfcPostalAddress.

std::vector<std::string> AddressLines() const

The postal address. NOTE: A postal address may occupy several lines (or elements) when recorded. It is expected that normal usage will incorporate relevant elements of the following address concepts: A location within a building (e.g. 3rd Floor) Building name (e.g. Interoperability House) Street number (e.g. 6400) Street name (e.g. Alliance Boulevard). Typical content of address lines may vary in different countries.

void setAddressLines(std::vector<std::string> v)
bool hasPostalBox() const

Whether the optional attribute PostalBox is defined for this IfcPostalAddress.

std::string PostalBox() const

An address that is implied by an identifiable mail drop.

void setPostalBox(std::string v)
bool hasTown() const

Whether the optional attribute Town is defined for this IfcPostalAddress.

std::string Town() const

The name of a town.

void setTown(std::string v)
bool hasRegion() const

Whether the optional attribute Region is defined for this IfcPostalAddress.

std::string Region() const

The name of a region. NOTE: The counties of the United Kingdom and the states of North America are examples of regions.

void setRegion(std::string v)
bool hasPostalCode() const

Whether the optional attribute PostalCode is defined for this IfcPostalAddress.

std::string PostalCode() const

The code that is used by the country’s postal service.

void setPostalCode(std::string v)
bool hasCountry() const

Whether the optional attribute Country is defined for this IfcPostalAddress.

std::string Country() const

The name of a country.

void setCountry(std::string v)
const IfcParse::entity &declaration() const
IfcPostalAddress(IfcEntityInstanceData *e)
IfcPostalAddress(boost::optional<::Ifc2x3::IfcAddressTypeEnum::Value> v1_Purpose, boost::optional<std::string> v2_Description, boost::optional<std::string> v3_UserDefinedPurpose, boost::optional<std::string> v4_InternalLocation, boost::optional<std::vector<std::string>> v5_AddressLines, boost::optional<std::string> v6_PostalBox, boost::optional<std::string> v7_Town, boost::optional<std::string> v8_Region, boost::optional<std::string> v9_PostalCode, boost::optional<std::string> v10_Country)

Public Static Functions

const IfcParse::entity &Class()
class IfcPowerMeasure : public IfcUtil::IfcBaseType

IfcPowerMeasure is a measure of power required or used. Usually measured in Watts (W, J/s). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPowerMeasure(IfcEntityInstanceData *e)
IfcPowerMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPreDefinedColour : public Ifc2x3::IfcPreDefinedItem

The pre defined colour determines those qualified names which can be used to identify a colour that is in scope of the current data exchange specification (in contrary to colour specification which defines the colour directly by its colour components).

NOTE Corresponding ISO 10303 name: pre_defined_colour. It has been made into an abstract entity in IFC. Please refer to ISO/IS 10303-46:1994, p. 141 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Subclassed by Ifc2x3::IfcDraughtingPreDefinedColour

Public Types

typedef IfcTemplatedEntityList<IfcPreDefinedColour> list

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedColour(IfcEntityInstanceData *e)
IfcPreDefinedColour(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedCurveFont : public Ifc2x3::IfcPreDefinedItem

Definition from ISO/CD 10303-46:1992: The predefined curve font type is an abstract supertype provided to define an application specific curve font. The name label shall be constrained in the application protocol to values that are given specific meaning for curve fonts in that application protocol.

NOTE: The IfcPreDefinedCurveFont is an abstract entity, subtypes of it provide the predefined curve font by agreement of the values of the inherited Name attribute. Currently the only subtype provided is IfcDraughtingPreDefinedCurveFont.

NOTE: Corresponding ISO 10303 name: pre_defined_curve_font. Please refer to ISO/IS 10303-46:1994, p. 103 for the final definition of the formal standard.

HISTORY: New entity in IFC2x2.

Subclassed by Ifc2x3::IfcDraughtingPreDefinedCurveFont

Public Types

typedef IfcTemplatedEntityList<IfcPreDefinedCurveFont> list

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedCurveFont(IfcEntityInstanceData *e)
IfcPreDefinedCurveFont(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedDimensionSymbol : public Ifc2x3::IfcPreDefinedSymbol

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedDimensionSymbol(IfcEntityInstanceData *e)
IfcPreDefinedDimensionSymbol(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedItem : public IfcUtil::IfcBaseEntity

A pre defined item is a qualified name given to a style or font which is determined within the data exchange specification by convention on using the Name attribute value (in contrary to externally defined items, which are agreed by an external source).

NOTE The convention on using the Name value is defined at the subtypes of IfcPreDefinedItem and is part of the specification.

NOTE Corresponding ISO 10303 name: pre_defined_item. Please refer to ISO/IS 10303-41:1994, page 137 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Subclassed by Ifc2x3::IfcPreDefinedColour, Ifc2x3::IfcPreDefinedCurveFont, Ifc2x3::IfcPreDefinedSymbol, Ifc2x3::IfcPreDefinedTextFont

Public Types

typedef IfcTemplatedEntityList<IfcPreDefinedItem> list

Public Functions

std::string Name() const

The string by which the pre defined item is identified. Allowable values for the string are declared at the level of subtypes.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcPreDefinedItem(IfcEntityInstanceData *e)
IfcPreDefinedItem(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedPointMarkerSymbol : public Ifc2x3::IfcPreDefinedSymbol

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedPointMarkerSymbol(IfcEntityInstanceData *e)
IfcPreDefinedPointMarkerSymbol(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedSymbol : public Ifc2x3::IfcPreDefinedItem

A predefined symbol is a symbol that gets its shape information by a conforming name that is specified within subtypes of the entity.

NOTE: The IfcPreDefinedSymbol is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: pre_defined_symbol. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Subclassed by Ifc2x3::IfcPreDefinedDimensionSymbol, Ifc2x3::IfcPreDefinedPointMarkerSymbol, Ifc2x3::IfcPreDefinedTerminatorSymbol

Public Types

typedef IfcTemplatedEntityList<IfcPreDefinedSymbol> list

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedSymbol(IfcEntityInstanceData *e)
IfcPreDefinedSymbol(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedTerminatorSymbol : public Ifc2x3::IfcPreDefinedSymbol

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedTerminatorSymbol(IfcEntityInstanceData *e)
IfcPreDefinedTerminatorSymbol(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPreDefinedTextFont : public Ifc2x3::IfcPreDefinedItem

The pre defined text font determines those qualified names which can be used for fonts that are in scope of the current data exchange specification (in contrary to externally defined text fonts). There are two choices:

IfcDraughtingPreDefinedTextFont for definitions from ISO/IS 10303-46:1994 for (old) vector based and monospace text.

IfcTextStyleFontModel for definitions from Cascading Style Sheets, level 1, W3C Recommendation 17 Dec 1996, revised 11 Jan 1999, CSS1, for all true type text. The use of the CSS1 definitions is the preferred way to represent text fonts.

NOTE Corresponding ISO 10303 name: pre_defined_text_font. Please refer to ISO/IS 10303-46:1994, p. 138 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The IfcTextStyleFontModel has been added as new subtype.

Subclassed by Ifc2x3::IfcDraughtingPreDefinedTextFont, Ifc2x3::IfcTextStyleFontModel

Public Types

typedef IfcTemplatedEntityList<IfcPreDefinedTextFont> list

Public Functions

const IfcParse::entity &declaration() const
IfcPreDefinedTextFont(IfcEntityInstanceData *e)
IfcPreDefinedTextFont(std::string v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPresentableText : public IfcUtil::IfcBaseType

IfcPresentableText is a text string used to capture the content of a text literal for the purpose of presentation. The IfcPresentableText can include multiple lines of text, for which the line feed character LF, 0x0A, should be used to separate lines.

NOTE The non printable characters are converted within the standard exchange format ISO 10303-21 (STEP physical file format), commonly the \X\09 represents the TAB, and \X\0A the LF character.

NOTE The IfcPresentableText is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: presentable_text. Please refer to ISO/IS 10303-46:1994, p. 133 for the final definition of the formal standard.

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPresentableText(IfcEntityInstanceData *e)
IfcPresentableText(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcPresentationLayerAssignment : public IfcUtil::IfcBaseEntity

The presentation layer assignment provides the layer name (and optionally a description and an identifier) for a collection of geometric representation items. The IfcPresentationLayerAssignment corresponds to the term “CAD Layer” and is used mainly for grouping and visibility control.

NOTE The use of presentation layer shall be restricted to simple grouping and displaying purposes.

Visibility and access control and layer style assignment (colour, line style, line width) is handled by the subtype IfcPresentationLayerAssignmentWithStyle.

NOTE Corresponding ISO 10303 name: presentation layer assignment. Please refer to ISO/IS 10303-46:1994, p. 36 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Attribute use definition

Figure 305 illustrates assignment of items by shape representation or representation item. The set of AssignedItems can either include a whole shape representation, or individual geometric representation items. If both, the IfcShapeRepresentation has a layer assignment, and an individual geometric representation item in the set of IfcShapeRepresentation.Items, then the layer assignment of the IfcGeometricRepresentationItem overides the layer assignment of the IfcShapeRepresentation.

Figure 305 — Presentation layer assignment

Subclassed by Ifc2x3::IfcPresentationLayerWithStyle

Public Functions

std::string Name() const

Name of the layer.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcPresentationLayerAssignment.

std::string Description() const

Additional description of the layer.

void setDescription(std::string v)
IfcEntityList::ptr AssignedItems() const

The set of layered items, which are assigned to this layer.

void setAssignedItems(IfcEntityList::ptr v)
bool hasIdentifier() const

Whether the optional attribute Identifier is defined for this IfcPresentationLayerAssignment.

std::string Identifier() const

An (internal) identifier assigned to the layer.

void setIdentifier(std::string v)
const IfcParse::entity &declaration() const
IfcPresentationLayerAssignment(IfcEntityInstanceData *e)
IfcPresentationLayerAssignment(std::string v1_Name, boost::optional<std::string> v2_Description, IfcEntityList::ptr v3_AssignedItems, boost::optional<std::string> v4_Identifier)

Public Static Functions

const IfcParse::entity &Class()
class IfcPresentationLayerWithStyle : public Ifc2x3::IfcPresentationLayerAssignment

An IfcPresentationLayerAssignmentWithStyle extends the presentation layer assignment with capabilities to define visibility control, access control and common style information.

The visibility control allows to define a layer to be either ‘on’ or ‘off’, and/or ‘frozen’ or ‘not frozen’. The access control allows to block graphical entities from manipulations by setting a layer to be either ‘blocked’ or ‘not blocked’. Common style information can be given to the layer.

NOTE Style information assigned to layers is often restricted to ‘layer colour’, ‘curve font’, and/or ‘curve width’. These styles are assigned by using the IfcCurveStyle within the LayerStyles.

NOTE: If a styled item is assigned to a layer using the IfcPresentationLayerAssignmentWithStyle, it inherits the style information from the layer. In this case, it should omit its own style information. If the styled item has style information assigned (such as by IfcCurveStyle, IfcFillAreaStyle, IfcTextStyle, IfcSurfaceStyle, IfcSymbolStyle), then it overrides the style provided by the IfcPresentationLayerAssignmentWithStyle.

NOTE The IfcPresentationLayerAssignmentWithStyle extends the presentation_layer_assignment entity as defined in ISO/IS 10303-46:1994, p. 36.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The attributes have been modified without upward compatibility.

Public Functions

bool LayerOn() const

A logical setting, TRUE indicates that the layer is set to ‘On’, FALSE that the layer is set to ‘Off’, UNKNOWN that such information is not available.

void setLayerOn(bool v)
bool LayerFrozen() const

A logical setting, TRUE indicates that the layer is set to ‘Frozen’, FALSE that the layer is set to ‘Not frozen’, UNKNOWN that such information is not available.

void setLayerFrozen(bool v)
bool LayerBlocked() const

A logical setting, TRUE indicates that the layer is set to ‘Blocked’, FALSE that the layer is set to ‘Not blocked’, UNKNOWN that such information is not available.

void setLayerBlocked(bool v)
IfcEntityList::ptr LayerStyles() const

Assignment of presentation styles to the layer to provide a default style for representation items.

NOTE In most cases the assignment of styles to a layer is restricted to an IfcCurveStyle representing the layer curve colour, layer curve thickness, and layer curve type.

IFC2x4 CHANGE The data type has been changed from IfcPresentationStyleSelect (now deprecated) to IfcPresentationStyle.

void setLayerStyles(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcPresentationLayerWithStyle(IfcEntityInstanceData *e)
IfcPresentationLayerWithStyle(std::string v1_Name, boost::optional<std::string> v2_Description, IfcEntityList::ptr v3_AssignedItems, boost::optional<std::string> v4_Identifier, bool v5_LayerOn, bool v6_LayerFrozen, bool v7_LayerBlocked, IfcEntityList::ptr v8_LayerStyles)

Public Static Functions

const IfcParse::entity &Class()
class IfcPresentationStyle : public IfcUtil::IfcBaseEntity

IfcPresentationStyle is an abstract generalization of style table for presentation information assigned to geometric representation items. It includes styles for curves, areas, surfaces, text and symbols. Style information may include colour, hatching, rendering, and text fonts.

Each subtype of IfcPresentationStyle can be assigned to IfcGeometricRepresentationItem’s via the IfcPresentationStyleAssignment through an intermediate IfcStyledItem or one of its subtypes.

HISTORY New entity in IFC2x3.

Subclassed by Ifc2x3::IfcCurveStyle, Ifc2x3::IfcFillAreaStyle, Ifc2x3::IfcSurfaceStyle, Ifc2x3::IfcSymbolStyle, Ifc2x3::IfcTextStyle

Public Types

typedef IfcTemplatedEntityList<IfcPresentationStyle> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcPresentationStyle.

std::string Name() const

Name of the presentation style.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcPresentationStyle(IfcEntityInstanceData *e)
IfcPresentationStyle(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcPresentationStyleAssignment : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: The presentation style assignment is a set of styles which are assigned to styled items for the purpose of presenting these styled items.

NOTE Corresponding ISO 10303 name: presentation_style_assignment. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in Release IFC2x2.

Public Functions

IfcEntityList::ptr Styles() const

A set of presentation styles that are assigned to styled items.

void setStyles(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcPresentationStyleAssignment(IfcEntityInstanceData *e)
IfcPresentationStyleAssignment(IfcEntityList::ptr v1_Styles)

Public Static Functions

const IfcParse::entity &Class()
class IfcPressureMeasure : public IfcUtil::IfcBaseType

IfcPressureMeasure is a measure of the quantity of a medium acting on a unit area. Usually measured in Pascals (Pa, N/m2). Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcPressureMeasure(IfcEntityInstanceData *e)
IfcPressureMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcProcedure : public Ifc2x3::IfcProcess

An IfcProcedure is a logical set of actions to be taken in response to an event or to cause an event to occur.

HISTORY New entity in IFC2x2

IFC2x4 CHANGE ProcedureType renamed to PredefinedType and made optional (upward compatible). Where rules WR1 and WR2 have been removed.

Use definitions

IfcProcedure is used to capture information about stepped processes such as calibration, start/stop procedures for equipment items, designated actions to take in the event of an emergency etc. A procedure is not a task, but may describe a set of tasks and their order of occurrence in response to or to cause an event.

Type use definition

IfcProcedure defines the anticipated or actual occurrence of any procedure; common information about procedure types is handled by IfcProcedureType. The IfcProcedureType (if present) may establish the common type name, usage (or predefined) type, common nested procedures (using IfcRelNests), common set of properties, and common product assignment using IfcRelAssignsToProduct. The IfcProcedureType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Property set use definition

The property sets relating to IfcProcedure are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the inverse IsDefinedBy relationship. Such property sets may define procedure parameters. No property sets for IfcProcedure are currently defined by IFC.

Connectivity use definition

The relationship IfcRelSequence is used to indicate control flow. An IfcProcedure as a successor to an IfcEvent indicates that the procedure should be performed in response to the event. An IfcProcedure as a predecessor to an IfcEvent indicates that the event should be trigerred following the procedure. As procedures have arbitrary duration, the IfcRelSequence.SequenceType attribute has no effect on an IfcProcedure but still applies to the opposite end of the relationship if IfcTask is used.

Composition use definition

IfcProcedure may be contained within an IfcTask or IfcProcedure using the IfcRelNests relationship. An IfcProcedure may in turn nest other IfcProcedure or IfcEvent entities. Such nesting indicates decomposed level of detail.

Note that a particular type of IfcProcedure is a caution, warning or other form of advisory note. Typically, it is anticipated that such a procedure would be assigned to the specific IfcProcess for which it gives advice using IfcRelAssignsToProcess.

Assignment use definition

An IfcProcedure may be assigned to an IfcWorkCalendar to indicate times when such procedure may be performed using IfcRelAssignsToControl; otherwise the effective calendar is determined by the nearest IfcProcess ancestor with a calendar assigned. Advisory notes should be assigned to the specific IfcProcess for which it gives advice using IfcRelAssignsToProcess.

For building operation scenarios, IfcProcedure may be assigned to a product (IfcElement subtype) using IfcRelAssignsToProduct to indicate a specific product occurrence that performs the procedure. For example, an IfcActuator may have a “Close” procedure. If the IfcProcedure is defined by an IfcProcedureType and the IfcProcedureType is assigned to a product type (using IfcRelAssignsToProduct), then the IfcProcedure must be assigned to one or more occurrences of the specified product type using IfcRelAssignsToProduct.

As shown in Figure 12, IfcProcedure

does not restrict anything but describes specific steps of how something should happen. While a procedure does control/restrict in the sense of indicating “this is how the task should be performed” by nature of describing inner detail, this is not different than parts of a product indicating “this is how the parts should

be assembled”. Consequently, it doesn’t restrict the outer item as a whole but provides inner detail of the item.

Figure 12 — Procedure relationships

Public Types

typedef IfcTemplatedEntityList<IfcProcedure> list

Public Functions

std::string ProcedureID() const
void setProcedureID(std::string v)
::Ifc2x3::IfcProcedureTypeEnum::Value ProcedureType() const
void setProcedureType(::Ifc2x3::IfcProcedureTypeEnum::Value v)
bool hasUserDefinedProcedureType() const

Whether the optional attribute UserDefinedProcedureType is defined for this IfcProcedure.

std::string UserDefinedProcedureType() const
void setUserDefinedProcedureType(std::string v)
const IfcParse::entity &declaration() const
IfcProcedure(IfcEntityInstanceData *e)
IfcProcedure(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_ProcedureID, ::Ifc2x3::IfcProcedureTypeEnum::Value v7_ProcedureType, boost::optional<std::string> v8_UserDefinedProcedureType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcProcedureTypeEnum

Public Types

enum Value

The IfcProcedureTypeEnum defines the range of different types of procedure that can be specified.

HISTORY: New type in IFC2x2

Enumeration:

ADVICE_CAUTION: A caution that should be taken note of as a procedure or when carrying out a procedure ADVICE_NOTE: Additional information or advice that should be taken note of as a procedure or when carrying out a procedure ADVICE_WARNING: A warning of potential danger that should be taken note of as a procedure or when carrying out a procedure CALIBRATION: A procedure undertaken to calibrate an artifact SHUTDOWN: A procedure undertaken to shutdown the operation an artifact STARTUP: A procedure undertaken to start up the operation an artifact USERDEFINED NOTDEFINED

Values:

enumerator IfcProcedureType_ADVICE_CAUTION
enumerator IfcProcedureType_ADVICE_NOTE
enumerator IfcProcedureType_ADVICE_WARNING
enumerator IfcProcedureType_CALIBRATION
enumerator IfcProcedureType_DIAGNOSTIC
enumerator IfcProcedureType_SHUTDOWN
enumerator IfcProcedureType_STARTUP
enumerator IfcProcedureType_USERDEFINED
enumerator IfcProcedureType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcProcess : public Ifc2x3::IfcObject

Definition from ISO9000: A process is a set of activities that are interrelated or that interact with one another. Processes use resources to transform inputs into outputs. Processes are interconnected because the output from one process becomes the input for another process. In effect, processes are “glued” together by means of such input output relationships.

IfcProcess is defined as one individual activity or event, that is ordered in time, that has sequence relationships with other processes, which transforms input in output, and may connect to other other processes through input output relationships. An IfcProcess can be an activity (or task), or an event. It takes usually place in building construction with the intent of designing, costing, acquiring, constructing, or maintaining products or other and similar tasks or procedures.

Figure 2 — Process relationships and the ICON process diagram.

HISTORY New entity in IFC Release 1.0.

IFC2x PLATFORM CHANGE The attribute Productivity has been removed.

IFC2x4 CHANGE The attribute Identification has been promoted from subtypes IfcTask and others.

Relationship use definition Process information relates to other objects by establishing the following relationships:

Nesting of processes : IfcRelNests - A process can contain sub processes and thereby be nested. Sequencing of processes : IfcRelSequence - Processes can be placed in sequence (including overlapping for parallel tasks), and have predecessors and successors. Assigning process to schedules : IfcRelAssignsToControl - Activities such as tasks, and predominately summary tasks, are assigned to a work schedule. Having a product assigned to the process as input : IfcRelAssignsToProcess - Products can be assigned as input to a process, such as for construction process planning. Having a product assigned to the process as output : IfcRelAssignsToProduct - Products can be assigned as output to a process, such as for construction process planning. Having a control assigned to the process as process control : IfcRelAssignsToProcess - Items that act as a control onto the process can be assigned to a process, such as for cost management (a cost item assigned to a work task). Having a resource assigned to the process as consumed by the process : IfcRelAssignsToProcess - Items that act as a mechanism to a process, such as labor, material and equipment in cost calculations.

Subclassed by Ifc2x3::IfcProcedure, Ifc2x3::IfcTask

Public Types

typedef IfcTemplatedEntityList<IfcProcess> list

Public Functions

IfcTemplatedEntityList<IfcRelAssignsToProcess>::ptr OperatesOn() const
IfcTemplatedEntityList<IfcRelSequence>::ptr IsSuccessorFrom() const
IfcTemplatedEntityList<IfcRelSequence>::ptr IsPredecessorTo() const
const IfcParse::entity &declaration() const
IfcProcess(IfcEntityInstanceData *e)
IfcProcess(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcProduct : public Ifc2x3::IfcObject

Any object that relates to a geometric or spatial context. Subtypes of IfcProduct usually hold a shape representation and a object placement within the project structure. This includes manufactured, supplied or created objects (referred to as elements) for incorporation into an AEC/FM project. This also includes objects that are created indirectly by other products, as spaces are defined by bounding elements. Products can be designated for permanent use or temporary use, an example for the latter is formwork. Products are defined by their properties and representations. In addition to physical products (covered by the subtype IfcElement) and spatial items (covered by the subtype IfcSpatialElement) the IfcProduct also includes non-physical items, that relate to a geometric or spatial contexts, such as grid, port, annotation, structural actions, etc. The inherited ObjectType attribute can be used to designate a particular type of the product instance. If subtypes of IfcProduct have a PredefinedType defined, the ObjectType is used to provide the user defined, particular type of the product instance, if the PredefinedType is set to USERDEFINED.

HISTORY New Entity in IFC Release 1.0

Relationship use definition On a generic level products can be assigned to processes, controls, resources, project by using the relationship objects that refer to the corresponding object:

Having a control applied: assigned using IfcRelAssignsToControl linking the IfcProduct to an IfcControl

An example of this relationship is the assignment of a performance history to a distribution element.

Being assigned to a process: assigned using IfcRelAssignsToProcess linking the IfcProduct to an IfcProcess

An example of this relationship is the assignment of products like wall, slab, column to a contruction task for construction planning.

Being assigned to a resource: assigned using IfcRelAssignsToResource linking the IfcProduct to an IfcResource

An example of this relationship is the assignment of products to a construction resource that consumes the product.

Type use definition Any instance of IfcProduct defines a particular occurrence of a product, the common type information, that relates to many similar (or identical) occurrences of IfcProduct, is handled by the IfcTypeProduct (and its subtypes), assigned to one or many occurrences of IfcProduct by using the objectified relationship IfcRelDefinesByType. The IfcTypeProduct may provide, in addition to common properties, also a common geometric representation for all occurrences. See IfcTypeProduct for how to use a common geometric representation and IfcRelDefinesByType for using and overriding common properties.

Representation use definition An IfcProduct occurs at a specific location in space if it has a geometric representation assigned. It can be placed relatively to other products, but ultimately relative to the world coordinate system defined for this project. The ObjectPlacement attribute establishes the coordinate system in which all points and directions used by the geometric representation items under Representation are founded. The placement can either be:

a relative placement: by IfcLocalPlacement with PlacementRelTo pointing to a parent placement an absolute placement: by IfcLocalPlacement with PlacementRelTo being NIL a placement relative to a grid: by IfcGridPlacement

The Representation is provided by an IfcProductDefinitionShape being either a geometric shape representation, or a topology representation (with or without underlying geometry of the topological items).

Subclassed by Ifc2x3::IfcAnnotation, Ifc2x3::IfcElement, Ifc2x3::IfcGrid, Ifc2x3::IfcPort, Ifc2x3::IfcProxy, Ifc2x3::IfcSpatialStructureElement, Ifc2x3::IfcStructuralActivity, Ifc2x3::IfcStructuralItem

Public Types

typedef IfcTemplatedEntityList<IfcProduct> list

Public Functions

bool hasObjectPlacement() const

Whether the optional attribute ObjectPlacement is defined for this IfcProduct.

::Ifc2x3::IfcObjectPlacement *ObjectPlacement() const

Placement of the product in space, the placement can either be absolute (relative to the world coordinate system), relative (relative to the object placement of another product), or constraint (e.g. relative to grid axes). It is determined by the various subtypes of IfcObjectPlacement, which includes the axis placement information to determine the transformation for the object coordinate system.

void setObjectPlacement(::Ifc2x3::IfcObjectPlacement *v)
bool hasRepresentation() const

Whether the optional attribute Representation is defined for this IfcProduct.

::Ifc2x3::IfcProductRepresentation *Representation() const

Reference to the representations of the product, being either a representation (IfcProductRepresentation) or as a special case a shape representations (IfcProductDefinitionShape). The product definition shape provides for multiple geometric representations of the shape property of the object within the same object coordinate system, defined by the object placement.

void setRepresentation(::Ifc2x3::IfcProductRepresentation *v)
IfcTemplatedEntityList<IfcRelAssignsToProduct>::ptr ReferencedBy() const
const IfcParse::entity &declaration() const
IfcProduct(IfcEntityInstanceData *e)
IfcProduct(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation)

Public Static Functions

const IfcParse::entity &Class()
class IfcProductDefinitionShape : public Ifc2x3::IfcProductRepresentation

The IfcProductDefinitionShape defines all shape relevant information about an IfcProduct. It allows for multiple geometric shape representations of the same product. The shape relevant information includes:

the shape representation including geometric representation items (for 3D solids, 2D annotations, etc.) and:

associated presentation information (line color, line type, surface rendering properties) assignment to presentation layers (CAD layers for visibility control)

or the topological representation items for connectivity systems (vertex, edge, face representations) that may include geometric representation items (vertex points, edge curves, face surfaces)

NOTE The definition of this entity relates to the ISO 10303 entity product_definition_shape. Please refer to ISO/IS 10303-41:1994 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 1.5

Public Functions

IfcTemplatedEntityList<IfcProduct>::ptr ShapeOfProduct() const
IfcTemplatedEntityList<IfcShapeAspect>::ptr HasShapeAspects() const
const IfcParse::entity &declaration() const
IfcProductDefinitionShape(IfcEntityInstanceData *e)
IfcProductDefinitionShape(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentation>::ptr v3_Representations)

Public Static Functions

const IfcParse::entity &Class()
class IfcProductRepresentation : public IfcUtil::IfcBaseEntity

IfcProductRepresentation defines a representation of a product, including its (geometric or topological) representation. A product can have zero, one or many geometric representations, and a single geometric representation can be shared among various products using mapped representations.

NOTE: The definition of this entity relates to the ISO 10303 entity property_definition. The use of the term ‘property’ was avoided since it conflicts with the property, property type, and property set definitions elsewhere in the IFC model.

HISTORY New entity in IFC Release 2.0

IFC2x3 NOTEUsers should not instantiate the entity from IFC2x Edition 3 onwards.

IFC2x4 CHANGE Entity made abstract.

Subclassed by Ifc2x3::IfcMaterialDefinitionRepresentation, Ifc2x3::IfcProductDefinitionShape

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcProductRepresentation.

std::string Name() const

The word or group of words by which the product representation is known.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcProductRepresentation.

std::string Description() const

The word or group of words that characterize the product representation. It can be used to add additional meaning to the name of the product representation.

void setDescription(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcRepresentation>::ptr Representations() const

Contained list of representations (including shape representations). Each member defines a valid representation of a particular type within a particular representation context.

void setRepresentations(IfcTemplatedEntityList<::Ifc2x3::IfcRepresentation>::ptr v)
const IfcParse::entity &declaration() const
IfcProductRepresentation(IfcEntityInstanceData *e)
IfcProductRepresentation(boost::optional<std::string> v1_Name, boost::optional<std::string> v2_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentation>::ptr v3_Representations)

Public Static Functions

const IfcParse::entity &Class()
class IfcProductsOfCombustionProperties : public Ifc2x3::IfcMaterialProperties

Public Functions

bool hasSpecificHeatCapacity() const

Whether the optional attribute SpecificHeatCapacity is defined for this IfcProductsOfCombustionProperties.

double SpecificHeatCapacity() const
void setSpecificHeatCapacity(double v)
bool hasN20Content() const

Whether the optional attribute N20Content is defined for this IfcProductsOfCombustionProperties.

double N20Content() const
void setN20Content(double v)
bool hasCOContent() const

Whether the optional attribute COContent is defined for this IfcProductsOfCombustionProperties.

double COContent() const
void setCOContent(double v)
bool hasCO2Content() const

Whether the optional attribute CO2Content is defined for this IfcProductsOfCombustionProperties.

double CO2Content() const
void setCO2Content(double v)
const IfcParse::entity &declaration() const
IfcProductsOfCombustionProperties(IfcEntityInstanceData *e)
IfcProductsOfCombustionProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_SpecificHeatCapacity, boost::optional<double> v3_N20Content, boost::optional<double> v4_COContent, boost::optional<double> v5_CO2Content)

Public Static Functions

const IfcParse::entity &Class()
class IfcProfileDef : public IfcUtil::IfcBaseEntity

IfcProfileDef is the supertype of all definitions of standard and arbitrary profiles within IFC. It is used to define a standard set of commonly used section profiles by their parameters or by their explicit curve geometry.

Parameterized profiles are 2D primitives, which are used within the industry to describe cross sections by a description of its parameters. Arbitrary profiles are cross sections defined by an outer boundary as bounded curve, which may also include holes, defined by inner boundaries. Derived profiles, based on a transformation of a parent profile, are also part of the profile definitions available. In addition composite profiles can be defined, which include two or more profile definitions to define the resulting profile.

HISTORY New class in IFC Release 1.5, the capabilities have been extended in IFC Release 2x. Profiles can now support swept surfaces and swept area solids with inner boundaries. It had been renamed from IfcAttDrivenProfileDef.

IFC2x4 CHANGE Changed from ABSTRACT to non-abstract for uses which do not require an explicitly defined geometry. Added inverse attributes HasProperties and HasExternalReference.

Use in material association

Beams, columns, and similarly shaped building elements and their type objects may be associated with a section profile definition, combined with material definition, by means of IfcRelAssociatesMaterial together with IfcMaterialProfileSet and IfcMaterialProfileSetUsage. This way, building elements and element types with same section and material can share a common section profile definition and association.

The profile definition in material association is required to be consistent with shape representations of the respective building elements.

A higher-level description of spatial aligment of the section profile of a member (such as centered, bottom-left, in the geometric centroid, and more) can be provided within IfcMaterialProfileSetUsage by means of a cardinal point reference. This can be used redundant to geometric data in order to convey design intent.

Use in shape models

Profile definitions are used within the geometry and geometric model resource to create either swept surfaces, swept area solids, or sectioned spines.

The purpose of the profile definition within the swept surfaces or swept area solids is to define a uniform cross section being swept:

along a line (extrusion) using IfcSurfaceOfLinearExtrusion or IfcExtrudedAreaSolid along a circular arc (revolution) using IfcSurfaceOfRevolution or IfcRevolvedAreaSolid along a directrix lying on a reference surface using IfcSurfaceCurveSweptAreaSolid

The purpose fo the profile definition within the sectioned spine is to define a varying cross sections at several positions along a spine curve. The subtype IfcDerivedProfileDef is particularly suited to provide the consecutive profiles to be based on transformations of the start profile and thus maintaining the identity of vertices and edges.

NOTE Subtypes of the IfcProfileDef contain parameterized profiles (as subtypes of IfcParameterizedProfileDef) which establish their own 2D position coordinate system, profiles given by explicit curve geometry (either open or closed profiles) and two special types for composite profiles and derived profiles, based on a 2D Cartesian transformation.

An IfcProfileDef is treated as bounded area if it is used within swept area solids. In this case, the inside of the profile is part of the profile. The attribute ProfileType is set to AREA. An IfcProfileDef is treated as a curve if it is used within swept surfaces. In this case, the inside of the profile (if the curve is closed) is not part of the profile. The attribute ProfileType is set to CURVE.

Figure 320 illustrates use of parameterized profiles within a swept area solid.

Position The IfcProfileDef is defined within the underlying coordinate system which is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane

of IfcSweptSurface.Position or of IfcSweptAreaSolid.Position or of each list member of IfcSectionedSpine.CrossSectionPositions.

In the figure to the left, the z axis of the position coordinate system points outwards of the drawing plane.

Note: The subtype IfcParameterizedProfileDef optionally provides an additional 2D position coordinate system relative to the underlying coordinate system of the IfcProfileDef.

Sweeping

In the later use of the IfcProfileDef within the swept surface or swept area solid, e.g. the IfcExtrudedAreaSolid (here used as an example), the profile boundaries (here based on the 2D position coordinate system of IfcParameterizedProfileDef) are placed within the xy plane of the 3D position coordinate system of the swept surface or swept area solid.

The profile is inserted into the underlying coordinate system either:

directly in case of using IfcArbitraryClosedProfileDef and IfcArbitraryOpenProfileDef,

through an intermediate position coordinate system in case of using IfcParameterizedProfileDef.

through an 2D Cartesian transformation operator (applied directly to the curve position when using arbitrary profile definitions, or applied to the position coordinate system when using parameterized profile definitions) in case of using IfcDerivedProfileDef.

when using IfcCompositeProfileDef the insertion depends on the subtype of the included sub-profiles.

Figure 320 — Profile sweeping

Profile types

Results of the different usage of the ProfileType attribute are demonstrated here. The ProfileType defines whether the inside (the bounded area) is part of the profile definition (Area) or not (Curve). Figure 321 illustrates the resulting area or curve depending on ProfileType.

ProfileType = AREA

ProfileType = CURVE

Figure 321 — Profile types

Profile specification by external reference

If the profile is standardized by a norm or a catalogue, a reference to this norm or catalogue should be provided by means of HasExternalReference. This inverse relationship is used to associate an IfcExternalReference (notably IfcClassificationReference or IfcLibraryReference) with the profile.

IfcClassificationReference is used to refer to a profile norm (a common standard or manufacturer’s standard). In this case,

IfcClassificationReference.ItemReference contains the formal profile designation from the norm. (On the other hand, IfcProfileDef.ProfileName contains a displayable name which may not necessarily be the same as the formal designation.) IfcClassificationReference.Name carries the short name of the profile norm. Optionally, the norm can be further described by IfcClassificationReference.ReferencedSource.

IfcLibraryReference is used to refer to a library which contains profile definitions. In this case,

IfcLibraryReference.ItemReference contains the identifier of the profile within the library and is meant to be machine-readable (in contrast to IfcProfileDef.ProfileName which should be human-readable). IfcLibraryReference.Location and .Name or .ReferencedLibrary further describe the library.

If an external reference is provided, sending systems shall ensure that the shape of the profile definition object agrees with the definitions in the referenced classification or library.

Direct instances of IfcProfileDef

Usually, only subtypes of IfcProfileDef should be instantiated. In some special cases, e.g. if the profile object is used for purposes other than geometric models (e.g. for structural analysis models), it may be possible to directly instantiate IfcProfileDef and further specify the profile only by external reference or by profile properties. The latter are tracked by the inverse attribute HasProperties.

Subclassed by Ifc2x3::IfcArbitraryClosedProfileDef, Ifc2x3::IfcArbitraryOpenProfileDef, Ifc2x3::IfcCompositeProfileDef, Ifc2x3::IfcDerivedProfileDef, Ifc2x3::IfcParameterizedProfileDef

Public Types

typedef IfcTemplatedEntityList<IfcProfileDef> list

Public Functions

::Ifc2x3::IfcProfileTypeEnum::Value ProfileType() const

Defines the type of geometry into which this profile definition shall be resolved, either a curve or a surface area. In case of curve the profile should be referenced by a swept surface, in case of area the profile should be referenced by a swept area solid.

void setProfileType(::Ifc2x3::IfcProfileTypeEnum::Value v)
bool hasProfileName() const

Whether the optional attribute ProfileName is defined for this IfcProfileDef.

std::string ProfileName() const

Human-readable name of the profile, for example according to a standard profile table. As noted above, machine-readable standardized profile designations should be provided in IfcExternalReference.ItemReference.

void setProfileName(std::string v)
const IfcParse::entity &declaration() const
IfcProfileDef(IfcEntityInstanceData *e)
IfcProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName)

Public Static Functions

const IfcParse::entity &Class()
class IfcProfileProperties : public IfcUtil::IfcBaseEntity

This is a collection of properties applicable to section profile definitions.

The following sets of extended profile property definitions are part of this IFC release:

mechanical properties for all classes of profiles properties for precast concrete double-T sections properties for precast concrete hollow core sections

HISTORY New entity in IFC2x2.

IFC2x4 CHANGE Entity made non-abstract. Subtypes IfcGeneralProfileProperties, IfcStructuralProfileProperties, and IfcStructuralSteelProfileProperties deleted. Attribute ProfileName deleted, use ProfileDefinition.ProfileName instead. Attribute ProfileDefinition made mandatory. Attributes Name, Description, and HasProperties added.

Subclassed by Ifc2x3::IfcGeneralProfileProperties, Ifc2x3::IfcRibPlateProfileProperties

Public Types

typedef IfcTemplatedEntityList<IfcProfileProperties> list

Public Functions

bool hasProfileName() const

Whether the optional attribute ProfileName is defined for this IfcProfileProperties.

std::string ProfileName() const
void setProfileName(std::string v)
bool hasProfileDefinition() const

Whether the optional attribute ProfileDefinition is defined for this IfcProfileProperties.

::Ifc2x3::IfcProfileDef *ProfileDefinition() const

Profile definition which is qualified by these properties.

void setProfileDefinition(::Ifc2x3::IfcProfileDef *v)
const IfcParse::entity &declaration() const
IfcProfileProperties(IfcEntityInstanceData *e)
IfcProfileProperties(boost::optional<std::string> v1_ProfileName, ::Ifc2x3::IfcProfileDef *v2_ProfileDefinition)

Public Static Functions

const IfcParse::entity &Class()
struct IfcProfileTypeEnum

Public Types

enum Value

The enumeration defines whether the definition of a profile shape shall be geometrically resolved into a curve or into a surface.

HISTORY: New type in IFC 1.5.

Enumeration values:

CURVE: The resulting geometric item is of type curve and closed (with the only exception of the curve created by the IfcArbitraryOpenProfileDef which resolves into an open curve). The resulting geometry after applying a sweeping operation is a swept surface. This can be used to define shapes with thin sheets, such as ducts, where the thickness is not appropriate for geometric representation. AREA: The resulting geometric item is of type surface. The resulting geometry after applying a sweeping operation is a swept solid with defined volume.

Values:

enumerator IfcProfileType_CURVE
enumerator IfcProfileType_AREA

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcProject : public Ifc2x3::IfcObject

IfcProject indicates the undertaking of some design, engineering, construction, or maintenance activities leading towards a product. The project establishes the context for information to be exchanged or shared, and it may represent a construction project but does not have to. The IfcProject’s main purpose in an exchange structure is to provide the root instance and the context for all other information items included. The context provided by the IfcProject includes:

the default units the geometric representation context for exchange structures including shape representations

the world coordinate system the coordinate space dimension the precision used within the geometric representations, and optionally the indication of the true north relative to the world coordinate system

HISTORY New Entity in IFC Release 1.0

IFC2x4 CHANGE The attributes RepresentationContexts and UnitsInContext are made optional and are promoted to supertype IfcContext.

Relationship use definition The IfcProject is used to reference the root of the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical). The spatial structure elements are linked together, and to the IfcProject, by using the objectified relationship IfcRelAggregates. The IfcProject references them by its inverse relationship:

IfcProject.Decomposes it shall be NIL, i.e. the IfcProject shall not be decomposed into any parts. IfcProject.IsDecomposedBy referencing (IfcSite || IfcBuilding) by IfcRelAggregates.RelatingObject. The IfcSite or IfcBuilding referenced shall be the root of the spatial structure.

The IfcProject is also the context for other information about the construction project such as a work plan. Non-product structures are assigned by their first level object to IfcProject using the IfcRelDeclares relationship.

The IfcProject provides the context for spatial elements and the associated products, and for work plans (or other non-product based) descriptions of the construction project. It is handled by two distinct relationship objects as shown in Figure 3. NOTE The spatial structure and the schedule structure can be decomposed. For example the IfcBuilding can be decomposed into IfcBuildingStorey’s, and the IfcWorkPlan can be decomposed into IfcWorkSchedule’s. NOTE The products and tasks can be decomposed further. For example the IfcCurtainWall can be decomposed into IfcMember and IfcPlate, the IfcTask can be decomposed into other IfcTask’s. NOTE The products and tasks can have direct linking relationships. For example the IfcCurtainWall can be assigned to a IfcTask as an input or output for a construction schedule. NOTE The anomaly to use the composition structure through IfcRelAggregates for assigning the uppermost spatial container to IfcProject is due to upward compatibility reasons with earlier releases of this standard.

Figure 3 — Project spatial and work plan structure

As shown in Figure 4, the IfcProject provides the context for project libraries that in return provide a context to the library items assigned to it. Product types are an example for items that can be included in a project library.

Figure 4 — Project spatial structure, products and product type library

Informal propositions:

There shall only be one project within the exchange context. This is enforced by the global rule IfcSingleProjectInstance.

Public Types

typedef IfcTemplatedEntityList<IfcProject> list

Public Functions

bool hasLongName() const

Whether the optional attribute LongName is defined for this IfcProject.

std::string LongName() const
void setLongName(std::string v)
bool hasPhase() const

Whether the optional attribute Phase is defined for this IfcProject.

std::string Phase() const
void setPhase(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationContext>::ptr RepresentationContexts() const
void setRepresentationContexts(IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationContext>::ptr v)
::Ifc2x3::IfcUnitAssignment *UnitsInContext() const
void setUnitsInContext(::Ifc2x3::IfcUnitAssignment *v)
const IfcParse::entity &declaration() const
IfcProject(IfcEntityInstanceData *e)
IfcProject(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_LongName, boost::optional<std::string> v7_Phase, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationContext>::ptr v8_RepresentationContexts, ::Ifc2x3::IfcUnitAssignment *v9_UnitsInContext)

Public Static Functions

const IfcParse::entity &Class()
struct IfcProjectedOrTrueLengthEnum

Public Types

enum Value

This enumeration type is needed for load definition and is only considered if the load values are given as global actions and if they define linear or planar loads (that is, one- or two-dimensionally distributed loads). Figure 234 illustrates the interpretation of a load definition depending on the enumeration types IfcGlobalOrLocalEnum and IfcProjectedOrTrueLengthEnum.

HISTORY New type in IFC2x2.

Figure 234 — Projected or true length

Values:

enumerator IfcProjectedOrTrueLength_PROJECTED_LENGTH
enumerator IfcProjectedOrTrueLength_TRUE_LENGTH

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcProjectionCurve : public Ifc2x3::IfcAnnotationCurveOccurrence

Public Types

typedef IfcTemplatedEntityList<IfcProjectionCurve> list

Public Functions

const IfcParse::entity &declaration() const
IfcProjectionCurve(IfcEntityInstanceData *e)
IfcProjectionCurve(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcProjectionElement : public Ifc2x3::IfcFeatureElementAddition

The projection element is a specialization of the general feature element to represent projections applied to building elements. It represents a solid attached to any element that has physical manifestation. EXAMPLE A wall projection such as a pilaster strip is handled by IfcProjectionElement NOTE View definitions or implementer agreements may restrict the types of elements to which IfcProjectionElement can be applied. An IfcProjectionElement has to be linked to a element (all subtypes of IfcElement) by using the IfcRelProjectsElement relationship. Its existence depends on the existence of the master element. The relationship implies a Boolean union operation between the volume of the projection element and the volume of the element. HISTORY New entity in IFC2x2. IFC2x4 CHANGE The attribute PredefinedType has been added at the end of attribute list. The quantities relating to the IfcProjectionElement are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_ProjectionElementBaseQuantities: base quantities for all opening occurrences.

Containment Use Definition The IfcProjectionElement shall not participate in the containment relationship, i.e. it is not linked directly to the spatial structure of the project. It has a mandatory ProjectsElements inverse relationship pointing to the IfcElement that is contained in the spatial structure.

The inverse relationship ContainedInStructure shall be NIL.

Geometry Use Definition The geometric representation of IfcProjectionElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. Local Placement The local placement for IfcOpeningRecess is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement should point to the local placement of the same element, to which the projection adds, i.e. referred to by ProjectsElement.RelatingBuildingElement.

Swept Solid Representation The geometric representation of IfcProjectionElement is defined using the swept area solid geometry. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the swept solid representation:

Solid: IfcExtrudedAreaSolid is required. Profile: IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef shall be supported. Extrusion: The profile shall be extruded horizontally (that is, perpendicular to the extrusion direction of the modified element), such as for wall projections, or vertically (that is, in the extrusion direction of the projected element), such as for floor projections.

As shown in Figure 38, the following interpretation of dimension parameter applies for rectangular projection:

IfcRectangleProfileDef.YDim interpreted as projection width IfcRectangleProfileDef.XDim interpreted as projection height IfcExtrudedAreaSolid.Depth is interpreted as projection depth

NOTE Rectangles are now defined centric, the placement location has to be set: IfcCartesianPoint(XDim/2,YDim/2) NOTE The local placement directions for the IfcProjectionElement are only given as an example, other directions are valid as well.

Figure 38 — Projection representation

Brep Representation The general b-rep geometric representation of IfcProjectionElement is defined using the Brep geometry. The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

Public Types

typedef IfcTemplatedEntityList<IfcProjectionElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcProjectionElement(IfcEntityInstanceData *e)
IfcProjectionElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcProjectOrder : public Ifc2x3::IfcControl

A project order is a directive to purchase products and/or perform work, such as for construction or facilities management.

Project orders are typically formal contracts between two organizations, where cost and time information may be rigid or flexible according to contained schedule types and constraints.

HISTORY New entity in IFC 2.0 IFC2x4 CHANGE Attribute ‘ID’ changed to Identification and promoted to supertype IfcControl. Attribute ‘LongDescription’ added.

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Refer to the documentation at the supertype IfcControl and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ProjectOrderChangeOrder (CHANGEORDER) Pset_ProjectOrderMaintenanceWorkOrder (MAINTENANCEWORKORDER) Pset_ProjectOrderMoveOrder (MOVEORDER) Pset_ProjectOrderPurchaseOrder (PURCHASEORDER) Pset_ProjectOrderWorkOrder (WORKORDER)

Declaration Use Definition The IfcProjectOrder may be declared within the project using the IfcRelDeclares relationship where RelatingContext refers to the single IfcProject and RelatedDefinitions contains the IfcProjectOrder. Alternatively, if the IfcProjectOrder is aggregated within an IfcWorkPlan, then it shall not have a direct declaration relationship (whereas the containing work plan may have a declaration relationship).

Composition Use Definition As shown in Figure 160, an IfcProjectOrder may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcProjectOrder and RelatedObjects contains one or more components. Aggregation use is defined for the following predefined types:

(All Types): May contain IfcCostSchedule components. A cost schedule may indicate costs and quantities where the cost schedule type may designate whether rates and/or quantities are estimated or final. Such cost schedule may have assigned cost items indicating detail, where each cost item may have assigned products, processes, or resources. WORKORDER: May contain IfcWorkSchedule components. A work schedule may indicate tasks and scheduled times where the work schedule type may designate whether tasks and/or times are planned or actual. Such work schedule may have assigned tasks indicating detail, where tasks may be assigned to products and may have assigned resources.

The IfcProjectOrder may be nested into sub-items using IfcRelNests where RelatingObject refers to the enclosing IfcProjectOrder and RelatedObjects contains one or more sub-items. Nesting use is defined for the following predefined types:

WORKORDER: May contain IfcProjectOrder sub-items having PredefinedType CHANGEORDER. A work order may be nested into change orders to indicate contract ammendment, in order of issue.

Figure 161 — Project order composition

Assignment Use Definition As shown in Figure 161, an IfcProjectOrder may be assigned to the following entities using relationships as indicated:

IfcActor (IfcRelAssignsToActor): Organization issuing the order such as an owner or contractor.

The IfcProjectOrder may have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcProjectOrder and RelatedObjects contains one or more objects of the following types: IfcActor: Organization(s) contracted to fulfill the order, typically a single contractor, subcontractor, or supplier.

Figure 162 — Project order assignment

Approval Use Definition Approvals may be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcProjectOrder. Approvals may be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.

Public Types

typedef IfcTemplatedEntityList<IfcProjectOrder> list

Public Functions

std::string ID() const
void setID(std::string v)
::Ifc2x3::IfcProjectOrderTypeEnum::Value PredefinedType() const

Predefined generic type for a project order that is specified in an enumeration. There may be a property set given specificly for the predefined types.

IFC2x4 CHANGE The attribute has been made optional.

void setPredefinedType(::Ifc2x3::IfcProjectOrderTypeEnum::Value v)
bool hasStatus() const

Whether the optional attribute Status is defined for this IfcProjectOrder.

std::string Status() const

The current status of a project order.Examples of status values that might be used for a project order status include:

PLANNED REQUESTED APPROVED ISSUED STARTED DELAYED DONE

void setStatus(std::string v)
const IfcParse::entity &declaration() const
IfcProjectOrder(IfcEntityInstanceData *e)
IfcProjectOrder(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_ID, ::Ifc2x3::IfcProjectOrderTypeEnum::Value v7_PredefinedType, boost::optional<std::string> v8_Status)

Public Static Functions

const IfcParse::entity &Class()
class IfcProjectOrderRecord : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcProjectOrderRecord> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcRelAssignsToProjectOrder>::ptr Records() const
void setRecords(IfcTemplatedEntityList<::Ifc2x3::IfcRelAssignsToProjectOrder>::ptr v)
::Ifc2x3::IfcProjectOrderRecordTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcProjectOrderRecordTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcProjectOrderRecord(IfcEntityInstanceData *e)
IfcProjectOrderRecord(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, IfcTemplatedEntityList<::Ifc2x3::IfcRelAssignsToProjectOrder>::ptr v6_Records, ::Ifc2x3::IfcProjectOrderRecordTypeEnum::Value v7_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcProjectOrderRecordTypeEnum

Public Types

enum Value

Values:

enumerator IfcProjectOrderRecordType_CHANGE
enumerator IfcProjectOrderRecordType_MAINTENANCE
enumerator IfcProjectOrderRecordType_MOVE
enumerator IfcProjectOrderRecordType_PURCHASE
enumerator IfcProjectOrderRecordType_WORK
enumerator IfcProjectOrderRecordType_USERDEFINED
enumerator IfcProjectOrderRecordType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcProjectOrderTypeEnum

Public Types

enum Value

An IfcProjectOrderTypeEnum is a list of the types of project order that may be identified. HISTORY: New type in IFC 2x2

Enumeration

CHANGEORDER: An instruction to make a change to a product or work being undertaken and a description of the work that is to be performed. MAINTENANCEWORKORDER: An instruction to carry out maintenance work and a description of the work that is to be performed. MOVEORDER: An instruction to move persons and artefacts and a description of the move locations, objects to be moved, etc.

PURCHASEORDER: An instruction to purchase goods and/or services and a description of the goods and/or services to be purchased that is to be performed. WORKORDER: A general instruction to carry out work and a description of the work to be done. Note the difference between a work order generally and a maintenance work order. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcProjectOrderType_CHANGEORDER
enumerator IfcProjectOrderType_MAINTENANCEWORKORDER
enumerator IfcProjectOrderType_MOVEORDER
enumerator IfcProjectOrderType_PURCHASEORDER
enumerator IfcProjectOrderType_WORKORDER
enumerator IfcProjectOrderType_USERDEFINED
enumerator IfcProjectOrderType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcProperty : public IfcUtil::IfcBaseEntity

IfcProperty is an abstract generalization for all types of properties that can be associated with IFC objects through the property set mechanism.

HISTORY New entity in IFC Release 1.0.

Subclassed by Ifc2x3::IfcComplexProperty, Ifc2x3::IfcSimpleProperty

Public Types

typedef IfcTemplatedEntityList<IfcProperty> list

Public Functions

std::string Name() const

Name for this property. This label is the significant name string that defines the semantic meaning for the property.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcProperty.

std::string Description() const

Informative text to explain the property.

void setDescription(std::string v)
IfcTemplatedEntityList<IfcPropertyDependencyRelationship>::ptr PropertyForDependance() const
IfcTemplatedEntityList<IfcPropertyDependencyRelationship>::ptr PropertyDependsOn() const
IfcTemplatedEntityList<IfcComplexProperty>::ptr PartOfComplex() const
const IfcParse::entity &declaration() const
IfcProperty(IfcEntityInstanceData *e)
IfcProperty(std::string v1_Name, boost::optional<std::string> v2_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyBoundedValue : public Ifc2x3::IfcSimpleProperty

A property with a bounded value, IfcPropertyBoundedValue, defines a property object which has a maximum of two (numeric or descriptive) values assigned, the first value specifying the upper bound and the second value specifying the lower bound. It defines a property - value bound (min-max) combination for which the property Name, an optional Description,the optional UpperBoundValue with measure type, the optional LowerBoundValue with measure type, and the optional Unit is given.

A set point value can be provided in addition to the upper and lower bound values for operational value setting.

The unit is handled by the Unit attribute:

If the Unit attribute is not given, then the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).

If the Unit attribute is given, then the unit assigned by the Unit attribute overrides the globally assigned unit.

The IfcPropertyBoundedValue allows for the specification of an interval for the value component of the property description. If either the LowerBoundValue or the UpperBoundValue is not given, then it indicates an open bound (either a minimum value or a maximum value). The interval is by definition inclusive, that is, the value given for the LowerBoundValue or the UpperBoundValue is included in the interval.

NOTE An IfcPropertyBoundedValue may be exchanged with no values assigned yet. In this case the LowerBoundValue and the UpperBoundValue are set to NIL.

Examples of a property with bounded value are:

Name

UpperBoundValue

LowerBoundValue

SetPointValue

Type (through IfcValue, WR1 ensures same type for both values)

Unit

OverallHeight

1930

2300

IfcPositiveLengthMeasure

  • OverallWidth

0.9

1.25

IfcPositiveLengthMeasure

m

MaxHeight

20.0

IfcPositiveLengthMeasure

  • MinWeight

20

IfcMassMeasure

kg

HISTORYNew entity in IFC Release 2x.

IFC2x2 CHANGE The attribute type of the attribute UpperBoundValue and LowerBoundValue has been changed from mandatory to optional with upward compatibility for file based exchange.

IFC2x4 CHANGE The attribute SetPointValue has been added.

Informal proposition:

If the measure type for the upper and lover bound value is a numeric measure, then the following shall be true: UpperBoundValue > LowerBoundValue.

Public Types

typedef IfcTemplatedEntityList<IfcPropertyBoundedValue> list

Public Functions

bool hasUpperBoundValue() const

Whether the optional attribute UpperBoundValue is defined for this IfcPropertyBoundedValue.

::Ifc2x3::IfcValue *UpperBoundValue() const

Upper bound value for the interval defining the property value. If the value is not given, it indicates an open bound (all values to be greater than or equal to LowerBoundValue).

void setUpperBoundValue(::Ifc2x3::IfcValue *v)
bool hasLowerBoundValue() const

Whether the optional attribute LowerBoundValue is defined for this IfcPropertyBoundedValue.

::Ifc2x3::IfcValue *LowerBoundValue() const

Lower bound value for the interval defining the property value. If the value is not given, it indicates an open bound (all values to be lower than or equal to UpperBoundValue).

void setLowerBoundValue(::Ifc2x3::IfcValue *v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcPropertyBoundedValue.

::Ifc2x3::IfcUnit *Unit() const

Unit for the upper and lower bound values, if not given, the default value for the measure type is used as defined by the global unit assignment at IfcProject.UnitInContext. The applicable unit is then selected by the underlying TYPE of the UpperBoundValue, LowerBoundValue, and SetPointValue)

void setUnit(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcPropertyBoundedValue(IfcEntityInstanceData *e)
IfcPropertyBoundedValue(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcValue *v3_UpperBoundValue, ::Ifc2x3::IfcValue *v4_LowerBoundValue, ::Ifc2x3::IfcUnit *v5_Unit)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyConstraintRelationship : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcConstraint *RelatingConstraint() const
void setRelatingConstraint(::Ifc2x3::IfcConstraint *v)
IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr RelatedProperties() const
void setRelatedProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcPropertyConstraintRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcPropertyConstraintRelationship.

std::string Description() const
void setDescription(std::string v)
const IfcParse::entity &declaration() const
IfcPropertyConstraintRelationship(IfcEntityInstanceData *e)
IfcPropertyConstraintRelationship(::Ifc2x3::IfcConstraint *v1_RelatingConstraint, IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v2_RelatedProperties, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyDefinition : public Ifc2x3::IfcRoot

IfcPropertyDefinition defines the generalization of all characteristics (i.e. a grouping of individual properties), that may be assigned to objects. Currently, subtypes of IfcPropertyDefinition include property set occurrences, property set templates, and property templates.

Property set template - IfcPropertySetTemplate, a collection of property templates that determine the definition of properties used within a project context. Property template - IfcPropertyTemplate, a single template that determines the definition of a particular property used in the same project context. The template may determine the name, description, data type, the unit, or a standard expression for each property that is based on that template. Property set occurrence - IfcPropertySet, a set of individual properties (that may or may not be determined by a property template) holding individual values, measure types and units, and are associated to an object occurrence or object type.

NOTE 1 The subtype hierarchy of IfcPropertyDefinition also includes statically defined property sets as IfcPreDefinedPropertySet. Those are rarely used collections of fixed attributes combined in an entity definition. The IfcPreDefinedPropertySet can not be determined by an IfcPropertySetTemplate.

NOTE 2 Individual properties, (subtypes of IfcProperty), are currently not included in the subtype hierarchy of IfcPropertyDefinition. This anomaly is due to upward compatibility reasons with earlier releases of this standard.

HISTORY New Entity in IFC2.0

Relationship use definition Property definitions define information that is shared among multiple instances of objects, either object occurrences or object types. IfcPropertyDefinition’s (by their instantiable subtypes) can participated within the following relationships:

Assignment to a project context - an HasContext relationship to IfcRelDeclares that establishes the project context in which this property definition is declared. This relationship is predominately applicable to subtypes of IfcPropertyTemplateDefinition. Association to external resources - an HasAssociation relationship to IfcRelAssociates that refers to external sources of information (most notably a classification or document) and creates a uni-directional association. There is no dependency implied by the association.

Subtypes are included in more specific relationships, see IfcPropertySetDefinition and IfcPropertyTemplateDefinition for details.

Subclassed by Ifc2x3::IfcPropertySetDefinition

Public Types

typedef IfcTemplatedEntityList<IfcPropertyDefinition> list

Public Functions

IfcTemplatedEntityList<IfcRelAssociates>::ptr HasAssociations() const
const IfcParse::entity &declaration() const
IfcPropertyDefinition(IfcEntityInstanceData *e)
IfcPropertyDefinition(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyDependencyRelationship : public IfcUtil::IfcBaseEntity

An IfcPropertyDependencyRelationship describes an identified dependency between the value of one property and that of another.

HISTORY New entity in IFC2x2

IFC2x4 CHANGE Made subtype of IfcResourceLevelRelationship (attribute order changed).

Use Definition Whilst the IfcPropertyDependencyRelationship may be used to describe the dependency, and it may do so in terms of the expression of how the dependency operates, it is not possible through the current IFC model for the value of the related property to be actually derived from the value of the relating property. The determination of value according to the dependency is required to be performed by an application that can then use the Expression attribute to flag the form of the dependency.

Public Functions

::Ifc2x3::IfcProperty *DependingProperty() const

The property on which the relationship depends.

void setDependingProperty(::Ifc2x3::IfcProperty *v)
::Ifc2x3::IfcProperty *DependantProperty() const

The dependant property.

void setDependantProperty(::Ifc2x3::IfcProperty *v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcPropertyDependencyRelationship.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcPropertyDependencyRelationship.

std::string Description() const
void setDescription(std::string v)
bool hasExpression() const

Whether the optional attribute Expression is defined for this IfcPropertyDependencyRelationship.

std::string Expression() const

Expression that further describes the nature of the dependency relation.

void setExpression(std::string v)
const IfcParse::entity &declaration() const
IfcPropertyDependencyRelationship(IfcEntityInstanceData *e)
IfcPropertyDependencyRelationship(::Ifc2x3::IfcProperty *v1_DependingProperty, ::Ifc2x3::IfcProperty *v2_DependantProperty, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_Expression)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyEnumeratedValue : public Ifc2x3::IfcSimpleProperty

A property with an enumerated value, IfcPropertyEnumeratedValue, defines a property object which has a value assigned that is chosen from an enumeration. It defines a property - value combination for which theproperty Name, an optional Description,the optional EnumerationValues with measure type and optionally an Unit is given.

NOTE Multiple choices from the property enumeration are supported.

The unit is handled by the Unit attribute of the IfcPropertyEnumeration:

If the Unit attribute is not given, then the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext). If the Unit attribute is given, then the unit assigned by the unit attribute overrides the globally assigned unit.

More precisely: The IfcPropertyEnumeratedValue defines a property, which value is selected from a defined list of enumerators. The enumerators are stored in a dynamic enumeration of values including the type information from IfcValue (see IfcPropertyEnumeration). This enables applications to use an enumeration value as a property within a property set (IfcPropertySet) including the allowed list of values.

NOTE An IfcPropertyEnumeratedValue may be exchanged with no values assigned yet. In this case the EnumerationValues are set to NIL.

Examples of a property with enumerated value are:

Name Value (EnumerationValue) Type (through IfcValue) ref.IfcPropertyEnumeration (Name)

BladeAction Opposed IfcString DamperBladeActionEnum

BladeAction Parallel IfcString DamperBladeActionEnum

The IfcPropertyEnumeratedValue refers to an IfcPropertyEnumeration, e.g. for the above:

Name EnumerationValues Type (through IfcValue) Unit

DamperBladeActionEnum (Parallel, Opposed, Other, Unset) IfcString

HISTORYNew Entity in IFC Release 2.0, capabilities enhanced in IFC2x. The entity has been renamed from IfcEnumeratedProperty in IFC2x.

IFC2x4 CHANGE Attribute EnumerationValues has been made OPTIONAL with upward compatibility for file based exchange.

Public Functions

IfcEntityList::ptr EnumerationValues() const

Enumeration values, which shall be listed in the referenced IfcPropertyEnumeration, if such a reference is provided.

IFC2x4 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setEnumerationValues(IfcEntityList::ptr v)
bool hasEnumerationReference() const

Whether the optional attribute EnumerationReference is defined for this IfcPropertyEnumeratedValue.

::Ifc2x3::IfcPropertyEnumeration *EnumerationReference() const

Enumeration from which a enumeration value has been selected. The referenced enumeration also establishes the unit of the enumeration value.

void setEnumerationReference(::Ifc2x3::IfcPropertyEnumeration *v)
const IfcParse::entity &declaration() const
IfcPropertyEnumeratedValue(IfcEntityInstanceData *e)
IfcPropertyEnumeratedValue(std::string v1_Name, boost::optional<std::string> v2_Description, IfcEntityList::ptr v3_EnumerationValues, ::Ifc2x3::IfcPropertyEnumeration *v4_EnumerationReference)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyEnumeration : public IfcUtil::IfcBaseEntity

IfcPropertyEnumeration is a collection of simple or measure values that define a prescribed set of alternatives from which ‘enumeration values’ are selected. This enables inclusion of enumeration values in property sets. IfcPropertyEnumeration provides a name for the enumeration as well as a list of unique (numeric or descriptive) values (that may have a measure type assigned). The entity defines the list of potential enumerators to be exchanged together (or separately) with properties of type IfcPropertyEnumeratedValue that selects their actual property values from this enumeration. The unit is handled by the Unit attribute:

If the Unit attribute is not given, than the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext). If the Unit attribute is given, the unit assigned by the unit attribute overrides the globally assigned unit.

Name EnumerationValues Type (through IfcValue) Unit

PEnum_DamperBladeAction Parallel IfcString

  • Opposed IfcString

Other IfcString

Unset IfcString

HISTORY New Entity in IFC Release 2.0, capabilities enhanced in IFC Release 2x. Entity has been renamed from IfcEnumeration in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcPropertyEnumeration> list

Public Functions

std::string Name() const

Name of this enumeration.

void setName(std::string v)
IfcEntityList::ptr EnumerationValues() const

List of values that form the enumeration.

void setEnumerationValues(IfcEntityList::ptr v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcPropertyEnumeration.

::Ifc2x3::IfcUnit *Unit() const

Unit for the enumerator values, if not given, the default value for the measure type (given by the TYPE of nominal value) is used as defined by the global unit assignment at IfcProject.

void setUnit(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcPropertyEnumeration(IfcEntityInstanceData *e)
IfcPropertyEnumeration(std::string v1_Name, IfcEntityList::ptr v2_EnumerationValues, ::Ifc2x3::IfcUnit *v3_Unit)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyListValue : public Ifc2x3::IfcSimpleProperty

An IfcPropertyListValue defines a property that has several (numeric or descriptive) values assigned, these values are given by an ordered list.It defines a property - list value combination for which the property Name, an optional Description,the optional ListValues with measure type and optionally an Unit is given.

An IfcPropertyListValue is a list of values. The order in which values appear is significant. Each value in the list is unique i.e. no duplicate values are allowed. All list members shall be of the same type.

The unit applicable to all values is handled by the Unit attribute:

If the Unit attribute is not given, then the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).

If the Unit attribute is given, then the unit assigned by the Unit attribute overrides the globally assigned unit.

Example of a property with list value is:

Name

ListValues

Type (through IfcValue)

Unit

ApplicableSizes

1200

IfcPositiveLengthMeasure

  • 1600

IfcPositiveLengthMeasure

  • 2400

IfcPositiveLengthMeasure

  • HISTORY New Entity in Release IFC 2x Edition 2.

IFC2x4 CHANGE Attribute ListValues has been made OPTIONAL with upward compatibility for file based exchange.

Public Types

typedef IfcTemplatedEntityList<IfcPropertyListValue> list

Public Functions

IfcEntityList::ptr ListValues() const

List of property values.

IFC2x4 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setListValues(IfcEntityList::ptr v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcPropertyListValue.

::Ifc2x3::IfcUnit *Unit() const

Unit for the list values, if not given, the default value for the measure type (given by the TYPE of nominal value) is used as defined by the global unit assignment at IfcProject.

void setUnit(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcPropertyListValue(IfcEntityInstanceData *e)
IfcPropertyListValue(std::string v1_Name, boost::optional<std::string> v2_Description, IfcEntityList::ptr v3_ListValues, ::Ifc2x3::IfcUnit *v4_Unit)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertyReferenceValue : public Ifc2x3::IfcSimpleProperty

IfcPropertyReferenceValue allows a property value to be given by referencing other entities within the resource definitions of IFC. Those other entities are regarded as predefined complex properties and can be aggregated within a property set (IfcPropertySet). The allowable entities to be used as value references are given by the IfcObjectReferenceSelect.

HISTORY New entity in IFC Release 1.5. Entity has been renamed from IfcObjectReference in IFC Release 2x.

IFC2x4 CHANGE Attribute PropertyReference has been made OPTIONAL with upward compatibility for file based exchange.

Public Functions

bool hasUsageName() const

Whether the optional attribute UsageName is defined for this IfcPropertyReferenceValue.

std::string UsageName() const

Description of the use of the referenced value within the property.

void setUsageName(std::string v)
::Ifc2x3::IfcObjectReferenceSelect *PropertyReference() const

Reference to another property entity through one of the select types in the IfcObjectReferenceSelect.

IFC2x4 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setPropertyReference(::Ifc2x3::IfcObjectReferenceSelect *v)
const IfcParse::entity &declaration() const
IfcPropertyReferenceValue(IfcEntityInstanceData *e)
IfcPropertyReferenceValue(std::string v1_Name, boost::optional<std::string> v2_Description, boost::optional<std::string> v3_UsageName, ::Ifc2x3::IfcObjectReferenceSelect *v4_PropertyReference)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertySet : public Ifc2x3::IfcPropertySetDefinition

IfcPropertySet defines all dynamically extensible properties. The property set is a container class that holds properties within a property tree. These properties are interpreted according to their name attribute. The same IfcPropertySet can be assignd to multiple object occurrences, it should then be assigned by a single instance of IfcRelDefinedByProperties to a set of related objects. Those property sets are referred to as shared property sets. It can also be assigned to an object type. The underlying structure, i.e. the required name, the applicable object or object types to which the property set can be attached and the individual properties that maybe included can be assigned using the property set template.

NOTE See IfcRelDefinesByType for how to override property sets assigned to an object type within the object occurrence.

HISTORY New Entity in IFC Release 1.0

IFC2x4 CHANGE All statically defined property set entities are no longer subtypes of IfcPropertySet.

Relationship use definition Property sets are related to other objects by using the relationship object that refers to the corresponding object:

Occurrence Object: IfcRelDefinesByProperties using the inverse attribute DefinesOccurrence. Type Object: using a direct link by inverse attribute DefinesType. External reference: subtypes of IfcRelAssociates are used to provide a link to a classification system, or external library providing further reference to the property set. Accessible by inverse attribute HasAssociations. Underlying template: IfcRelDefinesByTemplate using the inverse attribute IsDefinedBy.

Attribute use definition Instances of IfcPropertySet are used to assign named sets of individual properties (complex or single properties). Each individual property has a significant name string. Some property sets are included in the IFC specification and havea predefined set of properties indicated by assigning a significant name. These property sets are listed under “property sets” main menu item within this specification and from the object documentation sheet for those object to which they are applicable. The naming convention “Pset_Xxx” applies to all those property sets that are defined as part of the IFC specification and it shall be used as the value of the Name attribute. In addition any user defined property set can be captured. Property sets that are not declared as part of the IFC specification shall have a Name value not including the “Pset_” prefix.

Public Types

typedef IfcTemplatedEntityList<IfcPropertySet> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr HasProperties() const

Contained set of properties. For property sets defined as part of the IFC Object model, the property objects within a property set are defined as part of the standard. If a property is not contained within the set of predefined properties, its value has not been set at this time.

void setHasProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
const IfcParse::entity &declaration() const
IfcPropertySet(IfcEntityInstanceData *e)
IfcPropertySet(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v5_HasProperties)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertySetDefinition : public Ifc2x3::IfcPropertyDefinition

IfcPropertySetDefinition is a generalization of all individual property sets that can be assigned to an object or type object. The property set definition can be either:

Dynamically extendable property sets - IfcPropertySet, a set of properties for which the IFC model only provides a kind of “meta model”, to be further declared by agreement. This means no entity definition of the properties exists within the IFC model. The declaration is done by assigning a significant string value to the Name attribute of the entity as defined in the entity IfcPropertySet and at each subtype of IfcProperty, referenced by the property set. Dynamically defined property sets may have an underlying template provided by IfcPropertySetTemplate. Statically defined property sets - IfcPreDefinedPropertySet, a property set entity that exists within the IFC specification. The semantic meaning of each statically defined property set is declared by its entity type and the meaning of the properties is defined by the name and data type of the explicit attribute representing it.

HISTORY New Entity in IFC Release 2x

IFC2x4 CHANGE The subtype IfcPreDefinedPropertySet has been added.

Relationship use definition Property set definitions define information that is shared among multiple instances of objects, either object occurrences or object types. IfcPropertySetDefinition’s (by their instantiable subtypes) can participated within the following relationships:

Assignment to object types - an DefinesType direct relationship to IfcTypeObject that applies the property set, with all included properties, to the object type. Those properties apply to all object occurrences having the same object type. Assignment to object occurrences - an DefinesOccurrence relationship to IfcRelDefinesByProperties that applies the property set, with all included properties, to the object occurrence.

NOTE Properties assigned to object occurrences may override properties assigned to the object type. See IfcRelDefinesByType for further information.

Subclassed by Ifc2x3::IfcDoorLiningProperties, Ifc2x3::IfcDoorPanelProperties, Ifc2x3::IfcElementQuantity, Ifc2x3::IfcEnergyProperties, Ifc2x3::IfcFluidFlowProperties, Ifc2x3::IfcPermeableCoveringProperties, Ifc2x3::IfcPropertySet, Ifc2x3::IfcReinforcementDefinitionProperties, Ifc2x3::IfcServiceLifeFactor, Ifc2x3::IfcSoundProperties, Ifc2x3::IfcSoundValue, Ifc2x3::IfcSpaceThermalLoadProperties, Ifc2x3::IfcWindowLiningProperties, Ifc2x3::IfcWindowPanelProperties

Public Functions

IfcTemplatedEntityList<IfcRelDefinesByProperties>::ptr PropertyDefinitionOf() const
IfcTemplatedEntityList<IfcTypeObject>::ptr DefinesType() const
const IfcParse::entity &declaration() const
IfcPropertySetDefinition(IfcEntityInstanceData *e)
IfcPropertySetDefinition(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcPropertySingleValue : public Ifc2x3::IfcSimpleProperty

The property with a single value IfcPropertySingleValue defines a property object which has a single (numeric or descriptive) value assigned. It defines a property - single value combination for which the property Name, an optional Description,and an optional NominalValue with measure type is provided. In addition, the default unit as specified within the project unit context can be overriden by assigning an Unit. The unit is handled by the Unit attribute:

If the Unit attribute is not given, then the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext). If the Unit attribute is given, then the unit assigned by the Unit attribute overrides the globally assigned unit.

Examples of a property with single value are:

Name NominalValue Type (through IfcValue) Unit

Description Manufacturer “A” door IfcLabel

HISTORYNew entity in IFC Release 1.0. The entity has been renamed from IfcSimpleProperty in IFC Release 2x.

IFC2x3 CHANGEAttribute NominalValue has been made OPTIONAL with upward compatibility for file based exchange.

Public Types

typedef IfcTemplatedEntityList<IfcPropertySingleValue> list

Public Functions

bool hasNominalValue() const

Whether the optional attribute NominalValue is defined for this IfcPropertySingleValue.

::Ifc2x3::IfcValue *NominalValue() const

Value and measure type of this property.

NOTE By virtue of the defined data type, that is selected from the SELECT IfcValue, the appropriate unit can be found within the IfcUnitAssignment, defined for the project if no value for the unit attribute is given.

IFC2x3 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setNominalValue(::Ifc2x3::IfcValue *v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcPropertySingleValue.

::Ifc2x3::IfcUnit *Unit() const

Unit for the nominal value, if not given, the default value for the measure type (given by the TYPE of nominal value) is used as defined by the global unit assignment at IfcProject.

void setUnit(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcPropertySingleValue(IfcEntityInstanceData *e)
IfcPropertySingleValue(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcValue *v3_NominalValue, ::Ifc2x3::IfcUnit *v4_Unit)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPropertySourceEnum

Public Types

enum Value

Values:

enumerator IfcPropertySource_DESIGN
enumerator IfcPropertySource_DESIGNMAXIMUM
enumerator IfcPropertySource_DESIGNMINIMUM
enumerator IfcPropertySource_SIMULATED
enumerator IfcPropertySource_ASBUILT
enumerator IfcPropertySource_COMMISSIONING
enumerator IfcPropertySource_MEASURED
enumerator IfcPropertySource_USERDEFINED
enumerator IfcPropertySource_NOTKNOWN

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcPropertyTableValue : public Ifc2x3::IfcSimpleProperty

A property with a range value (IfcPropertyTableValue) defines a property object which has two lists of (numeric or descriptive) values assigned, the values specifying a table with two columns. The defining values provide the first column and establish the scope for the defined values (the second column). Interpolations are out of scope of the IfcPropertyTableValue. An optional Expression attribute may give the equation used for deriving the range value, which is for information purposes only.

The IfcPropertyTableValue defines a defining/defined property value combination for which the property name, the table with defining and defined values with measure type (and optional the units for defining and defined values) are given.

The units are handled by the DefiningUnit and DefinedUnit attributes:

If the DefiningUnit or DefinedUnit attribute is not given, then the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).

If the DefiningUnit or DefinedUnit attribute is given, then the unit assigned by the unit attribute overrides the globally assigned unit.

The IfcPropertyTableValue allows for the specification of a table of defining/defined value pairs of the property description. The optional attribute CurveInterpolation allows to determine the interval between two given values.

Examples of a property with range value are:

Name

DefiningValues

DefiningValue Type (through IfcValue)

DefinedValues

DefinedValue Type (through IfcValue)

DefingUnit

DefinedUnit

SoundTransmissionLoss

100

IfcFrequencyMeasure

20

IfcNumericMeasure

  • dB

200

IfcFrequencyMeasure

42

IfcNumericMeasure

400

IfcFrequencyMeasure

46

IfcNumericMeasure

800

IfcFrequencyMeasure

56

IfcNumericMeasure

1600

IfcFrequencyMeasure

60

IfcNumericMeasure

3200

IfcFrequencyMeasure

65

IfcNumericMeasure

HISTORY: New entity in IFC2x.

IFC2x4 CHANGE Attributes DefiningValues and DefinedValues have been made OPTIONAL with upward compatibility for file based exchange. The attribute CurveInterpolation has been added..

Informal propositions:

The list of DefinedValues and the list of DefiningValues are corresponding lists.

Public Types

typedef IfcTemplatedEntityList<IfcPropertyTableValue> list

Public Functions

IfcEntityList::ptr DefiningValues() const

List of defining values, which determine the defined values. This list shall have unique values only.

IFC2x4 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setDefiningValues(IfcEntityList::ptr v)
IfcEntityList::ptr DefinedValues() const

Defined values which are applicable for the scope as defined by the defining values.

IFC2x4 CHANGE The attribute has been made optional with upward compatibility for file based exchange.

void setDefinedValues(IfcEntityList::ptr v)
bool hasExpression() const

Whether the optional attribute Expression is defined for this IfcPropertyTableValue.

std::string Expression() const

Expression for the derivation of defined values from the defining values, the expression is given for information only, i.e. no automatic processing can be expected from the expression.

void setExpression(std::string v)
bool hasDefiningUnit() const

Whether the optional attribute DefiningUnit is defined for this IfcPropertyTableValue.

::Ifc2x3::IfcUnit *DefiningUnit() const

Unit for the defining values, if not given, the default value for the measure type (given by the TYPE of the defining values) is used as defined by the global unit assignment at IfcProject.

void setDefiningUnit(::Ifc2x3::IfcUnit *v)
bool hasDefinedUnit() const

Whether the optional attribute DefinedUnit is defined for this IfcPropertyTableValue.

::Ifc2x3::IfcUnit *DefinedUnit() const

Unit for the defined values, if not given, the default value for the measure type (given by the TYPE of the defined values) is used as defined by the global unit assignment at IfcProject.

void setDefinedUnit(::Ifc2x3::IfcUnit *v)
const IfcParse::entity &declaration() const
IfcPropertyTableValue(IfcEntityInstanceData *e)
IfcPropertyTableValue(std::string v1_Name, boost::optional<std::string> v2_Description, IfcEntityList::ptr v3_DefiningValues, IfcEntityList::ptr v4_DefinedValues, boost::optional<std::string> v5_Expression, ::Ifc2x3::IfcUnit *v6_DefiningUnit, ::Ifc2x3::IfcUnit *v7_DefinedUnit)

Public Static Functions

const IfcParse::entity &Class()
class IfcProtectiveDeviceType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcProtectiveDeviceType defines commonly shared information for occurrences of protective devices. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a protective device specification (i.e. the specific product information, that is common to all occurrences of that product type). Protective Device types may be exchanged without being already assigned to occurrences. Occurrences of IfcProtectiveDeviceType are represented by instances of IfcProtectiveDevice.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_ProtectiveDeviceTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ProtectiveDeviceTypeCircuitBreaker (CIRCUITBREAKER) Pset_ProtectiveDeviceTypeEarthLeakageCircuitBreaker (EARTHLEAKAGECIRCUITBREAKER) Pset_ProtectiveDeviceTypeFuseDisconnector (FUSEDISCONNECTOR) Pset_ProtectiveDeviceTypeResidualCurrentCircuitBreaker (RESIDUALCURRENTCIRCUITBREAKER) Pset_ProtectiveDeviceTypeResidualCurrentSwitch (RESIDUALCURRENTSWITCH) Pset_ProtectiveDeviceTypeVaristor (VARISTOR)

Material Use Definition The material of the IfcProtectiveDeviceType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcProtectiveDeviceType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcProtectiveDevice for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcProtectiveDeviceType> list

Public Functions

::Ifc2x3::IfcProtectiveDeviceTypeEnum::Value PredefinedType() const

Identifies the predefined types of protective device from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcProtectiveDeviceTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcProtectiveDeviceType(IfcEntityInstanceData *e)
IfcProtectiveDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcProtectiveDeviceTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcProtectiveDeviceTypeEnum

Public Types

enum Value

The IfcProtectiveDeviceTypeEnum specifically defines the range of different breaker unit types that can be used in conjunction with protective device. Types may also be used as a reference to a complete protective device in circumstances where tripping units are not separately identified (typically expected to be the case during earlier stages of design).

HISTORY: New type in IFC 2x2. Modified definition and usage in IFC 2x4

Enumeration

FUSEDISCONNECTOR: A device that will electrically open the circuit after a period of prolonged, abnormal current flow. CIRCUITBREAKER: A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time and breaking, current under specified abnormal circuit conditions such as those of short circuit. EARTHINGSWITCH: A safety device used to open or close a circuit when there is no current. Used to isolate a part of a circuit, a machine, a part of an overhead line or an underground line so that maintenance can be safely conducted. EARTHLEAKAGECIRCUITBREAKER: A device that opens, closes, or isolates a circuit and has short circuit protection but no overload protection. It attempts to break the circuit when there is a leakage of current from phase to earth, by measuring voltage on the earth conductor. RESIDUALCURRENTCIRCUITBREAKER: A device that opens, closes, or isolates a circuit and has short circuit and overload protection. It attempts to break the circuit when there is a difference in current between any two phases. May also be referred to as ‘Ground Fault Interupter (GFI)’ or ‘Ground Fault Circuit Interuptor (GFCI)’ RESIDUALCURRENTSWITCH: A device that opens, closes or isolates a circuit and has no short circuit or overload protection. May also be identified as a ‘ground fault switch’. VARISTOR: A high voltage surge protection device. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcProtectiveDeviceType_FUSEDISCONNECTOR
enumerator IfcProtectiveDeviceType_CIRCUITBREAKER
enumerator IfcProtectiveDeviceType_EARTHFAILUREDEVICE
enumerator IfcProtectiveDeviceType_RESIDUALCURRENTCIRCUITBREAKER
enumerator IfcProtectiveDeviceType_RESIDUALCURRENTSWITCH
enumerator IfcProtectiveDeviceType_VARISTOR
enumerator IfcProtectiveDeviceType_USERDEFINED
enumerator IfcProtectiveDeviceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcProxy : public Ifc2x3::IfcProduct

IfcProxy is intended to be a kind of a container for wrapping objects which are defined by associated properties, which may or may not have a geometric representation and placement in space. A proxy may have a semantic meaning, defined by the Name attribute, and property definitions, attached through the property assignment relationship, which definition may be outside of the definitions given by the current release of IFC.

The ProxyType may give an indication to which high level semantic breakdown of object the semantic definition of the proxy relates to. the Tag attribute may be used to assign a human or system interpretable identifier (such as a serial number or bar code).

NOTE 1 Given that only a limited number of semantic constructs can be formally defined within IFC (and it will never be possible to define all), there has to be a mechanism for capturing those constructs that are not (yet) defined by IFC.

NOTE 2 Product proxies are a mechanism that allows to exchange data that is part of the project but not necessarily part of the IFC model. Those proxies may have geometric representations assigned.

HISTORY New entity in IFC Release 1.5.

Public Types

typedef IfcTemplatedEntityList<IfcProxy> list

Public Functions

::Ifc2x3::IfcObjectTypeEnum::Value ProxyType() const

High level (and only) semantic meaning attached to the IfcProxy, defining the basic construct type behind the Proxy, e.g. Product or Process.

void setProxyType(::Ifc2x3::IfcObjectTypeEnum::Value v)
bool hasTag() const

Whether the optional attribute Tag is defined for this IfcProxy.

std::string Tag() const

The tag (or label) identifier at the particular instance of a product, e.g. the serial number, or the position number. It is the identifier at the occurrence level.

void setTag(std::string v)
const IfcParse::entity &declaration() const
IfcProxy(IfcEntityInstanceData *e)
IfcProxy(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcObjectTypeEnum::Value v8_ProxyType, boost::optional<std::string> v9_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcPumpType : public Ifc2x3::IfcFlowMovingDeviceType

The flow moving device type IfcPumpType defines commonly shared information for occurrences of pumps. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a pump specification (i.e. the specific product information, that is common to all occurrences of that product type). Pump types may be exchanged without being already assigned to occurrences. Occurrences of IfcPumpType are represented by instances of IfcPump.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowMovingDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_PumpTypeCommon

Material Use Definition The material of the IfcPumpType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Impeller’: Material from which the impeller of the pump is constructed. In the case of a positive displacement pump, the piston acts as the impeller. ‘ImpellerSeal’: Material from which the impeller shaft seal of the pump is constructed.

Port Use Definition The distribution ports relating to the IfcPumpType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcPump for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcPumpType> list

Public Functions

::Ifc2x3::IfcPumpTypeEnum::Value PredefinedType() const

Defines the type of pump typically used in building services.

void setPredefinedType(::Ifc2x3::IfcPumpTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcPumpType(IfcEntityInstanceData *e)
IfcPumpType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcPumpTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcPumpTypeEnum

Public Types

enum Value

Defines general types of pumps.

The IfcPumpTypeEnum contains the following:

CIRCULATOR: A Circulator pump is a generic low-pressure, low-capacity pump. It may have a wet rotor and may be driven by a flexible-coupled motor.

ENDSUCTION: An End Suction pump, when mounted horizontally, has a single horizontal inlet on the impeller suction side and a vertical discharge. It may have a direct or close-coupled motor.

SPLITCASE: A Split Case pump, when mounted horizontally, has an inlet and outlet on each side of the impeller. The impeller can be easily accessed by removing the front of the impeller casing. It may have a direct or close-coupled motor.

SUBMERSIBLEPUMP: A pump designed to be immersed in a fluid, typically a collection tank.

SUMPPUMP: A pump designed to sit above a collection tank with a suction inlet extending into the tank.

VERTICALINLINE: A Vertical Inline pump has the pump and motor close-coupled on the pump casing. The pump depends on the connected, horizontal piping for support, with the suction and discharge along the piping axis.

VERTICALTURBINE: A Vertical Turbine pump has a motor mounted vertically on the pump casing for either wet-pit sump mounting or dry-well mounting.

USERDEFINED: User-defined pump type.

NOTDEFINED: Pump type has not been defined.

HISTORY: New enumeration in IFC R2x. SUBMERSIBLEPUMP and SUMPPUMP added in IFC2x4.

Values:

enumerator IfcPumpType_CIRCULATOR
enumerator IfcPumpType_ENDSUCTION
enumerator IfcPumpType_SPLITCASE
enumerator IfcPumpType_VERTICALINLINE
enumerator IfcPumpType_VERTICALTURBINE
enumerator IfcPumpType_USERDEFINED
enumerator IfcPumpType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcQuantityArea : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityArea is a physical quantity that defines a derived area measure to provide an element’s physical property. It is normally derived from the physical properties of the element under the specific measure rules given by a method of measurement.

EXAMPLE An opening may have an opening area used to deduct it from the wall surface area. The actual size of the area depends on the method of measurement used.

HISTORY New entity in IFC2x. It replaces the calcXxx attributes used in previous IFC Releases.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityArea> list

Public Functions

double AreaValue() const

Area measure value of this quantity.

void setAreaValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityArea(IfcEntityInstanceData *e)
IfcQuantityArea(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_AreaValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcQuantityCount : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityCount is a physical quantity that defines a derived count measure to provide an element’s physical property. It is normally derived from the physical properties of the element under the specific measure rules given by a method of measurement.

EXAMPLE An radiator may be measured according to its number of coils. The actual counting method depends on the method of measurement used.

HISTORY New entity in IFC2x. It replaces the calcXxx attributes used in previous IFC Releases.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityCount> list

Public Functions

double CountValue() const

Count measure value of this quantity.

void setCountValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityCount(IfcEntityInstanceData *e)
IfcQuantityCount(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_CountValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcQuantityLength : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityLength is a physical quantity that defines a derived length measure to provide an element’s physical property. It is normally derived from the physical properties of the element under the specific measure rules given by a method of measurement.

EXAMPLE A rafter within a roof construction may be measured according to its length (taking a common cross section into account). The actual size of the length depends on the method of measurement used.

HISTORY New entity in IFC Release 2.x. It replaces the calcXxx attributes used in previous IFC Releases.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityLength> list

Public Functions

double LengthValue() const

Length measure value of this quantity.

void setLengthValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityLength(IfcEntityInstanceData *e)
IfcQuantityLength(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_LengthValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcQuantityTime : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityTime is an element quantity that defines a time measure to provide an property of time related to an element. It is normally given by the recipe information of the element under the specific measure rules given by a method of measurement.

EXAMPLE The amount of time needed to pour concrete for a wall is given as a time quantity for the labor part of the recipe information.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityTime> list

Public Functions

double TimeValue() const

Time measure value of this quantity.

void setTimeValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityTime(IfcEntityInstanceData *e)
IfcQuantityTime(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_TimeValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcQuantityVolume : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityVolume is a physical quantity that defines a derived volume measure to provide an element’s physical property. It is normally derived from the physical properties of the element under the specific measure rules given by a method of measurement.

EXAMPLE A thick brick wall may be measured according to its volume. The actual size of the volume depends on the method of measurement used.

HISTORY New entity in IFC2x. It replaces the calcXxx attributes used in previous IFC Releases.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityVolume> list

Public Functions

double VolumeValue() const

Volume measure value of this quantity.

void setVolumeValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityVolume(IfcEntityInstanceData *e)
IfcQuantityVolume(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_VolumeValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcQuantityWeight : public Ifc2x3::IfcPhysicalSimpleQuantity

IfcQuantityWeight is a physical element quantity that defines a derived weight measure to provide an element’s physical property. It is normally derived from the physical properties of the element under the specific measure rules given by a method of measurement.

EXAMPLE The amount of reinforcement used within a building element may be measured according to its weight. The actual size of the weight depends on the method of measurement used.

HISTORY New entity in IFC2x. It replaces the calcXxx attributes used in previous IFC Releases.

Public Types

typedef IfcTemplatedEntityList<IfcQuantityWeight> list

Public Functions

double WeightValue() const

Mass measure value of this quantity.

void setWeightValue(double v)
const IfcParse::entity &declaration() const
IfcQuantityWeight(IfcEntityInstanceData *e)
IfcQuantityWeight(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcNamedUnit *v3_Unit, double v4_WeightValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcRadioActivityMeasure : public IfcUtil::IfcBaseType

IfcRadioActivityMeasure is a measure of activity of radionuclide. Usually measured in Becquerel (Bq, 1/s). Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcRadioActivityMeasure(IfcEntityInstanceData *e)
IfcRadioActivityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRadiusDimension : public Ifc2x3::IfcDimensionCurveDirectedCallout

Public Types

typedef IfcTemplatedEntityList<IfcRadiusDimension> list

Public Functions

const IfcParse::entity &declaration() const
IfcRadiusDimension(IfcEntityInstanceData *e)
IfcRadiusDimension(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcRailing : public Ifc2x3::IfcBuildingElement

Definition of IAI: The railing is a frame assembly adjacent to human circulation spaces and at some space boundaries where it is used in lieu of walls or to compliment walls. Designed to aid humans, either as an optional physical support, or to prevent injury by falling. HISTORY New Entity in IFC Release 2.0 Type Use Definition IfcRailing defines the occuurence of any railing, common information about railing types (or styles) is handled by IfcRailingType. The IfcRailingType (if present) may establish the commontype name, usage (or predefined) type, common material, common set of properties and common shape representations (using IfcRepresentationMap). The IfcRailingType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. Material Use Definition The material of the IfcRailing is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be given at the IfcRailingType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsDefinedBy relationship pointing to IfcRailingType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are given, then the material directly assigned to IfcRailing overrides the material assigned to IfcRailingType. Property Set Use Definition The property sets relating to the IfcRailing are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcRailing are part of this IFC release:

Pset_RailingCommon: common property set for all railing occurrences

Quantity Use Definition The quantities relating to the IfcRailing are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.MethodOfMeasurement = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to MethodOfMeasurement.

Qto_RailingBaseQuantities: base quantities for all railing occurrences.

Containment Use Definition The IfcRailing, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcRailing is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcRailing may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcStair, or IfcRamp as a special focus subtypes. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcRailing is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local placement The local placement for IfcRailing is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the same IfcSpatialStructureElement that is used in the ContainedInStructure inverse attribute or to a referenced spatial structure element at a higher level If the IfcRailing, however, is used by an IfcStair or IfcRamp, and this container class defines its own local placement, then the PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of IfcStair or IfcRamp. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Axis’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Axis Representation The axis geometric representation of IfcRailing is defined using the ‘Axis’ representation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’, ‘Curve3D’

Body Representation Currently the use of ‘SurfaceModel’, ‘Brep’ and ‘MappedRepresentation’ representations of IfcRailing are supported. The conventions to use these representations are given at the level of the supertype, IfcBuildingElement. No further constraints or provisions on how to use the representation types are defined for IfcRailing.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’, ‘Brep’, ‘MappedRepresentation’

Public Types

typedef IfcTemplatedEntityList<IfcRailing> list

Public Functions

bool hasPredefinedType() const

Whether the optional attribute PredefinedType is defined for this IfcRailing.

::Ifc2x3::IfcRailingTypeEnum::Value PredefinedType() const

Predefined generic types for a railing that are specified in an enumeration. There may be a property set given for the predefined types. NOTE: The use of the predefined type directly at the occurrence object level of IfcRailing is only permitted, if no type object IfcRailingType is assigned. IFC2x PLATFORM CHANGE: The attribute has been changed into an OPTIONAL attribute.

void setPredefinedType(::Ifc2x3::IfcRailingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRailing(IfcEntityInstanceData *e)
IfcRailing(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcRailingTypeEnum::Value> v9_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRailingType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type (IfcRailingType) defines a list of commonly shared property set definitions of a railing element and an optional set of product representations. It is used to define a railing specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. A railing type is used to define the common properties of a certain type of railing that may be applied to many instances of that type to assign a specific style. Railing types may be exchanged without being already assigned to occurrences. The occurrences of the IfcRailingType are represented by instances of IfcRailing.

HISTORY New entity in Release IFC2x Editon 2.

Public Types

typedef IfcTemplatedEntityList<IfcRailingType> list

Public Functions

::Ifc2x3::IfcRailingTypeEnum::Value PredefinedType() const

Identifies the predefined types of a railing element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcRailingTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRailingType(IfcEntityInstanceData *e)
IfcRailingType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcRailingTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcRailingTypeEnum

Public Types

enum Value

Definition from IAI: Enumeration defining the valid types of railings that can be predefined using the enumeration values.

HISTORY: New Enumeration in IFC Release 2.0

Enumeration

HANDRAIL: A type of railing designed to serve as an optional structural support for loads applied by human occupants (at hand height). Generally located adjacent to ramps and stairs. Generally floor or wall mounted. GUARDRAIL: A type of railing designed to guard human occupants from falling off a stair, ramp or landing where there is a vertical drop at the edge of such floors/landings. BALUSTRADE: Similar to the definitions of a guardrail except the location is at the edge of a floor, rather then a stair or ramp. Examples are balustrates at roof-tops or balconies. USERDEFINED: User-defined railing element, a term to identify the user type is given by the attribute IfcRailing.ObjectType. NOTDEFINED: Undefined railing element, no type information available.

Values:

enumerator IfcRailingType_HANDRAIL
enumerator IfcRailingType_GUARDRAIL
enumerator IfcRailingType_BALUSTRADE
enumerator IfcRailingType_USERDEFINED
enumerator IfcRailingType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRamp : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Inclined way or floor joining two surfaces at different levels. A ramp is a vertical passageway which provides a human circulation link between one floor level and another floor level at a different elevation. It may include a landing as an intermediate floor slab. A ramp normally does not include steps (stepped ramps are out of scope for this IFC Release). The ramp is a container entity that aggregates all components of the ramp, it represents. The aggregation is handled via the IfcRelAggregates relationship, relating an IfcRamp with the related flights (IfcRampFlight) and landings (IfcSlab with type ‘Landing’). Railings belonging to the ramp may be included into the aggregation as IfcRailing.

HISTORY New Entity in IFC Release 2.0. IFC2x4 CHANGE Attribute ShapeType renamed to PredefinedType

Type Use Definition IfcRamp defines the occuurence of any ramp, common information about ramp types (or styles) is handled by IfcRampType. The IfcRampType (if present) may establish the commontype name, usage (or predefined) type, common material, common set of properties and common shape representations (using IfcRepresentationMap). The IfcRampType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. NOTE Since the IfcRamp might be represented as an aggregate of parts, e.g. represented by IfcRampFlight, or IfcSlab, these individual parts may have type information attached (represented e.g. by IfcRampFlightType, or IfcSlabType). Material Use Definition The material of the IfcRamp is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be given at the IfcRampType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsDefinedBy relationship pointing to IfcRampType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are given, then the material directly assigned to IfcRamp overrides the material assigned to IfcRampType. Property Set Use Definition: The property sets relating to the IfcRamp are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcRamp are part of this IFC release:

Pset_RampCommon: common property set for all ramp occurrences

Quantity Use Definition The quantities relating to the IfcRamp are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.MethodOfMeasurement = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcRampType. The individual quantities shall only be given at IfcRamp, it is not decomposed into the individual parts, IfcRampFlight and IfcSlab.

Qto_RampBaseQuantities: base quantities for all ramp occurrences.

Geometry Use Definitions: The geometric representation of IfcRamp is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Independent geometric representations should only be used when the IfcRamp is not defined as an aggregate. If defined as an aggregate, the geometric representation is the sum of the representation of the components within the aggregate. Local placement The local placement for IfcRamp is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

If the LocalPlacement is given for the IfcRamp, then all components, which are aggregated to the ramp should use this placement as their relative placement. Geometric representations Geometric representation by own shape representation If the IfcRamp has no components defined (empty set of SELF\IfcProduct.IsDecomposedBy) then the IfcRamp may be represented by an own IfcShapeRepresentation with the following values:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘Clipping’, ‘SurfaceModel’, or ‘Brep’

The conventions to use these representations are provided at IfcBuildingElement. No further constraints or provisions on how to use the representation types are defined for IfcRamp. Geometric representation by aggregated elements If the IfcRamp has components (referenced by SELF\IfcProduct.IsDecomposedBy) then no independent geometric representation shall be defined for the IfcRamp. The IfcRamp is then geometrically represented by the geometric representation of its components. The components are accessed via SELF\IfcProduct.IsDecomposedBy[1].RelatedObjects.

Figure 111 illustrates IfcRamp defining the local placement for all components.

Figure 111 — Ramp placement

Public Types

typedef IfcTemplatedEntityList<IfcRamp> list

Public Functions

::Ifc2x3::IfcRampTypeEnum::Value ShapeType() const
void setShapeType(::Ifc2x3::IfcRampTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRamp(IfcEntityInstanceData *e)
IfcRamp(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcRampTypeEnum::Value v9_ShapeType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRampFlight : public Ifc2x3::IfcBuildingElement

A ramp is an inclined slab segment, normally providing a human circulation link between two landings, floors or slabs at different elevations. An IfcRampFlight is normally aggregated by an IfcRamp through the IfcRelAggregates relationship, the ramp flight is then included in the set of IfcRelAggregates.RelatedObjects. An IfcRampFlight normally connects the floor slab of zero to two different storeys (or partial storeys or landings) within a building. The connection relationship between the IfcRampFlight and the IfcSlab is expressed using the IfcRelConnectsElements relationship. HISTORY New Entity in IFC Release 2.0.

Type Use Definition IfcRampFlight defines the occurrence of any ramp flight, common information about ramp flight types (or styles) is handled by IfcRampFlightType. The IfcRampFlightType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcRampFlightType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. Material Use Definition The material of the IfcRampFlight is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Property Set Use Definition: The property sets relating to the IfcRampFlight are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcRampFlight are part of this IFC release:

Pset_RampFlightCommon: common property set for all ramp flight occurrences

Quantity Use Definition The quantities relating to the IfcRampFlight are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcRampFlightType.

Qto_RampFlightBaseQuantities: base quantities for all ramp flight occurrences.

Containment Use Definition The IfcRampFlight, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first relationship is the hierachical spatial containment, the second relationship is the aggregation within anelement assembly.

The IfcRampFlight is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcRampFlight may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcRamp as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Geometry Use Definition The geometric representation of IfcRampFlight is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are: Local placement The local placement for IfcRampFlight is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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 IfcRampFlight, however, is used by an IfcRamp, and this container class defines its own local placement, then the PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the IfcRamp.

Geometric Representations Currently, the ‘Axis’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement.

Axis: A two-dimensional open curve IfcBoundedCurve defining the walking line for the ramp flight. FootPrint: A geometric curve set defining the footing print, including the boundary of the ramp flight. Body: A solid representation defining the 3D shape of the ramp flight

Axis Representation The walking line is represented by a two-dimensional open curve as the axis. The curve is directed into the upward direction (direction has to be interpreted as specified at the subtypes of IfcCurve). The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

Figure 112 illustrates the axis representation which has the following constraints:

In case of straight flights the curve shall be a single item of type IfcPolyline. In case of winding flights the curve shall be a single item of type IfcCompositeCurve. In case of a curved flight or a spiral flight the curve shall be a single item of type IfcTrimmedCurve.

Figure 112 — Ramp flight axis

FootPrint Representation The flight foot print, including the flight boundary is represented by a two-dimensional geometric curve set. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’

Figure 113 illustrates the footprint representation which has the following constraints:

In case of straight flights the curve set shall consist of a single item of type IfcPolyline. In case of winding flights or curved flights the curve set shall consists of a single item of type IfcCompositeCurve. In case of a spiral flight the curve set shall consists of a single item of type IfcConic or IfcPolyline.

Figure 113 — Ramp flight footprint

Body Representation The body representation of IfcRampFlight can be represented using the representation types ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’. The general usage of representation is are explained at IfcBuildingElement. For further constraints on the ‘SweptSolid’ the representation types see below..

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, ‘MappedRepresentation’

SweptSolid Representation Type The ‘SweptSolid’ representation type is a valid body representation of IfcRampFlight is defined using the swept area geometry. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation type:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcRectangleProfileDef and IfcArbitraryClosedProfileDef shall be supported. Extrusion: The profile shall be extruded in any direction relative to the XY plane of the position coordinate system of the IfcExtrudedAreaSolid. Therefore non-perpendicular sweep operation has to be supported. It might be further constrained to be in the direction of the global z-axis in implementers agreements.

Figure 114 illustrates the body representation.

Figure 114 — Ramp flight body

Public Types

typedef IfcTemplatedEntityList<IfcRampFlight> list

Public Functions

const IfcParse::entity &declaration() const
IfcRampFlight(IfcEntityInstanceData *e)
IfcRampFlight(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcRampFlightType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type (IfcRampFlightType) defines a list of commonly shared property set definitions of a ramp flight and an optional set of product representations. It is used to define an ramp flight specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. A ramp flight type is used to define the common properties of a certain type of a ramp flight that may be applied to many instances of that type to assign a specific style. Ramp flight types may be exchanged without being already assigned to occurrences. The occurrences of the IfcRampFlightType are represented by instances of IfcRampFlight.

HISTORY New entity in Release IFC2x Edition 2.

Public Types

typedef IfcTemplatedEntityList<IfcRampFlightType> list

Public Functions

::Ifc2x3::IfcRampFlightTypeEnum::Value PredefinedType() const

Identifies the predefined types of a ramp flight element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcRampFlightTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRampFlightType(IfcEntityInstanceData *e)
IfcRampFlightType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcRampFlightTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcRampFlightTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of linear elements an IfcRampFlightType object can fulfill:

STRAIGHT: A ramp flight with a straight walking line.

SPIRAL: A ramp flight with a circular or elliptic walking line. USERDEFINED: User-defined ramp flight. NOTDEFINED: Undefined ramp flight.

HISTORY: New Enumeration in Release IFC2x Edition 2.

Values:

enumerator IfcRampFlightType_STRAIGHT
enumerator IfcRampFlightType_SPIRAL
enumerator IfcRampFlightType_USERDEFINED
enumerator IfcRampFlightType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcRampTypeEnum

Public Types

enum Value

This enumeration defines the basic configuration of the ramp type in terms of the number and shape of ramp flights, as shown in Figure 67. The type also distinguished turns by landings. In addition the subdivision of the straight and changing direction ramps is included. The ramp configurations are given for ramps without and with one and two landings.

Ramps which are subdivided into more than two landings have to be defined by the geometry only. Also ramps with non-regular shapes have to be defined by the geometry only. The type of such ramps is USERDEFINED.

HISTORY New Enumeration in IFC Release 2.0.

Enumerator Description Figure

StraightRunRamp A ramp - which is a sloping floor, walk, or roadway - connecting two levels. The straight ramp consists of one straight flight without turns or winders.

TwoStraightRunRamp A straight ramp consisting of two straight flights without turns but with one landing.

QuarterTurnRamp A ramp making a 90° turn, consisting of two straight flights connected by a quarterspace landing. The direction of the turn is determined by the walking line.

TwoQuarterTurnRamp A ramp making a 180° turn, consisting of three straight flights connected by two quarterspace landings. The direction of the turn is determined by the walking line.

HalfTurnRamp A ramp making a 180° turn, consisting of two straight flights connected by a halfspace landing. The orientation of the turn is determined by the walking line.

SpiralRamp A ramp constructed around a circular or elliptical well without newels and landings.

UserDefined Free form ramp (user defined operation type)

NotDefined

Figure 67 — Ramp types

Values:

enumerator IfcRampType_STRAIGHT_RUN_RAMP
enumerator IfcRampType_TWO_STRAIGHT_RUN_RAMP
enumerator IfcRampType_QUARTER_TURN_RAMP
enumerator IfcRampType_TWO_QUARTER_TURN_RAMP
enumerator IfcRampType_HALF_TURN_RAMP
enumerator IfcRampType_SPIRAL_RAMP
enumerator IfcRampType_USERDEFINED
enumerator IfcRampType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRatioMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A ratio measure is the value of the relation between two physical quantities that are of the same kind.

NOTE: Input given in percent is to be divided by 100% when stored as an IfcRatioMeasure. For example, 25% becomes 0.25.

Type: REAL

NOTE Corresponding STEP name: ratio_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Subclassed by Ifc2x3::IfcNormalisedRatioMeasure, Ifc2x3::IfcPositiveRatioMeasure

Public Functions

const IfcParse::type_declaration &declaration() const
IfcRatioMeasure(IfcEntityInstanceData *e)
IfcRatioMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRationalBezierCurve : public Ifc2x3::IfcBezierCurve

Public Types

typedef IfcTemplatedEntityList<IfcRationalBezierCurve> list

Public Functions

std::vector<double> WeightsData() const
void setWeightsData(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcRationalBezierCurve(IfcEntityInstanceData *e)
IfcRationalBezierCurve(int v1_Degree, IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v2_ControlPointsList, ::Ifc2x3::IfcBSplineCurveForm::Value v3_CurveForm, bool v4_ClosedCurve, bool v5_SelfIntersect, std::vector<double> v6_WeightsData)

Public Static Functions

const IfcParse::entity &Class()
class IfcReal : public IfcUtil::IfcBaseType

IfcReal is a defined type of simple data type REAL. It is required since a select type (IfcSimpleValue), cannot directly include simple types in its select list.

In principle, the domain of IfcReal (being a Real) is all rational, irrational and scientific real numbers. Here the precision is unconstrained, but in practice it is implementation specific.

Type: REAL

HISTORY: New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcReal(IfcEntityInstanceData *e)
IfcReal(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRectangleHollowProfileDef : public Ifc2x3::IfcRectangleProfileDef

IfcRectangleHollowProfileDef defines a section profile that provides the defining parameters of a rectangular (or square) hollow section to be used by the swept surface geometry or the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration. A square hollow section can be defined by equal values for h and b. The centre of the position coordinate system is in the profiles centre of the bounding box (for symmetric profiles identical with the centre of gravity). Normally, the longer sides are parallel to the y-axis, the shorter sides parallel to the x-axis.

HISTORY New entity in IFC2x2.

IFC2x4 CHANGE Types of InnerFilletRadius and OuterFilletRadius relaxed to allow for zero values.

Figure 322 illustrates parameters of a rectangular or square hollow profile definition.

Position The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

by using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile.

Figure 322 — Rectangle hollow profile

Public Functions

double WallThickness() const

Thickness of the material.

void setWallThickness(double v)
bool hasInnerFilletRadius() const

Whether the optional attribute InnerFilletRadius is defined for this IfcRectangleHollowProfileDef.

double InnerFilletRadius() const

Inner corner radius.

void setInnerFilletRadius(double v)
bool hasOuterFilletRadius() const

Whether the optional attribute OuterFilletRadius is defined for this IfcRectangleHollowProfileDef.

double OuterFilletRadius() const

Outer corner radius.

void setOuterFilletRadius(double v)
const IfcParse::entity &declaration() const
IfcRectangleHollowProfileDef(IfcEntityInstanceData *e)
IfcRectangleHollowProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_XDim, double v5_YDim, double v6_WallThickness, boost::optional<double> v7_InnerFilletRadius, boost::optional<double> v8_OuterFilletRadius)

Public Static Functions

const IfcParse::entity &Class()
class IfcRectangleProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcRectangleProfileDef defines a rectangle as the profile definition used by the swept surface geometry or the swept area solid. It is given by its X extent and its Y extent, and placed within the 2D position coordinate system, established by the Position attribute. It is placed centric within the position coordinate system.

HISTORY: New class in IFC 1.5. The use definition has changed in IFC Release 2x.

Figure 323 illustrates parameters of the rectangle profile definition.

Position

The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions.

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (for example, upper-left bound). Parameter

The IfcRectangleProfileDef is defined within the position coordinate system, where the XDim defines the length measure for the length of the rectangle (half along the positive x-axis) and the YDim defines the length measure for the width of the rectangle (half along the positive y-axis).

Figure 323 — Rectangle profile

Subclassed by Ifc2x3::IfcRectangleHollowProfileDef, Ifc2x3::IfcRoundedRectangleProfileDef

Public Types

typedef IfcTemplatedEntityList<IfcRectangleProfileDef> list

Public Functions

double XDim() const

The extent of the rectangle in the direction of the x-axis.

void setXDim(double v)
double YDim() const

The extent of the rectangle in the direction of the y-axis.

void setYDim(double v)
const IfcParse::entity &declaration() const
IfcRectangleProfileDef(IfcEntityInstanceData *e)
IfcRectangleProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_XDim, double v5_YDim)

Public Static Functions

const IfcParse::entity &Class()
class IfcRectangularPyramid : public Ifc2x3::IfcCsgPrimitive3D

The IfcRectangularPyramid is a Construction Solid Geometry (CSG) 3D primitive. It is a solid with a rectangular base and a point called apex as the top. The tapers from the base to the top. The axis from the center of the base to the apex is perpendicular to the base. The inherited Position attribute defines the IfcAxisPlacement3D and provides the location and orientation of the pyramid:

SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The center of the circular area being the bottom face of the cone. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z-axis of the inherited placement coordinate system provides the center axis of the IfcRightCircularCone, and the apex is at the Height value applied to the positive direction of the z-axis. The BottomRadius defines the circular base at the xy-plane of the placement coordinate system.

As shown in Figure 260, the pyramid is positioned within its own placement coordinate system. The origin is the center of the bottom rectangle, that lies in the XY plane. The apex lies on the positive z axis at [0, 0, Height].

Figure 260 — Rectangular pyramid geometry

NOTE Corresponding ISO 10303 entity: right_circular_cone, the position attribute has been promoted to the immediate supertype IfcCsgPrimitive3D. No semi_angle attribute, and the radius defines the bottom radius, since only a non-truncated cone is in scope. Please refer to ISO/IS 10303-42:1994, p. 176 for the final definition of the formal standard.

HISTORY New entity in IFC2x3

Texture use definition

On each triangular side face, textures are aligned facing upright. Textures are stretched or repeated to the extent of the base of each face according to RepeatS. Textures are stretched or repeated towards the top point according to Repeat T, where the top point has coordinates of (0.5,1.0) if RepeatT is False.

On the bottom face, textures are aligned facing front-to-back.

Figure 261 illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

Side Normal Origin X Origin Y Origin Z S Axis T Axis

Left -X 0 +YLength 0 -Y (towards top point)

Right +X 0 +YLength 0 +Y (towards top point)

Front +X 0 0 0 +X (towards top point)

Back +Y +XLength +YLength 0 -X (towards top point)

Bottom -Z +XLength 0 0 -X +Y

Figure 261 — Right circular cone textures

Public Types

typedef IfcTemplatedEntityList<IfcRectangularPyramid> list

Public Functions

double XLength() const

The length of the base measured along the placement X axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[1].

void setXLength(double v)
double YLength() const

The length of the base measured along the placement Y axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[2].

void setYLength(double v)
double Height() const

The height of the apex above the plane of the base, measured in the direction of the placement Z axis, the SELF\IfcCsgPrimitive3D.Position.P[2].

void setHeight(double v)
const IfcParse::entity &declaration() const
IfcRectangularPyramid(IfcEntityInstanceData *e)
IfcRectangularPyramid(::Ifc2x3::IfcAxis2Placement3D *v1_Position, double v2_XLength, double v3_YLength, double v4_Height)

Public Static Functions

const IfcParse::entity &Class()
class IfcRectangularTrimmedSurface : public Ifc2x3::IfcBoundedSurface

Definition from ISO/CD 10303-42:1992: The trimmed surface is a simple bounded surface in which the boundaries are the constant parametric lines u1 = u1, u2 = u2, v1 = v1 and v2 = v2. All these values shall be within the parametric range of the referenced surface. Cyclic properties of the parameter range are assumed.

NOTE 1 For example, 370 degrees is equivalent to 10 degrees, for those surfaces whose parametric form is defined using circular functions (sine and cosine).

The rectangular trimmed surface inherits its parameterization directly from the basis surface and has parameter ranges from 0 to |u2 - u1| and 0 to|v2-v1|.

NOTE 2 If the surface is closed in a given parametric direction, the values of u2 or v2 may require to be increased by the cyclic range.

NOTE Corresponding ISO 10303 name: rectangular_trimmed_surface. Please refer to ISO/IS 10303-42:1994, p.86 for the final definition of the formal standard.

HISTORY New class in IFC Release 2x.

Informal propositions:

The domain of the trimmed surface shall be within the domain of the surface being trimmed.

Public Functions

::Ifc2x3::IfcSurface *BasisSurface() const

Surface being trimmed.

void setBasisSurface(::Ifc2x3::IfcSurface *v)
double U1() const

First u parametric value.

void setU1(double v)
double V1() const

First v parametric value.

void setV1(double v)
double U2() const

Second u parametric value.

void setU2(double v)
double V2() const

Second v parametric value.

void setV2(double v)
bool Usense() const

Flag to indicate whether the direction of the first parameter of the trimmed surface agrees with or opposes the sense of u in the basis surface.

void setUsense(bool v)
bool Vsense() const

Flag to indicate whether the direction of the second parameter of the trimmed surface agrees with or opposes the sense of v in the basis surface.

void setVsense(bool v)
const IfcParse::entity &declaration() const
IfcRectangularTrimmedSurface(IfcEntityInstanceData *e)
IfcRectangularTrimmedSurface(::Ifc2x3::IfcSurface *v1_BasisSurface, double v2_U1, double v3_V1, double v4_U2, double v5_V2, bool v6_Usense, bool v7_Vsense)

Public Static Functions

const IfcParse::entity &Class()
class IfcReferencesValueDocument : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcDocumentSelect *ReferencedDocument() const
void setReferencedDocument(::Ifc2x3::IfcDocumentSelect *v)
IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr ReferencingValues() const
void setReferencingValues(IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcReferencesValueDocument.

std::string Name() const
void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcReferencesValueDocument.

std::string Description() const
void setDescription(std::string v)
const IfcParse::entity &declaration() const
IfcReferencesValueDocument(IfcEntityInstanceData *e)
IfcReferencesValueDocument(::Ifc2x3::IfcDocumentSelect *v1_ReferencedDocument, IfcTemplatedEntityList<::Ifc2x3::IfcAppliedValue>::ptr v2_ReferencingValues, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
struct IfcReflectanceMethodEnum

Public Types

enum Value

The IfcReflectanceMethodEnum defines the range of different reflectance methods available.

HISTORY: New type in IFC 2x2.

Enumeration

BLINN: A reflectance model providing a smooth, slightly shiny appearance. FLAT: A reflectance model providing a constant colour. This model ignores the effect of all light sources. GLASS: A reflectance model that supports an approximation of glass-like materials that have both reflective and transmissive properties. MATT: A reflectance model providing a dull matte appearance. METAL: A reflectance model providing a specular metallic appearance. MIRROR: A reflectance model that supports secondary mirrored views through ray tracing. PHONG: A reflectance model conforming with the Phong model in which reflections are greatest in the mirror direction of a surface opposite the viewing direction with respect to the surface normal. PLASTIC: A reflectance model providing a specular effect which is similar to the Phong model. STRAUSS: A reflectance model for metallic and non-metallic appearance based on a limited set of control parameter. NOTDEFINED

Values:

enumerator IfcReflectanceMethod_BLINN
enumerator IfcReflectanceMethod_FLAT
enumerator IfcReflectanceMethod_GLASS
enumerator IfcReflectanceMethod_MATT
enumerator IfcReflectanceMethod_METAL
enumerator IfcReflectanceMethod_MIRROR
enumerator IfcReflectanceMethod_PHONG
enumerator IfcReflectanceMethod_PLASTIC
enumerator IfcReflectanceMethod_STRAUSS
enumerator IfcReflectanceMethod_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRegularTimeSeries : public Ifc2x3::IfcTimeSeries

In a regular time series, the data arrives predictably at predefined intervals. In a regular time series there is no need to store multiple time stamps and the algorithms for analyzing the time series are therefore significantly simpler. Using the start time provided in the supertype, the time step is used to identify the frequency of the occurrences of the list of values.

EXAMPLE: A smoke detector samples the concentration of particulates in a space at a fixed rate (for example, every six seconds); a control system measures the outside air temperature every hour.

HISTORY: New entity in IFC 2x2.

Public Types

typedef IfcTemplatedEntityList<IfcRegularTimeSeries> list

Public Functions

double TimeStep() const

A duration of time intervals between values.

void setTimeStep(double v)
IfcTemplatedEntityList<::Ifc2x3::IfcTimeSeriesValue>::ptr Values() const

The collection of time series values.

void setValues(IfcTemplatedEntityList<::Ifc2x3::IfcTimeSeriesValue>::ptr v)
const IfcParse::entity &declaration() const
IfcRegularTimeSeries(IfcEntityInstanceData *e)
IfcRegularTimeSeries(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDateTimeSelect *v3_StartTime, ::Ifc2x3::IfcDateTimeSelect *v4_EndTime, ::Ifc2x3::IfcTimeSeriesDataTypeEnum::Value v5_TimeSeriesDataType, ::Ifc2x3::IfcDataOriginEnum::Value v6_DataOrigin, boost::optional<std::string> v7_UserDefinedDataOrigin, ::Ifc2x3::IfcUnit *v8_Unit, double v9_TimeStep, IfcTemplatedEntityList<::Ifc2x3::IfcTimeSeriesValue>::ptr v10_Values)

Public Static Functions

const IfcParse::entity &Class()
class IfcReinforcementBarProperties : public IfcUtil::IfcBaseEntity

IfcReinforcementProperties defines the set of properties for a specific combination of reinforcement bar steel grade, bar type and effective depth.

HISTORY New entity in IFC2x2.

The total cross section area for the specific steel grade is always provided. Additionally also general reinforcing bar configurations as a count of bars may be provided as defined in attribute BarCount. In this case the nominal bar diameter should be identical for all given bars as defined in attribute NominalBarDiameter.

Public Functions

double TotalCrossSectionArea() const

The total effective cross-section area of the reinforcement of a specific steel grade.

void setTotalCrossSectionArea(double v)
std::string SteelGrade() const

The nominal steel grade defined according to local standards.

void setSteelGrade(std::string v)
bool hasBarSurface() const

Whether the optional attribute BarSurface is defined for this IfcReinforcementBarProperties.

::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value BarSurface() const

Indicator for whether the bar surface is plain or textured.

void setBarSurface(::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value v)
bool hasEffectiveDepth() const

Whether the optional attribute EffectiveDepth is defined for this IfcReinforcementBarProperties.

double EffectiveDepth() const

The effective depth, i.e. the distance of the specific reinforcement cross section area or reinforcement configuration in a row, counted from a common specific reference point. Usually the reference point is the upper surface (for beams and slabs) or a similar projection in a plane (for columns).

void setEffectiveDepth(double v)
bool hasNominalBarDiameter() const

Whether the optional attribute NominalBarDiameter is defined for this IfcReinforcementBarProperties.

double NominalBarDiameter() const

The nominal diameter defining the cross-section size of the reinforcing bar. The bar diameter should be identical for all bars included in the specific reinforcement configuration.

void setNominalBarDiameter(double v)
bool hasBarCount() const

Whether the optional attribute BarCount is defined for this IfcReinforcementBarProperties.

double BarCount() const

The number of bars with identical nominal diameter and steel grade included in the specific reinforcement configuration.

void setBarCount(double v)
const IfcParse::entity &declaration() const
IfcReinforcementBarProperties(IfcEntityInstanceData *e)
IfcReinforcementBarProperties(double v1_TotalCrossSectionArea, std::string v2_SteelGrade, boost::optional<::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value> v3_BarSurface, boost::optional<double> v4_EffectiveDepth, boost::optional<double> v5_NominalBarDiameter, boost::optional<double> v6_BarCount)

Public Static Functions

const IfcParse::entity &Class()
class IfcReinforcementDefinitionProperties : public Ifc2x3::IfcPropertySetDefinition

Definition from IAI: An IfcReinforcementDefinitionProperties defines the cross section properties of reinforcement included in reinforced concrete building elements. The property set definition may be used both in conjunction with insitu and precast structures.

HISTORY New entity in IFC Release 2x2 IFC 2x4 change: Supertype changed from IfcPropertySetDefinition to IfcPreDefinedPropertySet

General usage: This subtype of IfcPropertySetDefinition is used to define the reinforcement properties in early design stages, such as in requirement definition or scheme design. In later design stages explicit instances of subtypes of IfcReinforcingElement are used. The intended usage may be indicated using the DefinitionType attribute value as a designator: recommended values are ‘Reinforcement area requirement’ or ‘Reinforcement configuration requirement’. Other values may be used according to local standards.

Only one property set definition of this kind is used for each concrete building element in each intended usage indicated by the DefinitionType attribute value. This set then defines a list of cross section properties in a discrete number of longitudinal sections as instances of

IfcSectionReinforcementProperties (one for each structural reinforcement bar role), which in turn have a section cross section property defined as a profile and a number of reinforcement properties, one for each steel grade / bar type.

Public Functions

bool hasDefinitionType() const

Whether the optional attribute DefinitionType is defined for this IfcReinforcementDefinitionProperties.

std::string DefinitionType() const

Descriptive type name applied to reinforcement definition properties.

void setDefinitionType(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcSectionReinforcementProperties>::ptr ReinforcementSectionDefinitions() const

The list of section reinforcement properties attached to the reinforcement definition properties.

void setReinforcementSectionDefinitions(IfcTemplatedEntityList<::Ifc2x3::IfcSectionReinforcementProperties>::ptr v)
const IfcParse::entity &declaration() const
IfcReinforcementDefinitionProperties(IfcEntityInstanceData *e)
IfcReinforcementDefinitionProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_DefinitionType, IfcTemplatedEntityList<::Ifc2x3::IfcSectionReinforcementProperties>::ptr v6_ReinforcementSectionDefinitions)

Public Static Functions

const IfcParse::entity &Class()
class IfcReinforcingBar : public Ifc2x3::IfcReinforcingElement

Definition from IAI: A steel bar, usually with manufactured deformations in the surface, used in concrete and masonry construction to provide additional strength. A single instance of this class may represent one or many of actual rebars, for example a row of rebars.

HISTORY New entity in IFC Release 2x2

IFC 2x4 CHANGE All attributes removed; information now provided by IfcReinforcingBarType.

Geometry Use Definition

The geometric representation of IfcReinforcingBar is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are:

Local Placement The use of local placement is defined at the supertype IfcElementComponent.

Multiple Mapped Representation See supertype IfcElementComponent. This method of representation allows for several rebars represented by a single instance of IfcReinforcingBar. The representation map should contain one IfcSweptDiskSolidPolygonal.

An IfcElementQuantity, attached via IfcRelDefinesByProperties, should contain an IfcQuantityCount named ‘Count’ with the number rebars and, if this is a regularly spaced arrangement of rebars, an IfcQuantityLength named ‘Spacing’ which expresses the center-to-center distances of bars.

Simplified Geometric Representation Simplified geometric representations may be used based on local agreements.

Public Types

typedef IfcTemplatedEntityList<IfcReinforcingBar> list

Public Functions

double NominalDiameter() const
void setNominalDiameter(double v)
double CrossSectionArea() const
void setCrossSectionArea(double v)
bool hasBarLength() const

Whether the optional attribute BarLength is defined for this IfcReinforcingBar.

double BarLength() const
void setBarLength(double v)
::Ifc2x3::IfcReinforcingBarRoleEnum::Value BarRole() const
void setBarRole(::Ifc2x3::IfcReinforcingBarRoleEnum::Value v)
bool hasBarSurface() const

Whether the optional attribute BarSurface is defined for this IfcReinforcingBar.

::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value BarSurface() const
void setBarSurface(::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value v)
const IfcParse::entity &declaration() const
IfcReinforcingBar(IfcEntityInstanceData *e)
IfcReinforcingBar(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_SteelGrade, double v10_NominalDiameter, double v11_CrossSectionArea, boost::optional<double> v12_BarLength, ::Ifc2x3::IfcReinforcingBarRoleEnum::Value v13_BarRole, boost::optional<::Ifc2x3::IfcReinforcingBarSurfaceEnum::Value> v14_BarSurface)

Public Static Functions

const IfcParse::entity &Class()
struct IfcReinforcingBarRoleEnum

Public Types

enum Value

Definition from IAI: Enumeration defining standard types for the role, purpose or usage of the bar, i.e. the kind of loads and stresses they are intended to carry.

HISTORY New type in IFC Release 2x2. Item ANCHORING (documented since IFC 2x2) added to the EXPRESS definition in IFC 2x4.

ENUMERATION

MAIN The reinforcing bar is a main bar. SHEAR The reinforcing bar is a shear bar. LIGATURE The reinforcing bar is a ligature (link, stirrup). STUD The reinforcing bar is a stud. PUNCHING Punching reinforcement. EDGE Edge reinforcement. RING Ring reinforcement. ANCHORING Anchoring reinforcement. USERDEFINED The type of reinforcement is user defined. NOTDEFINED The type of reinforcement is not defined.

Values:

enumerator IfcReinforcingBarRole_MAIN
enumerator IfcReinforcingBarRole_SHEAR
enumerator IfcReinforcingBarRole_LIGATURE
enumerator IfcReinforcingBarRole_STUD
enumerator IfcReinforcingBarRole_PUNCHING
enumerator IfcReinforcingBarRole_EDGE
enumerator IfcReinforcingBarRole_RING
enumerator IfcReinforcingBarRole_USERDEFINED
enumerator IfcReinforcingBarRole_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcReinforcingBarSurfaceEnum

Public Types

enum Value

Definition from IAI: Enumeration indicating whether the bar has a plain or textured (ribbed) surface.

HISTORY New type in IFC Release 2x2

ENUMERATION

PLAIN The reinforcing bar surface is plain. TEXTURED The reinforcing bar surface is textured (ribbed).

Values:

enumerator IfcReinforcingBarSurface_PLAIN
enumerator IfcReinforcingBarSurface_TEXTURED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcReinforcingElement : public Ifc2x3::IfcBuildingElementComponent

Definition from IAI: Bars, wires, strands, meshes, tendons, and other components embedded in concrete in such a manner that the reinforcement and the concrete act together in resisting forces.

HISTORY New entity in IFC Release 2x2

IFC 2x4 CHANGE Entity made non-abstract. Subtypes IfcTendon and IfcTendonAnchor removed. Attribute SteelGrade removed. Attributes PredefinedType and Role added.

Subclassed by Ifc2x3::IfcReinforcingBar, Ifc2x3::IfcReinforcingMesh, Ifc2x3::IfcTendon, Ifc2x3::IfcTendonAnchor

Public Types

typedef IfcTemplatedEntityList<IfcReinforcingElement> list

Public Functions

bool hasSteelGrade() const

Whether the optional attribute SteelGrade is defined for this IfcReinforcingElement.

std::string SteelGrade() const
void setSteelGrade(std::string v)
const IfcParse::entity &declaration() const
IfcReinforcingElement(IfcEntityInstanceData *e)
IfcReinforcingElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_SteelGrade)

Public Static Functions

const IfcParse::entity &Class()
class IfcReinforcingMesh : public Ifc2x3::IfcReinforcingElement

Definition from IAI: A series of longitudinal and transverse wires or bars of various gauges, arranged at right angles to each other and welded at all points of intersection; usually used for concrete slab reinforcement. Also known as welded wire fabric.

HISTORY New entity in IFC Release 2x2

IFC 2x4 CHANGE All attributes removed; information now provided by IfcReinforcingMeshType.

Geometry Use Definition

The geometric representation of IfcReinforcingBar is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Included are:

Local Placement The use of local placement is defined at the supertype IfcElementComponent.

Multiple Mapped Representation See supertype IfcElementComponent. This method of representation allows for several meshes represented by a single instance of IfcReinforcingMesh.

An IfcElementQuantity, attached via IfcRelDefinesByProperties, should contain an IfcQuantityCount named ‘Count’ with the number of meshes represented by this instance.

Simplified Geometric Representation Simplified geometric representations may be used based on local agreements.

Public Types

typedef IfcTemplatedEntityList<IfcReinforcingMesh> list

Public Functions

bool hasMeshLength() const

Whether the optional attribute MeshLength is defined for this IfcReinforcingMesh.

double MeshLength() const
void setMeshLength(double v)
bool hasMeshWidth() const

Whether the optional attribute MeshWidth is defined for this IfcReinforcingMesh.

double MeshWidth() const
void setMeshWidth(double v)
double LongitudinalBarNominalDiameter() const
void setLongitudinalBarNominalDiameter(double v)
double TransverseBarNominalDiameter() const
void setTransverseBarNominalDiameter(double v)
double LongitudinalBarCrossSectionArea() const
void setLongitudinalBarCrossSectionArea(double v)
double TransverseBarCrossSectionArea() const
void setTransverseBarCrossSectionArea(double v)
double LongitudinalBarSpacing() const
void setLongitudinalBarSpacing(double v)
double TransverseBarSpacing() const
void setTransverseBarSpacing(double v)
const IfcParse::entity &declaration() const
IfcReinforcingMesh(IfcEntityInstanceData *e)
IfcReinforcingMesh(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_SteelGrade, boost::optional<double> v10_MeshLength, boost::optional<double> v11_MeshWidth, double v12_LongitudinalBarNominalDiameter, double v13_TransverseBarNominalDiameter, double v14_LongitudinalBarCrossSectionArea, double v15_TransverseBarCrossSectionArea, double v16_LongitudinalBarSpacing, double v17_TransverseBarSpacing)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAggregates : public Ifc2x3::IfcRelDecomposes

The aggregation relationship IfcRelAggregates is a special type of the general composition/decomposition (or whole/part) relationship IfcRelDecomposes. The aggregation relationship can be applied to all subtypes of IfcObjectDefinition. In cases of aggregation of physical elements into a physical aggregate the shape representation of the whole (within the same representation identifier) can be taken from the sum of the shape representations of the parts. EXAMPLE A roof is the aggregation of the roof elements, such as roof slabs, rafters, purlins, etc. Within the same representation identifier, e.g. the body geometric representation, the shape representation of the roof is given by the shape representation of its parts Decompositions imply a dependency, i.e. the definition of the whole depends on the definition of the parts and the parts depend on the existence of the whole. The behaviour that is implied from the dependency has to be established inside the applications.

HISTORY New entity in IFC Release 2x.

IFC2x4 CHANGE The attributes RelatingObject and RelatedObjects are demoted from the supertype IfcRelDecomposes.

Public Types

typedef IfcTemplatedEntityList<IfcRelAggregates> list

Public Functions

const IfcParse::entity &declaration() const
IfcRelAggregates(IfcEntityInstanceData *e)
IfcRelAggregates(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcObjectDefinition *v5_RelatingObject, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v6_RelatedObjects)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssigns : public Ifc2x3::IfcRelationship

The assignment relationship, IfcRelAssigns, is a generalization of “link” relationships among instances of IfcObject and its various 1st level subtypes. A link denotes the specific association through which one object (the client) applies the services of other objects (the suppliers), or through which one object may navigate to other objects.

The client is denoted as the relating object and is established at the level of the specific, instantiable subtypes of IfcRelAssigns. The suppliers are denoted as the related objects and they are established by the RelatedObjects attribute.

NOTE: The terms “client” and “supplier” are used in a general concept and do not imply any meaning for implementations of systems (like client-server).

EXAMPLE: A resource may receive information about its nature of representing real building products by establishing a link between IfcResource and IfcBuildingElement (subtype of IfcProduct) through the assignment relationship IfcRelAssignsToResource. The resource is then the client that applies the services of other objects (here building elements) to express the particular view of elements to be consumed as a resource in a process.

The assignment relationship establishs a bi-directional relationship among the participating objects and does not imply any dependency. The subtypes of IfcRelAssigns establishes the particular semantic meaning of the assignment relationship.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcRelAssignsToActor, Ifc2x3::IfcRelAssignsToControl, Ifc2x3::IfcRelAssignsToGroup, Ifc2x3::IfcRelAssignsToProcess, Ifc2x3::IfcRelAssignsToProduct, Ifc2x3::IfcRelAssignsToResource

Public Types

typedef IfcTemplatedEntityList<IfcRelAssigns> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr RelatedObjects() const

Related objects, which are assigned to a single object. The type of the single (or relating) object is defined in the subtypes of IfcRelAssigns.

void setRelatedObjects(IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v)
bool hasRelatedObjectsType() const

Whether the optional attribute RelatedObjectsType is defined for this IfcRelAssigns.

::Ifc2x3::IfcObjectTypeEnum::Value RelatedObjectsType() const

Particular type of the assignment relationship. It can constrain the applicable object types, used within the role of RelatedObjects. IFC2x4 CHANGE The attribute is deprecated and shall no longer be used. A NIL value should always be assigned.

void setRelatedObjectsType(::Ifc2x3::IfcObjectTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRelAssigns(IfcEntityInstanceData *e)
IfcRelAssigns(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsTasks : public Ifc2x3::IfcRelAssignsToControl

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsTasks> list

Public Functions

bool hasTimeForTask() const

Whether the optional attribute TimeForTask is defined for this IfcRelAssignsTasks.

::Ifc2x3::IfcScheduleTimeControl *TimeForTask() const
void setTimeForTask(::Ifc2x3::IfcScheduleTimeControl *v)
const IfcParse::entity &declaration() const
IfcRelAssignsTasks(IfcEntityInstanceData *e)
IfcRelAssignsTasks(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcControl *v7_RelatingControl, ::Ifc2x3::IfcScheduleTimeControl *v8_TimeForTask)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToActor : public Ifc2x3::IfcRelAssigns

The objectified relationship IfcRelAssignsToActor handles the assignment of objects (subtypes of IfcObject) to an actor (subtypes of IfcActor).

The IfcRelAssignsToActor objectified relationship defines a relationship between an IfcActor and one or many objects. A particular role of the actor played in that relationship can be associated. If specified, it takes priority over the role that may be directly assigned to the person or organization.

EXAMPLE: An occupant (as an actor) may rent a flat (as a collection of spaces or a zone). This would be an application of this generic relationship.

Reference to the objects (or single object) on which the actor acts upon in a certain role (if given) is specified in the inherited RelatedObjects attribute.

HISTORY New Entity in IFC Release 2.0. Has been renamed from IfcRelActsUpon in IFC Release 2x.

Subclassed by Ifc2x3::IfcRelOccupiesSpaces

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToActor> list

Public Functions

::Ifc2x3::IfcActor *RelatingActor() const

Reference to the information about the actor. It comprises the information about the person or organization and its addresses.

void setRelatingActor(::Ifc2x3::IfcActor *v)
bool hasActingRole() const

Whether the optional attribute ActingRole is defined for this IfcRelAssignsToActor.

::Ifc2x3::IfcActorRole *ActingRole() const

Role of the actor played within the context of the assignment to the object(s).

void setActingRole(::Ifc2x3::IfcActorRole *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToActor(IfcEntityInstanceData *e)
IfcRelAssignsToActor(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcActor *v7_RelatingActor, ::Ifc2x3::IfcActorRole *v8_ActingRole)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToControl : public Ifc2x3::IfcRelAssigns

The objectified relationship IfcRelAssignsToControl handles the assignment of a control (represented by subtypes of IfcControl) to other objects (represented by subtypes of IfcObject, with the exception of controls).

EXAMPLE The assignment of a performance history (as subtype of IfcControl) for a building service element (as subtype of IfcObject) is an application of this generic relationship.

HISTORY New Entity in IFC Release 2.0. Has been renamed from IfcRelControls in IFC Release 2x.

Subclassed by Ifc2x3::IfcRelAssignsTasks, Ifc2x3::IfcRelAssignsToProjectOrder, Ifc2x3::IfcRelSchedulesCostItems

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToControl> list

Public Functions

::Ifc2x3::IfcControl *RelatingControl() const

Reference to the IfcControl that applies a control upon objects.

void setRelatingControl(::Ifc2x3::IfcControl *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToControl(IfcEntityInstanceData *e)
IfcRelAssignsToControl(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcControl *v7_RelatingControl)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToGroup : public Ifc2x3::IfcRelAssigns

The objectified relationship IfcRelAssignsToGroup handles the assignment of object definitions (individual object occurrences as subtypes of IfcObject, and object types as subtypes of IfcTypeObject) to a group (subtypes of IfcGroup).

The relationship handles the assignment of group members to the group object. It allows for grouping arbitrary objects within a group, including other groups. The grouping relationship can be applied in a recursive manner. The resulting group is of type IfcGroup.

NOTE Examples of groups include zones as a grouping of spaces, distribution systems as a grouping of building service components, or structural analysis models as a grouping of structural items.

The inherited attribute RelatedObjects gives the references to the objects, which are the elements within the group. The RelatingGroup is the group that comprises all elements. The same object or object type can be included in zero, one or many groups. Grouping relationships are not hierarchical.

Informal proposition:

The group assignment relationship shall be acyclic, that is, a group shall not participate in its own grouping relationship.

HISTORY New entity in IFC Release 1.0. It has been renamed from IfcRelGroups in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToGroup> list

Public Functions

::Ifc2x3::IfcGroup *RelatingGroup() const

Reference to group that contains all assigned group members.

void setRelatingGroup(::Ifc2x3::IfcGroup *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToGroup(IfcEntityInstanceData *e)
IfcRelAssignsToGroup(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcGroup *v7_RelatingGroup)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToProcess : public Ifc2x3::IfcRelAssigns

The objectified relationship IfcRelAssignsToProcess handles the assignment of one or many objects to a process or activity. An object can be a product that is the item the process operates on. Processes and activities can operate on things other than products, and can operate in ways other than input and output.

EXAMPLE It may be common to define processes during estimating or scheduling that describe design tasks (resulting in documents), procurement tasks (resulting in construction materials), planning tasks (resulting in processes), etc. Furthermore, the ways in which process can operate on something might include “installs”, “finishes”, “transports”, “removes”, etc. The ways are described as operation types. The inherited attribute RelatedObjects gives the references to the objects, or object type, which the process operates on. The RelatingProcess is the process or process type, that operates on the object. The operation types are captured in the inherited attribute Name. NOTE The agreement on valid and recognizable values for the Name attribute is part of view definitions and implementer agreements.

HISTORY New entity in IFC Release 1.5. Has been renamed from IfcRelProcessOperatesOn in IFC Release 2x.

IFC2x4 CHANGE The data type RelatingProcess has been extended to cover also IfcTypeProcess

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToProcess> list

Public Functions

::Ifc2x3::IfcProcess *RelatingProcess() const

Reference to the process to which the objects are assigned to.

IFC2x4 CHANGE Datatype expanded to include IfcProcess and IfcTypeProcess.

void setRelatingProcess(::Ifc2x3::IfcProcess *v)
bool hasQuantityInProcess() const

Whether the optional attribute QuantityInProcess is defined for this IfcRelAssignsToProcess.

::Ifc2x3::IfcMeasureWithUnit *QuantityInProcess() const

Quantity of the object specific for the operation by this process.

void setQuantityInProcess(::Ifc2x3::IfcMeasureWithUnit *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToProcess(IfcEntityInstanceData *e)
IfcRelAssignsToProcess(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcProcess *v7_RelatingProcess, ::Ifc2x3::IfcMeasureWithUnit *v8_QuantityInProcess)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToProduct : public Ifc2x3::IfcRelAssigns

The objectified relationshipIfcRelAssignsToProduct handles the assignment of objects (subtypes of IfcObject) to a product (subtypes of IfcProduct). The Name attribute should be used to classify the usage of the IfcRelAssignsToProduct objectified relationship. The following Name values are proposed:

‘Context’ : Assignment of a context specific representation, such as of structural members to a different context representation (with potentially different decomposition breakdown) such as of building elementsfor a specificcontext specific representation. ‘View’ : Assignment of a product (via RelatingProduct) that is decomposed according to a discipline view, to another product (via RelatedObjects) that is decomposed according to a different discipline view. An example is the assignment of the architectural slab to a different decomposition of the pre manufactured sections of a slab (under a precast concrete discipline view).

HISTORY New Entity in IFC Release 2x

IFC2x3 CHANGE The reference of a product within a spatial structure is now handled by a new relationship object IfcRelReferencedInSpatialStructure. The IfcRelAssignsToProduct shall not be used to represent this relation from IFC2x3 onwards.

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToProduct> list

Public Functions

::Ifc2x3::IfcProduct *RelatingProduct() const

Reference to the product or product type to which the objects are assigned to.

IFC2x4 CHANGE Datatype expanded to include IfcProduct and IfcTypeProduct.

void setRelatingProduct(::Ifc2x3::IfcProduct *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToProduct(IfcEntityInstanceData *e)
IfcRelAssignsToProduct(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcProduct *v7_RelatingProduct)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToProjectOrder : public Ifc2x3::IfcRelAssignsToControl

Public Functions

const IfcParse::entity &declaration() const
IfcRelAssignsToProjectOrder(IfcEntityInstanceData *e)
IfcRelAssignsToProjectOrder(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcControl *v7_RelatingControl)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssignsToResource : public Ifc2x3::IfcRelAssigns

The objectified relationship IfcRelAssignsToResource handles the assignment of objects (as subtypes of IfcObject), acting as a resource usage or consumption, to a resource (as subtypes of IfcResource).

EXAMPLE The assignment of a resource usage to a construction resource is an application of this generic relationship. It could be an actor, as person or organization assigned to a labor resource, or a raw product assigned to a construction product or material resource).

HISTORY New Entity in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcRelAssignsToResource> list

Public Functions

::Ifc2x3::IfcResource *RelatingResource() const

Reference to the resource to which the objects are assigned to.

IFC2x4 CHANGE Datatype expanded to include IfcResource and IfcTypeResource.

void setRelatingResource(::Ifc2x3::IfcResource *v)
const IfcParse::entity &declaration() const
IfcRelAssignsToResource(IfcEntityInstanceData *e)
IfcRelAssignsToResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcResource *v7_RelatingResource)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociates : public Ifc2x3::IfcRelationship

The association relationship IfcRelAssociates refers to external sources of information (most notably a classification, library or document). There is no dependency implied by the association.

EXAMPLE Further information may be given to the tank equipment (as subtype of IfcProduct) in terms of its classification and instruction documents, the source of the additional information is held external to the IFC project model.

Association relationships can be established to objects (occurrences as subtypes of IfcObject) or to types (as subtypes of IfcTypeObject).

EXAMPLE 1 The classification information for the storage tank equipment may be associated to the IfcTankType (subtype of IfcTypeObject), defining the specific information for all occurencies of that tank in the project. Therefore the association of the (e.g.) Uniclass notation ‘L6814’ may be associated by a subtype of IfcRelAssociates to the type information.

EXAMPLE 2 The classification information for a particular space within a building may the associated to the IfcSpace object (subtype of IfcObject), defining a particular occurrence of space. Therefore the association of the (e.g.) DIN notation ‘HNF 1.5’ may be associated by a subtype of IfcRelAssociates to the object.

The association relationship establishs a uni-directional association. The subtypes of IfcRelAssociates establishes the particular semantic meaning of the association relationship.

HISTORY New entity in IFC Release 2x.

IFC2x4 CHANGE Entity has been changed into an ABSTRACT supertype

Subclassed by Ifc2x3::IfcRelAssociatesAppliedValue, Ifc2x3::IfcRelAssociatesApproval, Ifc2x3::IfcRelAssociatesClassification, Ifc2x3::IfcRelAssociatesConstraint, Ifc2x3::IfcRelAssociatesDocument, Ifc2x3::IfcRelAssociatesLibrary, Ifc2x3::IfcRelAssociatesMaterial, Ifc2x3::IfcRelAssociatesProfileProperties

Public Types

typedef IfcTemplatedEntityList<IfcRelAssociates> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr RelatedObjects() const

Set of object or property definitions to which the external references or information is associated. It includes object and type objects, property set templates, property templates and property sets and contexts.

IFC2x4 CHANGE The attribute datatype has been changed from IfcRoot to IfcDefinitionSelect.

void setRelatedObjects(IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v)
const IfcParse::entity &declaration() const
IfcRelAssociates(IfcEntityInstanceData *e)
IfcRelAssociates(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesAppliedValue : public Ifc2x3::IfcRelAssociates

Public Functions

::Ifc2x3::IfcAppliedValue *RelatingAppliedValue() const
void setRelatingAppliedValue(::Ifc2x3::IfcAppliedValue *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesAppliedValue(IfcEntityInstanceData *e)
IfcRelAssociatesAppliedValue(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcAppliedValue *v6_RelatingAppliedValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesApproval : public Ifc2x3::IfcRelAssociates

The entity IfcRelAssociatesApproval is used to apply approval information defined by IfcApproval, in IfcApprovalResource schema, to subtypes of IfcRoot.

HISTORY: New entity in IFC2x2.

Public Functions

::Ifc2x3::IfcApproval *RelatingApproval() const

Reference to approval that is being applied using this relationship.

void setRelatingApproval(::Ifc2x3::IfcApproval *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesApproval(IfcEntityInstanceData *e)
IfcRelAssociatesApproval(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcApproval *v6_RelatingApproval)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesClassification : public Ifc2x3::IfcRelAssociates

The objectified relationship IfcRelAssociatesClassification handles the assignment of a classification item (items of the select IfcClassificationSelect) to objects occurrences (subtypes of IfcObject) or object types (subtypes of IfcTypeObject). The relationship is used to assign a classification item, or a classification system itself to objects. Depending on the type of the RelatingClassification it is either:

a reference to an classification item within an external classification system, or a reference to the classification system itself

NOTE The reference to a classification item includes a link to the classification system within which the item is declared. It assigns the meaning of the classification item to the object (ocurrence or type). The reference to the classification system provides the information that the object (occurrence or type) is governed by the classification system but no assignment of a particular items has been done yet.

The inherited attribute RelatedObjects define the objects or object types to which the classification is applied. The attribute RelatingClassification is the reference to a classification, applied to the object(s). A single RelatingClassification can thereby be applied to one or multiple objects.

HISTORY New entity in IFC Release 2x.

Public Functions

::Ifc2x3::IfcClassificationNotationSelect *RelatingClassification() const

Classification applied to the objects.

void setRelatingClassification(::Ifc2x3::IfcClassificationNotationSelect *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesClassification(IfcEntityInstanceData *e)
IfcRelAssociatesClassification(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcClassificationNotationSelect *v6_RelatingClassification)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesConstraint : public Ifc2x3::IfcRelAssociates

The entity IfcRelAssociatesConstraint is used to apply constraint information defined by IfcConstraint, in the IfcConstraintResource schema, to subtypes of IfcRoot.

HISTORY: New entity in IFC2x2.

Public Functions

std::string Intent() const

The intent of the constraint usage with regard to its related IfcConstraint and IfcObjects, IfcPropertyDefinitions or IfcRelationships. Typical values can be e.g. RATIONALE or EXPECTED PERFORMANCE.

void setIntent(std::string v)
::Ifc2x3::IfcConstraint *RelatingConstraint() const

Reference to constraint that is being applied using this relationship.

void setRelatingConstraint(::Ifc2x3::IfcConstraint *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesConstraint(IfcEntityInstanceData *e)
IfcRelAssociatesConstraint(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, std::string v6_Intent, ::Ifc2x3::IfcConstraint *v7_RelatingConstraint)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesDocument : public Ifc2x3::IfcRelAssociates

The objectified relationship (IfcRelAssociatesDocument) handles the assignment of a document information (items of the select IfcDocumentSelect) to objects occurrences (subtypes of IfcObject) or object types (subtypes of IfcTypeObject).

The relationship is used to assign a document reference or a more detailed document information to objects. A single document reference can be applied to multiple objects.

The inherited attribute RelatedObjects define the objects to which the document association is applied. The attribute RelatingDocument is the reference to a document reference, applied to the object(s).

HISTORY: New entity in IFC Release 2x.

Public Functions

::Ifc2x3::IfcDocumentSelect *RelatingDocument() const

Document information or reference which is applied to the objects.

void setRelatingDocument(::Ifc2x3::IfcDocumentSelect *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesDocument(IfcEntityInstanceData *e)
IfcRelAssociatesDocument(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcDocumentSelect *v6_RelatingDocument)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesLibrary : public Ifc2x3::IfcRelAssociates

The objectified relationship (IfcRelAssociatesLibrary) handles the assignment of a library item (items of the select IfcLibrarySelect) to subtypes of IfcObjectDefinition or IfcPropertyDefinition.

The relationship is used to assign a library reference or a more detailed link to a library information to objects, property sets or types. A single library reference can be applied to multiple items.

The inherited attribute RelatedObjects define the items to which the library association is applied. The attribute RelatingLibrary is the reference to a library reference, applied to the item(s).

HISTORY: New entity in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcRelAssociatesLibrary> list

Public Functions

::Ifc2x3::IfcLibrarySelect *RelatingLibrary() const

Reference to a library, from which the definition of the property set is taken.

void setRelatingLibrary(::Ifc2x3::IfcLibrarySelect *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesLibrary(IfcEntityInstanceData *e)
IfcRelAssociatesLibrary(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcLibrarySelect *v6_RelatingLibrary)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesMaterial : public Ifc2x3::IfcRelAssociates

Definition from IAI: Objectified relationship between a material definition and elements or element types to which this material definition applies. The material definition can be:

assigned to an element occurrence as a specific usage of a layer set or profile set assigned to an element occurrence or element type as a layer set, profile set, constituent set or a single material

Materials can be arranged by layers and applied to layered elements. Typical elements are walls and slabs.

An IfcMaterialLayerSet, for layered elements with an indication of the layering direction and individual layer thicknesses An IfcMaterialLayerSetUsage, i.e. a material layer set with positioning information along the reference axis or surface of the element. NOTE As a material layer set usage is an occurrence based information, that applies to each individual element, it cannot be assigned to an element type.

Material can be applied to profiles. Typical elements using profile material are beam, column, member

An IfcMaterialProfileSet, i.e. a set of material assigned to a set of profiles, with a single material assigned to a single profile as the default. An IfcMaterialProfileSetUsage, i.e. a material profile set with positioning information relative to the element axis, also refered to as cardinal point. NOTE As a material profile set usage is an occurrence based information, that applies to each individual element, it cannot be assigned to an element type.

Materials can be arranged by identified parts of a component based element. Typical elements are dorrs/windows (with components such as lining, framing and glazing), or distribution elements.

An IfcMaterialConstituentSet, for component based elements with an indication of the component by keyword to which the material consituent applies. NOTE See the material use definitions at each applicable subtype of IfcElement or IfcElementType for a provision of these keywords.

As a fallback, or in cases where only a single material information is needed, material information can be directly associated

A single IfcMaterial for any element where the material use definition does not prohibits its direct association An IfcMaterialList, e.g. for composite elements, without an information, how the different materials are arranged. NOTE The use of IfcMaterialList is deprecated in IFC2x4 onwards. Use IfcMaterialConstituentSet instead.

The IfcRelAssociatesMaterial relationship is a special type of the IfcRelAssociates relationship. It can be applied to subtypes of IfcElement and subtypes of IfcElementType.

The IfcElement has an inverse relation to its material definition by the HasAssociations attribute, inherited from IfcObject. The IfcElementType has an inverse relation to its material definition by the HasAssociations attribute, inherited from IfcPropertyDefinition.

If both, the element occurrence (by an instance of IfcElement) and the element type (by an instance of IfcElementType, connected through IfcRelDefinesByType) have an associated material, then the material associated to the element occurrence overrides the material associated to the element type.

HISTORY New entity in IFC Release 2.x.

Informal proposition

An IfcMaterialLayerSetUsage shall not be associated with a subtype of IfcElementType, it should only be associated with individual occurrences An IfcMaterialProfileSetUsage shall not be associated with a subtype of IfcElementType, it should only be associated with individual occurrences

Public Functions

::Ifc2x3::IfcMaterialSelect *RelatingMaterial() const

Material definition assigned to the elements or element types.

void setRelatingMaterial(::Ifc2x3::IfcMaterialSelect *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesMaterial(IfcEntityInstanceData *e)
IfcRelAssociatesMaterial(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcMaterialSelect *v6_RelatingMaterial)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelAssociatesProfileProperties : public Ifc2x3::IfcRelAssociates

Public Functions

::Ifc2x3::IfcProfileProperties *RelatingProfileProperties() const
void setRelatingProfileProperties(::Ifc2x3::IfcProfileProperties *v)
bool hasProfileSectionLocation() const

Whether the optional attribute ProfileSectionLocation is defined for this IfcRelAssociatesProfileProperties.

::Ifc2x3::IfcShapeAspect *ProfileSectionLocation() const
void setProfileSectionLocation(::Ifc2x3::IfcShapeAspect *v)
bool hasProfileOrientation() const

Whether the optional attribute ProfileOrientation is defined for this IfcRelAssociatesProfileProperties.

::Ifc2x3::IfcOrientationSelect *ProfileOrientation() const
void setProfileOrientation(::Ifc2x3::IfcOrientationSelect *v)
const IfcParse::entity &declaration() const
IfcRelAssociatesProfileProperties(IfcEntityInstanceData *e)
IfcRelAssociatesProfileProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcRoot>::ptr v5_RelatedObjects, ::Ifc2x3::IfcProfileProperties *v6_RelatingProfileProperties, ::Ifc2x3::IfcShapeAspect *v7_ProfileSectionLocation, ::Ifc2x3::IfcOrientationSelect *v8_ProfileOrientation)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelationship : public Ifc2x3::IfcRoot

IfcRelationship is the abstract generalization of all objectified relationships in IFC. Objectified relationships are the preferred way to handle relationships among objects. This allows to keep relationship specific properties directly at the relationship and opens the possibility to later handle relationship specific behavior.

There are two different types of relationships, 1-to-1 relationships and 1-to-many relationship. used within the subtypes of IfcRelationship. The following convention applies to all subtypes:

The two sides of the objectified relationship are named - Relating+ and - Related+ In case of the 1-to-many relationship, the related side of the relationship shall be an aggregate SET 1:N

HISTORY: New entity in IFC Release 1.0.

Subclassed by Ifc2x3::IfcRelAssigns, Ifc2x3::IfcRelAssociates, Ifc2x3::IfcRelConnects, Ifc2x3::IfcRelDecomposes, Ifc2x3::IfcRelDefines

Public Types

typedef IfcTemplatedEntityList<IfcRelationship> list

Public Functions

const IfcParse::entity &declaration() const
IfcRelationship(IfcEntityInstanceData *e)
IfcRelationship(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelaxation : public IfcUtil::IfcBaseEntity

Public Types

typedef IfcTemplatedEntityList<IfcRelaxation> list

Public Functions

double RelaxationValue() const
void setRelaxationValue(double v)
double InitialStress() const
void setInitialStress(double v)
const IfcParse::entity &declaration() const
IfcRelaxation(IfcEntityInstanceData *e)
IfcRelaxation(double v1_RelaxationValue, double v2_InitialStress)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnects : public Ifc2x3::IfcRelationship

IfcRelConnects is a connectivity relationship that connects objects under some criteria. As a general connectivity it does not imply constraints, however subtypes of the relationship define the applicable object types for the connectivity relationship and the semantics of the particular connectivity.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcRelConnectsElements, Ifc2x3::IfcRelConnectsPorts, Ifc2x3::IfcRelConnectsPortToElement, Ifc2x3::IfcRelConnectsStructuralActivity, Ifc2x3::IfcRelConnectsStructuralElement, Ifc2x3::IfcRelConnectsStructuralMember, Ifc2x3::IfcRelContainedInSpatialStructure, Ifc2x3::IfcRelCoversBldgElements, Ifc2x3::IfcRelCoversSpaces, Ifc2x3::IfcRelFillsElement, Ifc2x3::IfcRelFlowControlElements, Ifc2x3::IfcRelInteractionRequirements, Ifc2x3::IfcRelProjectsElement, Ifc2x3::IfcRelReferencedInSpatialStructure, Ifc2x3::IfcRelSequence, Ifc2x3::IfcRelServicesBuildings, Ifc2x3::IfcRelSpaceBoundary, Ifc2x3::IfcRelVoidsElement

Public Types

typedef IfcTemplatedEntityList<IfcRelConnects> list

Public Functions

const IfcParse::entity &declaration() const
IfcRelConnects(IfcEntityInstanceData *e)
IfcRelConnects(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsElements : public Ifc2x3::IfcRelConnects

Definition from IAI: The IfcRelConnectsElements objectified relationship provides the generalization of the connectivity between elements. It is a 1 to 1 relationship. The concept of two elements being physically or logically connected is described independently from the connecting elements. The connectivity may be related to the shape representation of the connected entities by providing a connection geometry.

In this case the geometrical constraints of the connection are provided by the optional relationship to the IfcConnectionGeometry. The connection geometry is provided as a point, curve or surface within the local placement coordinate systems of the connecting elements.

If the connection geometry is omitted then the connection is provided as a logical connection. Under this circumstance, the connection point, curve or surface has to be recalculated by the receiving application.

HISTORY New entity in IFC Release 1.0.

Subclassed by Ifc2x3::IfcRelConnectsPathElements, Ifc2x3::IfcRelConnectsWithRealizingElements

Public Types

typedef IfcTemplatedEntityList<IfcRelConnectsElements> list

Public Functions

bool hasConnectionGeometry() const

Whether the optional attribute ConnectionGeometry is defined for this IfcRelConnectsElements.

::Ifc2x3::IfcConnectionGeometry *ConnectionGeometry() const

The geometric shape representation of the connection geometry that is provided in the object coordinate system of the RelatingElement (mandatory) and in the object coordinate system of the RelatedElement (optionally).

void setConnectionGeometry(::Ifc2x3::IfcConnectionGeometry *v)
::Ifc2x3::IfcElement *RelatingElement() const

Reference to a subtype of IfcElement that is connected by the connection relationship in the role of RelatingElement.

void setRelatingElement(::Ifc2x3::IfcElement *v)
::Ifc2x3::IfcElement *RelatedElement() const

Reference to a subtype of IfcElement that is connected by the connection relationship in the role of RelatedElement.

void setRelatedElement(::Ifc2x3::IfcElement *v)
const IfcParse::entity &declaration() const
IfcRelConnectsElements(IfcEntityInstanceData *e)
IfcRelConnectsElements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcConnectionGeometry *v5_ConnectionGeometry, ::Ifc2x3::IfcElement *v6_RelatingElement, ::Ifc2x3::IfcElement *v7_RelatedElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsPathElements : public Ifc2x3::IfcRelConnectsElements

The IfcRelConnectsPathElements relationship provides the connectivity information between two elements, which have path information.

The objectified relationship provides the additional information required to describe the connection between two path based elements that might have single or multiple layers of material. The connection type specifies where at the path based element a connection is given (at the start, in the middle or at the end).

The connection is described by a connection geometry, given within the object coordinate systems of the RelatingElement and of the RelatedElement. In case of IfcWallStandardCase as the RelatingElement and RelatedElement the connection geometry is provided by the subtype IfcConnectionCurveGeometry. Both curves indicate the so called “end cap”, i.e. the curve that trims the wall outer edges (being parallel along the wall axis) at the end. HISTORY New entity in IFC Release 1.5.

Figure 115 shows the application of IfcRelConnectsPathElements with the ConnectionGeometry of type IfcConnectionCurveGeometry. The example shows the connection relationship between two instances of IfcWallStandardCase using the IfcRelConnectsPathElements relationship. The ConnectionCurveGeometry defines the CurveOnReleatingElement and CurveOnRelatedElement, both are of type IfcPolyline.

Figure 115 — Path connection geometry

Figure 116 illustrates using the IfcRelConnectsPathElements for a “T” type connection between two instances of IfcWallStandardCase. Figure 117 illustrates using the IfcRelConnectsPathElements for a “L” type connection between two instances of IfcWallStandardCase. NOTE The two wall axes connect in each case.

Figure 116 — Path connection T-Type Figure 117 — Path connection L-Type

Public Functions

std::vector<int> RelatingPriorities() const

Priorities for connection. It refers to the layers of the RelatingObject.

void setRelatingPriorities(std::vector<int> v)
std::vector<int> RelatedPriorities() const

Priorities for connection. It refers to the layers of the RelatedObject.

void setRelatedPriorities(std::vector<int> v)
::Ifc2x3::IfcConnectionTypeEnum::Value RelatedConnectionType() const

Indication of the connection type in relation to the path of the RelatingObject.

void setRelatedConnectionType(::Ifc2x3::IfcConnectionTypeEnum::Value v)
::Ifc2x3::IfcConnectionTypeEnum::Value RelatingConnectionType() const

Indication of the connection type in relation to the path of the RelatingObject.

void setRelatingConnectionType(::Ifc2x3::IfcConnectionTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRelConnectsPathElements(IfcEntityInstanceData *e)
IfcRelConnectsPathElements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcConnectionGeometry *v5_ConnectionGeometry, ::Ifc2x3::IfcElement *v6_RelatingElement, ::Ifc2x3::IfcElement *v7_RelatedElement, std::vector<int> v8_RelatingPriorities, std::vector<int> v9_RelatedPriorities, ::Ifc2x3::IfcConnectionTypeEnum::Value v10_RelatedConnectionType, ::Ifc2x3::IfcConnectionTypeEnum::Value v11_RelatingConnectionType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsPorts : public Ifc2x3::IfcRelConnects

Definition from IAI: An IfcRelConnectsPorts defines the relationship that is made between two ports at their point of connection. It may include the connection geometry between two ports.

IfcRelConnectsPorts is required for defining how instances of IfcPort connect together. Each of the port is being logically attached to the IfcElement by using the IfcRelConnectsPortToElement relationship.

HISTORY New entity in IFC 2.0, modified in IFC2x.

Public Types

typedef IfcTemplatedEntityList<IfcRelConnectsPorts> list

Public Functions

::Ifc2x3::IfcPort *RelatingPort() const

Reference to the first port that is connected by the objectified relationship.

void setRelatingPort(::Ifc2x3::IfcPort *v)
::Ifc2x3::IfcPort *RelatedPort() const

Reference to the second port that is connected by the objectified relationship.

void setRelatedPort(::Ifc2x3::IfcPort *v)
bool hasRealizingElement() const

Whether the optional attribute RealizingElement is defined for this IfcRelConnectsPorts.

::Ifc2x3::IfcElement *RealizingElement() const

Defines the element that realizes a port connection relationship.

void setRealizingElement(::Ifc2x3::IfcElement *v)
const IfcParse::entity &declaration() const
IfcRelConnectsPorts(IfcEntityInstanceData *e)
IfcRelConnectsPorts(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcPort *v5_RelatingPort, ::Ifc2x3::IfcPort *v6_RelatedPort, ::Ifc2x3::IfcElement *v7_RealizingElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsPortToElement : public Ifc2x3::IfcRelConnects

The objectified relationship IfcRelConnectsPortToElement defines the relationship that is made between a port and the IfcElement, or IfcElementType in which it is contained. It is a 1 to 1 relationship.

The IfcRelConnectsPortToElement established a whole part relationship between the element and its port. The port is used as the means to connect to other ports in other elements. Since both, the element-to-port, and the port-to-port relationships are 1:1 relationships, a topological system (or system path or ciruit) can be defined.

Ports contained in different elements are connected to each other using the IfcRelConnectsPorts relationship.

See relevant subtypes of IfcDistributionElement for examples and port use definition sections.

HISTORY New entity in Release IFC2x Edition 2. IFC2x4 CHANGE The definition has been extended to include element types.

Public Functions

::Ifc2x3::IfcPort *RelatingPort() const

Reference to an Port that is connected by the objectified relationship.

void setRelatingPort(::Ifc2x3::IfcPort *v)
::Ifc2x3::IfcElement *RelatedElement() const

Reference to an IfcElement, or IfcElementType that has ports assigned.

IFC2x4 CHANGE Data type extended to IfcObjectDefinition to enable elements and element types for the port relationship.

void setRelatedElement(::Ifc2x3::IfcElement *v)
const IfcParse::entity &declaration() const
IfcRelConnectsPortToElement(IfcEntityInstanceData *e)
IfcRelConnectsPortToElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcPort *v5_RelatingPort, ::Ifc2x3::IfcElement *v6_RelatedElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsStructuralActivity : public Ifc2x3::IfcRelConnects

Definition from IAI: The IfcRelConnectsStructuralActivity relationship connects a structural activity (either an action or reaction) to a structural member, structural connection, or element.

HISTORY: New entity in IFC 2x2.

Public Functions

::Ifc2x3::IfcStructuralActivityAssignmentSelect *RelatingElement() const

Reference to a structural item or element to which the specified activity is applied.

void setRelatingElement(::Ifc2x3::IfcStructuralActivityAssignmentSelect *v)
::Ifc2x3::IfcStructuralActivity *RelatedStructuralActivity() const

Reference to a structural activity which is acting upon the specified structural item or element.

void setRelatedStructuralActivity(::Ifc2x3::IfcStructuralActivity *v)
const IfcParse::entity &declaration() const
IfcRelConnectsStructuralActivity(IfcEntityInstanceData *e)
IfcRelConnectsStructuralActivity(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcStructuralActivityAssignmentSelect *v5_RelatingElement, ::Ifc2x3::IfcStructuralActivity *v6_RelatedStructuralActivity)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsStructuralElement : public Ifc2x3::IfcRelConnects

Public Functions

::Ifc2x3::IfcElement *RelatingElement() const
void setRelatingElement(::Ifc2x3::IfcElement *v)
::Ifc2x3::IfcStructuralMember *RelatedStructuralMember() const
void setRelatedStructuralMember(::Ifc2x3::IfcStructuralMember *v)
const IfcParse::entity &declaration() const
IfcRelConnectsStructuralElement(IfcEntityInstanceData *e)
IfcRelConnectsStructuralElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcElement *v5_RelatingElement, ::Ifc2x3::IfcStructuralMember *v6_RelatedStructuralMember)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsStructuralMember : public Ifc2x3::IfcRelConnects

The entity IfcRelConnectsStructuralMember defines all needed properties describing the connection between structural members and structural connection objects (nodes or supports).

HISTORY New entity in IFC2x2.

Use Definition

Point Connection Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralPointConnection and either an instance of IfcStructuralCurveMember or IfcStructuralSurfaceMember. The RelatedStructuralConnection for point connections has to be of type IfcStructuralPointConnection.

Curve Connection Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralCurveConnection and an instance of either IfcStructuralCurveMember or IfcStructuralSurfaceMember. The RelatedStructuralConnection for curve connections has to be of type IfcStructuralCurveConnection.

Surface Connection Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralSurfaceConnection and an instance of IfcStructuralSurfaceMember. The RelatedStructuralConnection for curve connections has to be of type IfcStructuralSurfaceConnection.

Coordinate System for Applied Conditions All values defined by AppliedCondition or AdditionalConditions are given within the coordinate system provided by ConditionCoordinateSystem, which is defined relative to the local coordinate system of the structural member. If the ConditionCoordinateSystem is not defined, the local coordinate system of the structural member is used instead.

Supported Length Optionally a supported length can be given, which specifies the length (or width) of the physical connection along a curve connection.

Figure 235 illustrates the appropriate definition of support lengths.

Figure 235 — Structural member support lengths

Subclassed by Ifc2x3::IfcRelConnectsWithEccentricity

Public Functions

::Ifc2x3::IfcStructuralMember *RelatingStructuralMember() const

Reference to an instance of IfcStructuralMember (or its subclasses) which is connected to the specified structural connection.

void setRelatingStructuralMember(::Ifc2x3::IfcStructuralMember *v)
::Ifc2x3::IfcStructuralConnection *RelatedStructuralConnection() const

Reference to an instance of IfcStructuralConnection (or its subclasses) which is connected to the specified structural member.

void setRelatedStructuralConnection(::Ifc2x3::IfcStructuralConnection *v)
bool hasAppliedCondition() const

Whether the optional attribute AppliedCondition is defined for this IfcRelConnectsStructuralMember.

::Ifc2x3::IfcBoundaryCondition *AppliedCondition() const

Conditions which define the connections properties. Connection conditions are often called “release” but are not only used to define mechanisms like hinges but also rigid, elastic, and other conditions.

void setAppliedCondition(::Ifc2x3::IfcBoundaryCondition *v)
bool hasAdditionalConditions() const

Whether the optional attribute AdditionalConditions is defined for this IfcRelConnectsStructuralMember.

::Ifc2x3::IfcStructuralConnectionCondition *AdditionalConditions() const

Describes additional connection properties.

void setAdditionalConditions(::Ifc2x3::IfcStructuralConnectionCondition *v)
bool hasSupportedLength() const

Whether the optional attribute SupportedLength is defined for this IfcRelConnectsStructuralMember.

double SupportedLength() const

Defines the ‘supported length’ of this structural connection. See Fig. for more detail.

void setSupportedLength(double v)
bool hasConditionCoordinateSystem() const

Whether the optional attribute ConditionCoordinateSystem is defined for this IfcRelConnectsStructuralMember.

::Ifc2x3::IfcAxis2Placement3D *ConditionCoordinateSystem() const

Defines a coordinate system used for the description of the connection properties in ConnectionCondition relative to the local coordinate system of RelatingStructuralMember. If left unspecified, the placement IfcAxis2Placement3D((x,y,z), ?, ?) is implied with x,y,z being the local member coordinates where the connection is made and the default axes directions being in parallel with the local axes of RelatingStructuralMember.

void setConditionCoordinateSystem(::Ifc2x3::IfcAxis2Placement3D *v)
const IfcParse::entity &declaration() const
IfcRelConnectsStructuralMember(IfcEntityInstanceData *e)
IfcRelConnectsStructuralMember(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcStructuralMember *v5_RelatingStructuralMember, ::Ifc2x3::IfcStructuralConnection *v6_RelatedStructuralConnection, ::Ifc2x3::IfcBoundaryCondition *v7_AppliedCondition, ::Ifc2x3::IfcStructuralConnectionCondition *v8_AdditionalConditions, boost::optional<double> v9_SupportedLength, ::Ifc2x3::IfcAxis2Placement3D *v10_ConditionCoordinateSystem)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsWithEccentricity : public Ifc2x3::IfcRelConnectsStructuralMember

Definition from IAI: The entity IfcRelConnectsWithEccentricity adds the definition of eccentricity to the connection between a structural member and a structural connection (representing either a node or support).

NOTE Another eccentricity model is available independently of eccentric connection specification: The section profile of a curve member may be inserted eccentrically with respect to the member’s reference curve, see definitions at IfcStructuralCurveMember. Whether one or the other or both eccentricity models may be used is subject to information requirements and local agreements.

HISTORY New entity in IFC 2x3. Use definitions changed in IFC 2x4 to always require two topology items.

Use Definition

Point Connection ConnectionConstraint shall be of type IfcConnectionPointGeometry and shall refer to two instances of IfcVertexPoint.

Curve Connection ConnectionConstraint shall be of type IfcConnectionCurveGeometry and shall refer to two instances of IfcEdge or subtypes.

Surface Connection ConnectionConstraint shall be of type IfcConnectionSurfaceGeometry and shall refer to two instances of IfcFaceSurface.

Public Functions

::Ifc2x3::IfcConnectionGeometry *ConnectionConstraint() const

The connection constraint explicitly states the eccentricity between a structural member and a structural connection by means of two topological objects (vertex and vertex, or edge and edge, or face and face).

void setConnectionConstraint(::Ifc2x3::IfcConnectionGeometry *v)
const IfcParse::entity &declaration() const
IfcRelConnectsWithEccentricity(IfcEntityInstanceData *e)
IfcRelConnectsWithEccentricity(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcStructuralMember *v5_RelatingStructuralMember, ::Ifc2x3::IfcStructuralConnection *v6_RelatedStructuralConnection, ::Ifc2x3::IfcBoundaryCondition *v7_AppliedCondition, ::Ifc2x3::IfcStructuralConnectionCondition *v8_AdditionalConditions, boost::optional<double> v9_SupportedLength, ::Ifc2x3::IfcAxis2Placement3D *v10_ConditionCoordinateSystem, ::Ifc2x3::IfcConnectionGeometry *v11_ConnectionConstraint)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelConnectsWithRealizingElements : public Ifc2x3::IfcRelConnectsElements

Definition from IAI: IfcRelConnectsWithRealizingElements defines a generic relationship that is made between two elements that require the realization of that relationship by means of further realizing elements.

An IfcRelConnectsWithRealizingElements is a specialization of IfcRelConnectsElement where the connecting operation has the additional attribute of (one or many) realizing elements that may be used to realize or further qualify the relationship. It is defined as a ternary relationship.

EXAMPLE: It may be used to describe the attachment of one element to another where the attachment is realized by a ‘fixing’ element such as a bracket. It may also be used to describe the mounting of one element onto another such as the requirement for the mounting major plant items onto builders work bases and/or anti-vibration isolators.

HISTORY: New entity in Release IFC2x Edition 2.

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcElement>::ptr RealizingElements() const

Defines the elements that realize a connection relationship.

void setRealizingElements(IfcTemplatedEntityList<::Ifc2x3::IfcElement>::ptr v)
bool hasConnectionType() const

Whether the optional attribute ConnectionType is defined for this IfcRelConnectsWithRealizingElements.

std::string ConnectionType() const

The type of the connection given for informal purposes, it may include labels, like ‘joint’, ‘rigid joint’, ‘flexible joint’, etc.

void setConnectionType(std::string v)
const IfcParse::entity &declaration() const
IfcRelConnectsWithRealizingElements(IfcEntityInstanceData *e)
IfcRelConnectsWithRealizingElements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcConnectionGeometry *v5_ConnectionGeometry, ::Ifc2x3::IfcElement *v6_RelatingElement, ::Ifc2x3::IfcElement *v7_RelatedElement, IfcTemplatedEntityList<::Ifc2x3::IfcElement>::ptr v8_RealizingElements, boost::optional<std::string> v9_ConnectionType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelContainedInSpatialStructure : public Ifc2x3::IfcRelConnects

This objectified relationship, IfcRelContainedInSpatialStructure, is used to assign elements to a certain level of the spatial project structure. Any element can only be assigned once to a certain level of the spatial structure. The question, which level is relevant for which type of element, can only be answered within the context of a particular project and might vary within the various regions.

EXAMPLE A multi-storey space is contained (or belongs to) the building storey at which its ground level is, but it is referenced by all the other building storeys, in which it spans. A lift shaft might be contained by the basement, but referenced by all storeys, through which it spans.

The containment relationship of an element within a spatial structure has to be a hierarchical relationship, an element can only be contained within a single spatial structure element. The reference relationship between an element and the spatial structure may not be hierarchical, i.e. an element can reference many spatial structure elements.

NOTE The reference relationship is expressed by IfcRelReferencedInSpatialStructure.

Predefined spatial structure elements to which elements can be assigned are

site as IfcSite

building as IfcBuilding

storey as IfcBuildingStorey

space as IfcSpace

Occurrences of the same element type can be assigned to different spatial structure elements depending on the context of the occurrence.

EXAMPLE A wall might be normally assigned to a storey, however the curtain wall might be assigned to the building and the retaining wall in the terrain might be assigned to the site.

HISTORY New entity in IFC Release 2x.

IFC2x PLATFORM CHANGE: The data type of the attribute RelatedElements has been changed from IfcElement to its supertype IfcProduct with upward compatibility for file based exchange.

Containment Use Definition Figure 39 shows the use of IfcRelContainedInSpatialStructure to assign a stair and two walls to two different levels within the spatial structure.

Figure 39 — Relationship for spatial structure containment

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr RelatedElements() const

Set of elements products, which are contained within this level of the spatial structure hierarchy.

IFC2x PLATFORM CHANGE The data type has been changed from IfcElement to IfcProduct with upward compatibility

void setRelatedElements(IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr v)
::Ifc2x3::IfcSpatialStructureElement *RelatingStructure() const

Spatial structure element, within which the element is contained. Any element can only be contained within one element of the project spatial structure.

void setRelatingStructure(::Ifc2x3::IfcSpatialStructureElement *v)
const IfcParse::entity &declaration() const
IfcRelContainedInSpatialStructure(IfcEntityInstanceData *e)
IfcRelContainedInSpatialStructure(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr v5_RelatedElements, ::Ifc2x3::IfcSpatialStructureElement *v6_RelatingStructure)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelCoversBldgElements : public Ifc2x3::IfcRelConnects

Definition from IAI: The IfcRelCoversBldgElements is an objectified relationship between an element and one to many coverings, which cover the building element.

IfcRelCoversBldgElements, this relationship, expresses the primary relation to the element, IfcRelCoversSpaces expresses the primary relation to the space.

HISTORY New Entity in IFC Release 1.5 IFC2x4 CHANGE: The data type of the attribute RelatingElement has been changed from IfcElement to its subtype IfcBuildingElement.

Public Functions

::Ifc2x3::IfcElement *RelatingBuildingElement() const

Relationship to the building element that is covered.

IFC2x4 CHANGE: The attribute type has been changed from IfcElement to IfcBuildingElement.

void setRelatingBuildingElement(::Ifc2x3::IfcElement *v)
IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr RelatedCoverings() const

Relationship to the set of coverings at this element.

void setRelatedCoverings(IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr v)
const IfcParse::entity &declaration() const
IfcRelCoversBldgElements(IfcEntityInstanceData *e)
IfcRelCoversBldgElements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcElement *v5_RelatingBuildingElement, IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr v6_RelatedCoverings)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelCoversSpaces : public Ifc2x3::IfcRelConnects

Definition from IAI: The objectified relationship, IfcRelCoversSpace, relatesa space object to one or many coverings, which faces (or is assigned to) the space.

NOTE Particularly floorings, ceilings and wall coverings, such as claddings or tiling are often considered as space coverings, rather then wall or slab coverings. In some life cycle phases, such as the operation phase, the relationship is always made to the space.

The IFC specification provides two relationships:

IfcRelCoversBldgElements to assign coverings to elements, and

IfcRelCoversSpaces to assign coverings to spaces

Which relationship should be applied has to be determined by the context of the project or application .

NOTE View definition may determine the necessity to use either of the two relationship elements

HISTORY New Entity in Release IFC 2x Edition 3.

Public Types

typedef IfcTemplatedEntityList<IfcRelCoversSpaces> list

Public Functions

::Ifc2x3::IfcSpace *RelatedSpace() const
void setRelatedSpace(::Ifc2x3::IfcSpace *v)
IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr RelatedCoverings() const

Relationship to the set of coverings covering this space.

void setRelatedCoverings(IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr v)
const IfcParse::entity &declaration() const
IfcRelCoversSpaces(IfcEntityInstanceData *e)
IfcRelCoversSpaces(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcSpace *v5_RelatedSpace, IfcTemplatedEntityList<::Ifc2x3::IfcCovering>::ptr v6_RelatedCoverings)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelDecomposes : public Ifc2x3::IfcRelationship

The decomposition relationship, IfcRelDecomposes, defines the general concept of elements being composed or decomposed. The decomposition relationship denotes a whole/part hierarchy with the ability to navigate from the whole (the composition) to the parts and vice versa. Decompositions may be constrained by requiring both, the whole and its parts, to be of the same type - thus establishing a nesting relationship. Or they may require some form of physical containment, thus establishing special types of aggregation relationships. NOTE There are two special names for decomposition, which are linguistically distinguished, nesting and aggregation. The subtypes of IfcRelDecomposes will introduce either the nesting or aggregation convention (see IfcRelNests and IfcRelAggregates). EXAMPLE A cost element is a nest of other cost elements. Or a structural frame is an aggregation of beams and columns. Both are applications of decomposition relationship. Decompositions imply a dependency, i.e. the definition of the whole depends on the definition of the parts and the parts depend on the existence of the whole. The decomposition relationship can be applied in a recursive manner, i.e. a decomposed element can be part in another decomposition. Cyclic references have to be prevented at application level.

HISTORY New entity in IFC Release 1.5, it is a generalisation of the IFC2.0 entity IfcRelNests.

IFC2x4 CHANGE The differentiation between the aggregation and nesting is determined to be a non-ordered or an ordered collection of parts. The attributes RelatingObject and RelatedObjects have been demoted to the subtypes.

Subclassed by Ifc2x3::IfcRelAggregates, Ifc2x3::IfcRelNests

Public Types

typedef IfcTemplatedEntityList<IfcRelDecomposes> list

Public Functions

::Ifc2x3::IfcObjectDefinition *RelatingObject() const
void setRelatingObject(::Ifc2x3::IfcObjectDefinition *v)
IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr RelatedObjects() const
void setRelatedObjects(IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v)
const IfcParse::entity &declaration() const
IfcRelDecomposes(IfcEntityInstanceData *e)
IfcRelDecomposes(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcObjectDefinition *v5_RelatingObject, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v6_RelatedObjects)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelDefines : public Ifc2x3::IfcRelationship

A generic and abstract relationship which subtypes are used to:

assign a object type to an object occurrence assign a property set to an object instance assign a property set template to a property set

EXAMPLE Several instances of windows within the IFC project model may be of the same (catalogue or manufacturer) type. Thereby they share the same properties. This relationship is established by the subtype IfcRelDefinesByType of IfcRelDefines relationship assigning an IfcWindowStyle to multiple occurrences IfcWindow.

EXAMPLE The (same) property set, e.g. Pset_ProductManufacturerInfo, keeping the manufacturer name, label and production year of a product, can be assigned to one, or many instances of furnishing. This relationship is established by the subtype IfcRelDefinesByProperties of IfcRelDefines relationship assigning an IfcPropertySet to one or more instances of IfcFurnishingElement.

HISTORY New entity in IFC2x.

IFC2x4 CHANGE The attribute RelatedObjects had been demoted to the subtypes IfcRelDefinesByProperties and IfcRelDefinesByType.

Subclassed by Ifc2x3::IfcRelDefinesByProperties, Ifc2x3::IfcRelDefinesByType

Public Types

typedef IfcTemplatedEntityList<IfcRelDefines> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr RelatedObjects() const
void setRelatedObjects(IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr v)
const IfcParse::entity &declaration() const
IfcRelDefines(IfcEntityInstanceData *e)
IfcRelDefines(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr v5_RelatedObjects)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelDefinesByProperties : public Ifc2x3::IfcRelDefines

The objectified relationship IfcRelDefinesByProperties defines the relationships between property set definitions and objects. Properties are aggregated in property sets. Property sets can be either directly assigned to occurrence objects using this relationship, or assigned to an object type and assigned via that type to occurrence objects. The IfcRelDefinesByProperties is a 1-to-N relationship, as it allows for the assignment of one property set to a single or to many objects. Those objects then share the same property definition.

HISTORY New Entity in IFC Release 2.0. Has been renamed from IfcRelAssignsProperties in IFC Release 2x.

IFC2x4 CHANGE The attribute RelatedObjects had been demoted from the supertype IfcRelDefines to IfcRelDefinesByProperties.

Subclassed by Ifc2x3::IfcRelOverridesProperties

Public Functions

::Ifc2x3::IfcPropertySetDefinition *RelatingPropertyDefinition() const

Reference to the property set definition for that object or set of objects.

void setRelatingPropertyDefinition(::Ifc2x3::IfcPropertySetDefinition *v)
const IfcParse::entity &declaration() const
IfcRelDefinesByProperties(IfcEntityInstanceData *e)
IfcRelDefinesByProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr v5_RelatedObjects, ::Ifc2x3::IfcPropertySetDefinition *v6_RelatingPropertyDefinition)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelDefinesByType : public Ifc2x3::IfcRelDefines

The objectified relationship IfcRelDefinesByType defines the relationship between an object type and object occurrences. The IfcRelDefinesByType is a 1-to-N relationship, as it allows for the assignment of one type information to a single or to many objects. Those objects then share the same object type, and the property sets and properties assigned to the object type.

HISTORY New entity in IFC2x.

IFC2x4 CHANGE The attribute RelatedObjects had been demoted from the supertype IfcRelDefines to IfcRelDefinesByType.

Relationship use definition

The IfcRelDefinesByType links the object type definition with the object occurrence. Both may define properties by assigning an IfcPropertySet, including one or many subtypes of IfcProperty to either the object type or object occurrence, as shown in Figure 8. There are several scenarios to define the same property set on the object type definition and object occurrence side:

All properties for all object occurrences of a common object type have the same value - then only the object type definition has a property set assigned. All properties for all object occurrences are different, that is there are no common property values for the object type definition - then each of the object occurrence has a property set assigned. Some properties within the same property set have common values and are assigned to the object type definition and some are occurrence specific and assigned (with potentially different values) to the object occurrences - then:

The sum of all properties within a given property set applicable to an object occurrence is the union of properties assigned to the object type definition plus the properties assigned to the object occurrence. If the object occurrence has a property with the same IfcProperty.Name in an IfcPropertySet, as the corresponding object type definition, then the occurrence property value overrides the type property value.

Figure 8 — Type definition relationships

The following table provides an example of assigning

properties assigned to IfcWall properties assigned to IfcWallType resulting property value for individual wall

Pset_WallCommon Pset_WallCommon

-ExtendToStructure = TRUE

TRUE

-ThermalTransmittance = 0.375 0.375

-ExtendToStructure = FALSE -ExtendToStructure = TRUE FALSE

Public Types

typedef IfcTemplatedEntityList<IfcRelDefinesByType> list

Public Functions

::Ifc2x3::IfcTypeObject *RelatingType() const

Reference to the type (or style) information for that object or set of objects.

void setRelatingType(::Ifc2x3::IfcTypeObject *v)
const IfcParse::entity &declaration() const
IfcRelDefinesByType(IfcEntityInstanceData *e)
IfcRelDefinesByType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr v5_RelatedObjects, ::Ifc2x3::IfcTypeObject *v6_RelatingType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelFillsElement : public Ifc2x3::IfcRelConnects

IfcRelFillsElement is an objectified relationship between an opening element and an element that fills (or partially fills) the opening element. It is an one-to-one relationship.

NOTE view definitions or implementer agreements may restrict an opening to be filled by one filling element only.

HISTORY New entity in IFC Release 1.0

As shown in Figure 40, the insertion of a door into a wall is represented by two separate relationships. First the door opening is created within the wall by IfcWall(StandardCase) o IfcRelVoidsElement o IfcOpeningElement, then the door is inserted within the opening by IfcOpeningElement o IfcRelFillsElement o IfcDoor.

Figure 40 — Relationships for element filling

Public Types

typedef IfcTemplatedEntityList<IfcRelFillsElement> list

Public Functions

::Ifc2x3::IfcOpeningElement *RelatingOpeningElement() const

Opening Element being filled by virtue of this relationship.

void setRelatingOpeningElement(::Ifc2x3::IfcOpeningElement *v)
::Ifc2x3::IfcElement *RelatedBuildingElement() const

Reference to building element that occupies fully or partially the associated opening.

IFC2x PLATFORM CHANGE: The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file based exchange.

void setRelatedBuildingElement(::Ifc2x3::IfcElement *v)
const IfcParse::entity &declaration() const
IfcRelFillsElement(IfcEntityInstanceData *e)
IfcRelFillsElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcOpeningElement *v5_RelatingOpeningElement, ::Ifc2x3::IfcElement *v6_RelatedBuildingElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelFlowControlElements : public Ifc2x3::IfcRelConnects

Objectified relationship between a distribution flow element occurrence instance and one-to-many control element occurrence instances indicating that the control element(s) sense or control some aspect of the flow element. It is applied to IfcDistributionFlowElement and IfcDistributionControlElement.

This relationship may be used to indicate an operation relationship such as an actuator operating a valve, damper, or switch. It may also be used to indicate a sensing relationship such as a sensor detecting conditions of fluid flow.

This relationship implies a sensing or controlling relationship; if elements are merely connected without any control relationship, then IfcRelConnectsElements should be used.

HISTORY: New entity in IFC R2x.

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcDistributionControlElement>::ptr RelatedControlElements() const

References control elements which may be used to impart control on the Distribution Element.

void setRelatedControlElements(IfcTemplatedEntityList<::Ifc2x3::IfcDistributionControlElement>::ptr v)
::Ifc2x3::IfcDistributionFlowElement *RelatingFlowElement() const

Relationship to a distribution flow element.

void setRelatingFlowElement(::Ifc2x3::IfcDistributionFlowElement *v)
const IfcParse::entity &declaration() const
IfcRelFlowControlElements(IfcEntityInstanceData *e)
IfcRelFlowControlElements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcDistributionControlElement>::ptr v5_RelatedControlElements, ::Ifc2x3::IfcDistributionFlowElement *v6_RelatingFlowElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelInteractionRequirements : public Ifc2x3::IfcRelConnects

Public Functions

bool hasDailyInteraction() const

Whether the optional attribute DailyInteraction is defined for this IfcRelInteractionRequirements.

double DailyInteraction() const
void setDailyInteraction(double v)
bool hasImportanceRating() const

Whether the optional attribute ImportanceRating is defined for this IfcRelInteractionRequirements.

double ImportanceRating() const
void setImportanceRating(double v)
bool hasLocationOfInteraction() const

Whether the optional attribute LocationOfInteraction is defined for this IfcRelInteractionRequirements.

::Ifc2x3::IfcSpatialStructureElement *LocationOfInteraction() const
void setLocationOfInteraction(::Ifc2x3::IfcSpatialStructureElement *v)
::Ifc2x3::IfcSpaceProgram *RelatedSpaceProgram() const
void setRelatedSpaceProgram(::Ifc2x3::IfcSpaceProgram *v)
::Ifc2x3::IfcSpaceProgram *RelatingSpaceProgram() const
void setRelatingSpaceProgram(::Ifc2x3::IfcSpaceProgram *v)
const IfcParse::entity &declaration() const
IfcRelInteractionRequirements(IfcEntityInstanceData *e)
IfcRelInteractionRequirements(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<double> v5_DailyInteraction, boost::optional<double> v6_ImportanceRating, ::Ifc2x3::IfcSpatialStructureElement *v7_LocationOfInteraction, ::Ifc2x3::IfcSpaceProgram *v8_RelatedSpaceProgram, ::Ifc2x3::IfcSpaceProgram *v9_RelatingSpaceProgram)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelNests : public Ifc2x3::IfcRelDecomposes

The nesting relationship IfcRelNests is a special type of the general composition/decomposition (or whole/part) relationship IfcRelDecomposes. The nesting relationship can be applied to all non physical subtypes of object and object types, namely processes, controls (like cost items), and resources. The nesting implies an order among the nested parts. EXAMPLE1 A nesting of costs items in a cost schedule is the composition of complex cost items from other cost items. The order of the nested cost items underneath the parent cost item is determined by the order of the list of RelatedObjects. EXAMPLE2 A nesting of work tasks within a work schedule is the composition of a parent work task from more specific sub work tasks. The order of the sub tasks underneath the parent task is determined by the order of the list of RelatedObjects.. Decompositions imply a dependency, i.e. the definition of the whole depends on the definition of the parts and the parts depend on the existence of the whole. The behaviour that is implied from the dependency has to be established inside the applications.

HISTORY New entity in IFC Release 2.0

IFC2x4 CHANGE The attributes RelatingObject and RelatedObjects are demoted from the supertype IfcRelDecomposes, and RelatedObjects is refined to be a list. The use of IfcRelNests is repurposed to be a nesting of an ordered collections of parts.

Public Types

typedef IfcTemplatedEntityList<IfcRelNests> list

Public Functions

const IfcParse::entity &declaration() const
IfcRelNests(IfcEntityInstanceData *e)
IfcRelNests(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcObjectDefinition *v5_RelatingObject, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v6_RelatedObjects)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelOccupiesSpaces : public Ifc2x3::IfcRelAssignsToActor

Public Types

typedef IfcTemplatedEntityList<IfcRelOccupiesSpaces> list

Public Functions

const IfcParse::entity &declaration() const
IfcRelOccupiesSpaces(IfcEntityInstanceData *e)
IfcRelOccupiesSpaces(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcActor *v7_RelatingActor, ::Ifc2x3::IfcActorRole *v8_ActingRole)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelOverridesProperties : public Ifc2x3::IfcRelDefinesByProperties

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr OverridingProperties() const
void setOverridingProperties(IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v)
const IfcParse::entity &declaration() const
IfcRelOverridesProperties(IfcEntityInstanceData *e)
IfcRelOverridesProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObject>::ptr v5_RelatedObjects, ::Ifc2x3::IfcPropertySetDefinition *v6_RelatingPropertyDefinition, IfcTemplatedEntityList<::Ifc2x3::IfcProperty>::ptr v7_OverridingProperties)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelProjectsElement : public Ifc2x3::IfcRelConnects

The IfcRelProjectsElement is an objectified relationship between an element and one projection element that creates a modifier to the shape of the element. The relationship is defined to be a 1:1 relationship, if an element has more than one projection, several relationship objects have to be used, each pointing to a different projection element. The IfcRelProjectsElement establishes an aggregation relationship between the main element and a sub ordinary addition feature.

NOTE In contrary the IfcRelAggregates relationship established an aggregation of equal parts to a whole.

The IfcRelProjectsElement implies a Boolean operation of addition for the geometric bodies of the element and the feature element. As with all decomposition relationships it determines:

existence dependency - the RelatedFeatureElement cannot exist without the RelatingElement hierarchical and non-cyclical relationship - the IfcRelProjectsElement can only alter a single IfcElement no spatial containment - the IfcFeatureElementAddition as related element never participates in the hiearchical spatial containment relationship IfcRelContainedInSpatialStructure

HISTORY New entity in Release IFC2x Edition 2. IFC2x4 CHANGE Supertype changed to IfcRelDecomposes.

Public Types

typedef IfcTemplatedEntityList<IfcRelProjectsElement> list

Public Functions

::Ifc2x3::IfcElement *RelatingElement() const

Element at which a projection is created by the associated IfcProjectionElement.

void setRelatingElement(::Ifc2x3::IfcElement *v)
::Ifc2x3::IfcFeatureElementAddition *RelatedFeatureElement() const

Reference to the IfcFeatureElementAddition that defines an addition to the volume of the element, by using a Boolean addition operation. An example is a projection at the associated element.

void setRelatedFeatureElement(::Ifc2x3::IfcFeatureElementAddition *v)
const IfcParse::entity &declaration() const
IfcRelProjectsElement(IfcEntityInstanceData *e)
IfcRelProjectsElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcElement *v5_RelatingElement, ::Ifc2x3::IfcFeatureElementAddition *v6_RelatedFeatureElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelReferencedInSpatialStructure : public Ifc2x3::IfcRelConnects

The objectified relationship, IfcRelReferencedInSpatialStructure is used to assign elements in addition to those levels of the project spatialstructure, in which they are referenced, but not primarily contained.

NOTE The primary containment relationship between an element and the spatial structure is handled byIfcRelContainsInSpatialStructure.

Any element can be referencedto zero, one or several levels of the spatial structure. Whereas the IfcRelContainsInSpatialStructure relationship is required to be hierarchical (an element can only be contained in exactly one spatial structure element), the IfcRelReferencedInSpatialStructure is not restricted to be hierarchical.

EXAMPLE A wall might be normally contained within a storey, and since it does not span through several stories, it is not referenced in any additional storey. However a curtain wall might span through several stories, in this case it can be contained within the ground floor, but it would be referenced by all additional stories, it spans.

Predefined spatial structure elements to which elements can be assigned are

site as IfcSite

building as IfcBuilding

storey as IfcBuildingStorey

space as IfcSpace

Elements can also be references in a spatial zone that is provided as IfcSpatialZone.

The same element can be assigned to different spatial structure elements depending on the context.

HISTORY New entity inRelease IFC2x Edition 3.

Use Definition Figure 41 shows the use of IfcRelContainedInSpatialStructure and IfcRelReferencedInSpatialStructure to assign an IfcCurtainWallto two different levels within the spatial structure. It is primarily contained within the ground floor, and additionally referenced within the first and second floor.

Figure 41 — Relationship for spatial structure referencing

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr RelatedElements() const

Set of products, which are referenced within this level of the spatial structure hierarchy. NOTE Referenced elements are contained elsewhere within the spatial structure, they are referenced additionally by this spatial structure element, e.g., because they span several stories.

void setRelatedElements(IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr v)
::Ifc2x3::IfcSpatialStructureElement *RelatingStructure() const

Spatial structure element, within which the element is referenced. Any element can be contained within zero, one or many elements of the project spatial and zoning structure.

IFC2x Edition 4 CHANGE The attribute relatingStructure as been promoted to the new supertype IfcSpatialElement with upward compatibility for file based exchange.

void setRelatingStructure(::Ifc2x3::IfcSpatialStructureElement *v)
const IfcParse::entity &declaration() const
IfcRelReferencedInSpatialStructure(IfcEntityInstanceData *e)
IfcRelReferencedInSpatialStructure(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcProduct>::ptr v5_RelatedElements, ::Ifc2x3::IfcSpatialStructureElement *v6_RelatingStructure)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelSchedulesCostItems : public Ifc2x3::IfcRelAssignsToControl

Public Functions

const IfcParse::entity &declaration() const
IfcRelSchedulesCostItems(IfcEntityInstanceData *e)
IfcRelSchedulesCostItems(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, IfcTemplatedEntityList<::Ifc2x3::IfcObjectDefinition>::ptr v5_RelatedObjects, boost::optional<::Ifc2x3::IfcObjectTypeEnum::Value> v6_RelatedObjectsType, ::Ifc2x3::IfcControl *v7_RelatingControl)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelSequence : public Ifc2x3::IfcRelConnects

IfcRelSequence is a sequential relationship between processes where one process must occur before the other in time and where the timing of the relationship may be described as a type of sequence. The relating process (IfcRelSequence.RelatingProcess) is considered to be the predecessor in the relationship (has precedence) whilst the related process (IfcRelSequence.RelatedProcess) is the successor.

IfcRelSequence is defined as one-to-one relationship; therefore it assigns one predecessor to one successor.

HISTORY New entity in IFC 1.0.

IFC2x4 CHANGE Relocated to IfcProcessExtension schema. TimeLag and SequenceType made optional. USERDEFINED added to the IfcSequenceType enumeration. UserDefinedSequenceType attribute added. WHERE rule controlling use of the USERDEFINED enumeration added.

Use definitions

IfcRelSequence is used to describe the logical sequence relationship that exists between two processes. This logical relationship identifies that there is a predecessor or relating process and a successor or related process. In IFC, there may be one predecessor and one successor in the relationship. Many occurrences of IfcRelSequence may exist to describe the sequence relationships of a predecessor task with many successor tasks or of many predecessor tasks with one successor task, thus enabling a m:n sequence relationship between tasks. Please note that sequence relationships always should stay within the limits of a directed, non-cyclic graph.

A sequence type may be set for a sequence. For tasks assigned to a work schedule, it is expected that the sequence type will be asserted. For a process map, where the sequence relationship between processes is simply a logical flow, it need not be asserted.

A time lag may be assigned to a sequence, and the sequence type defines the way in which the time lag applies to the sequence either as a ratio or percentage of time duration (e.g. start successor task when predecessor is 50% complete) or as a time measure (e.g. start successor task 1 week after commencement of the predecessor task). Care should be used when assigning a time lag to a sequence depending on the setting of the sequence type since there is no checking that the time lag value is in keeping with the sequence type set.

Public Types

typedef IfcTemplatedEntityList<IfcRelSequence> list

Public Functions

::Ifc2x3::IfcProcess *RelatingProcess() const

Reference to the process, that is the predecessor.

void setRelatingProcess(::Ifc2x3::IfcProcess *v)
::Ifc2x3::IfcProcess *RelatedProcess() const

Reference to the process, that is the successor.

void setRelatedProcess(::Ifc2x3::IfcProcess *v)
double TimeLag() const

Time duration of the sequence, it is the time lag between the predecessor and the successor as specified by the SequenceType.

void setTimeLag(double v)
::Ifc2x3::IfcSequenceEnum::Value SequenceType() const

The way in which the time lag applies to the sequence.

void setSequenceType(::Ifc2x3::IfcSequenceEnum::Value v)
const IfcParse::entity &declaration() const
IfcRelSequence(IfcEntityInstanceData *e)
IfcRelSequence(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcProcess *v5_RelatingProcess, ::Ifc2x3::IfcProcess *v6_RelatedProcess, double v7_TimeLag, ::Ifc2x3::IfcSequenceEnum::Value v8_SequenceType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelServicesBuildings : public Ifc2x3::IfcRelConnects

Definition from IAI: An objectified relationship that defines the relationship between a system and the sites, buildings, storeys or spaces, it serves. Examples of systems are:

building service systems (heating, cooling, waste water system) represented by instances of IfcSystem

idealized structural analysis systems represented by instances of IfcStructuralAnalysisSystem

HISTORY New entity in IFC Release 1.0

IFC2x PLATFORM CHANGE The data type of the attributeRelatedBuildings has been changed from IfcBuilding to its supertype IfcSpatialStructureElement with upward compatibility for file based exchange. The name IfcRelServicesBuildings is a knownanomaly, as the relationship is not restricted to buildings anymore.

Public Types

typedef IfcTemplatedEntityList<IfcRelServicesBuildings> list

Public Functions

::Ifc2x3::IfcSystem *RelatingSystem() const

System that services the Buildings.

void setRelatingSystem(::Ifc2x3::IfcSystem *v)
IfcTemplatedEntityList<::Ifc2x3::IfcSpatialStructureElement>::ptr RelatedBuildings() const

Spatial structure elements (including site, building, storeys) that are serviced by the system.

IFC2x PLATFORM CHANGE The data type has been changed from IfcBuilding to IfcSpatialStructureElement with upward compatibility for file based exchange.

IFC2x Edition 4 CHANGE The data type has been changed from IfcSpatialStructureElement to IfcSpatialElement with upward compatibility for file based exchange.

void setRelatedBuildings(IfcTemplatedEntityList<::Ifc2x3::IfcSpatialStructureElement>::ptr v)
const IfcParse::entity &declaration() const
IfcRelServicesBuildings(IfcEntityInstanceData *e)
IfcRelServicesBuildings(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcSystem *v5_RelatingSystem, IfcTemplatedEntityList<::Ifc2x3::IfcSpatialStructureElement>::ptr v6_RelatedBuildings)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelSpaceBoundary : public Ifc2x3::IfcRelConnects

The space boundary defines the physical or virtual delimiter of a space by the relationship IfcRelSpaceBoundary to the surrounding elements.

In the case of a physical space boundary, the placement and shape of the boundary may be given, and the building element, providing the boundary, is referenced, In the case of a virtual space boundary, the placement and shape of the boundary may be given, but no building element is referenced and a virtual element is referenced instead.

The IfcRelSpaceBoundary is defined as an objectified relationship that handles the element to space relationship by objectifying the relationship between an element and the space it bounds. It is given as a one-to-one relationship, but allows each element (including virutal elements and openings) to define many such relationship and each space to be defined by many such relationships. Space boundaries are always defined as seen from the space. In general two basic types of space boundaries are distinguished:

1st level space boundary: defined as boundaries of the space, not taking into account any change in building element or spaces on the other side. 2nd level space boundary: defined as boundary taking any change in building element or spaces on the other side into account. It can be further distinguished into

2nd level type A: There is a space on the other side. 2nd level type B: There is a building element on the other side.

The exact definition of how space boundaries are broken down depends on the view definition, more detailed conventions on how space boundaries are decomposed can only be given at the domain or application type level.

In an architectural or FM related view, a space boundary is defined totally from inside the space. This is a 1st level space boundary. In a thermal view, the decomposition of the space boundary depends on the material of the providing building element and the adjacent spaces behind. This is a 2nd level space boundary.

Figure 42 — Space boundary at first level Figure 43 — Space boundary at second level

Figure 44 — Space boundary at second level type A Figure 45 — Space boundary at second level type B

HISTORY New entity in IFC Release 1.5, the entity has been modified in IFC Release 2x. IFC2x CHANGE The data type of the attributeRelatedBuildingElement has been changed from IfcBuildingElement to its supertype IfcElement. The data type of the attribute ConnectionGeometry has been changed from IfcConnectionSurfaceGeometry to its supertype IfcConnectionGeometry. IFC2x4 CHANGE The attribute RelatedBuildingElement has been made mandatory. For virtual boundaries the reference to IfcVirtualElement is now mandatory.

Attribute Use Definitions The differences between the 1st and 2nd level space boundaries is identified by:

1st level: SELF\IfcRoot.Name = “1stLevel” SELF\IfcRootDescription = NIL 2nd level: SELF\IfcRoot.Name = “2ndLevel” SELF\IfcRootDescription = “2a”, or “2b”

Differentiation between physical and virtual space boundary is illustrated in Figure 46 and Figure 47.

As shown in Figure 46, if the IfcRelSpaceBoundary is used to express a virtual boundary, the attribute PhysicalOrVirtualBoundary has to be set to VIRTUAL. The attribute RelatedBuildingElement shall point to an instance of IfcVirtualElement. If the correct location is of interest, the attribute ConnectionGeometry is required. NOTE The connection geometry, either by a 2D curve or a 3D surface, is used to describe the portion of the “virtual wall” that separates the two spaces. All instances of IfcRelSpaceBoundary given at the adjacent spaces share the same instance of IfcVirtualElement. Each instance of IfcRelSpaceBoundary provides in addition the ConnectionGeometry given within the local placement of each space.

Figure 46 — Space boundary of virtual element

As shown in Figure 47, if the IfcRelSpaceBoundary is used to express a physical boundary between two spaces, the attribute PhysicalOrVirtualBoundary has to be set to PHYSICAL. The attribute RelatedBuildingElement has to be given and points to the element providing the space boundary. The attribute ConnectionGeometry may be inserted, in this case it describes the physical space boundary geometically, or it may be omited, in that case it describes a physical space boundary logically.

Figure 47 — Space boundary of physical element

Geometry Use Definitions The IfcRelSpaceBoundary may have geometry attached. If geometry is not attached, the relationship between space and building element is handled only on a logical level. If geometry is attached, it is given within the local coordinate systems of the space. NOTE: The attributes CurveOnRelatingElement at IfcConnectionCurveGeometry or SurfaceOnRelatingElement at IfcConnectionSurfaceGeometry provide the geometry within the local coordinate system of the IfcSpace, whereas the attributes CurveOnRelatedElement at IfcConnectionCurveGeometry or SurfaceOnRelatedElement at IfcConnectionSurfaceGeometry provide the geometry within the local coordinate system of the subtype of IfcElement. NOTE In most view definitions the connection geometry for the related IfcElement is not provided. The geometric representation (through the ConnectionGeometry attribute) is defined using either 2D curve geometry or 3D surface geometry for space boundaries. In most view definitions the 3D connection surface geometry is required.

1st level space boundary:

only connection geometry for related space shall be provided only surface connection geometry shall be provided only the following surface representations are supported:

IfcSurfaceOfLinearExtrusion IfcCurveBoundedPlane IfcCurveBoundedSurface IfcFaceBasedSurfaceModel

2nd level space boundary:

only connection geometry for related space shall be provided only surface connection geometry shall be provided only the following surface representations are supported:

IfcCurveBoundedPlane with restrictions to have polygonal boundaries only IfcFaceBasedSurfaceModel

Surface connection geometry The following constraints apply to the surface connection geometry representation:

planar boundaries:

IfcSurfaceOfLinearExtrusion defined by a SweptCurve being an IfcArbitraryOpenProfileDef with straight segements, or IfcCurveBoundedPlane

curved boundaries

IfcSurfaceOfLinearExtrusion defined by a SweptCurve being an IfcArbitraryOpenProfileDef with curves segements, or IfcCurveBoundedSurface with a BasisSurface being a non planar surface, such as IfcCylindricalSurface, or IfcFaceBasedSurfaceModel if already faceted.

Curve connection geometry The following constraints apply to the 2D curve representation:

Curve: IfcPolyline, IfcTrimmedCurve or IfcCompositeCurve

Public Types

typedef IfcTemplatedEntityList<IfcRelSpaceBoundary> list

Public Functions

::Ifc2x3::IfcSpace *RelatingSpace() const

Reference to one spaces that is delimited by this boundary.

void setRelatingSpace(::Ifc2x3::IfcSpace *v)
bool hasRelatedBuildingElement() const

Whether the optional attribute RelatedBuildingElement is defined for this IfcRelSpaceBoundary.

::Ifc2x3::IfcElement *RelatedBuildingElement() const

Reference to Building Element, that defines the Space Boundaries.

IFC2x PLATFORM CHANGE The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file based exchange.

IFC2x4 CHANGE The attribute has been changed to be mandatory.

void setRelatedBuildingElement(::Ifc2x3::IfcElement *v)
bool hasConnectionGeometry() const

Whether the optional attribute ConnectionGeometry is defined for this IfcRelSpaceBoundary.

::Ifc2x3::IfcConnectionGeometry *ConnectionGeometry() const

Physical representation of the space boundary. Provided as a curve or surface given within the LCS of the space.

IFC2x PLATFORM CHANGE The data type has been changed from IfcConnectionSurfaceGeometry to IfcConnectionGeometry with upward compatibility for file based exchange.

void setConnectionGeometry(::Ifc2x3::IfcConnectionGeometry *v)
::Ifc2x3::IfcPhysicalOrVirtualEnum::Value PhysicalOrVirtualBoundary() const

Defines, whether the Space Boundary is physical (Physical) or virtual (Virtual).

void setPhysicalOrVirtualBoundary(::Ifc2x3::IfcPhysicalOrVirtualEnum::Value v)
::Ifc2x3::IfcInternalOrExternalEnum::Value InternalOrExternalBoundary() const

Defines, whether the Space Boundary is internal (Internal), or external, i.e. adjacent to open space (that can be an partially enclosed space, such as terrace (External).

void setInternalOrExternalBoundary(::Ifc2x3::IfcInternalOrExternalEnum::Value v)
const IfcParse::entity &declaration() const
IfcRelSpaceBoundary(IfcEntityInstanceData *e)
IfcRelSpaceBoundary(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcSpace *v5_RelatingSpace, ::Ifc2x3::IfcElement *v6_RelatedBuildingElement, ::Ifc2x3::IfcConnectionGeometry *v7_ConnectionGeometry, ::Ifc2x3::IfcPhysicalOrVirtualEnum::Value v8_PhysicalOrVirtualBoundary, ::Ifc2x3::IfcInternalOrExternalEnum::Value v9_InternalOrExternalBoundary)

Public Static Functions

const IfcParse::entity &Class()
class IfcRelVoidsElement : public Ifc2x3::IfcRelConnects

IfcRelVoidsElement is an objectified relationship between a building element and one opening element that creates a void in the element. It is a one-to-one relationship. This relationship implies a Boolean operation of subtraction between the geometric bodies of the element and the opening.

As shown in Figure 50, the insertion of a void into a wall is represented by the relationship IfcRelVoidsElement. The opening is created within the wall by IfcWall(StandardCase) o IfcRelVoidsElement o IfcOpeningElement.

Figure 50 — Relationship for element voiding

HISTORY New entity in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcRelVoidsElement> list

Public Functions

::Ifc2x3::IfcElement *RelatingBuildingElement() const
void setRelatingBuildingElement(::Ifc2x3::IfcElement *v)
::Ifc2x3::IfcFeatureElementSubtraction *RelatedOpeningElement() const
void setRelatedOpeningElement(::Ifc2x3::IfcFeatureElementSubtraction *v)
const IfcParse::entity &declaration() const
IfcRelVoidsElement(IfcEntityInstanceData *e)
IfcRelVoidsElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcElement *v5_RelatingBuildingElement, ::Ifc2x3::IfcFeatureElementSubtraction *v6_RelatedOpeningElement)

Public Static Functions

const IfcParse::entity &Class()
class IfcRepresentation : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-43:1992: A representation is one or more representation items that are related in a specified representation context as the representation of some concept.

IfcRepresentation defines the general concept of representing product properties.

Representation Use Definition

Each representation, either IfcShapeRepresentation, or IfcTopologyRepresentation shall have a well defined:

ContextOfItems: Reference to an IfcGeometricRepresentationContext as agreed for this representation.

RepresentationIdentifier: Name of the representation, for example, ‘Body’ for 3D shape, ‘FootPrint’ for 2D ground view, ‘Axis’ for reference axis.

RepresentationType: Name for the geometric, or topological representation type, for example, ‘SweptSolid’ for 3D swept solids, ‘Brep’ for boundary representation.

Values and guidelines for these three items are provided in the geometry use definition section at each subtype of IfcElement, or in view definitions / implementer agreements.

NOTEThe definition of this entity relates to the ISO 10303 entity representation. Please refer to ISO/IS 10303-43:1994 for the final definition of the formal standard.

HISTORY New entity in IFC Release 2.0

IFC2x3 CHANGE The inverse attributes LayerAssignments andRepresentationMap have been added with upward compatibility.

IFC2x4 CHANGE Entity IfcRepresentation has been changed into an ABSTRACT supertype.

Subclassed by Ifc2x3::IfcShapeModel, Ifc2x3::IfcStyleModel

Public Types

typedef IfcTemplatedEntityList<IfcRepresentation> list

Public Functions

::Ifc2x3::IfcRepresentationContext *ContextOfItems() const

Definition of the representation context for which the different subtypes of representation are valid.

void setContextOfItems(::Ifc2x3::IfcRepresentationContext *v)
bool hasRepresentationIdentifier() const

Whether the optional attribute RepresentationIdentifier is defined for this IfcRepresentation.

std::string RepresentationIdentifier() const

The optional identifier of the representation as used within a project.

void setRepresentationIdentifier(std::string v)
bool hasRepresentationType() const

Whether the optional attribute RepresentationType is defined for this IfcRepresentation.

std::string RepresentationType() const

The description of the type of a representation context. The representation type defines the type of geometry or topology used for representing the product representation. More information is given at the subtypes IfcShapeRepresentation and IfcTopologyRepresentation. The supported values for context type are to be specified by implementers agreements.

void setRepresentationType(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr Items() const

Set of geometric representation items that are defined for this representation.

void setItems(IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v)
IfcTemplatedEntityList<IfcRepresentationMap>::ptr RepresentationMap() const
IfcTemplatedEntityList<IfcPresentationLayerAssignment>::ptr LayerAssignments() const
IfcTemplatedEntityList<IfcProductRepresentation>::ptr OfProductRepresentation() const
const IfcParse::entity &declaration() const
IfcRepresentation(IfcEntityInstanceData *e)
IfcRepresentation(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcRepresentationContext : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-42:1992: A representation context is a context in which a set of representation items are related.

The IfcRepresentationContext defines the context to which the IfcRepresentation of a product is related.

NOTE The definition of this class relates to the ISO 10303 entity representation_context. Please refer to ISO/IS 10303-43:1994 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.

IFC2x4 CHANGE Entity made abstract, had been deprecated from instantiation since IFC2x2.

Subclassed by Ifc2x3::IfcGeometricRepresentationContext

Public Functions

bool hasContextIdentifier() const

Whether the optional attribute ContextIdentifier is defined for this IfcRepresentationContext.

std::string ContextIdentifier() const

The optional identifier of the representation context as used within a project.

void setContextIdentifier(std::string v)
bool hasContextType() const

Whether the optional attribute ContextType is defined for this IfcRepresentationContext.

std::string ContextType() const

The description of the type of a representation context. The supported values for context type are to be specified by implementers agreements.

void setContextType(std::string v)
IfcTemplatedEntityList<IfcRepresentation>::ptr RepresentationsInContext() const
const IfcParse::entity &declaration() const
IfcRepresentationContext(IfcEntityInstanceData *e)
IfcRepresentationContext(boost::optional<std::string> v1_ContextIdentifier, boost::optional<std::string> v2_ContextType)

Public Static Functions

const IfcParse::entity &Class()
class IfcRepresentationItem : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-43:1992: A representation item is an element of product data that participates in one or more representations or contributes to the definition of another representation item. A representation item contributes to the definition of another representation item when it is referenced by that representation item.

NOTE Corresponding entity in ISO 10303-43:1994: representation_item. Please refer to ISO/IS 10303-43:1994, for the final definition of the formal standard. The following changes have been made: The attribute ‘name’ and the WR1 have not been incorporated.

The IfcRepresentationItem is used within an IfcRepresentation (directly or indirectly through other IfcRepresentationItem’s) to represent an IfcProductRepresentation. Most commonly these IfcRepresentationItem’s are geometric or topological representation items, that can (but not need to) have presentation style infomation assigned.

NOTE The assignment of a style is only applicable to the subtypes IfcGeometricRepresentationItem, IfcMappedItem and some selected subtypes of IfcTopologicalRepresentationItem (IfcVertexPoint, IfcEdgeCurve, IfcFaceSurface).

In case that presentation style information is applied, it can be either applied by an IfcStyledItem, or by an assignment to an IfcPresentationLayerWithStyle. If both are present, and both style assignments include the same subtype of IfcPresentationStyle, then the style assigned by IfcStyledItem takes priority.

Figure 281 shows an instance diagram explaining the use of IfcStyledItem and IfcPresentationLayerWithStyle to apply presentation styles.

EXAMPLE The assignment of style information by a styled item and a presentation layer with style. Since the presentation styles are different, IfcCurveStyle and IfcSurfaceStyle, both are applied to the geometric representation item.

Figure 281 — Representation item style

Figure 282 shows in instance diagram explaining the override of IfcPresentationLayerWithStyle by IfcStyledItem to apply presentation styles.

EXAMPLE The assignment of style information by a styled item and a presentation layer with style. Since the presentation styles for curve style are aprovided by both, the IfcCurveStyle provided by the IfcStyledItem overrides the IfcCurveStyle provided by the IfcPresentationLayerWithStyle

Figure 282 — Representation item style override

HISTORY New entity in IFC Release 2x.

IFC2x3 CHANGE The inverse attributes StyledByItem and LayerAssignments have been added. Upward compatibility for file based exchange is guaranteed.

Subclassed by Ifc2x3::IfcGeometricRepresentationItem, Ifc2x3::IfcMappedItem, Ifc2x3::IfcStyledItem, Ifc2x3::IfcTopologicalRepresentationItem

Public Types

typedef IfcTemplatedEntityList<IfcRepresentationItem> list

Public Functions

IfcTemplatedEntityList<IfcPresentationLayerAssignment>::ptr LayerAssignments() const
IfcTemplatedEntityList<IfcStyledItem>::ptr StyledByItem() const
const IfcParse::entity &declaration() const
IfcRepresentationItem(IfcEntityInstanceData *e)
IfcRepresentationItem()

Public Static Functions

const IfcParse::entity &Class()
class IfcRepresentationMap : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-43:1992: A representation map is the identification of a representation and a representation item in that representation for the purpose of mapping. The representation item defines the origin of the mapping. The representation map is used as the source of a mapping by a mapped item.

NOTE Corresponding ISO 10303 entity: representation_map. Please refer to ISO/IS 10303-43:1994, for the final definition of the formal standard. The following changes have been made: The mapping_origin (MappingOrigin) is constrained to be of type axis2_placement (IfcAxis2Placement).

An IfcRepresentationMap defines the base definition (also referred to as block, cell or macro) called MappedRepresentation within the MappingOrigin. The MappingOrigin defines the coordinate system in which the MappedRepresentation is defined.

The RepresentationMap is used through an IfcMappeditem in one or several IfcShapeRepresentation’s. An Cartesian transformation operator can be applied to transform the MappedRepresentation into the placement coordinate system of the shape representation. The transformation of the representation map is restricted to be a Cartesian transformation mapping (translation, rotation, mirroring and scaling).

NOTE The definition of a mapping which is used to specify a new representation item comprises a representation map and a mapped item entity. Without both entities, the mapping is not fully defined. Two entities are specified to allow the same source representation to be mapped into multiple new representations.

HISTORY New entity in IFC Release 2x.

Public Types

typedef IfcTemplatedEntityList<IfcRepresentationMap> list

Public Functions

::Ifc2x3::IfcAxis2Placement *MappingOrigin() const

An axis2 placement that defines the position about which the mapped representation is mapped.

void setMappingOrigin(::Ifc2x3::IfcAxis2Placement *v)
::Ifc2x3::IfcRepresentation *MappedRepresentation() const

A representation that is mapped to at least one mapped item.

void setMappedRepresentation(::Ifc2x3::IfcRepresentation *v)
IfcTemplatedEntityList<IfcMappedItem>::ptr MapUsage() const
const IfcParse::entity &declaration() const
IfcRepresentationMap(IfcEntityInstanceData *e)
IfcRepresentationMap(::Ifc2x3::IfcAxis2Placement *v1_MappingOrigin, ::Ifc2x3::IfcRepresentation *v2_MappedRepresentation)

Public Static Functions

const IfcParse::entity &Class()
class IfcResource : public Ifc2x3::IfcObject

IfcResource contains the information needed to represent the costs, schedule, and other impacts from the use of a thing in a process. It is not intended to use IfcResource to model the general properties of the things themselves, while an optional linkage from IfcResource to the things to be used can be specified (specifically, the relationship from subtypes of IfcResource to IfcProduct through the IfcRelAssignsToResource relationship).

There are two basic intended uses of IfcResource. First, if the attributes of the thing are not needed for the purpose of the use of IfcResource, or the types of things are not explicitly modeled in IFC yet, then the linkage between the resource and the thing doesn’t have to be instantiated in the system. That is, the attributes of IfcResource (or its subtypes) alone are sufficient to represent the use of the thing as a resource for the purpose of the project.

EXAMPLE: construction equipment such as earth-moving vehicles or tools are not currently modeled within the IFC. For the purpose of estimating and scheduling, these can be represented using subtypes of IfcResource alone.

Second, if the attributes of the thing are needed for the use of IfcResource objects, and they are modeled explicitly as objects, then the IfcResource instances can be linked to the instances of the type of the things being referenced. Things that might be used as resources and that are already modeled in the IFC include physical products, people and organizations, and materials. The relationship object IfcRelAssignsToResource is provided for this approach.

The inherited attribute ObjectType is used as a textual code that identifies the resource type.

HISTORY New entity in IFC Release 1.0

IFC2x PLATFORM CHANGE: The attributes BaseUnit and ResourceConsumption have been removed from the abstract entity; they are reintroduced at a lower level in the hierarchy.

Subclassed by Ifc2x3::IfcConstructionResource

Public Types

typedef IfcTemplatedEntityList<IfcResource> list

Public Functions

IfcTemplatedEntityList<IfcRelAssignsToResource>::ptr ResourceOf() const
const IfcParse::entity &declaration() const
IfcResource(IfcEntityInstanceData *e)
IfcResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcResourceConsumptionEnum

Public Types

enum Value

The IfcResourceConsumptionEnum indicates how a construction resource is consumed during its use. The IfcResourceConsumptionEnum contains the following:

CONSUMED: Resource is production-based and is immediately consumed at the start of its usage. PARTIALLYCONSUMED: Resource is production-based and is consumed over its usage. NOTCONSUMED: Resource is production-based and is not consumed during its usage. OCCUPIED: Resource is duration-based and is immediately consumed at the start of its usage. PARTIALLYOCCUPIED: Resource is duration-based and is consumed over its usage. NOTOCCUPIED: Resource is duration-based and is not consumed during its usage. USERDEFINED: User-defined consumption; custom property sets must indicate usage. NOTDEFINED: Undefined consumption.

HISTORY: New Enumeration in IFC Release 2.0.

Values:

enumerator IfcResourceConsumption_CONSUMED
enumerator IfcResourceConsumption_PARTIALLYCONSUMED
enumerator IfcResourceConsumption_NOTCONSUMED
enumerator IfcResourceConsumption_OCCUPIED
enumerator IfcResourceConsumption_PARTIALLYOCCUPIED
enumerator IfcResourceConsumption_NOTOCCUPIED
enumerator IfcResourceConsumption_USERDEFINED
enumerator IfcResourceConsumption_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRevolvedAreaSolid : public Ifc2x3::IfcSweptAreaSolid

An IfcRevolvedAreaSolid is a solid created by revolving a cross section provided by a profile definition about an axis. The axis and the cross section shall be in the same plane. NOTE Both the axis and the cross section are required to lie in the xy plane of the object position coordinate system. The following definitions from ISO 10303-42 apply:

A revolved area solid is a solid formed by revolving a planar bounded surface about an axis. The axis shall be in the plane of the surface and the axis shall not intersect the interior of the bounded surface. The bounded surface may have holes which will sweep into holes in the solid. The direction of revolution is clockwise when viewed along the axis in the positive direction. More precisely if A is the axis location and d is the axis direction and C is an arc on the surface of revolution generated by an arbitrary point p on the boundary of the swept area, then C leaves p in direction d x (p - A) as the area is revolved.

Figure 262 illustrates geometric parameters of the revolved solid. The revolved area solid defines the revolution of a 2D area (given by a profile definition) by an axis and angle. The result is a solid. The swept area is given by a profile definition. This profile is defined:

as a 2D bounded curve within the xy plane of the position coordinate system, as a 2D bounded curve with holes within the xy plane of the position coordinate system, or as a 2D primitive, defined within a 2D position coordinate system, that is placed relative to the xy plane of the position coordinate system

The AxisLine can have any orientation within the XY plane, it does not have to be parallel to the y-axis as shown in the illustration.

Figure 262 — Revolved area solid geometry

NOTE Corresponding ISO 10303-42 entity: revolved_area_solid. Please refer to ISO/IS 10303-42:1994, p. 184 for the final definition of the formal standard. The data type of the inherited SweptArea attribute is different, i.e. of type IfcProfileDef. The position attribute has been added to position the cross section used for the revolution.

HISTORY New entity in IFC Release 1.5, capabilities of this entity have been enhanced in IFC Release 2x.

Informal propositions:

The AxisLine shall lie in the plane of the SweptArea (as defined at supertype IfcSweptAreaSolid). The AxisLine shall not intersect the interior of the SweptArea (as defined at supertype IfcSweptAreaSolid). The Angle shall be between 0° and 360°, or 0 and 2π (depending on the unit type for IfcPlaneAngleMeasure).

Texture Use Definition For side faces, textures are aligned facing upright along the sides with origin at the first point of an arbitrary profile, and following the outer bound of the profile counter-clockwise (as seen from above). For parameterized profiles, the origin is defined at the +Y extent for rounded profiles (having no sharp edge) and the first sharp edge counter-clockwise from the +Y extent for all other profiles. Textures are stretched or repeated on each side along the outer boundary of the profile according to RepeatS. Textures are stretched or repeated on each side along the outermost (longest) revolution path according to RepeatT, where coordinates are compressed towards the axis of revolution. For top and bottom caps, textures are aligned facing front-to-back, with the origin at the minimum X and Y extent. Textures are stretched or repeated on the top and bottom to the extent of each face according to RepeatS and RepeatT. For profiles with voids, textures are aligned facing upright along the inner side with origin at the first point of an arbitrary profile, and following the inner bound of the profile clockwise (as seen from above). For parameterized profiles, the origin of inner sides is defined at the +Y extent for rounded profiles (having no sharp edge such as hollow ellipses or rounded rectangles) and the first sharp edge clockwise from the +Y extent for all other profiles.

Figure 263 illustrates default texture mapping with a repeated texture (RepeatS=True and RepeatT=True). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up. For an IfcRevolvedAreaSolid having a profile of IfcTShapeProfileDef and revolved at 22.5 degrees, the side texture coordinate origin is the first corner counter-clockwise from the +Y axis, which equals (-0.5*IfcTShapeProfileDef.OverallWidth, +0.5*IfcTShapeProfileDef.OverallDepth), while the top (end cap) texture coordinates start at (-0.5*IfcTShapeProfileDef.OverallWidth, -0.5*IfcTShapeProfileDef.OverallDepth).

Figure 263 — Revolved area solid textures

Public Types

typedef IfcTemplatedEntityList<IfcRevolvedAreaSolid> list

Public Functions

::Ifc2x3::IfcAxis1Placement *Axis() const

Axis about which revolution will take place.

void setAxis(::Ifc2x3::IfcAxis1Placement *v)
double Angle() const

The angle through which the sweep will be made. This angle is measured from the plane of the swept area provided by the XY plane of the position coordinate system.

void setAngle(double v)
const IfcParse::entity &declaration() const
IfcRevolvedAreaSolid(IfcEntityInstanceData *e)
IfcRevolvedAreaSolid(::Ifc2x3::IfcProfileDef *v1_SweptArea, ::Ifc2x3::IfcAxis2Placement3D *v2_Position, ::Ifc2x3::IfcAxis1Placement *v3_Axis, double v4_Angle)

Public Static Functions

const IfcParse::entity &Class()
struct IfcRibPlateDirectionEnum

Public Types

enum Value

Values:

enumerator IfcRibPlateDirection_DIRECTION_X
enumerator IfcRibPlateDirection_DIRECTION_Y

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRibPlateProfileProperties : public Ifc2x3::IfcProfileProperties

Public Functions

bool hasThickness() const

Whether the optional attribute Thickness is defined for this IfcRibPlateProfileProperties.

double Thickness() const
void setThickness(double v)
bool hasRibHeight() const

Whether the optional attribute RibHeight is defined for this IfcRibPlateProfileProperties.

double RibHeight() const
void setRibHeight(double v)
bool hasRibWidth() const

Whether the optional attribute RibWidth is defined for this IfcRibPlateProfileProperties.

double RibWidth() const
void setRibWidth(double v)
bool hasRibSpacing() const

Whether the optional attribute RibSpacing is defined for this IfcRibPlateProfileProperties.

double RibSpacing() const
void setRibSpacing(double v)
::Ifc2x3::IfcRibPlateDirectionEnum::Value Direction() const
void setDirection(::Ifc2x3::IfcRibPlateDirectionEnum::Value v)
const IfcParse::entity &declaration() const
IfcRibPlateProfileProperties(IfcEntityInstanceData *e)
IfcRibPlateProfileProperties(boost::optional<std::string> v1_ProfileName, ::Ifc2x3::IfcProfileDef *v2_ProfileDefinition, boost::optional<double> v3_Thickness, boost::optional<double> v4_RibHeight, boost::optional<double> v5_RibWidth, boost::optional<double> v6_RibSpacing, ::Ifc2x3::IfcRibPlateDirectionEnum::Value v7_Direction)

Public Static Functions

const IfcParse::entity &Class()
class IfcRightCircularCone : public Ifc2x3::IfcCsgPrimitive3D

The IfcRightCircularCone is a Construction Solid Geometry (CSG) 3D primitive. It is a solid with a circular base and a point called apex as the top. The tapers from the base to the top. The axis from the center of the circular base to the apex is perpendicular to the base. The inherited Position attribute defines the IfcAxisPlacement3D and provides the location and orientation of the cone:

SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The center of the circular area being the bottom face of the cone. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z-axis of the inherited placement coordinate system provides the center axis of the IfcRightCircularCone, and the apex is at the Height value applied to the positive direction of the z-axis. The BottomRadius defines the circular base at the xy-plane of the placement coordinate system.

Figure 264 illustrates geometric parameters of the cone. The cone is positioned within its own placement coordinate system. The origin is the center of the bottom circular disk, that lies in the XY plane. The apex lies on the positive z axis at [0, 0, Height].

Figure 264 — Right circular cone geometry

NOTE Corresponding ISO 10303 entity: right_circular_cone, the position attribute has been promoted to the immediate supertype IfcCsgPrimitive3D. No semi_angle attribute, and the radius defines the bottom radius, since only a non-truncated cone is in scope. Please refer to ISO/IS 10303-42:1994, p. 176 for the final definition of the formal standard.

HISTORY New entity in IFC2x3

Texture use definition On the circular side, textures are aligned facing upright with origin at the back (+Y direction) revolving counter-clockwise. Textures are stretched or repeated to the extent of the base circumference according to RepeatS. Textures are compressed linearly going upwards towards the top point according to RepeatT. On the bottom face, textures are aligned facing front-to-back, with the center of the circle aligned to the center of the texture.

Figure 265 illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

Side Normal Origin X Origin Y Origin Z S Axis T Axis

Side -Y 0 +Radius 0 -X (towards top point)

Bottom -Z 0 0 0 -X +Y

Figure 265 — Right circular cone textures

Public Types

typedef IfcTemplatedEntityList<IfcRightCircularCone> list

Public Functions

double Height() const

The distance between the base of the cone and the apex.

void setHeight(double v)
double BottomRadius() const

The radius of the cone at the base.

void setBottomRadius(double v)
const IfcParse::entity &declaration() const
IfcRightCircularCone(IfcEntityInstanceData *e)
IfcRightCircularCone(::Ifc2x3::IfcAxis2Placement3D *v1_Position, double v2_Height, double v3_BottomRadius)

Public Static Functions

const IfcParse::entity &Class()
class IfcRightCircularCylinder : public Ifc2x3::IfcCsgPrimitive3D

The IfcRightCircularCylinder is a Construction Solid Geometry (CSG) 3D primitive. It is a solid with a circular base and top. The cylindrical surface between if formed by points at a fixed distance from the axis of the cylinder. The inherited Position attribute defines the IfcAxisPlacement3D and provides:

SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The center of the circular area being the bottom face of the cylinder. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z axis provides the center axis and the height is measured from the origin along the positive direction of the z axis.

The following definitions from ISO 10303-42 apply:

A right circular cylinder is a CSG primitive in the form of a solid cylinder of finite height. It is defined by an axis point at the centre of one planar circular face, an axis, a height, and a radius. The faces are perpendicular to the axis and are circular discs with the specified radius. The height is the distance from the first circular face centre in the positive direction of the axis to the second circular face centre.

Figure 266 illustrates geometric parameters of the cylinder. The cylinder is positioned within its own placement coordiante system. The origin is the center of the bottom circular disk, that lies in the XY plane. The center of the top circular disk is on the positive z axis at [0, 0, Height].

Figure 266 — Right circular cylinder geometry

NOTE Corresponding ISO 10303 entity: right_circular_cyclinder, the position attribute has been promoted to the immediate supertype IfcCsgPrimitive3D. Please refer to ISO/IS 10303-42:1994, p. 177 for the definition in the international standard.

HISTORY New entity in IFC2x3.

Texture use definition On the circular side, textures are aligned facing upright with origin at the back (+Y direction) revolving counter-clockwise. Textures are stretched or repeated to the extent of the circumference according to RepeatS. Textures are stretched or repeated to the extent of the Height according to RepeatT. On the top and bottom faces, textures are aligned facing front-to-back, with the center of the circle aligned to the center of the texture.

Figure 267 illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

Side Normal Origin X Origin Y Origin Z S Axis T Axis

Side -Y 0 +Radius 0 -X +Z

Bottom -Z 0 0 0 -X +Y

Top +Z 0 0 +Height +X +Y

Figure 267 — Right circular cylinder textures

Public Functions

double Height() const

The distance between the planar circular faces of the cylinder.

void setHeight(double v)
double Radius() const

The radius of the cylinder.

void setRadius(double v)
const IfcParse::entity &declaration() const
IfcRightCircularCylinder(IfcEntityInstanceData *e)
IfcRightCircularCylinder(::Ifc2x3::IfcAxis2Placement3D *v1_Position, double v2_Height, double v3_Radius)

Public Static Functions

const IfcParse::entity &Class()
struct IfcRoleEnum

Public Types

enum Value

Definition: Roles which may be played by an actor.

HISTORY This type has changes after IFC Release 2.0. Spelling of COMMISSIONINGENGINEER fixed in IFC 2x4.

ENUMERATION

SUPPLIER MANUFACTURER CONTRACTOR SUBCONTRACTOR ARCHITECT STRUCTURALENGINEER COSTENGINEER CLIENT BUILDINGOWNER BUILDINGOPERATOR MECHANICALENGINEER ELECTRICALENGINEER PROJECTMANAGER FACILITIESMANAGER CIVILENGINEER COMMISSIONINGENGINEER ENGINEER OWNER CONSULTANT CONSTRUCTIONMANAGER FIELDCONSTRUCTIONMANAGER RESELLER USERDEFINED User defined value to be provided.

Values:

enumerator IfcRole_SUPPLIER
enumerator IfcRole_MANUFACTURER
enumerator IfcRole_CONTRACTOR
enumerator IfcRole_SUBCONTRACTOR
enumerator IfcRole_ARCHITECT
enumerator IfcRole_STRUCTURALENGINEER
enumerator IfcRole_COSTENGINEER
enumerator IfcRole_CLIENT
enumerator IfcRole_BUILDINGOWNER
enumerator IfcRole_BUILDINGOPERATOR
enumerator IfcRole_MECHANICALENGINEER
enumerator IfcRole_ELECTRICALENGINEER
enumerator IfcRole_PROJECTMANAGER
enumerator IfcRole_FACILITIESMANAGER
enumerator IfcRole_CIVILENGINEER
enumerator IfcRole_COMISSIONINGENGINEER
enumerator IfcRole_ENGINEER
enumerator IfcRole_OWNER
enumerator IfcRole_CONSULTANT
enumerator IfcRole_CONSTRUCTIONMANAGER
enumerator IfcRole_FIELDCONSTRUCTIONMANAGER
enumerator IfcRole_RESELLER
enumerator IfcRole_USERDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRoof : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Construction enclosing the building from above. The IfcRoof is a description of the total roof. It acts as a container entity, that aggregates all components of the roof, it represents. The aggregation is handled via the IfcRelAggregates relationship, relating an IfcRoof with the related roof elements, like slabs (represented by IfcSlab), rafters and purlins (represented by IfcBeam), or other included roofs, such as dormers (represented by IfcRoof).

HISTORY New Entity in IFC Release 2.0. IFC2x4 CHANGE Attribute ShapeType renamed to PredefinedType.

Property Set Use Definition: The property sets relating to the IfcRoof are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcRoof are part of this IFC release:

Pset_RoofCommon: common property set for all roof occurrences

The quantities relating to the IfcRoof are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.MethodOfMeasurement = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcRoofType. The individual quantities shall only be given at IfcRoof, it is not decomposed into the individual parts, e.g. IfcSlab as roof slabs.

Qto_RoofBaseQuantities: base quantities for all roof occurrences.

Containment Use Definition The IfcRoof, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within an element assembly.

The IfcRoof is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes of IfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcRoof may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcRoof, the overall roof, as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e. SELF\IfcElement.ContainedInStructure should be NIL.

NOTE A roof contained in another roof could be the representation of a dormer. The IfcRoof may be an aggregate i.e. being composed by other elements and acting as an assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.IsDecomposedBy. Components of a roof are described by instances of subtypes of IfcBuildingElement (e.g. IfcSlab, IfcBeam, IfcColumn, IfcBuildingElementPart) that are aggregated to form a complex roof. In this case, the contained elements should not be additionally contained in the project spatial hierarchy, i.e. the inverse attribute SELF\IfcElement.ContainedInStructure of the aggregated elements should be NIL.

Figure 118 illustrates roof containment, where only the IfcRoof as the aggregate is included in the spatial structure.

Figure 118 — Roof containment

Geometry Use Definitions: The geometric representation of IfcRoof is given by the IfcProductDefinitionShape, allowing multiple geometric representations. Independent geometric representations should only be used when the IfcRoof is not defined as an aggregate. If defined as an aggregate, the geometric representation is the sum of the representation of the components within the aggregate. NOTE View definitions and implementer agreements may restrict the IfcRoof to not have an independent geometry, but to always require aggregated elements to represent the shape of the roof. NOTE If the IfcRoof has aggregated elements to represent the shape of the roof, then only those elements shall have openings, not the IfcRoof itself. Local Position The local placement for IfcRoof is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

If the LocalPlacement is given for the IfcRoof, then all components, which are aggregated to the roof should use this placement as their relative placement. Geometric Representation The IfcRoof may have an independent geometric representation or may be an aggregate with elements holding the geometric representation of the roof. Geometric representation by own shape representation If the IfcRoof has no components defined (empty set of SELF\IfcObject.IsDecomposedBy) then the IfcRoof may be represented by an independent IfcShapeRepresentation. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘Clipping’, ‘SurfaceModel’, or ‘Brep’

Geometric representation by aggregated elements If the IfcRoof has components (referenced by SELF\IfcObject.IsDecomposedBy) then no independent geometric representation shall defined for the IfcRoof. The IfcRoof is then geometrically represented by the geometric representation of its components. The components are accessed via SELF\IfcObject.IsDecomposedBy[1].RelatedObjects. The geometric representations that are supported for the aggregated elements are defined with each element. See geometric use definition for IfcSlab, IfcBeam, IfcColumn, IfcBuildingElementPart and other subtypes of IfcBuildingElement.

Figure 119 illustrates roof placement, with an IfcRoof defining the local placement for all aggregated elements.

Figure 119 — Roof placement

Public Types

typedef IfcTemplatedEntityList<IfcRoof> list

Public Functions

::Ifc2x3::IfcRoofTypeEnum::Value ShapeType() const
void setShapeType(::Ifc2x3::IfcRoofTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcRoof(IfcEntityInstanceData *e)
IfcRoof(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcRoofTypeEnum::Value v9_ShapeType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcRoofTypeEnum

Public Types

enum Value

This enumeration defines the basic configuration of the roof in terms of the different roof shapes, as illustrated in Figure 68.

Roofs which are subdivided into more than these basic shapes have to be defined by the geometry only. Also roofs with non-regular shapes (free form roof) have to be defined by the geometry only. The type of such roofs is FREEFORM.

HISTORY New Enumeration in IFC Release 2x.

Enumerator Description Figure

FLAT_ROOF A roof having no slope, or one with only a slight pitch so as to drain rainwater.

SHED_ROOF A roof having a single slope.

GABLE_ROOF A roof sloping downward in two parts from a central ridge, so as to form a gable at each end.

HIP_ROOF A roof having sloping ends and sides meeting at an inclined projecting angle.

HIPPED_GABLE_ROOF A roof having a hipped end truncating a gable.

GAMBREL_ROOF A ridged roof divided on each side into a shallower slope above a steeper one.

MANSARD_ROOF A roof having on each side a steeper lower part and a shallower upper part.

BARREL_ROOF A roof or ceiling having a semicylindrical form.

RAINBOW_ROOF A gable roof in the form of a broad Gothic arch, with gently sloping convex surfaces.

BUTTERFLY_ROOF A roof having two slopes, each descending inward from the eaves.

PAVILION_ROOF A pyramidal hip roof.

DOME_ROOF A hemispherical hip roof.

FREEFORM Free form roof

NOTDEFINED No specification given

Figure 68 — Roof types

Values:

enumerator IfcRoofType_FLAT_ROOF
enumerator IfcRoofType_SHED_ROOF
enumerator IfcRoofType_GABLE_ROOF
enumerator IfcRoofType_HIP_ROOF
enumerator IfcRoofType_HIPPED_GABLE_ROOF
enumerator IfcRoofType_GAMBREL_ROOF
enumerator IfcRoofType_MANSARD_ROOF
enumerator IfcRoofType_BARREL_ROOF
enumerator IfcRoofType_RAINBOW_ROOF
enumerator IfcRoofType_BUTTERFLY_ROOF
enumerator IfcRoofType_PAVILION_ROOF
enumerator IfcRoofType_DOME_ROOF
enumerator IfcRoofType_FREEFORM
enumerator IfcRoofType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcRoot : public IfcUtil::IfcBaseEntity

IfcRoot is the most abstract and root class for all IFC entity definitions that roots in the kernel or in subsequent layers of the IFC object model. It is therefore the common supertype of all IFC entities, beside those defined in an IFC resource schema. All entities that are subtypes of IfcRoot can be used independently, whereas resource schema entities, that are not subtypes of IfcRoot, are not supposed to be independent entities.

IfcRoot assigns the globally unique ID, and the ownership and history information to the entity. In addition it may provide for a name and a description about the concept.

NOTE View definitions and implementation agreement may impose additional restrictions on the use of the OwnerHistory to handle object versioning.

HISTORY New entity in IFC Release 1.0

IFC2x4 CHANGE The attribute OwnerHistory has been made OPTIONAL.

Subclassed by Ifc2x3::IfcObjectDefinition, Ifc2x3::IfcPropertyDefinition, Ifc2x3::IfcRelationship

Public Types

typedef IfcTemplatedEntityList<IfcRoot> list

Public Functions

std::string GlobalId() const

Assignment of a globally unique identifier within the entire software world.

void setGlobalId(std::string v)
::Ifc2x3::IfcOwnerHistory *OwnerHistory() const

Assignment of the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object,

NOTE only the last modification in stored - either as addition, deletion or modification.

IFC2x4 CHANGE The attribute has been changed to be OPTIONAL.

void setOwnerHistory(::Ifc2x3::IfcOwnerHistory *v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcRoot.

std::string Name() const

Optional name for use by the participating software systems or users. For some subtypes of IfcRoot the insertion of the Name attribute may be required. This would be enforced by a where rule.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcRoot.

std::string Description() const

Optional description, provided for exchanging informative comments.

void setDescription(std::string v)
const IfcParse::entity &declaration() const
IfcRoot(IfcEntityInstanceData *e)
IfcRoot(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description)

Public Static Functions

const IfcParse::entity &Class()
class IfcRotationalFrequencyMeasure : public IfcUtil::IfcBaseType

IfcRotationalFrequencyMeasure is a measure of the number of cycles that an item revolves in unit time. Usually measured in cycles/s. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcRotationalFrequencyMeasure(IfcEntityInstanceData *e)
IfcRotationalFrequencyMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRotationalMassMeasure : public IfcUtil::IfcBaseType

The rotational mass measure denotes the inertia of a body with respect to angular acceleration. It is usually measured in kg*m^2.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcRotationalMassMeasure(IfcEntityInstanceData *e)
IfcRotationalMassMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRotationalStiffnessMeasure : public IfcUtil::IfcBaseType

IfcRotationalStiffnessMeasure is a measure of rotational stiffness. Usually measured in Nm/rad. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcRotationalStiffnessMeasure(IfcEntityInstanceData *e)
IfcRotationalStiffnessMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcRoundedEdgeFeature : public Ifc2x3::IfcEdgeFeature

Public Types

typedef IfcTemplatedEntityList<IfcRoundedEdgeFeature> list

Public Functions

bool hasRadius() const

Whether the optional attribute Radius is defined for this IfcRoundedEdgeFeature.

double Radius() const
void setRadius(double v)
const IfcParse::entity &declaration() const
IfcRoundedEdgeFeature(IfcEntityInstanceData *e)
IfcRoundedEdgeFeature(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_FeatureLength, boost::optional<double> v10_Radius)

Public Static Functions

const IfcParse::entity &Class()
class IfcRoundedRectangleProfileDef : public Ifc2x3::IfcRectangleProfileDef

IfcRoundedRectangleProfileDef defines a rectangle with equally rounded corners as the profile definition used by the swept surface geometry or the swept area solid. It is given by the X extent, the Y extent, and the radius for the rounded corners, and placed within the 2D position coordinate system, established by the Position attribute. It is placed centric within the position coordinate system, that is, in the center of the bounding box.

HISTORY New class in IFC2x.

IFC2x PLATFORM CHANGE The IfcRoundedRectangleProfileDef is now subtyped from IfcRectangleProfileDef. The XDim and YDim attributes have been removed (now inherited from supertype).

Figure 324 illustrates parameters of the rounded rectangle profile definition.

Position

The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions.

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (e.g. upper-left bound). Parameter

The IfcRoundedRectangleProfileDef is defined within the position coordinate system, where the XDim defines the measure for the length of the rectangle (half along the positive x-axis), the YDim defines the length measure for the width of the rectangle (half along the positive y-axis) and the RoundingRadius defines the radius of curvature in all four corners of the rectangle.

Figure 324 — Rounded rectangle profile

Public Functions

double RoundingRadius() const

Radius of the circular arcs by which all four corners of the rectangle are equally rounded.

void setRoundingRadius(double v)
const IfcParse::entity &declaration() const
IfcRoundedRectangleProfileDef(IfcEntityInstanceData *e)
IfcRoundedRectangleProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_XDim, double v5_YDim, double v6_RoundingRadius)

Public Static Functions

const IfcParse::entity &Class()
class IfcSanitaryTerminalType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcSanitaryTerminalType defines commonly shared information for occurrences of sanitary terminals. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a sanitary terminal specification (i.e. the specific product information, that is common to all occurrences of that product type). Sanitary Terminal types may be exchanged without being already assigned to occurrences. Occurrences of IfcSanitaryTerminalType are represented by instances of IfcSanitaryTerminal.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_SanitaryTerminalTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_SanitaryTerminalTypeBath (BATH) Pset_SanitaryTerminalTypeBidet (BIDET) Pset_SanitaryTerminalTypeCistern (CISTERN) Pset_SanitaryTerminalTypeSanitaryFountain (SANITARYFOUNTAIN) Pset_SanitaryTerminalTypeShower (SHOWER) Pset_SanitaryTerminalTypeSink (SINK) Pset_SanitaryTerminalTypeToiletPan (TOILETPAN) Pset_SanitaryTerminalTypeUrinal (URINAL) Pset_SanitaryTerminalTypeWashHandBasin (WASHHANDBASIN)

Material Use Definition The material of the IfcSanitaryTerminalType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcSanitaryTerminalType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcSanitaryTerminal for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcSanitaryTerminalType> list

Public Functions

::Ifc2x3::IfcSanitaryTerminalTypeEnum::Value PredefinedType() const

Identifies the predefined types of sanitary terminal from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcSanitaryTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSanitaryTerminalType(IfcEntityInstanceData *e)
IfcSanitaryTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSanitaryTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSanitaryTerminalTypeEnum

Public Types

enum Value

The IfcSanitaryTerminalTypeEnum defines the range of different types of sanitary terminal that can be specified.

NOTE: The value WCSEAT has been deprecated and should no longer be used; toilet seats should be represented by IfcDiscreteAccessory with ObjectType ‘WC Seat’. HISTORY: New type in IFC 2x2

Enumeration

BATH: Sanitary appliance for immersion of the human body or parts of it. BIDET: Waste water appliance for washing the excretory organs while sitting astride the bowl. CISTERN: A water storage unit attached to a sanitary terminal that is fitted with a device, operated automatically or by the user, that discharges water to cleanse a water closet (toilet) pan, urinal or slop hopper. SHOWER: Installation or waste water appliance that emits a spray of water to wash the human body. SINK: Waste water appliance for receiving, retaining or disposing of domestic, culinary, laboratory or industrial process liquids. SANITARYFOUNTAIN: A sanitary terminal that provides a low pressure jet of water for a specific purpose. TOILETPAN: Soil appliance for the disposal of excrement. URINAL: Soil appliance that receives urine and directs it to a waste outlet (BS6100). WASHHANDBASIN: Waste water appliance for washing the upper parts of the body. WCSEAT: [Deprecated] Hinged seat that fits on the top of a water closet (WC) pan. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcSanitaryTerminalType_BATH
enumerator IfcSanitaryTerminalType_BIDET
enumerator IfcSanitaryTerminalType_CISTERN
enumerator IfcSanitaryTerminalType_SHOWER
enumerator IfcSanitaryTerminalType_SINK
enumerator IfcSanitaryTerminalType_SANITARYFOUNTAIN
enumerator IfcSanitaryTerminalType_TOILETPAN
enumerator IfcSanitaryTerminalType_URINAL
enumerator IfcSanitaryTerminalType_WASHHANDBASIN
enumerator IfcSanitaryTerminalType_WCSEAT
enumerator IfcSanitaryTerminalType_USERDEFINED
enumerator IfcSanitaryTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcScheduleTimeControl : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcScheduleTimeControl> list

Public Functions

bool hasActualStart() const

Whether the optional attribute ActualStart is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *ActualStart() const
void setActualStart(::Ifc2x3::IfcDateTimeSelect *v)
bool hasEarlyStart() const

Whether the optional attribute EarlyStart is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *EarlyStart() const
void setEarlyStart(::Ifc2x3::IfcDateTimeSelect *v)
bool hasLateStart() const

Whether the optional attribute LateStart is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *LateStart() const
void setLateStart(::Ifc2x3::IfcDateTimeSelect *v)
bool hasScheduleStart() const

Whether the optional attribute ScheduleStart is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *ScheduleStart() const
void setScheduleStart(::Ifc2x3::IfcDateTimeSelect *v)
bool hasActualFinish() const

Whether the optional attribute ActualFinish is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *ActualFinish() const
void setActualFinish(::Ifc2x3::IfcDateTimeSelect *v)
bool hasEarlyFinish() const

Whether the optional attribute EarlyFinish is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *EarlyFinish() const
void setEarlyFinish(::Ifc2x3::IfcDateTimeSelect *v)
bool hasLateFinish() const

Whether the optional attribute LateFinish is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *LateFinish() const
void setLateFinish(::Ifc2x3::IfcDateTimeSelect *v)
bool hasScheduleFinish() const

Whether the optional attribute ScheduleFinish is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *ScheduleFinish() const
void setScheduleFinish(::Ifc2x3::IfcDateTimeSelect *v)
bool hasScheduleDuration() const

Whether the optional attribute ScheduleDuration is defined for this IfcScheduleTimeControl.

double ScheduleDuration() const
void setScheduleDuration(double v)
bool hasActualDuration() const

Whether the optional attribute ActualDuration is defined for this IfcScheduleTimeControl.

double ActualDuration() const
void setActualDuration(double v)
bool hasRemainingTime() const

Whether the optional attribute RemainingTime is defined for this IfcScheduleTimeControl.

double RemainingTime() const
void setRemainingTime(double v)
bool hasFreeFloat() const

Whether the optional attribute FreeFloat is defined for this IfcScheduleTimeControl.

double FreeFloat() const
void setFreeFloat(double v)
bool hasTotalFloat() const

Whether the optional attribute TotalFloat is defined for this IfcScheduleTimeControl.

double TotalFloat() const
void setTotalFloat(double v)
bool hasIsCritical() const

Whether the optional attribute IsCritical is defined for this IfcScheduleTimeControl.

bool IsCritical() const
void setIsCritical(bool v)
bool hasStatusTime() const

Whether the optional attribute StatusTime is defined for this IfcScheduleTimeControl.

::Ifc2x3::IfcDateTimeSelect *StatusTime() const
void setStatusTime(::Ifc2x3::IfcDateTimeSelect *v)
bool hasStartFloat() const

Whether the optional attribute StartFloat is defined for this IfcScheduleTimeControl.

double StartFloat() const
void setStartFloat(double v)
bool hasFinishFloat() const

Whether the optional attribute FinishFloat is defined for this IfcScheduleTimeControl.

double FinishFloat() const
void setFinishFloat(double v)
bool hasCompletion() const

Whether the optional attribute Completion is defined for this IfcScheduleTimeControl.

double Completion() const
void setCompletion(double v)
IfcTemplatedEntityList<IfcRelAssignsTasks>::ptr ScheduleTimeControlAssigned() const
const IfcParse::entity &declaration() const
IfcScheduleTimeControl(IfcEntityInstanceData *e)
IfcScheduleTimeControl(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcDateTimeSelect *v6_ActualStart, ::Ifc2x3::IfcDateTimeSelect *v7_EarlyStart, ::Ifc2x3::IfcDateTimeSelect *v8_LateStart, ::Ifc2x3::IfcDateTimeSelect *v9_ScheduleStart, ::Ifc2x3::IfcDateTimeSelect *v10_ActualFinish, ::Ifc2x3::IfcDateTimeSelect *v11_EarlyFinish, ::Ifc2x3::IfcDateTimeSelect *v12_LateFinish, ::Ifc2x3::IfcDateTimeSelect *v13_ScheduleFinish, boost::optional<double> v14_ScheduleDuration, boost::optional<double> v15_ActualDuration, boost::optional<double> v16_RemainingTime, boost::optional<double> v17_FreeFloat, boost::optional<double> v18_TotalFloat, boost::optional<bool> v19_IsCritical, ::Ifc2x3::IfcDateTimeSelect *v20_StatusTime, boost::optional<double> v21_StartFloat, boost::optional<double> v22_FinishFloat, boost::optional<double> v23_Completion)

Public Static Functions

const IfcParse::entity &Class()
class IfcSecondInMinute : public IfcUtil::IfcBaseType

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSecondInMinute(IfcEntityInstanceData *e)
IfcSecondInMinute(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSectionalAreaIntegralMeasure : public IfcUtil::IfcBaseType

The sectional area integral measure is typically used in torsional analysis. It is usually measured in m^5.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSectionalAreaIntegralMeasure(IfcEntityInstanceData *e)
IfcSectionalAreaIntegralMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSectionedSpine : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO 10303-42:1999: A sectioned spine is a representation of the shape of a three dimensional object composed of a spine curve and a number of planar cross sections. The shape is defined between the first element of cross sections and the last element of this set.

NOTE A sectioned spine may be used to represent a surface or a solid but the interpolation of the shape between the cross-sections is not defined. For the representation of a solid all cross-sections are closed curves.

A sectioned spine (IfcSectionedSpine) is a representation of the shape of a three dimensional object composed by a number of planar cross sections, and a spine curve. The shape is defined between the first element of cross sections and the last element of the cross sections. A sectioned spine may be used to represent a surface or a solid but the interpolation of the shape between the cross sections is not defined. For the representation of a solid all cross sections are areas. For representation of a surface all cross sections are curves. The cross sections are defined as profiles, whereas the consecutive profiles may be derived by a transformation of the start profile or the previous consecutive profile. The spine curve shall be of type IfcCompositeCurve, each of its segments (IfcCompositeCurveSegment) shall correspond to the part between exactly two consecutive cross-sections.

NOTE: Corresponding ISO 10303 entity: sectioned spine. Please refer to ISO/DIS 10303-42-ed2:1999, p. 282 for the definition of the formal standard. The cross sections are defined in IFC as IfcProfileDef. The position coordinate systems are added.

HISTORY New entity in IFC Release 2x.

Figure 268 illustrates an example of an IfcSectionedSpine.

The SpineCurve is given by an IfcCompositeCurve with two Segments. The Segments[1] has a ParentCurve of type IfcPolyline and a Transition = CONTSAMEGRADIENT. The Segments[2] has a ParentCurve of type IfcTrimmedCurve and a Transition = DISCONTINUOUS. Each CrossSectionPosition lies at a start or end point of the Segments. Each CrossSections are inserted by the CrossSectionPositions. The first two cross sections are of type IfcRectangleProfileDef, the third is of type IfcDerivedProfileDef.

Figure 268 — Sectioned spine geometry

Figure 269 illustrates the final result of the IfcSectionedSpine. The body (shown transparently) is not fully defined by the exchange definition.

Figure 269 — Sectioned spine result

Informal propositions

none of the cross sections, after being placed by the cross section positions, shall intersect none of the cross sections, after being placed by the cross section positions, shall lie in the same plane the local origin of each cross section position shall lie at the beginning or end of a composite curve segment.

Public Types

typedef IfcTemplatedEntityList<IfcSectionedSpine> list

Public Functions

::Ifc2x3::IfcCompositeCurve *SpineCurve() const

A single composite curve, that defines the spine curve. Each of the composite curve segments correspond to the part between two cross-sections.

void setSpineCurve(::Ifc2x3::IfcCompositeCurve *v)
IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr CrossSections() const

A list of at least two cross sections, each defined within the xy plane of the position coordinate system of the cross section. The position coordinate system is given by the corresponding list CrossSectionPositions.

void setCrossSections(IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr v)
IfcTemplatedEntityList<::Ifc2x3::IfcAxis2Placement3D>::ptr CrossSectionPositions() const

Position coordinate systems for the cross sections that form the sectioned spine. The profiles defining the cross sections are positioned within the xy plane of the corresponding position coordinate system.

void setCrossSectionPositions(IfcTemplatedEntityList<::Ifc2x3::IfcAxis2Placement3D>::ptr v)
const IfcParse::entity &declaration() const
IfcSectionedSpine(IfcEntityInstanceData *e)
IfcSectionedSpine(::Ifc2x3::IfcCompositeCurve *v1_SpineCurve, IfcTemplatedEntityList<::Ifc2x3::IfcProfileDef>::ptr v2_CrossSections, IfcTemplatedEntityList<::Ifc2x3::IfcAxis2Placement3D>::ptr v3_CrossSectionPositions)

Public Static Functions

const IfcParse::entity &Class()
class IfcSectionModulusMeasure : public IfcUtil::IfcBaseType

IfcSectionModulusMeasure is a measure for the resistance of a cross section against bending or torsional moment. It is usually measured in m^3.

Type: REAL

HISTORY New type in IFC Release 2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSectionModulusMeasure(IfcEntityInstanceData *e)
IfcSectionModulusMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSectionProperties : public IfcUtil::IfcBaseEntity

IfcSectionProperties defines the cross section properties for a single longitudinal piece of a cross section. It is a special-purpose helper class for IfcSectionReinforcementProperties.

HISTORY New entity in IFC2x2.

The section piece may be either uniform or tapered. In the latter case an end profile should also be provided. The start and end profiles are assumed to be of the same profile type. Generally only rectangular or circular cross section profiles are assumed to be used.

Public Types

typedef IfcTemplatedEntityList<IfcSectionProperties> list

Public Functions

::Ifc2x3::IfcSectionTypeEnum::Value SectionType() const

An indicator whether a specific piece of a cross section is uniform or tapered in longitudinal direction.

void setSectionType(::Ifc2x3::IfcSectionTypeEnum::Value v)
::Ifc2x3::IfcProfileDef *StartProfile() const

The cross section profile at the start point of the longitudinal section.

void setStartProfile(::Ifc2x3::IfcProfileDef *v)
bool hasEndProfile() const

Whether the optional attribute EndProfile is defined for this IfcSectionProperties.

::Ifc2x3::IfcProfileDef *EndProfile() const

The cross section profile at the end point of the longitudinal section.

void setEndProfile(::Ifc2x3::IfcProfileDef *v)
const IfcParse::entity &declaration() const
IfcSectionProperties(IfcEntityInstanceData *e)
IfcSectionProperties(::Ifc2x3::IfcSectionTypeEnum::Value v1_SectionType, ::Ifc2x3::IfcProfileDef *v2_StartProfile, ::Ifc2x3::IfcProfileDef *v3_EndProfile)

Public Static Functions

const IfcParse::entity &Class()
class IfcSectionReinforcementProperties : public IfcUtil::IfcBaseEntity

IfcSectionReinforcementProperties defines the cross section properties of reinforcement for a single longitudinal piece of a cross section with a specific reinforcement usage type.

HISTORY New entity in IFC2x2.

Several sets of cross section reinforcement properties represented by instances of IfcReinforcementProperties may be attached to the section reinforcement properties (IfcReinforcementDefinitionProperties of IfcStructuralElementsDomain schema), one for each combination of steel grades and reinforcement bar types and sizes.

Public Functions

double LongitudinalStartPosition() const

The start position in longitudinal direction for the section reinforcement properties.

void setLongitudinalStartPosition(double v)
double LongitudinalEndPosition() const

The end position in longitudinal direction for the section reinforcement properties.

void setLongitudinalEndPosition(double v)
bool hasTransversePosition() const

Whether the optional attribute TransversePosition is defined for this IfcSectionReinforcementProperties.

double TransversePosition() const

The position for the section reinforcement properties in transverse direction.

void setTransversePosition(double v)
::Ifc2x3::IfcReinforcingBarRoleEnum::Value ReinforcementRole() const

The role, purpose or usage of the reinforcement, i.e. the kind of loads and stresses it is intended to carry, defined for the section reinforcement properties.

void setReinforcementRole(::Ifc2x3::IfcReinforcingBarRoleEnum::Value v)
::Ifc2x3::IfcSectionProperties *SectionDefinition() const

Definition of the cross section profile and longitudinal section type.

void setSectionDefinition(::Ifc2x3::IfcSectionProperties *v)
IfcTemplatedEntityList<::Ifc2x3::IfcReinforcementBarProperties>::ptr CrossSectionReinforcementDefinitions() const

The set of reinforcment properties attached to a section reinforcement properties definition.

void setCrossSectionReinforcementDefinitions(IfcTemplatedEntityList<::Ifc2x3::IfcReinforcementBarProperties>::ptr v)
const IfcParse::entity &declaration() const
IfcSectionReinforcementProperties(IfcEntityInstanceData *e)
IfcSectionReinforcementProperties(double v1_LongitudinalStartPosition, double v2_LongitudinalEndPosition, boost::optional<double> v3_TransversePosition, ::Ifc2x3::IfcReinforcingBarRoleEnum::Value v4_ReinforcementRole, ::Ifc2x3::IfcSectionProperties *v5_SectionDefinition, IfcTemplatedEntityList<::Ifc2x3::IfcReinforcementBarProperties>::ptr v6_CrossSectionReinforcementDefinitions)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSectionTypeEnum

Public Types

enum Value

Definition from IAI: An enumeration indicating whether a specific piece of a cross section is uniform or tapered in longitudinal direction.

HISTORY New type in IFC Release 2x2

ENUMERATION

UNIFORM The section is uniform in longitudinal direction.

TAPERED The section is tapered in longitudinal direction.

Values:

enumerator IfcSectionType_UNIFORM
enumerator IfcSectionType_TAPERED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSensorType : public Ifc2x3::IfcDistributionControlElementType

The distribution control element type IfcSensorType defines commonly shared information for occurrences of sensors. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a sensor specification (i.e. the specific product information, that is common to all occurrences of that product type). Sensor types may be exchanged without being already assigned to occurrences. Occurrences of IfcSensorType are represented by instances of IfcSensor.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcDistributionControlElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_SensorTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_SensorTypeConductanceSensor (CONDUCTANCESENSOR) Pset_SensorTypeContactSensor (CONTACTSENSOR) Pset_SensorTypeFireSensor (FIRESENSOR) Pset_SensorTypeFlowSensor (FLOWSENSOR) Pset_SensorTypeGasSensor (GASSENSOR) Pset_SensorTypeHeatSensor (HEATSENSOR) Pset_SensorTypeHumiditySensor (HUMIDITYSENSOR) Pset_SensorTypeIonConcentrationSensor (IONCONCENTRATIONSENSOR) Pset_SensorTypeLevelSensor (LEVELSENSOR) Pset_SensorTypeLightSensor (LIGHTSENSOR) Pset_SensorTypeMoistureSensor (MOISTURESENSOR) Pset_SensorTypeMovementSensor (MOVEMENTSENSOR) Pset_SensorTypePHSensor (PHSENSOR) Pset_SensorTypePressureSensor (PRESSURESENSOR) Pset_SensorTypeRadiationSensor (RADIATIONSENSOR) Pset_SensorTypeRadioactivitySensor (RADIOACTIVITYSENSOR) Pset_SensorTypeSmokeSensor (SMOKESENSOR) Pset_SensorTypeSoundSensor (SOUNDSENSOR) Pset_SensorTypeTemperatureSensor (TEMPERATURESENSOR) Pset_SensorTypeWindSensor (WINDSENSOR)

Material Use Definition The material of the IfcSensorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcSensorType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcSensor for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcSensorType> list

Public Functions

::Ifc2x3::IfcSensorTypeEnum::Value PredefinedType() const

Identifies the predefined types of sensor from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcSensorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSensorType(IfcEntityInstanceData *e)
IfcSensorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSensorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSensorTypeEnum

Public Types

enum Value

The IfcSensorTypeEnum defines the range of different types of sensor that can be specified.

HISTORY: New type in IFC R2.0. Added missing enumerations in IFC2x4

Enumeration

CONDUCTANCESENSOR: A device that senses or detects electrical conductance. CONTACTSENSOR: A device that senses or detects contact, such as for detecting if a door is closed. FIRESENSOR: A device that senses or detects fire. FLOWSENSOR: A device that senses or detects flow in a fluid. GASSENSOR: A device that senses or detects gas concentration. HEATSENSOR: A device that senses or detects heat. IONCONCENTRATIONSENSOR: A device that senses or detects ion concentration, such as for water hardness. LEVELSENSOR: A device that senses or detects fill level, such as for a tank. HUMIDITYSENSOR: A device that senses or detects humidity. LIGHTSENSOR: A device that senses or detects light. MOISTURESENSOR: A device that senses or detects moisture. MOVEMENTSENSOR: A device that senses or detects movement.

PHSENSOR: A device that senses or detects acidity. PRESSURESENSOR: A device that senses or detects pressure. RADIATIONSENSOR: A device that senses or detects electromagnetic radiation. RADIOACTIVITYSENSOR: A device that senses or detects atomic decay. SMOKESENSOR: A device that senses or detects smoke. SOUNDSENSOR: A device that senses or detects sound.

TEMPERATURESENSOR: A device that senses or detects temperature. WINDSENSOR: A device that senses or detects airflow speed and direction. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcSensorType_CO2SENSOR
enumerator IfcSensorType_FIRESENSOR
enumerator IfcSensorType_FLOWSENSOR
enumerator IfcSensorType_GASSENSOR
enumerator IfcSensorType_HEATSENSOR
enumerator IfcSensorType_HUMIDITYSENSOR
enumerator IfcSensorType_LIGHTSENSOR
enumerator IfcSensorType_MOISTURESENSOR
enumerator IfcSensorType_MOVEMENTSENSOR
enumerator IfcSensorType_PRESSURESENSOR
enumerator IfcSensorType_SMOKESENSOR
enumerator IfcSensorType_SOUNDSENSOR
enumerator IfcSensorType_TEMPERATURESENSOR
enumerator IfcSensorType_USERDEFINED
enumerator IfcSensorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcSequenceEnum

Public Types

enum Value

IfcSequenceEnum is an enumeration that defines the different ways in which a time lag is applied to a sequence between two processes.

HISTORY New entity in IFC 1.0

Values:

enumerator IfcSequence_START_START
enumerator IfcSequence_START_FINISH
enumerator IfcSequence_FINISH_START
enumerator IfcSequence_FINISH_FINISH
enumerator IfcSequence_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcServiceLife : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcServiceLife> list

Public Functions

::Ifc2x3::IfcServiceLifeTypeEnum::Value ServiceLifeType() const
void setServiceLifeType(::Ifc2x3::IfcServiceLifeTypeEnum::Value v)
double ServiceLifeDuration() const
void setServiceLifeDuration(double v)
const IfcParse::entity &declaration() const
IfcServiceLife(IfcEntityInstanceData *e)
IfcServiceLife(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcServiceLifeTypeEnum::Value v6_ServiceLifeType, double v7_ServiceLifeDuration)

Public Static Functions

const IfcParse::entity &Class()
class IfcServiceLifeFactor : public Ifc2x3::IfcPropertySetDefinition

Public Types

typedef IfcTemplatedEntityList<IfcServiceLifeFactor> list

Public Functions

::Ifc2x3::IfcServiceLifeFactorTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcServiceLifeFactorTypeEnum::Value v)
bool hasUpperValue() const

Whether the optional attribute UpperValue is defined for this IfcServiceLifeFactor.

::Ifc2x3::IfcMeasureValue *UpperValue() const
void setUpperValue(::Ifc2x3::IfcMeasureValue *v)
::Ifc2x3::IfcMeasureValue *MostUsedValue() const
void setMostUsedValue(::Ifc2x3::IfcMeasureValue *v)
bool hasLowerValue() const

Whether the optional attribute LowerValue is defined for this IfcServiceLifeFactor.

::Ifc2x3::IfcMeasureValue *LowerValue() const
void setLowerValue(::Ifc2x3::IfcMeasureValue *v)
const IfcParse::entity &declaration() const
IfcServiceLifeFactor(IfcEntityInstanceData *e)
IfcServiceLifeFactor(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcServiceLifeFactorTypeEnum::Value v5_PredefinedType, ::Ifc2x3::IfcMeasureValue *v6_UpperValue, ::Ifc2x3::IfcMeasureValue *v7_MostUsedValue, ::Ifc2x3::IfcMeasureValue *v8_LowerValue)

Public Static Functions

const IfcParse::entity &Class()
struct IfcServiceLifeFactorTypeEnum

Public Types

enum Value

Values:

enumerator IfcServiceLifeFactorType_A_QUALITYOFCOMPONENTS
enumerator IfcServiceLifeFactorType_B_DESIGNLEVEL
enumerator IfcServiceLifeFactorType_C_WORKEXECUTIONLEVEL
enumerator IfcServiceLifeFactorType_D_INDOORENVIRONMENT
enumerator IfcServiceLifeFactorType_E_OUTDOORENVIRONMENT
enumerator IfcServiceLifeFactorType_F_INUSECONDITIONS
enumerator IfcServiceLifeFactorType_G_MAINTENANCELEVEL
enumerator IfcServiceLifeFactorType_USERDEFINED
enumerator IfcServiceLifeFactorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcServiceLifeTypeEnum

Public Types

enum Value

Values:

enumerator IfcServiceLifeType_ACTUALSERVICELIFE
enumerator IfcServiceLifeType_EXPECTEDSERVICELIFE
enumerator IfcServiceLifeType_OPTIMISTICREFERENCESERVICELIFE
enumerator IfcServiceLifeType_PESSIMISTICREFERENCESERVICELIFE
enumerator IfcServiceLifeType_REFERENCESERVICELIFE

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcShapeAspect : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-41:1992: The shape aspect is an identifiable element of the shape of a product.

IfcShapeAspect allows for grouping of shape representation items that represent aspects (or components) of the shape of a product. Thereby shape representations of components of the product shape represent a distinctive part to a product that can be explicitly addressed.

NOTEThe definition of this class relates to the ISO 10303 entity shape_aspect. Please refer to ISO/IS 10303-41:1994 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 2.0

IFC 2x4 CHANGE Attribute PartOfProductDefinitionShape declared OPTIONAL with upward compatibility for file based exchange.

Informal propositions:

If ShapeRepresentations points to shape representations that are part of an IfcProductDefinitionShape, PartOfProductDefinitionShape must refer to this instance of IfcProductDefinitionShape.

NOTE PartOfProductDefinitionShape is only to be omitted if the shape representations are attached to an IfcRepresentationMap. This enables the use of IfcShapeAspect with IfcRepresentationMap’s that are used by an IfcTypeProduct through the RepresentationMaps attribute.

Public Types

typedef IfcTemplatedEntityList<IfcShapeAspect> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcShapeModel>::ptr ShapeRepresentations() const

List of shape representations. Each member defines a valid representation of a particular type within a particular representation context as being an aspect (or part) of a product definition. IFC2x Edition 3 CHANGE The data type has been changed from IfcShapeRepresentation to IfcShapeModel with upward compatibility

void setShapeRepresentations(IfcTemplatedEntityList<::Ifc2x3::IfcShapeModel>::ptr v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcShapeAspect.

std::string Name() const

The word or group of words by which the shape aspect is known. It is a tag to indicate the particular semantic of a component within the product definition shape, used to provide meaning. Example: use the tag “Glazing” to define which component of a window shape defines the glazing area.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcShapeAspect.

std::string Description() const

The word or group of words that characterize the shape aspect. It can be used to add additional meaning to the name of the aspect.

void setDescription(std::string v)
bool ProductDefinitional() const
void setProductDefinitional(bool v)
::Ifc2x3::IfcProductDefinitionShape *PartOfProductDefinitionShape() const

Reference to the product definition shape of which this class is an aspect.

void setPartOfProductDefinitionShape(::Ifc2x3::IfcProductDefinitionShape *v)
const IfcParse::entity &declaration() const
IfcShapeAspect(IfcEntityInstanceData *e)
IfcShapeAspect(IfcTemplatedEntityList<::Ifc2x3::IfcShapeModel>::ptr v1_ShapeRepresentations, boost::optional<std::string> v2_Name, boost::optional<std::string> v3_Description, bool v4_ProductDefinitional, ::Ifc2x3::IfcProductDefinitionShape *v5_PartOfProductDefinitionShape)

Public Static Functions

const IfcParse::entity &Class()
class IfcShapeModel : public Ifc2x3::IfcRepresentation

IfcShapeModel represents the concept of a particular geometric and/or topological representation of a product’s shape or a product component’s shape within a representation context. This representation context has to be a geometric representation context (with the exception of topology representations without associated geometry). The two subtypes are IfcShapeRepresentation to cover geometric models that represent a shape, and IfcTopologyRepresentation to cover the conectivity of a product or product component. The topology may or may not have geometry associated.

The IfcShapeModel can be a shape representation (geometric and/or topologogical) of a product (via IfcProductDefinitionShape), or a shape representation (geometric and/or topologogical) of a component of a product shape (via IfcShapeAspect).

HISTORY New entity in IFC2x3.

Subclassed by Ifc2x3::IfcShapeRepresentation, Ifc2x3::IfcTopologyRepresentation

Public Types

typedef IfcTemplatedEntityList<IfcShapeModel> list

Public Functions

IfcTemplatedEntityList<IfcShapeAspect>::ptr OfShapeAspect() const
const IfcParse::entity &declaration() const
IfcShapeModel(IfcEntityInstanceData *e)
IfcShapeModel(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcShapeRepresentation : public Ifc2x3::IfcShapeModel

The IfcShapeRepresentation represents the concept of a particular geometric representation of a product or a product component within a specific geometric representation context. The inherited attribute RepresentationType is used to define the geometric model used for the shape representation (for example, ‘SweptSolid’, or ‘Brep’), the inherited attribute RepresentationIdentifier is used to denote the part of the representation captured by the IfcShapeRepresentation (for example, ‘Axis’, ‘Body’).

Several representation identifiers for shape representation are included as predefined values for RepresentationIdentifier:

Box Bounding box as simplified 3D box geometry of an element

Annotation 2D annotations not representing elements

Axis 2D or 3D Axis, or single line, representation of an element

FootPrint 2D Foot print, or double line, representation of an element, projected to ground view

Surface 3D Surface representation, e.g. of an analytical surface, of an elementplane)

Body 3D Body representation, e.g. as wireframe, surface, or solid model, of an element

Lighting Representation of emitting light as a light source within a shape representation

Several representation types for shape representation are included as predefined values for RepresentationType:

Curve2D 2 dimensional curve

Curve3D 3 dimensional curve

Surface2D 2 dimensional surface (a region on ground view)

Surface3D 3 dimensional surface

GeometricSet points, curves, surfaces (2 or 3 dimensional)

GeometricCurveSet points, curves (2 or 3 dimensional)

Annotation2D points, curves (2 or 3 dimensional), hatches and text (2 dimensional)

SurfaceModel face based and shell based surface model

SolidModel including swept solid, Boolean results and Brep bodies more specific types are:

SweptSolid swept area solids, by extrusion and revolution, excluding tapered sweeps

AdvancedSweptSolid swept area solids created by sweeping a profile along a directrix, and tapered sweeps

Brep faceted Brep’s with and without voids

AdvancedBrep Brep’s based on advanced faces, with b-spline surface geometry, with and without voids

CSG Boolean results of operations between solid models, half spaces and Boolean results

Clipping Boolean differences between swept area solids, half spaces and Boolean results

additional types

some additional representation types are provided:

BoundingBox simplistic 3D representation by a bounding box

SectionedSpine cross section based representation of a spine curve and planar cross sections. It can represent a surface or a solid and the interpolations of the between the cross sections is not defined

LightSource light source with (depending on type) position, orientation, light colour, intensity and attenuation

MappedRepresentation representation based on mapped item(s), referring to a representation map. Note: it can be seen as an inserted block reference. The shape representation of the mapped item has a representation type declaring the type of its representation items.

Table 1: string values for the inherited attribute ‘RepresentationType’.

NOTE The definition of this entity relates to the ISO 10303 entity shape_representation. Please refer to ISO/IS 10303-41:1994 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.

IFC2x4 CHANGE The RepresentationType’s ‘Curve3D’, ‘Surface2D’, ‘Surface3D’, ‘AdvancedBrep’, ‘LightSource’, and the RepresentationIdentifier ‘Lighting’ have been added.

Public Types

typedef IfcTemplatedEntityList<IfcShapeRepresentation> list

Public Functions

const IfcParse::entity &declaration() const
IfcShapeRepresentation(IfcEntityInstanceData *e)
IfcShapeRepresentation(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcShearModulusMeasure : public IfcUtil::IfcBaseType

IfcShearModulusMeasure is a measure of shear modulus. Usually measured in N/m2. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcShearModulusMeasure(IfcEntityInstanceData *e)
IfcShearModulusMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcShellBasedSurfaceModel : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A shell based surface model is described by a set of open or closed shells of dimensionality 2. The shells shall not intersect except at edges and vertices. In particular, distinct faces may not intersect. A complete face of one shell may be shared with another shell. Coincident portions of shells shall both reference the same faces, edges and vertices defining the coincident region. There shall be at least one shell.

A shell may exist independently of a surface model.

NOTE Corresponding ISO 10303-42 entity: shell_based_surface_model. Please refer to ISO/IS 10303-42:1994, p. 187 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Informal propositions

The dimensionality of the shell based surface model is 2.

The shells shall not overlap or intersect except at common faces, edges or vertices.

Public Functions

IfcEntityList::ptr SbsmBoundary() const
void setSbsmBoundary(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcShellBasedSurfaceModel(IfcEntityInstanceData *e)
IfcShellBasedSurfaceModel(IfcEntityList::ptr v1_SbsmBoundary)

Public Static Functions

const IfcParse::entity &Class()
class IfcSimpleProperty : public Ifc2x3::IfcProperty

IfcSimpleProperty is a generalization of a single property object. The various subtypes of IfcSimpleProperty establish different ways in which a property value can be set.

HISTORY New Entity in IFC Release 1.0, definition changed in IFC Release 2x.

Subclassed by Ifc2x3::IfcPropertyBoundedValue, Ifc2x3::IfcPropertyEnumeratedValue, Ifc2x3::IfcPropertyListValue, Ifc2x3::IfcPropertyReferenceValue, Ifc2x3::IfcPropertySingleValue, Ifc2x3::IfcPropertyTableValue

Public Types

typedef IfcTemplatedEntityList<IfcSimpleProperty> list

Public Functions

const IfcParse::entity &declaration() const
IfcSimpleProperty(IfcEntityInstanceData *e)
IfcSimpleProperty(std::string v1_Name, boost::optional<std::string> v2_Description)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSIPrefix

Public Types

enum Value

Definition from ISO/CD 10303-41:1992: An SI prefix is the name of a prefix that may be associated with an SI unit. The definitions of SI prefixes are specified in ISO 1000 (clause 3).

NOTE The prefix defines multiples and submultiples of the SI units.

NOTE Corresponding ISO 10303 name: SI_prefix, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

ENUMERATION

EXA: 10^18. PETA: 10^15. TERA: 10^12. GIGA: 10^9. MEGA: 10^6. KILO: 10^3. HECTO: 10^2.

DECA: 10. DECI: 10^-1. CENTI: 10^-2. MILLI: 10^-3. MICRO: 10^-6. NANO: 10^-9. PICO: 10^-12. FEMTO: 10^-15. ATTO: 10^-18.

HISTORY New entity in IFC Release 1.5.1.

Values:

enumerator IfcSIPrefix_EXA
enumerator IfcSIPrefix_PETA
enumerator IfcSIPrefix_TERA
enumerator IfcSIPrefix_GIGA
enumerator IfcSIPrefix_MEGA
enumerator IfcSIPrefix_KILO
enumerator IfcSIPrefix_HECTO
enumerator IfcSIPrefix_DECA
enumerator IfcSIPrefix_DECI
enumerator IfcSIPrefix_CENTI
enumerator IfcSIPrefix_MILLI
enumerator IfcSIPrefix_MICRO
enumerator IfcSIPrefix_NANO
enumerator IfcSIPrefix_PICO
enumerator IfcSIPrefix_FEMTO
enumerator IfcSIPrefix_ATTO

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSite : public Ifc2x3::IfcSpatialStructureElement

Definition from ISO 6707-1:1989: Area where construction works are undertaken. A site is a defined area of land, possibly covered with water, on which the project construction is to be completed. A site may be used to erect building(s) or other AEC products. A site (IfcSite) may include a definition of the single geographic reference point for this site (global position using WGS84 with Longitude, Latitude and Elevation). The precision is provided up to millionth of a second and it provides an absolute placement in relation to the real world as used in exchange with geospational information systems. If asserted, the Longitude, Latitude and Elevation establish the point in WGS84 where the point 0.,0.,0. of the LocalPlacement of IfcSite is situated. The geometrical placement of the site, defined by the IfcLocalPlacement, shall be always relative to the spatial structure element, in which this site is included, or absolute, i.e. to the world coordinate system, as established by the geometric representation context of the project. The world coordinate system, established at the IfcProject.RepresentationContexts, may include a definition of the true north within the XY plane of the world coordinate system, if provided, it can be obtained at IfcGeometricRepresentationContext.TrueNorth. A project may span over several connected or disconnected sites. Therefore site complex provides for a collection of sites included in a project. A site can also be decomposed in parts, where each part defines a site section. This is defined by the composition type attribute of the supertype IfcSpatialStructureElements which is interpreted as follow:

COMPLEX = site complex ELEMENT = site PARTIAL = site section

HISTORY New entity in IFC Release 1.0.

Property Set Use Definition The property sets relating to the IfcSite are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcSite are part of this IFC release:

Pset_SiteCommon: common property set for all types of site

Quantity Use Definition The quantities relating to the IfcSite are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_SiteBaseQuantities: base quantities for all site occurrences.

Spatial Structure Use Definition The IfcSite is used to build the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical). The spatial structure elements are linked together by using the objectified relationship IfcRelAggregates. The IfcSite references them by its inverse relationships:

IfcSite.Decomposes referencing (IfcProject || IfcSite) by IfcRelAggregates.RelatingObject, If it refers to another instance of IfcSite, the referenced IfcSite needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcSite has ELEMENT), or ELEMENT (if the other IfcSite has PARTIAL). IfcSite.IsDecomposedBy referencing (IfcSite || IfcBuilding || IfcSpace) by IfcRelAggregates.RelatedObjects. If it refers to another instance of IfcSite, the referenced IfcSite needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcSite has COMPLEX), or PARTIAL (if the other IfcSite has ELEMENT).

If there are building elements and/or other elements directly related to the IfcSite (like a fence, or a shear wall), they are associated with the IfcSite by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcIfcSite references them by its inverse relationship:

IfcSite.ContainsElements referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.

Figure 51 shows the IfcSite as part of the spatial structure. In addition to the logical spatial structure, also the placement hierarchy is shown. In this example the spatial structure hierarchy and the placement hierarchy are identical. NOTE Detailed requirements on mandatory element containment and placement structure relationships are given in view definitions and implementer agreements.

Figure 51 — Site composition

Attribute Use Definition Figure 52 describes the heights and elevations of the IfcSite. It is used to provide the geographic longitude, latitude, and height above sea level for the origin of the site. The origin of the site is the local placement. The provision of longitude, latitude, height at the IfcSite for georeferencing is provided for upward compatibility reasons. It requires a single instance of IfcSite and WGS84 as coordinate reference system. For exact georeferencing the new entities IfcCoordinateReferenceSystem and IfcMapConversion should be used.

reference height of site is provided by: IfcSite.RefElevation, it is given according to the height datum used at this location. the reference height of each building situated at the site is given againt the same height datum used at this location. the elevations of each storey belonging to each building are given as local height relative to the reference height of the building.

Figure 52 — Site elevations

Geometry Use Definitions The geometric representation of IfcSite is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. Local placement The local placement for IfcSite is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point to the IfcSpatialStructureElement of type “IfcSite”, if relative placement is used (e.g. to position a site relative a a site complex, or a site section to a site). If the relative placement is not used, the absolute placement is defined within the world coordinate system. If there is only one site object, then this is the default situation.

Foot Print Representation The foot print representation of IfcSite is given by either a single 2D curve (such as IfcPolyline or IfcCompositeCurve), or by a list of 2D curves (in case of inner boundaries). The representation identifier and type of this geometric representation of IfcSite is:

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’ IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’, or ‘Annotation2D’

Survey Points Representation The survey point representation of IfcSite is defined using a set of survey points and optionally breaklines. The breaklines are restricted to only connect points given in the set of survey points. Breaklines, if given, are used to constrain the triangulation. The representation identifier and type of this geometric representation of IfcSite is:

IfcShapeRepresentation.RepresentationIdentifier = ‘SurveyPoints’ IfcShapeRepresentation.RepresentationType = ‘GeometricCurveSet’

Figure 53 shows a set of survey points, given as 3D Cartesian points within the object coordinate system of the site. Figure 54 shows the result after facetation. The set of IfcCartesianPoint is included in the set of IfcGeometricCurveSet.Elements.

Figure 53 — Site survey points Figure 54 — Site survey points facetation

Figure 55 shows A set of survey points, given as 3D Cartesian points, and a set of break points, given as a set of lines, connecting some survey points, within the object coordinate system of the site. Figure 56 shows the result after facetation. The set of IfcCartesianPoint and the set of IfcPolyline are included in the set of IfcGeometricCurveSet.Elements.

Figure 55 — Site breaklines Figure 56 — Site breaklines facetation

NOTE The geometric representation of the site has been based on the ARM level description of the site_shape_representation given within the ISO 10303-225 “Building Elements using explicit shape representation”.

Body Representation The body representation of IfcSite is defined using a solid or surface model. Applicable solids are the IfcFacetedBrep or on the IfcFacetedBrepWithVoids, applicable surface models are the IfcFaceBasedSurfaceModel and the IfcShellBasedSurfaceModel. The representation identifier and type of this representation of IfcSite is:

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’ IfcShapeRepresentation.RepresentationType = ‘Brep’, or ‘SurfaceModel’

Public Types

typedef IfcTemplatedEntityList<IfcSite> list

Public Functions

bool hasRefLatitude() const

Whether the optional attribute RefLatitude is defined for this IfcSite.

std::vector<int> RefLatitude() const

World Latitude at reference point (most likely defined in legal description). Defined as integer values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84. Latitudes are measured relative to the geodetic equator, north of the equator by positive values - from 0 till +90, south of the equator by negative values - from 0 till -90.

void setRefLatitude(std::vector<int> v)
bool hasRefLongitude() const

Whether the optional attribute RefLongitude is defined for this IfcSite.

std::vector<int> RefLongitude() const

World Longitude at reference point (most likely defined in legal description). Defined as integer values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84. Longitudes are measured relative to the geodetic zero meridian, nominally the same as the Greenwich prime meridian: longitudes west of the zero meridian have negative values - from 0 till -180, longitudes east of the zero meridian have positive values - from 0 till -180. Example: Chicago Harbor Light has according to WGS84 a longitude -87.35.40 (or 87.35.40W) and a latitude 41.53.30 (or 41.53.30N).

void setRefLongitude(std::vector<int> v)
bool hasRefElevation() const

Whether the optional attribute RefElevation is defined for this IfcSite.

double RefElevation() const

Datum elevation relative to sea level.

void setRefElevation(double v)
bool hasLandTitleNumber() const

Whether the optional attribute LandTitleNumber is defined for this IfcSite.

std::string LandTitleNumber() const

The land title number (designation of the site within a regional system).

void setLandTitleNumber(std::string v)
bool hasSiteAddress() const

Whether the optional attribute SiteAddress is defined for this IfcSite.

::Ifc2x3::IfcPostalAddress *SiteAddress() const

Address given to the site for postal purposes.

void setSiteAddress(::Ifc2x3::IfcPostalAddress *v)
const IfcParse::entity &declaration() const
IfcSite(IfcEntityInstanceData *e)
IfcSite(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_LongName, ::Ifc2x3::IfcElementCompositionEnum::Value v9_CompositionType, boost::optional<std::vector<int>> v10_RefLatitude, boost::optional<std::vector<int>> v11_RefLongitude, boost::optional<double> v12_RefElevation, boost::optional<std::string> v13_LandTitleNumber, ::Ifc2x3::IfcPostalAddress *v14_SiteAddress)

Public Static Functions

const IfcParse::entity &Class()
class IfcSIUnit : public Ifc2x3::IfcNamedUnit

Definition from ISO/CD 10303-41:1992: An SI unit is the fixed quantity used as a standard in terms of which items are measured as defined by ISO 1000 (clause 2).

IfcSIUnit covers both standard base SI units such as meter and second, and derived SI units such as Pascal, square meter and cubic meter.

NOTE Corresponding ISO 10303 name: si_unit, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcSIUnit> list

Public Functions

bool hasPrefix() const

Whether the optional attribute Prefix is defined for this IfcSIUnit.

::Ifc2x3::IfcSIPrefix::Value Prefix() const

The SI Prefix for defining decimal multiples and submultiples of the unit.

void setPrefix(::Ifc2x3::IfcSIPrefix::Value v)
::Ifc2x3::IfcSIUnitName::Value Name() const

The word, or group of words, by which the SI unit is referred to.

NOTE Even though the SI system’s base unit for mass is kilogram, the IfcSIUnit for mass is gram if no Prefix is asserted.

void setName(::Ifc2x3::IfcSIUnitName::Value v)
const IfcParse::entity &declaration() const
IfcSIUnit(IfcEntityInstanceData *e)
IfcSIUnit(::Ifc2x3::IfcUnitEnum::Value v2_UnitType, boost::optional<::Ifc2x3::IfcSIPrefix::Value> v3_Prefix, ::Ifc2x3::IfcSIUnitName::Value v4_Name)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSIUnitName

Public Types

enum Value

Definition from ISO/CD 10303-41:1992: An SI unit name is the name of an SI unit. The definitions of the names of SI units are specified in ISO 1000 (clause 2).

NOTE Corresponding STEP name: SI_unit_name, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

ENUMERATION

AMPERE: Unit for electric current. BECQUEREL: Unit for radioactivity. CANDELA: Unit for luminousintensity. COULOMB: Unit for electric charge. CUBIC_METRE: Unit for volume. DEGREE_CELSIUS: Unit for thermodynamic temperature. FARAD: Unit for electric capacitance. GRAM: Unit for mass. GRAY: Unit for absorbed radioactive dose. HENRY: Unit for inductance. HERTZ: Unit for frequency. JOULE: Unit for energy. KELVIN: Unit for thermodynamic temperature. LUMEN: Unit for luminous flux. LUX: Unit for illuminance. METRE: Unit for length. MOLE: Unit for amount of substance. NEWTON: Unit for force. OHM: Unit for electric resistance. PASCAL: Unit for pressure. RADIAN: Unit for plane angle. SECOND: Unit for time. SIEMENS: Unit for electric conductance. SIEVERT: Unit for radioactive dose equivalent. SQUARE_METRE: Unit for area. STERADIAN: Unit for solid angle. TESLA: Unit for magnetic flux density. VOLT: Unit for electric voltage. WATT: Unit for power. WEBER: Unit for magnetic flux.

HISTORY New entity in IFC Release 1.5.1.

Values:

enumerator IfcSIUnitName_AMPERE
enumerator IfcSIUnitName_BECQUEREL
enumerator IfcSIUnitName_CANDELA
enumerator IfcSIUnitName_COULOMB
enumerator IfcSIUnitName_CUBIC_METRE
enumerator IfcSIUnitName_DEGREE_CELSIUS
enumerator IfcSIUnitName_FARAD
enumerator IfcSIUnitName_GRAM
enumerator IfcSIUnitName_GRAY
enumerator IfcSIUnitName_HENRY
enumerator IfcSIUnitName_HERTZ
enumerator IfcSIUnitName_JOULE
enumerator IfcSIUnitName_KELVIN
enumerator IfcSIUnitName_LUMEN
enumerator IfcSIUnitName_LUX
enumerator IfcSIUnitName_METRE
enumerator IfcSIUnitName_MOLE
enumerator IfcSIUnitName_NEWTON
enumerator IfcSIUnitName_OHM
enumerator IfcSIUnitName_PASCAL
enumerator IfcSIUnitName_RADIAN
enumerator IfcSIUnitName_SECOND
enumerator IfcSIUnitName_SIEMENS
enumerator IfcSIUnitName_SIEVERT
enumerator IfcSIUnitName_SQUARE_METRE
enumerator IfcSIUnitName_STERADIAN
enumerator IfcSIUnitName_TESLA
enumerator IfcSIUnitName_VOLT
enumerator IfcSIUnitName_WATT
enumerator IfcSIUnitName_WEBER

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSlab : public Ifc2x3::IfcBuildingElement

A slab is a component of the construction that normally encloses a space vertically. The slab may provide the lower support (floor) or upper construction (roof slab) in any space in a building. It shall be noted, that only the core or constructional part of this construction is considered to be a slap. The upper finish (flooring, roofing) and the lower finish (ceiling, suspended ceiling) are considered to be coverings. A special type of slab is the landing, described as a floor section to which one or more stair flights or ramp flights connect. NOTE There is a representation of slabs for structural analysis provided by a proper subtype of IfcStructuralMember being part of the IfcStructuralAnalysisModel.

NOTE An arbitrary planar element to which this semantic information is not applicable or irrelevant shall be modeled as IfcPlate. A slab may have openings, such as floor openings, or recesses. They are defined by an IfcOpeningElement attached to the slab using the inverse relationship HasOpenings pointing to IfcRelVoidsElement. The IFC specification provides three entities for slab occurrences:

IfcSlabStandardCase used for all occurrences of slabs, that are prismatic and where the thickness parameter can be fully described by the IfcMaterialLayerSetUsage. These slabs are always represented geometrically by a ‘SweptSolid’ geometry (or by a ‘Clipping’ geometry based on ‘SweptSolid’), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialLayerSetUsage assigned. IfcSlabElementedCase used for occurrences of slabs which are aggregated from subordinate elements, following specific decomposition rules expressed by the mandatory use of IfcRelAggregates relationship. IfcSlab used for all other occurrences of slabs, particularly for slabs with changing thickness, or slabs with non planar surfaces, and slabs having only ‘SweptSolid’ or ‘Brep’ geometry.

HISTORY New entity in IFC Release 2.0, it is a merger of the two previous entities IfcFloor, IfcRoofSlab, introduced in IFC Release 1.0

Type Use Definition The IfcSlab defines the occurrence of any slab, common information about slab types (or styles) is handled by IfcSlabType. The IfcSlabType (if present) may establish the commontype name, usage (or predefined) type, common set of properties, common material layer set, and common shape representations (using IfcRepresentationMap). The IfcSlabType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcSlabType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. Values of the enumeration are .FLOOR. (the default), .ROOF., .LANDING., .BASESLAB. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcSlab is defined by IfcMaterialLayerSet, or IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Multi-layer slabs can be represented by referring to several IfcMaterialLayer’s within the IfcMaterialLayerSet. NOTE It is illegal to assign an IfcMaterialLayerSetUsage to an IfcSlab. Only the subtype IfcSlabStandardCase supports this concept. NOTE Prismatic slabs, where the main face of the slab is extruded along the slab thickness, are exchanged as IfcSlabStandardCase, The material for IfcSlabStandardCase shall be defined byIfcMaterialLayerSetUsage. Multi-layer slabs can be represented by referring to several IfcMaterialLayer’s within the IfcMaterialLayerSet. Material information can also be given at the IfcSlabType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcSlabType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial. Property Set Use Definition: The property sets relating to the IfcSlab are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcSlab are part of this IFC release:

Pset_SlabCommon: common property set for all slab occurrences

Property sets can also be given at the IfcSlabType, defining the common property data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcSlabType.HasPropertySets. If both are given, then the properties directly assigned to IfcSlab overrides the properties assigned to IfcSlabType. Quantity Use Definition The quantities relating to the IfcSlab and IfcSlabStandardCase are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcSlabType.

Qto_SlabBaseQuantities: base quantities for all slab occurrences.

Containment Use Definition The IfcSlab, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierarchical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

TheIfcSlab is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. TheIfcSlab may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

The IfcSlabmay also be an aggregate i.e. being composed by other elements and acting as an assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.IsDecomposedBy. Components of a slab are described by instances of subtypes of IfcBuildingElement, with IfcBuildingElementPart as a special focus subtype that are aggregated to form a complex slab. In this case, the contained elements should not be additionally contained in the project spatial hierarchy, i.e. the inverse attribute SELF\IfcElement.ContainedInStructure of IfcBuildingElementPart (or other subtypes of IfcBuildingElement) should be NIL. Geometry Use Definition The geometric representation of IfcSlab is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Included are: NOTE. If the IfcSlab is of type Landing and is used within an IfcStair or IfcRamp, the special agreements to handle stair and ramp geometry will also affect the geometric representation of the IfcSlab. Local Placement The local placement for IfcSlab is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the placement of 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 IfcSlab is of type Landing and is used by an IfcStair or IfcRamp, and this container class defines its own local placement, then the PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the aggregate. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representation Currently, the ‘Surface’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Surface Representation The surfacic geometric representation of IfcSlab is defined using the ‘Surface’ representation.

RepresentationIdentifier : ‘Surface’ RepresentationType : ‘Surface3D’

NOTE The ‘Surface’ can be used to define a surfacic model of the building (e.g. for analytical purposes, or for reduced Level of Detail representation). Body Representation The body representation of IfcSlab can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used: If a corresponding material definition using IfcMaterialLayerSetUsage can be assigned, the subtype IfcSlabStandardCase shall be used.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the swept solid representation:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcArbitraryClosedProfileDef, IfcRectangleProfileDef, IfcCircleProfileDef, IfcEllipseProfileDef shall be supported. Extrusion: The profile can be extruded perpendicularly or non-perpendicularly to the plane of the swept profile.

Figure 120 illustrates a ‘SweptSolid’ geometric representation. NOTE The following interpretation of dimension parameter applies for polygonal slabs (in ground floor view):

IfcArbitraryClosedProfileDef.OuterCurve: closed bounded curve interpreted as area (or foot print) of the slab.

Figure 120 — Slab body extrusion

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The following constraints apply to the ‘Clipping’ representation:

Solid: see ‘SweptSolid’ shape representation, Profile:see ‘SweptSolid’ shape representation, Extrusion:see ‘SweptSolid’ shape representation, Boolean result: The IfcBooleanClippingResult shall be supported, allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid.

Figure 121 illustrates a ‘Clipping’ geometric representation with definition of a roof slab using advanced geometric representation. The profile is extruded non-perpendicular and the slab body is clipped at the eave.

Figure 121 — Slab body clipping

Public Types

typedef IfcTemplatedEntityList<IfcSlab> list

Public Functions

bool hasPredefinedType() const

Whether the optional attribute PredefinedType is defined for this IfcSlab.

::Ifc2x3::IfcSlabTypeEnum::Value PredefinedType() const

Predefined generic type for a slab that is specified in an enumeration. There may be a property set given specifically for the predefined types. NOTE The PredefinedType shall only be used, if no type object IfcSlabType is assigned, providing its own IfcSlabType.PredefinedType.

FC2x PLATFORM CHANGE: The attribute has been changed into an OPTIONAL attribute.

void setPredefinedType(::Ifc2x3::IfcSlabTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSlab(IfcEntityInstanceData *e)
IfcSlab(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcSlabTypeEnum::Value> v9_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
class IfcSlabType : public Ifc2x3::IfcBuildingElementType

The element type IfcSlabType defines commonly shared information for occurrences of slabs. The set of shared information may include:

common properties within shared property sets common material information common material layer definitions common shape representations

NOTE It is illegal to share shape representations as representation maps for occurrences of IfcSlabStandardCase.

It is used to define a slab specification (i.e. the specific product information, that is common to all occurrences of that product type). Slab types may be exchanged without being already assigned to occurrences. NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. The occurrences of the IfcSlabType within building models are represented by instances of IfcSlabStandardCase if the IfcSlabType has a single associated IfcMaterialLayerSet; otherwise they are represented by instances of IfcSlab, or IfcSlabElementedCase.

HISTORY New entity in Release IFC2x2.

Informal proposition:

The material assignment, if provided using the IfcRelAssociatesMaterial relationship, shall not reference the IfcMaterialLayerSetUsage.

Material Use Definition The material of the IfcSlabType is defined by the IfcMaterialLayerSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcSlabType, if there is at least one occurrences. of IfcSlabStandardCase for this type. Layer Set Use Definition: The shared material layer set definition is defined by assigning an IfcMaterialLayerSet (see material use definition above). The IfcMaterialLayer refers to one or several of IfcMaterial that is the common for all slab occurrence, if used. It is only applicable if the IfcSlabType has only occurrences of type IfcSlabStandardCase (see definition of IfcSlabStandardCase for further information). NOTE Since each individual instance of IfcSlabStandardCase defines its own IfcMaterialLayerSetUsage including the offset from the reference plane, the same IfcSlabType can be used independently of the reference plane alignment of its occurrences. Property Set Use Definition: The shared property sets relating to the IfcSlabType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcWallType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcSlabType and those that are only assignable to IfcSlab. If the same property is assigned to the IfcSlabType and the IfcSlab being an occurrence of the IfcSlabType, then the occurrence property overrides the type property.

Pset_SlabCommon: common property set for all slab types.

Public Types

typedef IfcTemplatedEntityList<IfcSlabType> list

Public Functions

::Ifc2x3::IfcSlabTypeEnum::Value PredefinedType() const

Identifies the predefined types of a slab element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcSlabTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSlabType(IfcEntityInstanceData *e)
IfcSlabType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSlabTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSlabTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the available predefined types of a slab. The IfcSlabTypeEnum can be used for slab occurrences, IfcSlab, and slab types, IfcSlabType. A special property set definition may be provided for each predefined type.

HISTORY New type in IFC Release 2.0

Floor

The slab is used to represent a floor slab.

Roof

The slab is used to represent a roof slab (either flat or sloped).

Landing

The slab is used to represent a landing within a stair or ramp.

BaseSlab

The slab is used to represent a floor slab against the ground (and thereby being a part of the foundation). Another name is mat foundation.

IFC2x3 CHANGE new enumerator added.

Values:

enumerator IfcSlabType_FLOOR
enumerator IfcSlabType_ROOF
enumerator IfcSlabType_LANDING
enumerator IfcSlabType_BASESLAB
enumerator IfcSlabType_USERDEFINED
enumerator IfcSlabType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSlippageConnectionCondition : public Ifc2x3::IfcStructuralConnectionCondition

Definition from IAI: Describes slippage in support conditions or connection conditions. Slippage means that a relative displacement may occur in a support or connection before support or connection reactions are awoken.

Applicability:

Point supports and connections, curve supports and connections, surface supports and connections.

HISTORY: New entity in IFC 2x2.

Public Functions

bool hasSlippageX() const

Whether the optional attribute SlippageX is defined for this IfcSlippageConnectionCondition.

double SlippageX() const

Slippage in x-direction of the coordinate system defined by the instance which uses this resource object.

void setSlippageX(double v)
bool hasSlippageY() const

Whether the optional attribute SlippageY is defined for this IfcSlippageConnectionCondition.

double SlippageY() const

Slippage in y-direction of the coordinate system defined by the instance which uses this resource object.

void setSlippageY(double v)
bool hasSlippageZ() const

Whether the optional attribute SlippageZ is defined for this IfcSlippageConnectionCondition.

double SlippageZ() const

Slippage in z-direction of the coordinate system defined by the instance which uses this resource object.

void setSlippageZ(double v)
const IfcParse::entity &declaration() const
IfcSlippageConnectionCondition(IfcEntityInstanceData *e)
IfcSlippageConnectionCondition(boost::optional<std::string> v1_Name, boost::optional<double> v2_SlippageX, boost::optional<double> v3_SlippageY, boost::optional<double> v4_SlippageZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcSolidAngleMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A solid angle measure is the value of an angle in a solid. Usually measured in Steradians, (sr, m2/m2). Type: REAL

NOTE Corresponding ISO 10303 name: solid_angle_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSolidAngleMeasure(IfcEntityInstanceData *e)
IfcSolidAngleMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSolidModel : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A solid model is a complete representation of the nominal shape of a product such that all points in the interior are connected. Any point can be classified as being inside, outside, or on the boundary of a solid. There are several different types of solid model representations.

NOTE: Corresponding ISO 10303-42 entity: solid_model, only three subtypes have been incorporated into the current IFC Release - subset of manifold_solid_brep (IfcManifoldSolidBrep, constraint to faceted B-rep), swept_area_solid (IfcSweptAreaSolid), the swept_disk_solid (IfcSweptDiskSolid) and subset of csg_solid (IfcCsgSolid). The derived attribute Dim has been added at this level and was therefore demoted from the geometric_representation_item. Please refer to ISO/IS 10303-42:1994, p. 170 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.5

Subclassed by Ifc2x3::IfcCsgSolid, Ifc2x3::IfcManifoldSolidBrep, Ifc2x3::IfcSweptAreaSolid, Ifc2x3::IfcSweptDiskSolid

Public Types

typedef IfcTemplatedEntityList<IfcSolidModel> list

Public Functions

const IfcParse::entity &declaration() const
IfcSolidModel(IfcEntityInstanceData *e)
IfcSolidModel()

Public Static Functions

const IfcParse::entity &Class()
class IfcSoundPowerMeasure : public IfcUtil::IfcBaseType

A sound power measure is a measure of total radiated noise with units of decibels with a reference value of picowatts.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSoundPowerMeasure(IfcEntityInstanceData *e)
IfcSoundPowerMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSoundPressureMeasure : public IfcUtil::IfcBaseType

A sound pressure measure is a measure of the pressure fluctuations superimposed over the ambient pressure level with units of decibels with a reference value of micropascals.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSoundPressureMeasure(IfcEntityInstanceData *e)
IfcSoundPressureMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSoundProperties : public Ifc2x3::IfcPropertySetDefinition

Public Types

typedef IfcTemplatedEntityList<IfcSoundProperties> list

Public Functions

bool IsAttenuating() const
void setIsAttenuating(bool v)
bool hasSoundScale() const

Whether the optional attribute SoundScale is defined for this IfcSoundProperties.

::Ifc2x3::IfcSoundScaleEnum::Value SoundScale() const
void setSoundScale(::Ifc2x3::IfcSoundScaleEnum::Value v)
IfcTemplatedEntityList<::Ifc2x3::IfcSoundValue>::ptr SoundValues() const
void setSoundValues(IfcTemplatedEntityList<::Ifc2x3::IfcSoundValue>::ptr v)
const IfcParse::entity &declaration() const
IfcSoundProperties(IfcEntityInstanceData *e)
IfcSoundProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, bool v5_IsAttenuating, boost::optional<::Ifc2x3::IfcSoundScaleEnum::Value> v6_SoundScale, IfcTemplatedEntityList<::Ifc2x3::IfcSoundValue>::ptr v7_SoundValues)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSoundScaleEnum

Public Types

enum Value

Values:

enumerator IfcSoundScale_DBA
enumerator IfcSoundScale_DBB
enumerator IfcSoundScale_DBC
enumerator IfcSoundScale_NC
enumerator IfcSoundScale_NR
enumerator IfcSoundScale_USERDEFINED
enumerator IfcSoundScale_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSoundValue : public Ifc2x3::IfcPropertySetDefinition

Public Types

typedef IfcTemplatedEntityList<IfcSoundValue> list

Public Functions

bool hasSoundLevelTimeSeries() const

Whether the optional attribute SoundLevelTimeSeries is defined for this IfcSoundValue.

::Ifc2x3::IfcTimeSeries *SoundLevelTimeSeries() const
void setSoundLevelTimeSeries(::Ifc2x3::IfcTimeSeries *v)
double Frequency() const
void setFrequency(double v)
bool hasSoundLevelSingleValue() const

Whether the optional attribute SoundLevelSingleValue is defined for this IfcSoundValue.

::Ifc2x3::IfcDerivedMeasureValue *SoundLevelSingleValue() const
void setSoundLevelSingleValue(::Ifc2x3::IfcDerivedMeasureValue *v)
const IfcParse::entity &declaration() const
IfcSoundValue(IfcEntityInstanceData *e)
IfcSoundValue(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcTimeSeries *v5_SoundLevelTimeSeries, double v6_Frequency, ::Ifc2x3::IfcDerivedMeasureValue *v7_SoundLevelSingleValue)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpace : public Ifc2x3::IfcSpatialStructureElement

A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building. A space is associated to a building storey (or in case of exterior spaces to a site). A space may span over several connected spaces. Therefore a space group provides for a collection of spaces included in a storey. A space can also be decomposed in parts, where each part defines a partial space. This is defined by the CompositionType attribute of the supertype IfcSpatialStructureElement which is interpreted as follow:

COMPLEX = space group ELEMENT = space PARTIAL = partial space

NOTE View definitions and implementation agreements may restrict spaces with CompositionType=ELEMENT to be non-overlapping. The following guidelines should apply for using the Name, Description, LongName and ObjectType attributes.

Name holds the unique name (or space number) from the plan. Description holds any additional information field the user may have specified, there are no further recommendations. LongName holds the full name of the space, it is often used in addition to the Name, if a number is assigned to the room, then the descriptive name is exchanged as LongName. ObjectType holds the space type, i.e. usually the functional category of the space .

HISTORY New Entity in IFC Release 1.0

Property Set Use Definition The property sets relating to the IfcSpace are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcSpace are part of this IFC release:

Pset_SpaceCommon: common property set for all types of spaces

Pset_SpaceParking: specific property set for only those spaces that are used to define parking spaces by PredefinedType: PARKING

Pset_SpaceFireSafetyRequirements: common property set for all types of spaces to capture the fire safety requirements Pset_SpaceLightingRequirements: common property set for all types of spaces to capture the lighting requirements Pset_SpaceOccupancyRequirements: common property set for all types of spaces to capture the occupancy requirements Pset_SpaceThermalRequirements: common property set for all types of spaces to capture the thermal requirements Pset_SpaceThermalDesign: common property set for allall types of spaces to capture building service design values

Quantity Use Definition The quantities relating to the IfcSpace are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, can be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement has to be provided.

Qto_SpaceBaseQuantities: base quantities for all space occurrences.

Spatial Structure Use Definition The IfcSpace is used to build the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical). The spatial structure elements are linked together by using the objectified relationship IfcRelAggregates. The IfcSpace references them by its inverse relationships:

IfcSpace.Decomposes referencing (IfcSite || IfcBuildingStorey || IfcSpace) by IfcRelAggregates.RelatingObject, If it refers to another instance ofIfcSpace, the referenced IfcSpace needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcSpace has ELEMENT), or ELEMENT (if the other IfcSpace has PARTIAL). IfcSpace.IsDecomposedBy referencing (IfcSpace) by IfcRelAggregates.RelatedObjects. If it refers to another instance of IfcSpace, the referenced IfcSpace needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcSpace has COMPLEX), or PARTIAL (if the other IfcSpace has ELEMENT).

If there are building elements and/or other elements directly related to the IfcSpace(like most furniture and distribution elements), they are associated with the IfcSpace by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcSpace references them by its inverse relationship:

IfcSpace.ContainsElements referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.

Figure 57 shows the IfcSpace as part of the spatial structure. It also serves as the spatial container for space related elements. NOTE Detailed requirements on mandatory element containment and placement structure relationships are given in view definitions and implementer agreements.

Figure 57 — Space composition

Attribute Use Definition

Figure 58 describes the heights and elevations of the IfcSpace.

elevation of the space (top of construction slab) equals elevation of storey: provided by IfcBuildingStorey.Elevation relative to IfcBuilding.ElevationOfRefHeight elevation of the space flooring (top of flooring on top of slab): provided by IfcSpace.ElevationWithFlooring relative to IfcBuilding.ElevationOfRefHeight height of space (top of slab below to bottom of slab above): provided by BaseQuantity with Name=”Height” floor height of space (top of slab below to top of flooring): provided by BaseQuantity with Name=”FinishFloorHeight” net height of space (top of flooring to bottom of suspended ceiling): provided by BaseQuantity with Name=”FinishCeilingHeight”

Figure 58 — Space elevations

Geometry Use Definition The geometric representation of IfcSpace is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. NOTE In cases of inconsistency between the geometric representation of the IfcSpace and the combined geometric representations of the surrounding IfcRelSpaceBoundary, the geometric representation of the space should take priority over the geometric representation of the surrounding space boundaries. Local Placement The local placement for IfcSpace is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the IfcSpatialStructureElement of type “IfcBuildingStorey”, if relative placement is used, or of type “IfcSpace” (e.g. to position a space relative to a space group, or a partial space to a space). If the relative placement is not used, the absolute placement is defined within the world coordinate system.

Geometric Representations Currently, the use of a 2D ‘FootPrint’ representation of type ‘Curve2D’ or ‘GeometricCurveSet’ and a 3D ‘Body’ representation of type ‘SweptSolid, ‘Clipping’ and ‘Brep’ is supported. ‘Foot Print’ Representation The 2D geometric representation of IfcSpace is defined using the ‘Curve2D’ or ‘GeometricCurveSet’ geometry. The following attribute values should be inserted

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’. IfcShapeRepresentation.RepresentationType = ‘Curve2D’ or ‘GeometricCurveSet’ .

The following constraints apply to the 2D representation:

Profile: IfcBoundedCurve is required, using IfcPolyline for faceted space contours or IfcCompositeCurve for space contours with arc segments. For spaces with inner boundaries, a set of IfcBoundedCurve’s is used, that should be grouped into an IfcGeometricCurveSet.

Figure 59 shows a two-dimensional bounded curve representing the foot print of IfcSpace.

Figure 59 — Space footprint

‘Swept Solid’ Representation The standard geometric representation of IfcSpace is defined using the swept area solid geometry. The following attribute values should be inserted

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’. IfcShapeRepresentation.RepresentationType = ‘SweptSolid’.

The following constraints apply to the standard representation:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcArbitraryClosedProfileDef is required, IfcArbitraryProfileDefWithVoids shall be supported. Extrusion: The extrusion direction shall be vertically, i.e., along the positive Z Axis of the co-ordinate system of the containing spatial structure element.

Figure 60 shows an extrusion of an arbitrary profile definition with voids into the swept area solid of IfcSpace.

Figure 60 — Space body swept solid

‘Clipping’ representation The advanced geometric representation of IfcSpace is defined using the swept area solid geometry that can be subjected to a Boolean expression. The following attribute values should be inserted.

IfcShapeRepresentation.RepresentationIdentifier = ‘Body’. IfcShapeRepresentation.RepresentationType = ‘Clipping’.

The following additional constraints apply to the advanced representation:

Solid: see standard geometric representation, Profile: see standard geometric representation, Extrusion: see standard geometric representation, Boolean result: The difference operation with the second operand being of type IfcHalfSpaceSolid (or one of its subtypes) shall be supported.

Figure 61 shows an extrusion of an arbitrary profile definition into the swept area solid. The solid and an half space solid are operands of the Boolean result of IfcSpace.

Figure 61 — Space body clipping

‘Brep’ representation The fallback advanced geometric representation of IfcSpace is defined using the Brep solid geometry.may be represented as a single or multiple instances of IfcFacetedBrep or IfcFacetedBrepWithVoids. The Brep representation allows for the representation of complex element shape. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

IfcShapeRepresentation.RepresentationIdentifier : ‘Body’ IfcShapeRepresentation.RepresentationType : ‘Brep’

Public Types

typedef IfcTemplatedEntityList<IfcSpace> list

Public Functions

::Ifc2x3::IfcInternalOrExternalEnum::Value InteriorOrExteriorSpace() const
void setInteriorOrExteriorSpace(::Ifc2x3::IfcInternalOrExternalEnum::Value v)
bool hasElevationWithFlooring() const

Whether the optional attribute ElevationWithFlooring is defined for this IfcSpace.

double ElevationWithFlooring() const

Level of flooring of this space; the average shall be taken, if the space ground surface is sloping or if there are level differences within this space.

void setElevationWithFlooring(double v)
IfcTemplatedEntityList<IfcRelCoversSpaces>::ptr HasCoverings() const
IfcTemplatedEntityList<IfcRelSpaceBoundary>::ptr BoundedBy() const
const IfcParse::entity &declaration() const
IfcSpace(IfcEntityInstanceData *e)
IfcSpace(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_LongName, ::Ifc2x3::IfcElementCompositionEnum::Value v9_CompositionType, ::Ifc2x3::IfcInternalOrExternalEnum::Value v10_InteriorOrExteriorSpace, boost::optional<double> v11_ElevationWithFlooring)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpaceHeaterType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcSpaceHeaterType defines commonly shared information for occurrences of space heaters. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a space heater specification (i.e. the specific product information, that is common to all occurrences of that product type). Space Heater types may be exchanged without being already assigned to occurrences. Occurrences of IfcSpaceHeaterType are represented by instances of IfcSpaceHeater.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_SpaceHeaterTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_SpaceHeaterTypeConvector (CONVECTOR) Pset_SpaceHeaterTypeRadiator (RADIATOR)

Material Use Definition The material of the IfcSpaceHeaterType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcSpaceHeaterType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcSpaceHeater for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcSpaceHeaterType> list

Public Functions

::Ifc2x3::IfcSpaceHeaterTypeEnum::Value PredefinedType() const

Enumeration of possible types of space heater (e.g., baseboard heater, convector, radiator, etc.).

void setPredefinedType(::Ifc2x3::IfcSpaceHeaterTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSpaceHeaterType(IfcEntityInstanceData *e)
IfcSpaceHeaterType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSpaceHeaterTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSpaceHeaterTypeEnum

Public Types

enum Value

Enumeration defining the functional type of space heater.

The IfcSpaceHeaterTypeEnum contains the following:

CONVECTOR: A heat-distributing unit that operates with gravity-circulated air. RADIATOR: A heat-distributing unit that operates with thermal radiation. USERDEFINED: User-defined space heater type. NOTDEFINED: Undefined space heater type.

NOTE: This enumeration was revised in IFC 2x4 and was renamed from IfcHydronicHeaterTypeEnum in IFC R2x.

HISTORY: New enumeration in IFC R2x.

Values:

enumerator IfcSpaceHeaterType_SECTIONALRADIATOR
enumerator IfcSpaceHeaterType_PANELRADIATOR
enumerator IfcSpaceHeaterType_TUBULARRADIATOR
enumerator IfcSpaceHeaterType_CONVECTOR
enumerator IfcSpaceHeaterType_BASEBOARDHEATER
enumerator IfcSpaceHeaterType_FINNEDTUBEUNIT
enumerator IfcSpaceHeaterType_UNITHEATER
enumerator IfcSpaceHeaterType_USERDEFINED
enumerator IfcSpaceHeaterType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSpaceProgram : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcSpaceProgram> list

Public Functions

std::string SpaceProgramIdentifier() const
void setSpaceProgramIdentifier(std::string v)
bool hasMaxRequiredArea() const

Whether the optional attribute MaxRequiredArea is defined for this IfcSpaceProgram.

double MaxRequiredArea() const
void setMaxRequiredArea(double v)
bool hasMinRequiredArea() const

Whether the optional attribute MinRequiredArea is defined for this IfcSpaceProgram.

double MinRequiredArea() const
void setMinRequiredArea(double v)
bool hasRequestedLocation() const

Whether the optional attribute RequestedLocation is defined for this IfcSpaceProgram.

::Ifc2x3::IfcSpatialStructureElement *RequestedLocation() const
void setRequestedLocation(::Ifc2x3::IfcSpatialStructureElement *v)
double StandardRequiredArea() const
void setStandardRequiredArea(double v)
IfcTemplatedEntityList<IfcRelInteractionRequirements>::ptr HasInteractionReqsFrom() const
IfcTemplatedEntityList<IfcRelInteractionRequirements>::ptr HasInteractionReqsTo() const
const IfcParse::entity &declaration() const
IfcSpaceProgram(IfcEntityInstanceData *e)
IfcSpaceProgram(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_SpaceProgramIdentifier, boost::optional<double> v7_MaxRequiredArea, boost::optional<double> v8_MinRequiredArea, ::Ifc2x3::IfcSpatialStructureElement *v9_RequestedLocation, double v10_StandardRequiredArea)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpaceThermalLoadProperties : public Ifc2x3::IfcPropertySetDefinition

Public Functions

bool hasApplicableValueRatio() const

Whether the optional attribute ApplicableValueRatio is defined for this IfcSpaceThermalLoadProperties.

double ApplicableValueRatio() const
void setApplicableValueRatio(double v)
::Ifc2x3::IfcThermalLoadSourceEnum::Value ThermalLoadSource() const
void setThermalLoadSource(::Ifc2x3::IfcThermalLoadSourceEnum::Value v)
::Ifc2x3::IfcPropertySourceEnum::Value PropertySource() const
void setPropertySource(::Ifc2x3::IfcPropertySourceEnum::Value v)
bool hasSourceDescription() const

Whether the optional attribute SourceDescription is defined for this IfcSpaceThermalLoadProperties.

std::string SourceDescription() const
void setSourceDescription(std::string v)
double MaximumValue() const
void setMaximumValue(double v)
bool hasMinimumValue() const

Whether the optional attribute MinimumValue is defined for this IfcSpaceThermalLoadProperties.

double MinimumValue() const
void setMinimumValue(double v)
bool hasThermalLoadTimeSeriesValues() const

Whether the optional attribute ThermalLoadTimeSeriesValues is defined for this IfcSpaceThermalLoadProperties.

::Ifc2x3::IfcTimeSeries *ThermalLoadTimeSeriesValues() const
void setThermalLoadTimeSeriesValues(::Ifc2x3::IfcTimeSeries *v)
bool hasUserDefinedThermalLoadSource() const

Whether the optional attribute UserDefinedThermalLoadSource is defined for this IfcSpaceThermalLoadProperties.

std::string UserDefinedThermalLoadSource() const
void setUserDefinedThermalLoadSource(std::string v)
bool hasUserDefinedPropertySource() const

Whether the optional attribute UserDefinedPropertySource is defined for this IfcSpaceThermalLoadProperties.

std::string UserDefinedPropertySource() const
void setUserDefinedPropertySource(std::string v)
::Ifc2x3::IfcThermalLoadTypeEnum::Value ThermalLoadType() const
void setThermalLoadType(::Ifc2x3::IfcThermalLoadTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSpaceThermalLoadProperties(IfcEntityInstanceData *e)
IfcSpaceThermalLoadProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<double> v5_ApplicableValueRatio, ::Ifc2x3::IfcThermalLoadSourceEnum::Value v6_ThermalLoadSource, ::Ifc2x3::IfcPropertySourceEnum::Value v7_PropertySource, boost::optional<std::string> v8_SourceDescription, double v9_MaximumValue, boost::optional<double> v10_MinimumValue, ::Ifc2x3::IfcTimeSeries *v11_ThermalLoadTimeSeriesValues, boost::optional<std::string> v12_UserDefinedThermalLoadSource, boost::optional<std::string> v13_UserDefinedPropertySource, ::Ifc2x3::IfcThermalLoadTypeEnum::Value v14_ThermalLoadType)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpaceType : public Ifc2x3::IfcSpatialStructureElementType

Definition from IAI: A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building. The IfcSpaceType defines a list of commonly shared defines commonly shared information for occurrences of spaces. The set of shared information may include:

common properties within shared property sets common shape representations

It is used to define an space specification (i.e. the specific space information, that is common to all occurrences of that space type. Space types may be exchanged without being already assigned to occurrences. NOTE The space types are often used to represent space catalogues, less so for sharing a common representation map. Space types in a space catalogue share same space classification and a common set of space requirement properties. The occurrences of IfcSpaceType are represented by instances of IfcSpace.

HISTORY New entity in IFC2x3.

Property Set Use Definition: The shared property sets relating to the IfcSpaceType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcSpaceType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcSpaceType and those that are only assignable to IfcSpace. If the same property is assigned to the IfcSpaceType and the IfcSpace being an occurrence of the IfcSpaceType, then the occurrence property overrides the type property.

Pset_SpaceCommon: common property set for all types of spaces

Pset_SpaceParking: specific property set for only those spaces that are used to define parking spaces by PredefinedType: PARKING

Pset_SpaceFireSafetyRequirements: common property set for all types of spaces to capture the fire safety requirements Pset_SpaceLightingRequirements: common property set for all types of spaces to capture the lighting requirements Pset_SpaceOccupancyRequirements: common property set for all types of spaces to capture the occupancy requirements Pset_SpaceThermalRequirements: common property set for all types of spaces to capture the thermal requirements Pset_SpaceThermalDesign: common property set for allall types of spaces to capture building service design values

Geometry Use Definition: The IfcSpaceType may define the shared geometric representation for all space occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘FootPrint’, or ‘Body’).

NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

However view definitions and implementer agreements may prevent the usage of shared geometry for spaces.

Public Types

typedef IfcTemplatedEntityList<IfcSpaceType> list

Public Functions

::Ifc2x3::IfcSpaceTypeEnum::Value PredefinedType() const

Predefined types to define the particular type of space. There may be property set definitions available for each predefined type.

void setPredefinedType(::Ifc2x3::IfcSpaceTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSpaceType(IfcEntityInstanceData *e)
IfcSpaceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSpaceTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSpaceTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the available generic types for IfcSpace and IfcSpaceType. HISTORY New enumeration in IFC2x3. IFC2x4 CHANGE The enumerators INTERNAL and EXTERNAL have been added for upward compatibility to replace InteriorOrExteriorSpace usage. Enumeration

SPACE Any space not falling into another category.

NOTE For classification of spaces according to its function that is often determined by national classification systems use IfcClassificationReference via the relationship IfcRelAssociatesClassification.

PARKING A space dedication for use as a parking spot for vehicles, including access, such as a parking aisle GFA Gross Floor Area - a specific kind of space for each building story that includes all net area and construction area (also the external envelop). Provision of such a specific space is often required by regulations. INTERNAL

NOTE the use is deprecated and only provided for backward compatibility purposes.

EXTERNAL

NOTE the use is deprecated and only provided for backward compatibility purposes.

Values:

enumerator IfcSpaceType_USERDEFINED
enumerator IfcSpaceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSpatialStructureElement : public Ifc2x3::IfcProduct

A spatial structure element (IfcSpatialStructureElement) is the generalization of all spatial elements that might be used to define a spatial structure. That spatial structure is often used to provide a project structure to organize a building project. A spatial project structure might define as many levels of decomposition as necessary for the building project. Elements within the spatial project structure are:

site as IfcSite building as IfcBuilding storey as IfcBuildingStorey space as IfcSpace

or aggregations or parts thereof. The composition type declares an element to be either an element itself, or an aggregation (complex) or a decomposition (part). The interpretation of these types is given at each subtype of IfcSpatialStructureElement. The IfcRelAggregates is defined as an 1-to-many relationship and used to establish the relationship between exactly two levels within the spatial project structure. Finally the highest level of the spatial structure is assigned to IfcProject using the IfcRelAggregates. Informal proposition:

The spatial project structure, established by the IfcRelAggregates, shall be acyclic. A site should not be (directly or indirectly) associated to a building, storey or space. A building should not be (directly or indirectly) associated to a storey or space. A storey should not be (directly or indirectly) associated to a space.

HISTORY New entity in IFC Release 2x.

Relationship Use Definition The subtypes of IfcSpatialStructureElement relate to other elements and systems by establishing the following relationships:

Containment of elements : IfcRelContainedInSpatialStructure by inverse attribute ContainsElements, used to assign any element, like building elements, MEP elements, etc. to the spatial structure element in which they are primarily contained.

NOTE This relationship is mandatory for elements in several view definitions and implementer agreements.

Reference of elements : IfcRelReferencedInSpatialStructure by inverse attribute ReferencesElements, used to reference any element, like building elements, MEP elements, etc. in spatial structure elements, other then the one, where it is contained. Reference of systems : IfcRelServicesBuildings by inverse attribute ServicedBySystems, used to reference a sytem, like a building service or electrical distribution system, a zonal system, or a structural analysis system, that is assigned to this spatial structure element.

NOTE Elements within the referenced system may be directly contained (or referenced) by other spatial structure elements.

The subtypes of IfcSpatialStructureElement relate to each other by using the IfcRelAggregates relationship to build the project spatial structure.

Figure 62 shows the use of IfcRelAggregates to establish a spatial structure including site, building, building section and storey. More information is provided at the level of the subtypes.

Figure 62 — Spatial structure element composition

Subclassed by Ifc2x3::IfcBuilding, Ifc2x3::IfcBuildingStorey, Ifc2x3::IfcSite, Ifc2x3::IfcSpace

Public Functions

bool hasLongName() const

Whether the optional attribute LongName is defined for this IfcSpatialStructureElement.

std::string LongName() const
void setLongName(std::string v)
::Ifc2x3::IfcElementCompositionEnum::Value CompositionType() const

Denotes, whether the predefined spatial structure element represents itself, or an aggregate (complex) or a part (part). The interpretation is given separately for each subtype of spatial structure element. If no CompositionType is asserted, the dafault value ‘ELEMENT’ applies.

IFC2x4 CHANGE&nbsp Attribute made optional.

void setCompositionType(::Ifc2x3::IfcElementCompositionEnum::Value v)
IfcTemplatedEntityList<IfcRelReferencedInSpatialStructure>::ptr ReferencesElements() const
IfcTemplatedEntityList<IfcRelServicesBuildings>::ptr ServicedBySystems() const
IfcTemplatedEntityList<IfcRelContainedInSpatialStructure>::ptr ContainsElements() const
const IfcParse::entity &declaration() const
IfcSpatialStructureElement(IfcEntityInstanceData *e)
IfcSpatialStructureElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_LongName, ::Ifc2x3::IfcElementCompositionEnum::Value v9_CompositionType)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpatialStructureElementType : public Ifc2x3::IfcElementType

Definition from IAI: The element type (IfcSpatialStructureElementType) defines a list of commonly shared property set definitions of a spatial structure element and an optional set of product representations. It is used to define an element specification (i.e. the specific element information, that is common to all occurrences of that element type).

NOTE The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

A spatial structure element type is used to define the common properties of a certain type of a spatial structure element that may be applied to many instances of thattype to assign a specific style. Spatial structure element types (i.e. the instantiable subtypes) may be exchanged without being already assigned to occurrences.

NOTE The spatial structure element types are often used to represent catalogues of predefined spatial types for shared attributes, less so for sharing a common representation map.

The occurrences of subtypes of the abstractIfcSpatialStructureElementType are represented by instances of subtypes of IfcSpatialStructureElement.

HISTORY New entity in Release IFC2x Edition 3.

Subclassed by Ifc2x3::IfcSpaceType

Public Functions

const IfcParse::entity &declaration() const
IfcSpatialStructureElementType(IfcEntityInstanceData *e)
IfcSpatialStructureElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcSpecificHeatCapacityMeasure : public IfcUtil::IfcBaseType

IfcSpecificHeatCapacityMeasure defines the specific heat of material: The heat energy absorbed per temperature unit. Usually measured in J / kg Kelvin. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSpecificHeatCapacityMeasure(IfcEntityInstanceData *e)
IfcSpecificHeatCapacityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSpecularExponent : public IfcUtil::IfcBaseType

The IfcSpecularExponent defines the datatype for exponent determining the sharpness of the ‘reflection’. reflection is made sharper with large values of the exponent, such as 10.0. Small values, such as 1.0, decrease the specular fall-off.

IfcSpecularExponent is of type REAL.

NOTE: The datatype relates to the definition of specular_exponent in ISO 10303-46 entity surface_style_reflectance_ambient_diffuse_specular.

HISTORY: New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSpecularExponent(IfcEntityInstanceData *e)
IfcSpecularExponent(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSpecularRoughness : public IfcUtil::IfcBaseType

The IfcSpecularRoughness defines the datatype for the reflection resulting from the roughness of a surface through the height of surface impurities where the specular highlight is made sharper with small values for the roughness, such as 0.1.

Applies to “glass”, “metal”, “mirror” and “plastic” reflection models. Larger values, close to 1.0 decrease the specular fall-off.

IfcSpecularRoughness is of type REAL. It is constraint to values between (and including) 0 and 1.

NOTE: The datatype relates to the definition of “shiness” in VRML97, which is the reciprocate value to the specular roughness.

HISTORY: New type in Release IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcSpecularRoughness(IfcEntityInstanceData *e)
IfcSpecularRoughness(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcSphere : public Ifc2x3::IfcCsgPrimitive3D

The IfcSphere is a Construction Solid Geometry (CSG) 3D primitive. It is a solid where all points at the surface have the same distance from the center point. The inherited Position attribute defines the IfcAxisPlacement3D and provides:

SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The center of the sphere. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z axis points at its positve direction towards the north pole, and by its negative directions towards the south pole.

The following definitions from ISO 10303-42 apply:

A sphere is a CSG primitive with a spherical shape defined by a centre and a radius.

Figure 270 illustrates geometric parameters of the sphere. The sphere is positioned within its own placement coordiante system. The origin is the center of the sphere.

Figure 270 — Sphere geometry

NOTE Corresponding STEP entity: sphere, the position attribute, including the centre point, has been promoted to the immediate supertype IfcCsgPrimitive3D. Please refer to ISO/IS 10303-42:1994, p. 175 for the final definition of the formal standard.

HISTORY New entity in IFC2x3.

Texture Use Definition Textures are aligned facing upright with origin at the back (+Y direction) revolving counter-clockwise. Textures are stretched or repeated to the extent of the circumference at the equator according to RepeatS and RepeatT.

Figure 271 illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

Side Normal Origin X Origin Y Origin Z S Axis T Axis

Side -Y 0 +Radius 0 (-X, then curving counter-clockwise) (+Y, then curving towards top)

Figure 271 — Sphere textures

Public Types

typedef IfcTemplatedEntityList<IfcSphere> list

Public Functions

double Radius() const

The radius of the sphere.

void setRadius(double v)
const IfcParse::entity &declaration() const
IfcSphere(IfcEntityInstanceData *e)
IfcSphere(::Ifc2x3::IfcAxis2Placement3D *v1_Position, double v2_Radius)

Public Static Functions

const IfcParse::entity &Class()
class IfcStackTerminalType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcStackTerminalType defines commonly shared information for occurrences of stack terminals. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a stack terminal specification (i.e. the specific product information, that is common to all occurrences of that product type). Stack Terminal types may be exchanged without being already assigned to occurrences. Occurrences of IfcStackTerminalType are represented by instances of IfcStackTerminal.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_StackTerminalTypeCommon

Material Use Definition The material of the IfcStackTerminalType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcStackTerminalType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcStackTerminal for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcStackTerminalType> list

Public Functions

::Ifc2x3::IfcStackTerminalTypeEnum::Value PredefinedType() const

Identifies the predefined types of stack terminal from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcStackTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcStackTerminalType(IfcEntityInstanceData *e)
IfcStackTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcStackTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcStackTerminalTypeEnum

Public Types

enum Value

An IfcStackTerminalTypeEnum defines the range of different types of stack terminal that can be specified for use at the top of a vertical stack subsystem. HISTORY: New type in IFC 2x

Enumeration

BIRDCAGE: Guard cage, typically wire mesh, at the top of the stack preventing access by birds. COWL: A cowling placed at the top of a stack to eliminate downdraft. RAINWATERHOPPER: A box placed at the top of a rainwater downpipe to catch rainwater from guttering. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcStackTerminalType_BIRDCAGE
enumerator IfcStackTerminalType_COWL
enumerator IfcStackTerminalType_RAINWATERHOPPER
enumerator IfcStackTerminalType_USERDEFINED
enumerator IfcStackTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcStair : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Construction comprising a succession of horizontal stages (steps or landings) that make it possible to pass on foot to other levels. A stair is a vertical passageway allowing occupants to walk (step) from one floor level to another floor level at a different elevation. It may include a landing as an intermediate floor slab. The stair should either be represented:

as a stair assembly entity that aggregates all components (stair flight, landing, etc. with own representations), or as a single stair entity without decomposition including all representation directly at the stair entity.

In case of a stair container, the aggregation is handled via the IfcRelAggregates relationship, relating an IfcStair with the related IfcStairFlight’s and landings (represented by IfcSlab with IfcSlab.PredefinedType = ‘LANDING’). IfcRailing’s belonging to the stair may be included into the aggregation as well.

HISTORY New Entity in IFC Release 2.0. IFC2x4 CHANGE Attribute ShapeType renamed to PredefinedType.

Type Use Definition IfcStair defines the occurrence of any stair, common information about stair types (or styles) is handled by IfcStairType. The IfcStairType (if present) may establish the common type name, usage (or predefined) type, common material, common set of properties and common shape representations (using IfcRepresentationMap). The IfcStairType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. NOTE Since the IfcStair might be represented as an aggregate of parts, e.g. represented by IfcStairFlight, or IfcSlab, these individual parts may have type information attached (represented e.g. by IfcStairFlightType, or IfcSlabType). Material Use Definition The material of the IfcStair is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be given at the IfcStairType, defining the common attribute data for all occurrences of the same type. It is then accessible by the inverse IsDefinedBy relationship pointing to IfcStair.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are given, then the material directly assigned to IfcStair overrides the material assigned to IfcStairType.

Property Set Use Definition: The property sets relating to the IfcStair are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcStair are part of this IFC release:

Pset_StairCommon: common property set for all stair occurrences

Figure 127 shows the use of property sets Pset_StairCommon and Pset_StairFlightCommon for the various stair properties.

Figure 127 — Stair properties

Geometry Use Definitions: The geometric representation of IfcStair is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Independent geometric representations should only be used when the IfcStair is not defined as an aggregate. If defined as an aggregate, the geometric representation is the sum of the representation of the components within the aggregate. Local placement The local placement for IfcStair is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

If the LocalPlacement is given for the IfcStair, then all components, which are aggregated to the stair should use this placement as their relative placement. Geometric Representation Currently, the ‘Axis’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement.

Axis: A two-dimensional open curve IfcBoundedCurve defining the walking line for the stair. FootPrint: A geometric curve set defining the footing print, including the boundary of the stair. Body: A solid representation defining the 3D shape of the stair.

Axis Representation The walking line is represented by a two-dimensional open curve as the axis. The curve is directed into the upward direction (direction has to be interpreted as specified at the subtypes of IfcCurve). The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

NOTE The ‘Axis’ representation of IfcStair may be provided even if the IfcStair has components with own shape representations.

FootPrint Representation The stair foot print, including the stair boundary is represented by a two-dimensional geometric curve set. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’

NOTE The ‘Footprint’ representation of IfcStair may be provided even if the IfcStair has components with own shape representations.

Body Representation The body representation of IfcStair can be represented using the representation types ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’. The general usage of representation is are explained at IfcBuildingElement. No further constraints or provisions on how to use the representation types are defined for IfcStairFlight.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, ‘MappedRepresentation’

The ‘Body’ representation shall only be provided if the IfcStair has no components defined (empty set of SELF\IfcObject.IsDecomposedBy) or if the components defined no not carry an own ‘Body’ representation. Geometric representation by aggregated elements If the IfcStair has components (referenced by SELF\IfcObject.IsDecomposedBy) with own ‘Body’ representation, then no ‘Body’ representation shall defined for the IfcStair. The IfcStair shape is then represented by the geometric representation of its components. The components are accessed via SELF\IfcObject.IsDecomposedBy[1].RelatedObjects.

Figure 128 illustrates stair placement, where the IfcStair defines the local placement for all components and the common ‘Axis’ representation, and each component has its own ‘Body’ representation.

Figure 128 — Stair placement

Public Types

typedef IfcTemplatedEntityList<IfcStair> list

Public Functions

::Ifc2x3::IfcStairTypeEnum::Value ShapeType() const
void setShapeType(::Ifc2x3::IfcStairTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcStair(IfcEntityInstanceData *e)
IfcStair(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcStairTypeEnum::Value v9_ShapeType)

Public Static Functions

const IfcParse::entity &Class()
class IfcStairFlight : public Ifc2x3::IfcBuildingElement

A stair flight is an assembly of building components in a single “run” of stair steps (not interrupted by a landing). The stair steps and any stringers are included in the stair flight. A winder is also regarded a part of a stair flight. An IfcStairFlight is normally aggregated by an IfcStair through the IfcRelAggregates relationship, the stair flight is then included in the set of IfcRelAggregates.RelatedObjects. An IfcStairFlight normally connects the floor slab of zero to two different storeys (or partial storeys, or landings) within a building. The connection relationship between the IfcStairFlight and the IfcSlab is expressed using the IfcRelConnectsElements relationship.

HISTORY: New Entity in IFC Release 2.0.

Type Use Definition IfcStairFlight defines the occurrence of any stair flight, common information about stair flight types (or styles) is handled by IfcStairFlightType. The IfcStairFlightType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcStairFlightType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsDefinedBy attribute. Material Use Definition The material of the IfcStairFlight is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Property Set Use Definition: The property sets relating to the IfcStairFlight are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcStairFlight are part of this IFC release:

Pset_StairFlightCommon: common property set for all stair flight occurrences

Quantity Use Definition The quantities relating to the IfcStairFlight are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcStairFlightType.

Qto_StairFlightBaseQuantities: base quantities for all stair flight occurrences.

Containment Use Definition The IfcStairFlight, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first relationship is the hierachical spatial containment, the second relationship is the aggregation within anelement assembly.

The IfcStairFlight is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcStairFlight may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcStair as a special focus subtype. In this case it shall not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure shall be NIL.

Geometry Use Definition The geometric representation of IfcStairFlight is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Included are: Local placement The local placement for IfcStairFlight is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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 IfcStairFlight, however, is used by an IfcStair, and this container class defines its own local placement, then the PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the IfcStair.

Geometric Representations Currently, the ‘Axis’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement.

Axis: A two-dimensional open curve IfcBoundedCurve defining the walking line for the stair flight. FootPrint: A geometric curve set defining the footing print, including the boundary of the stair flight. Body: A solid representation defining the 3D shape of the stair flight

Axis Representation The walking line is represented by a two-dimensional open curve as the axis. The curve is directed into the upward direction (direction has to be interpreted as specified at the subtypes of IfcCurve). The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

Figure 129 illustrates the axis representation which has the following constraints:

In case of straight flights the curve shall be a single item of type IfcPolyline. In case of winding flights the curve shall be a single item of type IfcCompositeCurve. In case of a curved flight or a spiral flight the curve shall be a single item of type IfcTrimmedCurve.

Figure 129 — Stair flight axis

FootPrint Representation The flight foot print, including the flight boundary is represented by a two-dimensional geometric curve set. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’

Figure 130 illustrates the footprint representation which has the following constraints:

In case of straight flights the curve set shall consists of a single item of type IfcPolyline. In case of winding flights or curved flights the curve set shall consists of a single item of type IfcCompositeCurve. In case of a spiral flight the curve set shall consists of a single item of type IfcConic or IfcPolyline.

Figure 130 — Stair flight footprint

Body Representation The body representation of IfcStairFlight can be represented using the representation types ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, and ‘MappedRepresentation’. The general usage of representation is are explained at IfcBuildingElement. No further constraints or provisions on how to use the representation types are defined for IfcStairFlight.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘SurfaceModel’, ‘Brep’, ‘MappedRepresentation’

Figure 131 illustrates the body representation.

Figure 131 — Stair flight body

Public Types

typedef IfcTemplatedEntityList<IfcStairFlight> list

Public Functions

bool hasNumberOfRiser() const

Whether the optional attribute NumberOfRiser is defined for this IfcStairFlight.

int NumberOfRiser() const

Number of the risers included in the stair flight

IFC2x4 CHANGE The attribute has been deprecated it shall only be exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfRisers instead.

void setNumberOfRiser(int v)
bool hasNumberOfTreads() const

Whether the optional attribute NumberOfTreads is defined for this IfcStairFlight.

int NumberOfTreads() const

Number of treads included in the stair flight.

IFC2x4 CHANGE The attribute has been deprecated it shall only be exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfTreads instead.

void setNumberOfTreads(int v)
bool hasRiserHeight() const

Whether the optional attribute RiserHeight is defined for this IfcStairFlight.

double RiserHeight() const

Vertical distance from tread to tread. The riser height is supposed to be equal for all stairs in a stair flight.

IFC2x4 CHANGE The attribute has been deprecated it shall only be exposed with a NIL value. Use Pset_StairFlightCommon.RiserHeight instead.

void setRiserHeight(double v)
bool hasTreadLength() const

Whether the optional attribute TreadLength is defined for this IfcStairFlight.

double TreadLength() const

Horizontal distance from the front to the back of the tread. The tread length is supposed to be equal for all steps of the stair flight.

IFC2x4 CHANGE The attribute has been deprecated it shall only be exposed with a NIL value. Use Pset_StairFlightCommon.TreadLength instead.

void setTreadLength(double v)
const IfcParse::entity &declaration() const
IfcStairFlight(IfcEntityInstanceData *e)
IfcStairFlight(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<int> v9_NumberOfRiser, boost::optional<int> v10_NumberOfTreads, boost::optional<double> v11_RiserHeight, boost::optional<double> v12_TreadLength)

Public Static Functions

const IfcParse::entity &Class()
class IfcStairFlightType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type (IfcStairFlightType) defines a list of commonly shared property set definitions of a stair flight and an optional set of product representations. It is used to define an stair flight specification (i.e. the specific product information, that is common to all occurrences of that product type).

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem. A stair flight type is used to define the common properties of a certain type of a stair flight that may be applied to many instances of that type to assign a specific style. Stair flight types may be exchanged without being already assigned to occurrences. The occurrences of the IfcStairFlightType are represented by instances of IfcStairFlight.

HISTORY: New entity in Release IFC2x Edition 2.

Public Types

typedef IfcTemplatedEntityList<IfcStairFlightType> list

Public Functions

::Ifc2x3::IfcStairFlightTypeEnum::Value PredefinedType() const

Identifies the predefined types of a stair flight element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcStairFlightTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcStairFlightType(IfcEntityInstanceData *e)
IfcStairFlightType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcStairFlightTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcStairFlightTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of stair flights an IfcStairFlightType object can fulfill:

STRAIGHT: A stair flight with a straight walking line.

WINDER: A stair flight with a straight walking line. SPIRAL: A stair flight with a circular or elliptic walking line. CURVED: A stair flight with a curved walking line. FREEFORM: A stair flight with a free form walking line (and outer boundaries). USERDEFINED: User-defined stair flight . NOTDEFINED: Undefined stair flight .

HISTORY: New Enumeration in Release IFC2x Edition 2.

Values:

enumerator IfcStairFlightType_STRAIGHT
enumerator IfcStairFlightType_WINDER
enumerator IfcStairFlightType_SPIRAL
enumerator IfcStairFlightType_CURVED
enumerator IfcStairFlightType_FREEFORM
enumerator IfcStairFlightType_USERDEFINED
enumerator IfcStairFlightType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcStairTypeEnum

Public Types

enum Value

This enumeration defines the basic configuration of the stair type in terms of the number of stair flights and the number of landings, as illustrated in Figure 69. The type also distinguished turns by windings or by landings. In addition the subdivision of the straight and changing direction stairs is included. The stair configurations are given for stairs without and with one, two or three landings.

Stairs which are subdivided into more than three landings have to be defined by the geometry only. Also stairs with non-regular shapes have to be defined by the geometry only. The type of such stairs is OTHEROPERATION.

HISTORY New Enumeration in IFC Release 2.0.

Enumerator Description Figure

StraightRunStair A stair extending from one level to another without turns or winders. The stair consists of one straight flight.

TwoStraightRunStair A straight stair consisting of two straight flights without turns but with one landing.

QuarterWindingStair A stair consisting of one flight with a quarter winder, which is making a 90° turn. The direction of the turn is determined by the walking line.

QuarterTurnStair A stair making a 90° turn, consisting of two straight flights connected by a quarterspace landing. The direction of the turn is determined by the walking line.

HalfWindingStair A stair consisting of one flight with one half winder, which makes a 180° turn. The orientation of the turn is determined by the walking line.

HalfTurnStair A stair making a 180° turn, consisting of two straight flights connected by a halfspace landing. The orientation of the turn is determined by the walking line.

TwoQuarterWindingStair A stair consisting of one flight with two quarter winders, which make a 90° turn. The stair makes a 180° turn. The direction of the turns is determined by the walking line.

TwoQuarterTurnStair A stair making a 180° turn, consisting of three straight flights connected by two quarterspace landings. The direction of the turns is determined by the walking line.

ThreeQuarterWindingStair

A stair consisting of one flight with three quarter winders, which make a 90° turn. The stair makes a 270° turn. The direction of the turns is determined by the walking line.

ThreeQuarterTurnStair A stair making a 270° turn, consisting of four straight flights connected by three quarterspace landings. The direction of the turns is determined by the walking line.

SpiralStair A stair constructed with winders around a circular newel often without landings. Depending on outer boundary it can be either a circular, elliptical or rectangular spiral stair. The orientation of the winding stairs is determined by the walking line.

DoubleReturnStair A stair having one straight flight to a wide quarterspace landing, and two side flights from that landing into opposite directions. The stair is making a 90° turn. The direction of traffic is determined by the walking line.

CurvedRunStair A stair extending from one level to another without turns or winders. The stair is consisting of one curved flight.

TwoCurvedRunStair A curved stair consisting of two curved flights without turns but with one landing.

OtherOperation Free form stair (user defined operation type)

NotDefined

Figure 69 — Stair types

Values:

enumerator IfcStairType_STRAIGHT_RUN_STAIR
enumerator IfcStairType_TWO_STRAIGHT_RUN_STAIR
enumerator IfcStairType_QUARTER_WINDING_STAIR
enumerator IfcStairType_QUARTER_TURN_STAIR
enumerator IfcStairType_HALF_WINDING_STAIR
enumerator IfcStairType_HALF_TURN_STAIR
enumerator IfcStairType_TWO_QUARTER_WINDING_STAIR
enumerator IfcStairType_TWO_QUARTER_TURN_STAIR
enumerator IfcStairType_THREE_QUARTER_WINDING_STAIR
enumerator IfcStairType_THREE_QUARTER_TURN_STAIR
enumerator IfcStairType_SPIRAL_STAIR
enumerator IfcStairType_DOUBLE_RETURN_STAIR
enumerator IfcStairType_CURVED_RUN_STAIR
enumerator IfcStairType_TWO_CURVED_RUN_STAIR
enumerator IfcStairType_USERDEFINED
enumerator IfcStairType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcStateEnum

Public Types

enum Value

The IfcStateEnum enumeration identifies the state or accessibility of the object (for example, read/write, locked).

Valid enumerations are:

READWRITE: Object is in a Read-Write state. It may be modified by an application. READONLY: Object is in a Read-Only state. It may be viewed but not modified by an application. LOCKED: Object is in a Locked state. It may not be accessed by an application. READWRITELOCKED: Object is in a Read-Write-Locked state. It may not be accessed by an application. READONLYLOCKED: Object is in a Read-Only-Locked state. It may not be accessed by an application.

HISTORY New enumeration in IFC R2.0.

IFC2x3 CHANGE This concept was initially introduced in IFC 2.0 as IfcModifiedFlag of type BINARY(3) FIXED and has been modified in R2x to an enumeration. It was initially introduced as a first step towards providing facilities for partial model exchange from a server as requested by the IFC implementers. It is intended for use primarily by a model server so that an application can identify the state of the object.

Values:

enumerator IfcState_READWRITE
enumerator IfcState_READONLY
enumerator IfcState_LOCKED
enumerator IfcState_READWRITELOCKED
enumerator IfcState_READONLYLOCKED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcStructuralAction : public Ifc2x3::IfcStructuralActivity

Definition from IAI: A structural action is a structural activity that acts upon a structural item or building element.

HISTORY New entity in IFC 2x2. IFC 2x4 change: Attribute DestabilizingLoad made optional. Attribute CausedBy deleted; use IfcRelAssignsToProduct via ReferencedBy instead.

Structural actions are grouped into either an IfcStructuralLoadGroup of predefined type LOAD_GROUP or, more often, an IfcStructuralLoadCase. This is accomplished via the inverse relationship HasAssignments and an IfcRelAssignsToGroup relationship object. IfcStructuralLoadGroup.LoadGroupFor or IfcStructuralLoadCase.LoadGroupFor respectively refers to the structural analysis model(s) in which the loads are used.

It is furthermore possible to establish relationships between actions in one analysis model and reactions in another analysis model which cause the actions. For example, a support reaction from one structural system may be taken over as a load onto another supporting structural system. This is expressed by means of the inverse relationship ReferencedBy of the action and an IfcRelAssignsToProduct relationship object. IfcRelAssignsToProduct.Name is set to ‘Causes’ and IfcRelAssignsToProduct.RelatedObjects refers to an instance of a subtype of IfcStructuralReaction.

Subclassed by Ifc2x3::IfcStructuralLinearAction, Ifc2x3::IfcStructuralPlanarAction, Ifc2x3::IfcStructuralPointAction

Public Types

typedef IfcTemplatedEntityList<IfcStructuralAction> list

Public Functions

bool DestabilizingLoad() const

Indicates if this action may cause a stability problem. If it is ‘FALSE’, no further investigations regarding stability problems are necessary.

void setDestabilizingLoad(bool v)
bool hasCausedBy() const

Whether the optional attribute CausedBy is defined for this IfcStructuralAction.

::Ifc2x3::IfcStructuralReaction *CausedBy() const
void setCausedBy(::Ifc2x3::IfcStructuralReaction *v)
const IfcParse::entity &declaration() const
IfcStructuralAction(IfcEntityInstanceData *e)
IfcStructuralAction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralActivity : public Ifc2x3::IfcProduct

Definition from IAI: The abstract entity IfcStructuralActivity combines the definition of actions (such as forces, displacements, etc.) and reactions (support reactions, internal forces, deflections, etc.) which are specified by using the basic load definitions from the IfcStructuralLoadResource.

The differentiation between actions and reactions is realized by instantiating objects either from subclasses of IfcStructuralAction or IfcStructuralReaction respectively. They inherit commonly needed attributes from the abstract superclass IfcStructuralActivity, notably the relationship which connects actions or reactions with connections, analysis members, or elements (subtypes of IfcStructuralItem or IfcElement).

NOTE Instances of IfcStructuralActivity which are connected with an IfcElement are subject to agreements outside the scope of this specification.

NOTE The semantics of IfcStructuralActivity are only fully defined if an activity instance is connected with exactly one structural item. The inverse attribute AssignedToStructuralItem can only be empty in incomplete models or in conceptual models which are not yet ready for analysis.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Cardinality of attribute AssignedToStructuralItem relaxed from 1 to 0..1 in order to allow for schema-compliant incomplete models as well as conceptual models without load—item relationships.

Coordinate Systems:

The following coordinate systems are distinguished:

The so-called global coordinate system is the coordinate system shared by all items and activities which are grouped in a common IfcStructuralAnalysisModel. This coordinate system is established by an ObjectPlacement. (This coordinate system is not necessarily the same as the IfcProject’s world coordinate system.) The so-called local coordinate system is a coordinate system local to a structural item (connection or member). This coordinate system is established by a Representation in conjunction with further use definitions and attributes of subtypes of IfcStructuralItem.

Representation items in topology representations are always given within the ObjectPlacement, i.e. in so-called global coordinates (global with respect to the IfcStructuralAnalysisModel to which this activity belongs).

Locations of the load objects in the AppliedLoad attribute (if of type IfcStructuralLoadConfiguration) are always given in local coordinates.

Directions of the load objects in the AppliedLoad attribute refer to global or local coordinates according to the GlobalOrLocal attribute.

The ObjectPlacement and Representation are sometimes not explicitly instantiated; instead they may be implied as described below. Global and local coordinate systems are then determined in the same way as with explicit placement and representation.

Topology Use Definitions:

Instances of IfcStructuralActivity which are connected with a structural item of same dimensionality, i.e.

a point action or reaction connected with a point item (IfcStructuralPointConnection), a curve action or reaction connected with a curve item (IfcStructuralCurveConnection, IfcStructuralCurveMember), or a surface action or reaction connected with a surface item (IfcStructuralSurfaceConnection, IfcStructuralSurfaceMember) and which acts on the entire surface of the item and is not specified by isocontours

shall not have an ObjectPlacement nor a Representation. It is implied that the placement and representation of the IfcStructuralActivity is the same as the ones of the IfcStructuralItem.

Instances of IfcStructuralActivity which are connected with

a curve item (IfcStructuralCurveConnection, IfcStructuralCurveMember) and act on a point of the item, or a surface item (IfcStructuralSurfaceConnection, IfcStructuralSurfaceMember) and act on a point or on a curve or on a part of the surface of the item

shall have a topology representation as specified below. It includes a placement and a product representation. The IfcProductRepresentation shall be given by an item in a Representation of type IfcTopologyRepresentation.

Instances of IfcStructuralActivity which are connected with

a surface item (IfcStructuralSurfaceConnection, IfcStructuralSurfaceMember) and are specified by isocontours

shall have a shape representation as specified below. It includes a placement and a product representation. The IfcProductRepresentation shall be given by items in a Representation of type IfcShapeRepresentation. Shape representation and topology representation may be combined.

Local Placement

The local placement for IfcStructuralActivity is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which establishes a global coordinate system which shall be common to all items and activities in an IfcStructuralAnalysisModel.

Topology Representation

Instances of IfcStructuralActivity which act on parts of a surface item shall have a topology representation given by a face with underlying surface geometry, IfcFaceSurface, which should be the single item of IfcTopologyRepresentation.Items. The surface establishes a local coordinate system of the activity:

The origin of surface parameters u,v is the origin of the local coordinate system. The local x and y directions follow the tangents on the surface and are in parallel with and directed like u and v respectively. The local z direction is in parallel with and directed like the surface normal.

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Face’

Instances of IfcStructuralActivity which act on a curve on a surface item shall have a topology representation given by an edge (IfcEdge or subtype), which should be the single item of IfcTopologyRepresentation.Items. The curve geometry shall be compatible with the surface geometry of the connected item. In conjunction with this surface, the curve establishes a local coordinate system of the activity:

The origin of the curve parameter u is the origin of the local coordinate system. The local x direction follows the tangent on the curve and is directed like u. The local z direction is in parallel with and directed like the surface normal of the connected surface item. The local x,y,z directions form a right-handed Cartesian coordinate system.

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Edge’

NOTE While an IfcEdge (or IfcOrientedEdge with underlying IfcEdge) does not provide an explicit underlying curve geometry, it may be used to imply an underlying straight line as reference curve with the origin of the curve parameter at the start vertex point.

Instances of IfcStructuralActivity which act on a single point on a curve or surface item shall have a topology representation given by an IfcVertexPoint, which should be the single item of IfcTopologyRepresentation.Items. The point geometry shall be compatible with the curve or surface geometry of the connected item. The local coordinate system of the activity is oriented by the curve or surface geometry of the connected item as described above for activities with edge or face topology.

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Vertex’

Shape Representation

Instances of IfcStructuralActivity which act on a surface item and are specified by isocontours (level sets) shall have a shape representation given by a set of curves on a surface, IfcPCurve. The basis surface shall comply with or preferably be identical with the surface of the structural item to which the activity is connected. The representation identifier and type of this geometric representation is:

RepresentationIdentifier: ‘Level set’ RepresentationType: ‘GeometricCurveSet’

Subclassed by Ifc2x3::IfcStructuralAction, Ifc2x3::IfcStructuralReaction

Public Types

typedef IfcTemplatedEntityList<IfcStructuralActivity> list

Public Functions

::Ifc2x3::IfcStructuralLoad *AppliedLoad() const

Load or result resource object which defines the load type, direction, and load values.

In case of activities which are variably distributed over curves or surfaces, IfcStructuralLoadConfiguration is used which provides a list of load samples and their locations within the load distribution, measured in local coordinates of the curve or surface on which this activity acts. The contents of this load or result distribution may be further restricted by definitions at subtypes of IfcStructuralActivity.

void setAppliedLoad(::Ifc2x3::IfcStructuralLoad *v)
::Ifc2x3::IfcGlobalOrLocalEnum::Value GlobalOrLocal() const

Indicates whether the load directions refer to the global coordinate system (global to the analysis model, i.e. as established by IfcStructuralAnalysisModel.SharedPlacement) or to the local coordinate system (local to the activity or connected item, as established by an explicit or implied representation and its parameter space).

NOTE, the informal definition of IfcRepresentationResource.IfcGlobalOrLocalEnum doe s not distinguish between “global coordinate system” and “world coordinate system”. On the other hand, this distinction is necessary in the IfcStructuralAnalysisDomain where the shared “global” coordinate system of an analysis model may very well not be the same as the project-wide world coordinate system.

In the scope of IfcStructuralActivity.GlobalOrLocal, the meaning of GLOBAL_COORDS is therefore not to be taken as world coordinate system but as the analysis model specific shared coordinate system. In contrast, LOCAL_COORDS is to be taken as coordinates which are local to individual structural items and activities, as established by subclass-specific geometry use definitions.

void setGlobalOrLocal(::Ifc2x3::IfcGlobalOrLocalEnum::Value v)
IfcTemplatedEntityList<IfcRelConnectsStructuralActivity>::ptr AssignedToStructuralItem() const
const IfcParse::entity &declaration() const
IfcStructuralActivity(IfcEntityInstanceData *e)
IfcStructuralActivity(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralAnalysisModel : public Ifc2x3::IfcSystem

Definition from IAI: The IfcStructuralAnalysisModel is used to assemble all information needed to represent a structural analysis model. It encompasses certain general properties (such as analysis type), references to all contained structural members, structural supports or connections, as well as loads and the respective load results.

Important functionalities for the description of an analysis model are derived from existing IFC entities:

From IfcSystem it inherits the ability to couple the analysis model via IfcRelServicesBuildings to one or more IfcBuildings as necessary. From IfcGroup it inherits the inverse attribute IsGroupedBy, pointing to the relationship class IfcRelAssignsToGroup. This allows to group structural members (instances of IfcStructuralMember), and supports (instances of IfcStructuralConnection) which belong to a specific analysis model. NOTE: Loads (as instances of IfcStructuralAction) are not included through IsGroupedBy. Loads are assigned through the LoadedBy attribute relationship, using load groups as a grouping mechanism. Only top-level load groups should be referenced via LoadedBy, i.e. load combinations if any load combinations exist, or load cases if no load combinations exist in this analysis model. NOTE: Results (as instances of IfcStructuralReaction) are not included through IsGroupedBy. Results are assigned through the HasResults attribute relationship, using result groups as a grouping mechanism.

From IfcObject it inherits the inverse attribute IsDecomposedBy pointing to the relationship class IfcRelNests. It provides the hierarchy between the separate (partial) analysis models.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attribute SharedPlacement and informal propositions added, allowing for easy retrieval of the common object placement and for specification of the analysis model’s coordiante system before any structural item is instantiated. WHERE rule added.

Informal propositions:

If one or more structural item (instance of a subtype of IfcStructuralItem) is grouped into an IfcStructuralAnalysisModel, the attribute SharedPlacement shall be provided with a value. The ObjectPlacements of all structural items which are grouped into the same instance of IfcStructuralAnalysisModel shall refer to the same instance of IfcObjectPlacement as IfcStructuralAnalysisModel.SharedPlacement.

NOTE This rule is necessary to achieve consistent topology representations. The topology representations of structural items in an analysis model are meant to share vertices and edges und must therefore have the same object placement.

NOTE A structural item may be grouped into more than one analysis model. In this case, all these models must use the same instance of IfcObjectPlacement.

Public Functions

::Ifc2x3::IfcAnalysisModelTypeEnum::Value PredefinedType() const

Defines the type of the structural analysis model.

void setPredefinedType(::Ifc2x3::IfcAnalysisModelTypeEnum::Value v)
bool hasOrientationOf2DPlane() const

Whether the optional attribute OrientationOf2DPlane is defined for this IfcStructuralAnalysisModel.

::Ifc2x3::IfcAxis2Placement3D *OrientationOf2DPlane() const

If the selected model type (PredefinedType) describes a 2D system, the orientation defines the analysis plane (P[1], P[2]) and the normal to the analysis plane (P[3]). This is needed because structural items and activities are always defined in three-dimensional space even if they are meant to be analysed in a two-dimensional manner.

In case of predefined type IN_PLANE_LOADING_2D, the analysis is to be performed within the projection into the P[1], P[2] plane. In case of predefined type OUT_PLANE_LOADING_2D, only the P[3] component of loads and their effects is meant to be analyzed. This is used for beam grids and for typical slab analyses. In case of predefined type LOADING_3D, OrientationOf2DPlane shall be omitted.

void setOrientationOf2DPlane(::Ifc2x3::IfcAxis2Placement3D *v)
bool hasLoadedBy() const

Whether the optional attribute LoadedBy is defined for this IfcStructuralAnalysisModel.

IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoadGroup>::ptr LoadedBy() const

References to all load groups to be analyzed.

void setLoadedBy(IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoadGroup>::ptr v)
bool hasHasResults() const

Whether the optional attribute HasResults is defined for this IfcStructuralAnalysisModel.

IfcTemplatedEntityList<::Ifc2x3::IfcStructuralResultGroup>::ptr HasResults() const

References to all result groups available for this structural analysis model.

void setHasResults(IfcTemplatedEntityList<::Ifc2x3::IfcStructuralResultGroup>::ptr v)
const IfcParse::entity &declaration() const
IfcStructuralAnalysisModel(IfcEntityInstanceData *e)
IfcStructuralAnalysisModel(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcAnalysisModelTypeEnum::Value v6_PredefinedType, ::Ifc2x3::IfcAxis2Placement3D *v7_OrientationOf2DPlane, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoadGroup>::ptr> v8_LoadedBy, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcStructuralResultGroup>::ptr> v9_HasResults)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralConnection : public Ifc2x3::IfcStructuralItem

Definition from IAI: An IfcStructuralConnection represents a structural connection object (node i.e. vertex connection, or edge connection, or surface connection) or supports.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc2x3::IfcStructuralCurveConnection, Ifc2x3::IfcStructuralPointConnection, Ifc2x3::IfcStructuralSurfaceConnection

Public Types

typedef IfcTemplatedEntityList<IfcStructuralConnection> list

Public Functions

bool hasAppliedCondition() const

Whether the optional attribute AppliedCondition is defined for this IfcStructuralConnection.

::Ifc2x3::IfcBoundaryCondition *AppliedCondition() const

Optional boundary conditions which define support conditions of this connection object, given in local coordinate directions of the connection object. If left unspecified, the connection object is assumed to have no supports besides being connected with members.

void setAppliedCondition(::Ifc2x3::IfcBoundaryCondition *v)
IfcTemplatedEntityList<IfcRelConnectsStructuralMember>::ptr ConnectsStructuralMembers() const
const IfcParse::entity &declaration() const
IfcStructuralConnection(IfcEntityInstanceData *e)
IfcStructuralConnection(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcBoundaryCondition *v8_AppliedCondition)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralConnectionCondition : public IfcUtil::IfcBaseEntity

Definition from IAI: Describe more rarely needed connection properties.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc2x3::IfcFailureConnectionCondition, Ifc2x3::IfcSlippageConnectionCondition

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcStructuralConnectionCondition.

std::string Name() const

Optionally defines a name for this connection condition.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcStructuralConnectionCondition(IfcEntityInstanceData *e)
IfcStructuralConnectionCondition(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralCurveConnection : public Ifc2x3::IfcStructuralConnection

Definition from IAI: Instances of IfcStructuralCurveConnection describe edge ‘nodes’, i.e. edges where two or more surface members are joined, or edge supports. Edge curves may be straight or curved.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attribute Axis added, allowing for skewed supports. Use definitions added.

Coordinate Systems:

See definitions at IfcStructuralItem. The local coordinate system is established by the reference curve given by topology representation and by the attribute Axis. The local x axis is parallel with the tangent on the reference curve. The local z axis is located in the surface which is created by sweeping Axis along the reference curve and is directed according to Axis. The local y axis is directed such that x,y,z form a right-handed Cartesian coordinate system.

Topology Use Definitions:

Instances of IfcStructuralCurveConnection shall have a topology representation which consists of one instance of IfcEdge or a subtype, representing the reference curve of the curve connection. See definitions at IfcStructuralItem for further specifications.

Informal propositions:

The reference curve must not be parallel with Axis at any point within the curve connections’s domain.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralCurveConnection(IfcEntityInstanceData *e)
IfcStructuralCurveConnection(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcBoundaryCondition *v8_AppliedCondition)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralCurveMember : public Ifc2x3::IfcStructuralMember

Definition from IAI: Instances of IfcStructuralCurveMember describe edge members, i.e. structural analysis idealizations of beams, columns, rods etc.. Curve members may be straight or curved.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attribute Axis and WHERE rule added. Use definitions changed.

Coordinate Systems:

See definitions at IfcStructuralItem. The local coordinate system is established by the reference curve given by topology representation and by the attribute Axis. The local x axis is parallel with the tangent on the reference curve. The local z axis is located in the surface which is created by sweeping Axis along the reference curve and is directed according to Axis. The local y axis is directed such that x,y,z form a right-handed Cartesian coordinate system.

Material Use Definition

The material of direct instances IfcStructuralCurveMember (in contrast to instances of the subtype IfcStructuralCurveMemberVarying) is defined by IfcMaterialProfileSetUsage and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Composite profile beams can be represented by refering to several IfcMaterialProfiles within the IfcMaterialProfileSet that is referenced from the IfcMaterialProfileSetUsage. In case of tapered members, the material profile usage subtype IfcMaterialProfileSetUsageDual is used which specifies IfcMaterialProfileSets separately at the start and the end of the tapered member.

The material (IfcMaterial) in each IfcMaterialProfile(Set) is specified minimally by a name which corresponds with an agreed upon standardized structural material designation. An external reference to the source which specifies the material designation should be provided. Alternatively, structural material properties may be provided by means of IfcMechanicalMaterialProperties and IfcExtendedMaterialProperties.

The profile (IfcProfileDef) in each IfcMaterialProfile(Set) is specified minimally by a name which corresponds with an agreed upon standardized structural profile designation. An external reference to the source which specifies the profile designation should be provided. Alternatively or additionally, explicit profile geometry should be provided by using respective subtypes of IfcProfileDef. Alternatively or additionally, structural profile properties may be provided by means of subtypes of IfcProfileProperties.

An IfcProfileDef is a two-dimensional geometric object with a xp,yp coordinate system. The profile is inserted into the curve member model thus that the origin of xp,yp is located at the member’s reference curve and that xp,yp are parallel with and directed like the local y,z.

NOTE Due to convention in structural mechanics, axis names of IfcStructuralCurveMember differ from axis names of building elements like IfcBeamStandardCase: The extrusion axis of IfcStructuralCurveMember is called x while the extrusion axis of IfcBeamStandardCase is called z. Hence x,y,z of IfcStructuralCurveMember correspond with z,x,y of IfcBeamStandardCase.

If the profile is meant to be inserted centrically in terms of structural section properties, it is necessary that the origin of xp,yp is identical with the geometric centroid of the profile (commonly also called centre of gravity). If subtypes of IfcParameterizedProfileDef are used which are only singly symmetric or are asymmetric, an explicit translation by IfcParameterizedProfileDef.Position.Location is required then.

If the profile is inserted at its geometric centroid, IfcMaterialProfileSetUsage.CardinalPoint shall be set to 10.

Otherwise, the profile is inserted eccentrically and a different cardinal point should be set accordingly.

NOTE Another eccentricity model is available independently of eccentric profile specification: The reference curve of the member may be located eccentrically relative to the reference points of the connected IfcStructuralPointConnections. The connection relationship is then established by IfcRelConnectsWithEccentricity. Whether one or the other or both eccentricity models may be used is subject to information requirements and local agreements.

Topology Use Definitions:

Direct instances of IfcStructuralCurveMember shall have a topology representation which consists of one instance of IfcEdge or a subtype, representing the reference curve of the curve member. See definitions at IfcStructuralItem for further specifications.

Informal propositions:

The reference curve must not be parallel with Axis at any point within the curve member’s domain.

Subclassed by Ifc2x3::IfcStructuralCurveMemberVarying

Public Functions

::Ifc2x3::IfcStructuralCurveTypeEnum::Value PredefinedType() const

Type of member with respect to its load carrying behavior in this analysis idealization.

void setPredefinedType(::Ifc2x3::IfcStructuralCurveTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcStructuralCurveMember(IfcEntityInstanceData *e)
IfcStructuralCurveMember(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralCurveTypeEnum::Value v8_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralCurveMemberVarying : public Ifc2x3::IfcStructuralCurveMember

Definition from IAI: Describes edge members with varying profile properties. Each instance of IfcStructuralCurveMemberVarying is composed of two or more instances of IfcStructuralCurveMember with differing profile properties. These subordinate members relate to the instance of IfcStructuralCurveMemberVarying by IfcRelAggregates.

NOTE A curve member whose variation of profile properties can be sufficiently described by a start profile and an end profile (e.g. tapers) shall be modeled as a single direct instance of the supertype IfcStructuralCurveMember.

NOTE It is recommended that structural activities (actions or reactions) are not connected with aggregated IfcStructuralCurveMemberVarying but only with the IfcStructuralCurveMembers in the aggregation. That way, difficulties in interpretation of local coordinates are avoided.

HISTORY: New entity in IFC 2x2. Use definition changed in IFC 2x4.

Coordinate Systems:

See definitions at IfcStructuralItem and IfcStructuralCurveMember. The local coordinates of the aggregate are derived from those of its parts. Length measures in local x direction of the aggregate depend on continuity and lengths of the parts. The Axis of the aggregate shal be the same as the Axis of the part at the start of the aggregate.

Material Use Definition

Only the individual parts (direct instances of IfcStructuralCurveMember) carry material and profile information.

Topology Use Definitions:

Instances of IfcStructuralCurveMemberVarying may have a topology representation which contains a single IfcEdgeLoop, based upon the edges of the parts.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralCurveMemberVarying(IfcEntityInstanceData *e)
IfcStructuralCurveMemberVarying(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralCurveTypeEnum::Value v8_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcStructuralCurveTypeEnum

Public Types

enum Value

Values:

enumerator IfcStructuralCurveType_RIGID_JOINED_MEMBER
enumerator IfcStructuralCurveType_PIN_JOINED_MEMBER
enumerator IfcStructuralCurveType_CABLE
enumerator IfcStructuralCurveType_TENSION_MEMBER
enumerator IfcStructuralCurveType_COMPRESSION_MEMBER
enumerator IfcStructuralCurveType_USERDEFINED
enumerator IfcStructuralCurveType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcStructuralItem : public Ifc2x3::IfcProduct

Definition from IAI: The abstract entity IfcStructuralItem is the generalization of structural members and structural connections, i.e. analysis idealizations of elements in the building model. It defines the relation between structural members and connections with structural activities (actions and reactions).

Relationships between elements in the building model and structural items as their idealizations can be expressed by instances of IfcRelAssignsToProduct.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Use definitions and informal proposition added.

Coordinate Systems:

The following coordinate systems are distinguished:

The so-called global coordinate system is the coordinate system shared by all items and activities which are grouped in a common IfcStructuralAnalysisModel. This coordinate system is established by SELF\IfcProduct.ObjectPlacement. (This coordinate system is not necessarily the same as the IfcProject’s world coordinate system.) The so-called local coordinate system is a coordinate system local to a structural item (connection or member). This coordinate system is established by a Representation (attribute inherited from IfcProduct) in conjunction with further use definitions and attributes of subtypes of IfcStructuralItem.

Representation items in topology representations are always given within the ObjectPlacement, i.e. in so-called global coordinates (global with respect to the IfcStructuralAnalysisModel to which this item belongs).

The usage of local coordinate systems is further defined in subtypes.

Topology Use Definitions:

Instances of IfcStructuralItem shall have a topology representation. It includes a placement and a product representation. The IfcProductRepresentation shall be given by an item in a Representation of type IfcTopologyRepresentation.

Local Placement

The local placement for IfcStructuralActivity is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which establishes a global coordinate system which shall be common to all items and activities in an IfcStructuralAnalysisModel.

Topology Representation

Instances of IfcStructuralItem shall have a topology representation given by an instance of a subtype of IfcTopologicalRepresentationItem, which should be the single item of IfcTopologyRepresentation.Items. Depending on the dimensionality of the structural item, one of the following types of toplogical representation items shall be used:

Point connections shall be represented by an IfcVertexPoint with an underlying IfcCartesianPoint. The Cartesian point is the reference point of the connection in the so-called global coordinate system. The following labels are used in the IfcTopologyRepresentation:

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Vertex’

Curve members and curve connections shall either be represented by an IfcOrientedEdge, IfcEdgeCurve, or IfcEdge. The curve to which the IfcEdgeCurve (or an IfcOrientedEdge’s underlying IfcEdgeCurve) refers to is the reference curve of the structural item in the global coordinate system. Start and end vertex of the edge shall be IfcVertexPoints with underlying IfcCartesianPoints. The following labels are used in the IfcTopologyRepresentation:

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Edge’

NOTE While an IfcEdge (or IfcOrientedEdge with underlying IfcEdge) does not provide an explicit underlying curve geometry, it may be used to imply an underlying straight line as reference curve with the origin of the curve parameter at the start vertex point.

Surface members and surface connections shall be represented by an IfcFaceSurface. The underlying surface defeines the reference surface of the structural surface item in the global coordiante system. All edges in the bounds of the face shall conform to the rules for edge representations of structural curve item. The following labels are used in the IfcTopologyRepresentation:

RepresentationIdentifier: ‘Reference’ RepresentationType: ‘Face’

The reference point, reference curve, or reference surface partially or completely defines the local coordinate system of the represented structural item according to the following rules. In all cases, The local x,y,z directions form a right-handed Cartesian coordinate system.

Structural point items

The reference point in the representation is the origin of the local coordinate system of the structural item. The axes of the local coordiante system are either parallel with and directed like the so-called global coordinate axes, or are oriented according to definitions at the respective subtype of IfcStructuralItem.

Structural curve items

The u parameter origin of the reference curve in the representation is the origin of the local coordinate system of the structural item. The local x axis is parallel with the tangent on the curve and directed like the u parameter direction. The local y and z axes are oriented according to definitions at the respective subtypes of IfcStructuralItem.

Structural surface items

The u,v parameter origin of the reference surface in the representation is the origin of the local coordinate system of the structural item. The local x and y directions follow the tangents on the surface and are in parallel with and directed like u and v respectively. The local z direction is in parallel with and directed like the surface normal.

Informal propositions:

The ObjectPlacements of all structural items which are grouped into the same instance of IfcStructuralAnalysisModel shall refer to the same instance of IfcObjectPlacement.

NOTE This rule is necessary to achieve consistent topology representations. The topology representations of structural items in an analysis model are meant to share vertices and edges und must therefore have the same object placement.

NOTE A structural item may be grouped into more than one analysis model. In this case, all these models must use the same instance of IfcObjectPlacement.

Subclassed by Ifc2x3::IfcStructuralConnection, Ifc2x3::IfcStructuralMember

Public Types

typedef IfcTemplatedEntityList<IfcStructuralItem> list

Public Functions

IfcTemplatedEntityList<IfcRelConnectsStructuralActivity>::ptr AssignedStructuralActivity() const
const IfcParse::entity &declaration() const
IfcStructuralItem(IfcEntityInstanceData *e)
IfcStructuralItem(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLinearAction : public Ifc2x3::IfcStructuralAction

Definition from IAI: Defines an action with constant value which is distributed over a curve.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Intermediate supertype IfcStructuralCurveAction inserted. Derived attribute PredefinedType added.

NOTE Like its supertype IfcStructuralCurveAction, this action type may also act on curved edges.

Subclassed by Ifc2x3::IfcStructuralLinearActionVarying

Public Functions

::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value ProjectedOrTrue() const
void setProjectedOrTrue(::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v)
const IfcParse::entity &declaration() const
IfcStructuralLinearAction(IfcEntityInstanceData *e)
IfcStructuralLinearAction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy, ::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v12_ProjectedOrTrue)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLinearActionVarying : public Ifc2x3::IfcStructuralLinearAction

Public Functions

::Ifc2x3::IfcShapeAspect *VaryingAppliedLoadLocation() const
void setVaryingAppliedLoadLocation(::Ifc2x3::IfcShapeAspect *v)
IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr SubsequentAppliedLoads() const
void setSubsequentAppliedLoads(IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr v)
const IfcParse::entity &declaration() const
IfcStructuralLinearActionVarying(IfcEntityInstanceData *e)
IfcStructuralLinearActionVarying(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy, ::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v12_ProjectedOrTrue, ::Ifc2x3::IfcShapeAspect *v13_VaryingAppliedLoadLocation, IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr v14_SubsequentAppliedLoads)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoad : public IfcUtil::IfcBaseEntity

Definition from IAI: The abstract entity IfcStructuralLoadOrResult is the supertype of all loads (actions or reactions) or of certain requirements resulting from structural analysis, or certain provisions which influence structural analysis.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc2x3::IfcStructuralLoadStatic

Public Types

typedef IfcTemplatedEntityList<IfcStructuralLoad> list

Public Functions

bool hasName() const

Whether the optional attribute Name is defined for this IfcStructuralLoad.

std::string Name() const

Optionally defines a name for this load.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcStructuralLoad(IfcEntityInstanceData *e)
IfcStructuralLoad(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadGroup : public Ifc2x3::IfcGroup

Definition from IAI: The entity IfcStructuralLoadGroup is used to structure the physical impacts. By using the grouping features inherited from IfcGroup, instances of IfcStructuralAction (or its subclasses) and of IfcStructuralLoadGroup can be used to define load groups, load cases and load combinations. (See also IfcLoadGroupTypeEnum.)

NOTE: Important functionality for the description of a load-bearing system is derived from the existing IFC entity IfcGroup. This class provides, via the relationship class IfcRelAssignsToGroup, the needed grouping mechanism. In this way, instances of IfcStructuralAction belonging to a specific load group can be unambiguously determined.

NOTE: The relationship class IfcRelAssignsToGroupByFactor is used to group load cases into load combinations. The factor provided in this assignment relationship is to applied together with the optional IfcStructuralLoadGroup.Coefficient. Unlike this coefficient which always affects the load group, the IfcRelAssignsToGroupByFactor.Factor is specific for a load case—load combination pair. As many instances of IfcRelAssignsToGroupByFactor are used within one load combination as there are different Factors to be applied to load cases in the load combination.

On the other hand, a load case may appear in more than one load combination and can have a different Factor in each assignment by IfcRelAssignsToGroupByFactor.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Subtype IfcStructuralLoadCase added. Informal propositions and WHERE rule added. Predefined type LOAD_COMBINATION_GROUP made obsolete and removed.

Informal propositions:

Load groups of type LOAD_GROUP shall only contain instances of IfcStructuralAction. Load groups of type LOAD_CASE shall always be instantiated from the subtype IfcStructuralLoadCase, not directly from the generic type IfcStructuralLoadGroup itself. Instances of IfcStructuralLoadCase shall only contain instances of IfcStructuralAction or/ and instances of IfcStructuralLoadGroup of type LOAD_GROUP. Load groups of type LOAD_COMBINATION shall only contain instances of IfcStructuralLoadCase.

Public Types

typedef IfcTemplatedEntityList<IfcStructuralLoadGroup> list

Public Functions

::Ifc2x3::IfcLoadGroupTypeEnum::Value PredefinedType() const

Selects a predefined type for the load group. It can be differentiated between load groups, load cases, load combinations, or userdefined grouping levels.

void setPredefinedType(::Ifc2x3::IfcLoadGroupTypeEnum::Value v)
::Ifc2x3::IfcActionTypeEnum::Value ActionType() const

Type of actions in the group. Normally needed if ‘PredefinedType’ specifies a LOAD_CASE.

void setActionType(::Ifc2x3::IfcActionTypeEnum::Value v)
::Ifc2x3::IfcActionSourceTypeEnum::Value ActionSource() const

Source of actions in the group. Normally needed if ‘PredefinedType’ specifies a LOAD_CASE.

void setActionSource(::Ifc2x3::IfcActionSourceTypeEnum::Value v)
bool hasCoefficient() const

Whether the optional attribute Coefficient is defined for this IfcStructuralLoadGroup.

double Coefficient() const

Load factor. If omitted, a factor is not yet known or not specified. A load factor of 1.0 shall be explicitly exported as Coefficient = 1.0.

void setCoefficient(double v)
bool hasPurpose() const

Whether the optional attribute Purpose is defined for this IfcStructuralLoadGroup.

std::string Purpose() const

Description of the purpose of this instance. Among else, possible values of the Purpose of load combinations are ‘SLS’, ‘ULS’, ‘ALS’ to indicate serviceability, ultimate, or accidental limit state.

void setPurpose(std::string v)
IfcTemplatedEntityList<IfcStructuralResultGroup>::ptr SourceOfResultGroup() const
IfcTemplatedEntityList<IfcStructuralAnalysisModel>::ptr LoadGroupFor() const
const IfcParse::entity &declaration() const
IfcStructuralLoadGroup(IfcEntityInstanceData *e)
IfcStructuralLoadGroup(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcLoadGroupTypeEnum::Value v6_PredefinedType, ::Ifc2x3::IfcActionTypeEnum::Value v7_ActionType, ::Ifc2x3::IfcActionSourceTypeEnum::Value v8_ActionSource, boost::optional<double> v9_Coefficient, boost::optional<std::string> v10_Purpose)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadLinearForce : public Ifc2x3::IfcStructuralLoadStatic

Definition from IAI: An instance of the entity IfcStructuralLoadLinearForce shall be used to define actions on curves.

HISTORY: New entity in Release IFC2x edition 2.

Public Functions

bool hasLinearForceX() const

Whether the optional attribute LinearForceX is defined for this IfcStructuralLoadLinearForce.

double LinearForceX() const

Linear force value in x-direction.

void setLinearForceX(double v)
bool hasLinearForceY() const

Whether the optional attribute LinearForceY is defined for this IfcStructuralLoadLinearForce.

double LinearForceY() const

Linear force value in y-direction.

void setLinearForceY(double v)
bool hasLinearForceZ() const

Whether the optional attribute LinearForceZ is defined for this IfcStructuralLoadLinearForce.

double LinearForceZ() const

Linear force value in z-direction.

void setLinearForceZ(double v)
bool hasLinearMomentX() const

Whether the optional attribute LinearMomentX is defined for this IfcStructuralLoadLinearForce.

double LinearMomentX() const

Linear moment about the x-axis.

void setLinearMomentX(double v)
bool hasLinearMomentY() const

Whether the optional attribute LinearMomentY is defined for this IfcStructuralLoadLinearForce.

double LinearMomentY() const

Linear moment about the y-axis.

void setLinearMomentY(double v)
bool hasLinearMomentZ() const

Whether the optional attribute LinearMomentZ is defined for this IfcStructuralLoadLinearForce.

double LinearMomentZ() const

Linear moment about the z-axis.

void setLinearMomentZ(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadLinearForce(IfcEntityInstanceData *e)
IfcStructuralLoadLinearForce(boost::optional<std::string> v1_Name, boost::optional<double> v2_LinearForceX, boost::optional<double> v3_LinearForceY, boost::optional<double> v4_LinearForceZ, boost::optional<double> v5_LinearMomentX, boost::optional<double> v6_LinearMomentY, boost::optional<double> v7_LinearMomentZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadPlanarForce : public Ifc2x3::IfcStructuralLoadStatic

Definition from IAI: An instance of the entity IfcStructuralLoadPlanarForce shall be used to define actions on faces.

HISTORY: New entity in Release IFC2x edition 2.

Public Functions

bool hasPlanarForceX() const

Whether the optional attribute PlanarForceX is defined for this IfcStructuralLoadPlanarForce.

double PlanarForceX() const

Planar force value in x-direction.

void setPlanarForceX(double v)
bool hasPlanarForceY() const

Whether the optional attribute PlanarForceY is defined for this IfcStructuralLoadPlanarForce.

double PlanarForceY() const

Planar force value in y-direction.

void setPlanarForceY(double v)
bool hasPlanarForceZ() const

Whether the optional attribute PlanarForceZ is defined for this IfcStructuralLoadPlanarForce.

double PlanarForceZ() const

Planar force value in z-direction.

void setPlanarForceZ(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadPlanarForce(IfcEntityInstanceData *e)
IfcStructuralLoadPlanarForce(boost::optional<std::string> v1_Name, boost::optional<double> v2_PlanarForceX, boost::optional<double> v3_PlanarForceY, boost::optional<double> v4_PlanarForceZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadSingleDisplacement : public Ifc2x3::IfcStructuralLoadStatic

Definition from IAI: Instances of the entity IfcStructuralLoadSingleDisplacement shall be used to define displacements.

HISTORY: New entity in Release IFC2x edition 2.

Subclassed by Ifc2x3::IfcStructuralLoadSingleDisplacementDistortion

Public Functions

bool hasDisplacementX() const

Whether the optional attribute DisplacementX is defined for this IfcStructuralLoadSingleDisplacement.

double DisplacementX() const

Displacement in x-direction.

void setDisplacementX(double v)
bool hasDisplacementY() const

Whether the optional attribute DisplacementY is defined for this IfcStructuralLoadSingleDisplacement.

double DisplacementY() const

Displacement in y-direction.

void setDisplacementY(double v)
bool hasDisplacementZ() const

Whether the optional attribute DisplacementZ is defined for this IfcStructuralLoadSingleDisplacement.

double DisplacementZ() const

Displacement in z-direction.

void setDisplacementZ(double v)
bool hasRotationalDisplacementRX() const

Whether the optional attribute RotationalDisplacementRX is defined for this IfcStructuralLoadSingleDisplacement.

double RotationalDisplacementRX() const

Rotation about the x-axis.

void setRotationalDisplacementRX(double v)
bool hasRotationalDisplacementRY() const

Whether the optional attribute RotationalDisplacementRY is defined for this IfcStructuralLoadSingleDisplacement.

double RotationalDisplacementRY() const

Rotation about the y-axis.

void setRotationalDisplacementRY(double v)
bool hasRotationalDisplacementRZ() const

Whether the optional attribute RotationalDisplacementRZ is defined for this IfcStructuralLoadSingleDisplacement.

double RotationalDisplacementRZ() const

Rotation about the z-axis.

void setRotationalDisplacementRZ(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadSingleDisplacement(IfcEntityInstanceData *e)
IfcStructuralLoadSingleDisplacement(boost::optional<std::string> v1_Name, boost::optional<double> v2_DisplacementX, boost::optional<double> v3_DisplacementY, boost::optional<double> v4_DisplacementZ, boost::optional<double> v5_RotationalDisplacementRX, boost::optional<double> v6_RotationalDisplacementRY, boost::optional<double> v7_RotationalDisplacementRZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadSingleDisplacementDistortion : public Ifc2x3::IfcStructuralLoadSingleDisplacement

Definition from IAI: Defines a displacement with warping.

HISTORY: New entity in IFC 2x2.

Public Functions

bool hasDistortion() const

Whether the optional attribute Distortion is defined for this IfcStructuralLoadSingleDisplacementDistortion.

double Distortion() const

The distortion curvature (warping, i.e. a cross-sectional deplanation) given to the displacement load.

void setDistortion(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadSingleDisplacementDistortion(IfcEntityInstanceData *e)
IfcStructuralLoadSingleDisplacementDistortion(boost::optional<std::string> v1_Name, boost::optional<double> v2_DisplacementX, boost::optional<double> v3_DisplacementY, boost::optional<double> v4_DisplacementZ, boost::optional<double> v5_RotationalDisplacementRX, boost::optional<double> v6_RotationalDisplacementRY, boost::optional<double> v7_RotationalDisplacementRZ, boost::optional<double> v8_Distortion)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadSingleForce : public Ifc2x3::IfcStructuralLoadStatic

Definition from IAI: Instances of the entity IfcStructuralLoadSingleForce shall be used to define the forces and moments of an action operating on a single point.

HISTORY: New entity in Release IFC2x edition 2.

Subclassed by Ifc2x3::IfcStructuralLoadSingleForceWarping

Public Functions

bool hasForceX() const

Whether the optional attribute ForceX is defined for this IfcStructuralLoadSingleForce.

double ForceX() const

Force value in x-direction.

void setForceX(double v)
bool hasForceY() const

Whether the optional attribute ForceY is defined for this IfcStructuralLoadSingleForce.

double ForceY() const

Force value in y-direction.

void setForceY(double v)
bool hasForceZ() const

Whether the optional attribute ForceZ is defined for this IfcStructuralLoadSingleForce.

double ForceZ() const

Force value in z-direction.

void setForceZ(double v)
bool hasMomentX() const

Whether the optional attribute MomentX is defined for this IfcStructuralLoadSingleForce.

double MomentX() const

Moment about the x-axis.

void setMomentX(double v)
bool hasMomentY() const

Whether the optional attribute MomentY is defined for this IfcStructuralLoadSingleForce.

double MomentY() const

Moment about the y-axis.

void setMomentY(double v)
bool hasMomentZ() const

Whether the optional attribute MomentZ is defined for this IfcStructuralLoadSingleForce.

double MomentZ() const

Moment about the z-axis.

void setMomentZ(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadSingleForce(IfcEntityInstanceData *e)
IfcStructuralLoadSingleForce(boost::optional<std::string> v1_Name, boost::optional<double> v2_ForceX, boost::optional<double> v3_ForceY, boost::optional<double> v4_ForceZ, boost::optional<double> v5_MomentX, boost::optional<double> v6_MomentY, boost::optional<double> v7_MomentZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadSingleForceWarping : public Ifc2x3::IfcStructuralLoadSingleForce

Definition from IAI: Instances of the entity IfcStructuralLoadSingleForceWarping, as a subtype of IfcStructuralLoadSingleForce, shall be used to define an action operation on a single point. In addition to forces and moments defined by its supertype a warping moment can be defined.

HISTORY: New entity in Release IFC2x edition 2.

Public Functions

bool hasWarpingMoment() const

Whether the optional attribute WarpingMoment is defined for this IfcStructuralLoadSingleForceWarping.

double WarpingMoment() const

The warping moment at the point load.

void setWarpingMoment(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadSingleForceWarping(IfcEntityInstanceData *e)
IfcStructuralLoadSingleForceWarping(boost::optional<std::string> v1_Name, boost::optional<double> v2_ForceX, boost::optional<double> v3_ForceY, boost::optional<double> v4_ForceZ, boost::optional<double> v5_MomentX, boost::optional<double> v6_MomentY, boost::optional<double> v7_MomentZ, boost::optional<double> v8_WarpingMoment)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadStatic : public Ifc2x3::IfcStructuralLoad

Definition from IAI: The abstract entity IfcStructuralLoadStatic is the supertype of all static loads (actions or reactions) which can be defined. Within scope are single i.e. concentrated forces and moments, linear i.e. one-dimensionally distributed forces and moments, planar i.e. two-dimensionally distributed forces, furthermore displacements and temperature loads.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc2x3::IfcStructuralLoadLinearForce, Ifc2x3::IfcStructuralLoadPlanarForce, Ifc2x3::IfcStructuralLoadSingleDisplacement, Ifc2x3::IfcStructuralLoadSingleForce, Ifc2x3::IfcStructuralLoadTemperature

Public Types

typedef IfcTemplatedEntityList<IfcStructuralLoadStatic> list

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralLoadStatic(IfcEntityInstanceData *e)
IfcStructuralLoadStatic(boost::optional<std::string> v1_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralLoadTemperature : public Ifc2x3::IfcStructuralLoadStatic

An instance of the entity IfcStructuralLoadTemperature shall be used to define actions which are caused by a temperature change. As shown in Figure 332, the change of temperature is given with a constant value which is applied to the complete section and values for temperature differences between outer fibres of the section.

HISTORY New entity in IFC2x2.

Figure 332 — Structural load temperature

Public Functions

bool hasDeltaT_Constant() const

Whether the optional attribute DeltaT_Constant is defined for this IfcStructuralLoadTemperature.

double DeltaT_Constant() const
void setDeltaT_Constant(double v)
bool hasDeltaT_Y() const

Whether the optional attribute DeltaT_Y is defined for this IfcStructuralLoadTemperature.

double DeltaT_Y() const
void setDeltaT_Y(double v)
bool hasDeltaT_Z() const

Whether the optional attribute DeltaT_Z is defined for this IfcStructuralLoadTemperature.

double DeltaT_Z() const
void setDeltaT_Z(double v)
const IfcParse::entity &declaration() const
IfcStructuralLoadTemperature(IfcEntityInstanceData *e)
IfcStructuralLoadTemperature(boost::optional<std::string> v1_Name, boost::optional<double> v2_DeltaT_Constant, boost::optional<double> v3_DeltaT_Y, boost::optional<double> v4_DeltaT_Z)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralMember : public Ifc2x3::IfcStructuralItem

Definition from IAI: The abstract entity IfcStructuralMember is the superclass of all structural items which represent the idealized structural behavior of building elements.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Use definitions moved to supertype and subtypes.

Subclassed by Ifc2x3::IfcStructuralCurveMember, Ifc2x3::IfcStructuralSurfaceMember

Public Types

typedef IfcTemplatedEntityList<IfcStructuralMember> list

Public Functions

IfcTemplatedEntityList<IfcRelConnectsStructuralElement>::ptr ReferencesElement() const
IfcTemplatedEntityList<IfcRelConnectsStructuralMember>::ptr ConnectedBy() const
const IfcParse::entity &declaration() const
IfcStructuralMember(IfcEntityInstanceData *e)
IfcStructuralMember(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralPlanarAction : public Ifc2x3::IfcStructuralAction

Definition from IAI: Defines an action with constant value which is distributed over a surface.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Intermediate supertype IfcStructuralSurfaceAction inserted. Derived attribute PredefinedType added.

NOTE Like its supertype IfcStructuralSurfaceAction, this action type may also act on curved faces.

Subclassed by Ifc2x3::IfcStructuralPlanarActionVarying

Public Functions

::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value ProjectedOrTrue() const
void setProjectedOrTrue(::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v)
const IfcParse::entity &declaration() const
IfcStructuralPlanarAction(IfcEntityInstanceData *e)
IfcStructuralPlanarAction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy, ::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v12_ProjectedOrTrue)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralPlanarActionVarying : public Ifc2x3::IfcStructuralPlanarAction

Public Functions

::Ifc2x3::IfcShapeAspect *VaryingAppliedLoadLocation() const
void setVaryingAppliedLoadLocation(::Ifc2x3::IfcShapeAspect *v)
IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr SubsequentAppliedLoads() const
void setSubsequentAppliedLoads(IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr v)
const IfcParse::entity &declaration() const
IfcStructuralPlanarActionVarying(IfcEntityInstanceData *e)
IfcStructuralPlanarActionVarying(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy, ::Ifc2x3::IfcProjectedOrTrueLengthEnum::Value v12_ProjectedOrTrue, ::Ifc2x3::IfcShapeAspect *v13_VaryingAppliedLoadLocation, IfcTemplatedEntityList<::Ifc2x3::IfcStructuralLoad>::ptr v14_SubsequentAppliedLoads)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralPointAction : public Ifc2x3::IfcStructuralAction

Definition from IAI: Defines an action which acts on a point. A point action is typically connected with a point connection. It may also be connected with a curve member or curve connection, or surface member or surface connection.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attributes in the supertypes IfcStructuralActivity and IfcStructuralAction changed. Use definitions changed, informal propositions added.

Coordinate Systems:

See definitions at IfcStructuralActivity.

Topology Use Definitions:

Standard Case: If connected with a point item, instances of IfcStructuralPointAction shall not have an ObjectPlacement nor a Representation. It is implied that the placement and representation of the action is the same as the structural item.

Special Case 1: If connected with a curve item or surface item, instances of IfcStructuralPointAction shall have an ObjectPlacement and Representation, containing an IfcVertexPoint. See IfcStructuralActivity for further definitions.

NOTE In order to model concentrated actions on a curve or surface item, IfcStructuralCurveAction or IfcStructuralSurfaceAction of type DISCRETE is preferable since they do not require an extra topology representation in this case. An IfcStructuralPointAction should be used for a concentrated action on a curve or surface item only when an explicit vertex point representation is actually desired.

Special Case 2: If not connected with a structural item (which may happen in an incomplete or conceptual model), a point action should have an ObjectPlacement and Representation, containing an IfcVertexPoint. See IfcStructuralActivity for further definitions.

Informal propositions:

SELF\IfcStructuralActivity.AppliedLoad shall be of type IfcStructuralLoadSingleForce or IfcStructuralLoadSingleDisplacement.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralPointAction(IfcEntityInstanceData *e)
IfcStructuralPointAction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal, bool v10_DestabilizingLoad, ::Ifc2x3::IfcStructuralReaction *v11_CausedBy)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralPointConnection : public Ifc2x3::IfcStructuralConnection

Definition from IAI: Instances of IfcStructuralPointConnection describe structural nodes or point supports.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attribute ConditionCoordinateSystem added, allowing for skewed supports. Use definitions added.

Coordinate Systems:

See definitions at IfcStructuralItem. The local coordinate system is established by the reference point given by topology representation and by the attribute ConditionCoordinateSystem.

Topology Use Definitions:

Instances of IfcStructuralPointConnection shall have a topology representation which consists of one IfcVertexPoint, representing the reference point of the point connection. See definitions at IfcStructuralItem for further specifications.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralPointConnection(IfcEntityInstanceData *e)
IfcStructuralPointConnection(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcBoundaryCondition *v8_AppliedCondition)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralPointReaction : public Ifc2x3::IfcStructuralReaction

Definition from IAI: Defines a reaction which occurs at a point. A point reaction is typically connected with a point connection. It may also be connected with a curve member or curve connection, or surface member or surface connection.

HISTORY: New entity in IFC 2x2.

IFC 2x4 change: Attributes in the supertypes IfcStructuralActivity and IfcStructuralReaction changed. Use definitions changed, informal propositions added.

Coordinate Systems:

See definitions at IfcStructuralActivity.

Topology Use Definitions:

Standard Case: If connected with a point item, instances of IfcStructuralPointReaction shall not have an ObjectPlacement nor a Representation. It is implied that the placement and representation of the reaction is the same as the structural item.

Special Case 1: If connected with a curve item or surface item, instances of IfcStructuralPointReaction shall have an ObjectPlacement and Representation, containing an IfcVertexPoint. See IfcStructuralActivity for further definitions.

NOTE In order to model concentrated reactions on a curve or surface item, IfcStructuralCurveReaction or IfcStructuralSurfaceAction of type DISCRETE is preferable since they do not require an extra topology representation in this case. An IfcStructuralPointReaction should be used for a concentrated reaction on a curve or surface item only when an explicit vertex point representation is actually desired.

Special Case 2: If not connected with a structural item (which may happen in an incomplete or conceptual model), a point action should have an ObjectPlacement and Representation, containing an IfcVertexPoint. See IfcStructuralActivity for further definitions.

Informal propositions:

SELF\IfcStructuralActivity.AppliedLoad shall be of type IfcStructuralLoadSingleForce or IfcStructuralLoadSingleDisplacement.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralPointReaction(IfcEntityInstanceData *e)
IfcStructuralPointReaction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralProfileProperties : public Ifc2x3::IfcGeneralProfileProperties

Subclassed by Ifc2x3::IfcStructuralSteelProfileProperties

Public Functions

bool hasTorsionalConstantX() const

Whether the optional attribute TorsionalConstantX is defined for this IfcStructuralProfileProperties.

double TorsionalConstantX() const
void setTorsionalConstantX(double v)
bool hasMomentOfInertiaYZ() const

Whether the optional attribute MomentOfInertiaYZ is defined for this IfcStructuralProfileProperties.

double MomentOfInertiaYZ() const
void setMomentOfInertiaYZ(double v)
bool hasMomentOfInertiaY() const

Whether the optional attribute MomentOfInertiaY is defined for this IfcStructuralProfileProperties.

double MomentOfInertiaY() const
void setMomentOfInertiaY(double v)
bool hasMomentOfInertiaZ() const

Whether the optional attribute MomentOfInertiaZ is defined for this IfcStructuralProfileProperties.

double MomentOfInertiaZ() const
void setMomentOfInertiaZ(double v)
bool hasWarpingConstant() const

Whether the optional attribute WarpingConstant is defined for this IfcStructuralProfileProperties.

double WarpingConstant() const
void setWarpingConstant(double v)
bool hasShearCentreZ() const

Whether the optional attribute ShearCentreZ is defined for this IfcStructuralProfileProperties.

double ShearCentreZ() const
void setShearCentreZ(double v)
bool hasShearCentreY() const

Whether the optional attribute ShearCentreY is defined for this IfcStructuralProfileProperties.

double ShearCentreY() const
void setShearCentreY(double v)
bool hasShearDeformationAreaZ() const

Whether the optional attribute ShearDeformationAreaZ is defined for this IfcStructuralProfileProperties.

double ShearDeformationAreaZ() const
void setShearDeformationAreaZ(double v)
bool hasShearDeformationAreaY() const

Whether the optional attribute ShearDeformationAreaY is defined for this IfcStructuralProfileProperties.

double ShearDeformationAreaY() const
void setShearDeformationAreaY(double v)
bool hasMaximumSectionModulusY() const

Whether the optional attribute MaximumSectionModulusY is defined for this IfcStructuralProfileProperties.

double MaximumSectionModulusY() const
void setMaximumSectionModulusY(double v)
bool hasMinimumSectionModulusY() const

Whether the optional attribute MinimumSectionModulusY is defined for this IfcStructuralProfileProperties.

double MinimumSectionModulusY() const
void setMinimumSectionModulusY(double v)
bool hasMaximumSectionModulusZ() const

Whether the optional attribute MaximumSectionModulusZ is defined for this IfcStructuralProfileProperties.

double MaximumSectionModulusZ() const
void setMaximumSectionModulusZ(double v)
bool hasMinimumSectionModulusZ() const

Whether the optional attribute MinimumSectionModulusZ is defined for this IfcStructuralProfileProperties.

double MinimumSectionModulusZ() const
void setMinimumSectionModulusZ(double v)
bool hasTorsionalSectionModulus() const

Whether the optional attribute TorsionalSectionModulus is defined for this IfcStructuralProfileProperties.

double TorsionalSectionModulus() const
void setTorsionalSectionModulus(double v)
bool hasCentreOfGravityInX() const

Whether the optional attribute CentreOfGravityInX is defined for this IfcStructuralProfileProperties.

double CentreOfGravityInX() const
void setCentreOfGravityInX(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcStructuralProfileProperties.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcStructuralProfileProperties(IfcEntityInstanceData *e)
IfcStructuralProfileProperties(boost::optional<std::string> v1_ProfileName, ::Ifc2x3::IfcProfileDef *v2_ProfileDefinition, boost::optional<double> v3_PhysicalWeight, boost::optional<double> v4_Perimeter, boost::optional<double> v5_MinimumPlateThickness, boost::optional<double> v6_MaximumPlateThickness, boost::optional<double> v7_CrossSectionArea, boost::optional<double> v8_TorsionalConstantX, boost::optional<double> v9_MomentOfInertiaYZ, boost::optional<double> v10_MomentOfInertiaY, boost::optional<double> v11_MomentOfInertiaZ, boost::optional<double> v12_WarpingConstant, boost::optional<double> v13_ShearCentreZ, boost::optional<double> v14_ShearCentreY, boost::optional<double> v15_ShearDeformationAreaZ, boost::optional<double> v16_ShearDeformationAreaY, boost::optional<double> v17_MaximumSectionModulusY, boost::optional<double> v18_MinimumSectionModulusY, boost::optional<double> v19_MaximumSectionModulusZ, boost::optional<double> v20_MinimumSectionModulusZ, boost::optional<double> v21_TorsionalSectionModulus, boost::optional<double> v22_CentreOfGravityInX, boost::optional<double> v23_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralReaction : public Ifc2x3::IfcStructuralActivity

Definition from IAI: A structural reaction is a structural activity that results from a structural action imposed to a structural item or building element. Examples are support reactions, internal forces, and deflections.

HISTORY New entity in IFC 2x2.

IFC 2x4 change: Inverse attribute Causes deleted; use IfcRelAssignsToProduct via HasAssignments instead.

Structural reactions are grouped into IfcStructuralResultGroups via the inverse relationship HasAssignments and an IfcRelAssignsToGroup relationship object. IfcStructuralResultGroup.ResultGroupFor finally refers to the structural analysis model in which the results occur.

It is furthermore possible to establish relationships between reactions in one analysis model and actions which they cause in another analysis model. For example, a support reaction from one structural system may be taken over as a load onto another supporting structural system. This is expressed by means of the inverse relationship HasAssignments of the reaction and an IfcRelAssignsToProduct relationship object. IfcRelAssignsToProduct.Name is set to ‘Causes’ and IfcRelAssignsToProduct.RelatingProduct refers to an instance of a subtype of IfcStructuralAction.

Subclassed by Ifc2x3::IfcStructuralPointReaction

Public Types

typedef IfcTemplatedEntityList<IfcStructuralReaction> list

Public Functions

IfcTemplatedEntityList<IfcStructuralAction>::ptr Causes() const
const IfcParse::entity &declaration() const
IfcStructuralReaction(IfcEntityInstanceData *e)
IfcStructuralReaction(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralLoad *v8_AppliedLoad, ::Ifc2x3::IfcGlobalOrLocalEnum::Value v9_GlobalOrLocal)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralResultGroup : public Ifc2x3::IfcGroup

Definition from IAI: Instances of the entity IfcStructuralResultGroup are used to group results of structural analysis calculations and to capture the connection to the underlying basic load group. The basic functionality for grouping inherited from IfcGroup is used to collect instances from IfcStructuralReaction or its respective subclasses.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: WHERE rule added.

Public Functions

::Ifc2x3::IfcAnalysisTheoryTypeEnum::Value TheoryType() const

Specifies the analysis theory used to obtain the respective results.

void setTheoryType(::Ifc2x3::IfcAnalysisTheoryTypeEnum::Value v)
bool hasResultForLoadGroup() const

Whether the optional attribute ResultForLoadGroup is defined for this IfcStructuralResultGroup.

::Ifc2x3::IfcStructuralLoadGroup *ResultForLoadGroup() const

Reference to an instance of IfcStructuralLoadGroup for which this instance represents the result.

void setResultForLoadGroup(::Ifc2x3::IfcStructuralLoadGroup *v)
bool IsLinear() const

This value allows to easily recognize whether a linear analysis has been applied (allowing the superposition of analysis results).

void setIsLinear(bool v)
IfcTemplatedEntityList<IfcStructuralAnalysisModel>::ptr ResultGroupFor() const
const IfcParse::entity &declaration() const
IfcStructuralResultGroup(IfcEntityInstanceData *e)
IfcStructuralResultGroup(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcAnalysisTheoryTypeEnum::Value v6_TheoryType, ::Ifc2x3::IfcStructuralLoadGroup *v7_ResultForLoadGroup, bool v8_IsLinear)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralSteelProfileProperties : public Ifc2x3::IfcStructuralProfileProperties

Public Functions

bool hasShearAreaZ() const

Whether the optional attribute ShearAreaZ is defined for this IfcStructuralSteelProfileProperties.

double ShearAreaZ() const
void setShearAreaZ(double v)
bool hasShearAreaY() const

Whether the optional attribute ShearAreaY is defined for this IfcStructuralSteelProfileProperties.

double ShearAreaY() const
void setShearAreaY(double v)
bool hasPlasticShapeFactorY() const

Whether the optional attribute PlasticShapeFactorY is defined for this IfcStructuralSteelProfileProperties.

double PlasticShapeFactorY() const
void setPlasticShapeFactorY(double v)
bool hasPlasticShapeFactorZ() const

Whether the optional attribute PlasticShapeFactorZ is defined for this IfcStructuralSteelProfileProperties.

double PlasticShapeFactorZ() const
void setPlasticShapeFactorZ(double v)
const IfcParse::entity &declaration() const
IfcStructuralSteelProfileProperties(IfcEntityInstanceData *e)
IfcStructuralSteelProfileProperties(boost::optional<std::string> v1_ProfileName, ::Ifc2x3::IfcProfileDef *v2_ProfileDefinition, boost::optional<double> v3_PhysicalWeight, boost::optional<double> v4_Perimeter, boost::optional<double> v5_MinimumPlateThickness, boost::optional<double> v6_MaximumPlateThickness, boost::optional<double> v7_CrossSectionArea, boost::optional<double> v8_TorsionalConstantX, boost::optional<double> v9_MomentOfInertiaYZ, boost::optional<double> v10_MomentOfInertiaY, boost::optional<double> v11_MomentOfInertiaZ, boost::optional<double> v12_WarpingConstant, boost::optional<double> v13_ShearCentreZ, boost::optional<double> v14_ShearCentreY, boost::optional<double> v15_ShearDeformationAreaZ, boost::optional<double> v16_ShearDeformationAreaY, boost::optional<double> v17_MaximumSectionModulusY, boost::optional<double> v18_MinimumSectionModulusY, boost::optional<double> v19_MaximumSectionModulusZ, boost::optional<double> v20_MinimumSectionModulusZ, boost::optional<double> v21_TorsionalSectionModulus, boost::optional<double> v22_CentreOfGravityInX, boost::optional<double> v23_CentreOfGravityInY, boost::optional<double> v24_ShearAreaZ, boost::optional<double> v25_ShearAreaY, boost::optional<double> v26_PlasticShapeFactorY, boost::optional<double> v27_PlasticShapeFactorZ)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralSurfaceConnection : public Ifc2x3::IfcStructuralConnection

Definition from IAI: Instances of IfcStructuralSurfaceConnection describe face ‘nodes’, i.e. faces where two or more surface members are joined, or face supports. Face surfaces may be planar or curved.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Use definitions added.

Coordinate Systems:

See definitions at IfcStructuralItem. The local coordinate system is established by the reference surface given by topology representation.

Topology Use Definitions:

Instances of IfcStructuralSurfaceConnection shall have a topology representation which consists of one IfcFaceSurface, representing the reference surface of the surface connection. See definitions at IfcStructuralItem for further specifications.

Public Functions

const IfcParse::entity &declaration() const
IfcStructuralSurfaceConnection(IfcEntityInstanceData *e)
IfcStructuralSurfaceConnection(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcBoundaryCondition *v8_AppliedCondition)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralSurfaceMember : public Ifc2x3::IfcStructuralMember

Definition from IAI: Instances of IfcStructuralSurfaceMember describe face members, i.e. structural analysis idealizations of slabs, walls, shells, etc.. Surface members may be planar or curved.

HISTORY: New entity in IFC 2x2. IFC 2x4 change: Use definitions changed, WHERE rule added.

Coordinate Systems:

See definitions at IfcStructuralItem. The local coordinate system is established by the reference surface given by topology representation.

Material Use Definition

The material of direct instances IfcStructuralSurfaceMember (in contrast to instances of the subtype IfcStructuralSurfaceMemberVarying) is defined by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship.

The material is specified minimally by a name which corresponds with an agreed upon standardized structural material designation. An external reference to the source which specifies the material designation should be provided. Alternatively, structural material properties may be provided by means of IfcMechanicalMaterialProperties and IfcExtendedMaterialProperties.

Direct instances of IfcStructuralSurfaceMember are assumed to be located centrically relative to their reference surface. Their depth is provided in the attribute Thickness.

Topology Use Definitions:

Direct instances of IfcStructuralSurfaceMember shall have a topology representation which consists of one IfcFaceSurface, representing the reference surface of the surface member. See definitions at IfcStructuralItem for further specifications.

Subclassed by Ifc2x3::IfcStructuralSurfaceMemberVarying

Public Functions

::Ifc2x3::IfcStructuralSurfaceTypeEnum::Value PredefinedType() const

Type of member with respect to its load carrying behavior in this analysis idealization.

void setPredefinedType(::Ifc2x3::IfcStructuralSurfaceTypeEnum::Value v)
bool hasThickness() const

Whether the optional attribute Thickness is defined for this IfcStructuralSurfaceMember.

double Thickness() const

Defines the typically understood thickness of the structural surface member, measured normal to its reference surface.

void setThickness(double v)
const IfcParse::entity &declaration() const
IfcStructuralSurfaceMember(IfcEntityInstanceData *e)
IfcStructuralSurfaceMember(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralSurfaceTypeEnum::Value v8_PredefinedType, boost::optional<double> v9_Thickness)

Public Static Functions

const IfcParse::entity &Class()
class IfcStructuralSurfaceMemberVarying : public Ifc2x3::IfcStructuralSurfaceMember

Definition from IAI: Describes surface members with varying section properties. The properties are provided by means of a property set and IfcRelDefinesByProperties or by means of aggregation: An instance of IfcStructuralSurfaceMemberVarying may be composed of two or more instances of IfcStructuralSurfaceMember with differing section properties. These subordinate members relate to the instance of IfcStructuralSurfaceMemberVarying by IfcRelAggregates.

NOTE It is recommended that structural activities (actions or reactions) are not connected with aggregated IfcStructuralSurfaceMemberVarying but only with the IfcStructuralSurfaceMembers in the aggregation. That way, difficulties in interpretation of local coordinates are avoided.

HISTORY: New entity in IFC 2x2. Use definition changed and attributes deleted in IFC 2x4.

Coordinate Systems:

See definitions at IfcStructuralItem and IfcStructuralSurfaceMember. The local coordinates of an aggregate are generally undefined since continuity of local coordinates of the parts is not ensured.

Material Use Definition

In case of aggregation, only the individual parts (direct instances of IfcStructuralSurfaceMember) carry material and thickness information. Otherwise, definitions at IfcStructuralSurfaceMember apply.

Topology Use Definitions:

In case of aggregation, instances of IfcStructuralSurfaceMemberVarying may have a topology representation which contains a single IfcConnectedFaceSet, based upon the faces of the parts. Otherwise, definitions at IfcStructuralSurfaceMember apply.

Public Functions

std::vector<double> SubsequentThickness() const
void setSubsequentThickness(std::vector<double> v)
::Ifc2x3::IfcShapeAspect *VaryingThicknessLocation() const
void setVaryingThicknessLocation(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcStructuralSurfaceMemberVarying(IfcEntityInstanceData *e)
IfcStructuralSurfaceMemberVarying(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, ::Ifc2x3::IfcStructuralSurfaceTypeEnum::Value v8_PredefinedType, boost::optional<double> v9_Thickness, std::vector<double> v10_SubsequentThickness, ::Ifc2x3::IfcShapeAspect *v11_VaryingThicknessLocation)

Public Static Functions

const IfcParse::entity &Class()
struct IfcStructuralSurfaceTypeEnum

Public Types

enum Value

Values:

enumerator IfcStructuralSurfaceType_BENDING_ELEMENT
enumerator IfcStructuralSurfaceType_MEMBRANE_ELEMENT
enumerator IfcStructuralSurfaceType_SHELL
enumerator IfcStructuralSurfaceType_USERDEFINED
enumerator IfcStructuralSurfaceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcStructuredDimensionCallout : public Ifc2x3::IfcDraughtingCallout

Public Functions

const IfcParse::entity &declaration() const
IfcStructuredDimensionCallout(IfcEntityInstanceData *e)
IfcStructuredDimensionCallout(IfcEntityList::ptr v1_Contents)

Public Static Functions

const IfcParse::entity &Class()
class IfcStyledItem : public Ifc2x3::IfcRepresentationItem

Definition from ISO/CD 10303-46:1992: The styled item is an assignment of style for presentation to a geometric representation item as it is used in a representation.

NOTE Corresponding ISO 10303 name: styled_item. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

The IfcStyledItem holds presentation style information for products, either explicitly for an IfcGeometricRepresentationItem being part of an IfcShapeRepresentation assigned to a product, or by assigning presentation information to IfcMaterial being assigned as other representation for a product.

If the IfcStyledItem is used within a reference from an IfcProductDefinitionShape then one Item shall be provided. If the IfcStyledItem is used within a reference from an IfcMaterialDefinitionRepresentation then no Item shall be provided.

HISTORY New entity in IFC2x2.

IFC2x2 Addendum 1 CHANGE The entity IfcStyledItem has been made non abstract and the attribute Name added.

IFC2x3 CHANGE The attribute Item has been made optional, upward compatibility for file based exchange is guaranteed.

IFC2x4 CHANGE The subtype IfcAnnotationOccurrence and its subtypes are deleted. Use IfcStyledItem for all instantiations. The data type of Styles has been changed to IfcStyleAssignmentSelect

Use Definition

Figure 293 illustrates use of IfcStyledItem for the two usage examples:

As a presentation for a geometric representation item As a presentation for a material definition

NOTE The new IfcStyleAssignmentSelect allows the direct assignment styles, such as IfcCurveStyle, IfcSurfaceStyle without using the intermediate IfcPresentationStyleAssignment

Figure 293 — Styled item

Subclassed by Ifc2x3::IfcAnnotationOccurrence

Public Types

typedef IfcTemplatedEntityList<IfcStyledItem> list

Public Functions

bool hasItem() const

Whether the optional attribute Item is defined for this IfcStyledItem.

::Ifc2x3::IfcRepresentationItem *Item() const

A geometric representation item to which the style is assigned.

IFC2x Edition 2 Addendum 2 CHANGE The attribute Item has been made optional. Upward compatibility for file based exchange is guaranteed.

void setItem(::Ifc2x3::IfcRepresentationItem *v)
IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr Styles() const

Representation styles which are assigned, either to an geometric representation item, or to a material definition.

IFC2x4 CHANGE The data type has been changed to IfcStyleAssignmentSelect with upward compatibility for file based exchange.

NOTE Only the select item IfcPresentationStyle shall be used from IFC2x4 onwards, the IfcPresentationStyleAssignment has been deprecated.

void setStyles(IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v)
bool hasName() const

Whether the optional attribute Name is defined for this IfcStyledItem.

std::string Name() const

The word, or group of words, by which the styled item is referred to.

void setName(std::string v)
const IfcParse::entity &declaration() const
IfcStyledItem(IfcEntityInstanceData *e)
IfcStyledItem(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name)

Public Static Functions

const IfcParse::entity &Class()
class IfcStyledRepresentation : public Ifc2x3::IfcStyleModel

The IfcStyledRepresentation represents the concept of a styled presentation being a representation of a product or a product component, like material. within a representation context. This representation context does not need to be (but may be) a geometric representation context.

NOTE Current usage of IfcStyledRepresentation is restricted to the assignment of presentation information to an material. The IfcStyledRepresentation includes only presentation styles (IfcCurveStyle, FillAreaStyle, IfcSurfaceStyle) that define how a material should be presented within a particular (eventually view and scale dependent) representation context. All instances of IfcStyledRepresentation are referenced by IfcMaterialDefinitionRepresentation, and assigned to IfcMaterial by IfcMaterialDefinitionRepresentation.RepresentedMaterial.

A styled representation has to include one or several styled items with the associated style information (curve, symbol, text, fill area, or surface styles). It shall not contain the geometric representation items that are styled.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcStyledRepresentation> list

Public Functions

const IfcParse::entity &declaration() const
IfcStyledRepresentation(IfcEntityInstanceData *e)
IfcStyledRepresentation(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcStyleModel : public Ifc2x3::IfcRepresentation

IfcStyleModel represents the concept of a particular presentation style defined for a material (or other characteristic) of a product or a product component within a representation context. This representation context may (but has not to be) a geometric representation context.

IfcStyleModel can be a style representation (presentation style) of a material (via IfcMaterialDefinitionRepresentation), potentially differentiated for different representation contexts (for example, different material hatching depending on the scale of the target representation context).

HISTORY New entity in IFC2x3.

Subclassed by Ifc2x3::IfcStyledRepresentation

Public Types

typedef IfcTemplatedEntityList<IfcStyleModel> list

Public Functions

const IfcParse::entity &declaration() const
IfcStyleModel(IfcEntityInstanceData *e)
IfcStyleModel(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcSubContractResource : public Ifc2x3::IfcConstructionResource

IfcSubContractResource is a construction resource needed in a construction process that represents a sub-contractor.

HISTORY: New Entity in IFC Release 2.0. Base type and documentation extended in IFC 2x4.

IFC2x4 CHANGE: The attribute SubContractor has been deleted; use IfcRelAssignsToResource to assign an IfcActor to fulfill the role as the subcontractor. The attribute JobDescription has been deleted; use LongDescription to describe the job.

An IfcSubContractResource can be used in cost estimating and work planning with or without specifying the subcontractor and contract agreement. The purpose of an IfcSubContractResource is to indicate work of a particular type that is that is to be engaged through the use of a sub-contract. It’s aim is to identify the description of the sub-contract work required. It can be used to identify the generic type of sub-contract resource that is required for a purpose without having to be specific about the actor (person or organization) providing the resource occurrence. It may be particularly useful when creating an overall plan for a process or processes. For instance, within maintenance or work planning there may be a known task that needs to be done which is planned to require an ‘insulation specialist’. A subcontract resource may be described at various stages and levels of detail through its assignments:

Subcontract resource designated for particular tasks Actors identified to request bids Cost schedules (bids) received from actors Project order (work order, change order, etc.) executed

Use definitions for composition, assignment, constraints, time series, and baselines are described at the base type IfcConstructionResource.

Type use definition IfcSubContractResource defines the occurrence of any subcontract resource; common information about subcontract resource types is handled by IfcSubContractResourceType. The IfcSubContractResourceType (if present) may establish the common type name, common properties, and common productivities for various task types using IfcRelAssignsToProcess. The IfcSubContractResourceType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Assignment use definition In addition to assignments specified at the base class IfcConstructionResource, a subcontract resource may have assignments of its own using IfcRelAssignsToResource where RelatingResource refers to the IfcSubContractResource and RelatedObjects contains one or more IfcActor, IfcCostSchedule, and/or IfcWorkOrder objects as shown in Figure 195. An IfcActor indicates a specific organization to be considered to fulfill the resource or invited to bid on the resource. An IfcCostSchedule indicates a bid or price quote made on behalf of an organization. An IfcProjectOrder indicates a specific work order committed to fulfill the resource.

Figure 195 — Subcontract assignment use

Public Types

typedef IfcTemplatedEntityList<IfcSubContractResource> list

Public Functions

bool hasSubContractor() const

Whether the optional attribute SubContractor is defined for this IfcSubContractResource.

::Ifc2x3::IfcActorSelect *SubContractor() const
void setSubContractor(::Ifc2x3::IfcActorSelect *v)
bool hasJobDescription() const

Whether the optional attribute JobDescription is defined for this IfcSubContractResource.

std::string JobDescription() const
void setJobDescription(std::string v)
const IfcParse::entity &declaration() const
IfcSubContractResource(IfcEntityInstanceData *e)
IfcSubContractResource(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_ResourceIdentifier, boost::optional<std::string> v7_ResourceGroup, boost::optional<::Ifc2x3::IfcResourceConsumptionEnum::Value> v8_ResourceConsumption, ::Ifc2x3::IfcMeasureWithUnit *v9_BaseQuantity, ::Ifc2x3::IfcActorSelect *v10_SubContractor, boost::optional<std::string> v11_JobDescription)

Public Static Functions

const IfcParse::entity &Class()
class IfcSubedge : public Ifc2x3::IfcEdge

Definition from ISO/DIS 10303-42:1999(E): A subedge is an edge whose domain is a connected portion of the domain of an existing edge. The topological constraints on a subedge are the same as those on an edge.

Informal propositions:

The domain of the subedge is formally defined to be the domain of the parent edge, as trimmed by the subedge start vertex and subedge end vertex. The start vertex and end vertex shall be within the union of the domains of the vertices of the parent edge and the domain of the parent edge.

NOTE Corresponding ISO 10303 entity: subedge. Please refer to ISO/DIS 10303-42:1999(E), p. 194 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcSubedge> list

Public Functions

::Ifc2x3::IfcEdge *ParentEdge() const

The Edge, or Subedge, which contains the Subedge.

void setParentEdge(::Ifc2x3::IfcEdge *v)
const IfcParse::entity &declaration() const
IfcSubedge(IfcEntityInstanceData *e)
IfcSubedge(::Ifc2x3::IfcVertex *v1_EdgeStart, ::Ifc2x3::IfcVertex *v2_EdgeEnd, ::Ifc2x3::IfcEdge *v3_ParentEdge)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurface : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: A surface can be envisioned as a set of connected points in 3-dimensional space which is always locally 2-dimensional, but need not be a manifold.

NOTE Corresponding ISO 10303 entity: surface, the following subtypes have been incorporated into IFC - elementary_surface (as IfcElementarySurface), swept_surface (as IfcSweptSurface) and bounded_surface (as IfcBoundedSurface). Please refer to ISO/IS 10303-42:1994, p. 68 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.5

Informal proposition:

A surface has non zero area. A surface is arcwise connected.

Subclassed by Ifc2x3::IfcBoundedSurface, Ifc2x3::IfcElementarySurface, Ifc2x3::IfcSweptSurface

Public Types

typedef IfcTemplatedEntityList<IfcSurface> list

Public Functions

const IfcParse::entity &declaration() const
IfcSurface(IfcEntityInstanceData *e)
IfcSurface()

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceCurveSweptAreaSolid : public Ifc2x3::IfcSweptAreaSolid

The IfcSurfaceCurveSweptAreaSolid is the result of sweeping an area along a directrix that lies on a reference surface. The swept area is provided by an IfcProfileDef (or subtypes). The profile definition is based on a 2D coordinate system, which is inserted into the XY plane of the 3D Position coordinate system inherited from the supertype IfcSweptAreaSolid. The following definitions from ISO 10303-42 apply:

A surface curve swept area solid is a type of swept area solid which is the result of sweeping a face along a Directrix lying on a ReferenceSurface. The orientation of the SweptArea is related to the direction of the surface normal. The SweptArea is required to be a curve bounded surface lying in the plane z = 0 and this is swept along the Directrix in such a way that the origin of the local coordinate system used to define the SweptArea is on the Directrix and the local x-axis is in the direction of the normal to the ReferenceSurface at the current point. The resulting solid has the property that the cross section of the surface by the normal plane to the Directrix at any point is a copy of the SweptArea. The orientation of the SweptArea as it sweeps along the Directrix is precisely defined by a Cartesian Transformation Operator 3D with attributes:

LocalOrigin as point (0; 0; 0), Axis1 as the normal N to the ReferenceSurface at the point of the Directrix with parameter u. Axis3 as the direction of the tangent vector t at the point of the Directrix with parameter u. The remaining attributes are defaulted to define a corresponding transformation matrix T(u), which varies with the Directrix parameter u.

NOTE The geometric shape of the solid is not dependent upon the curve parameterization; the volume depends upon the area swept and the length of the Directrix.

The attributes of the Cartesian Transformation Operator (as shown above) should apply to the Position coordinate system, in which the profile is inserted. The Directrix and the ReferenceSurface are positioned within the 3D Position coordinate system.

NOTE Corresponding ISO 10303-42 entity: surface_curve_swept_area_solid. Please refer to ISO 10303-42 ed.2:1999, p. 274 for the definition in the international standard.

HISTORY New entity in IFC2x2.

Informal propositions:

The SweptArea shall lie in the plane z = 0. The Directrix shall lie on the ReferenceSurface.

Public Functions

::Ifc2x3::IfcCurve *Directrix() const

The curve used to define the sweeping operation. The solid is generated by sweeping the SELF\IfcSweptAreaSolid.SweptArea along the Directrix.

void setDirectrix(::Ifc2x3::IfcCurve *v)
double StartParam() const

The parameter value on the Directrix at which the sweeping operation commences. If no value is provided the start of the sweeping operation is at the start of the Directrix..

IFC2x4 CHANGE The attribute has been changed to OPTIONAL with upward compatibility for file-based exchange.

void setStartParam(double v)
double EndParam() const

The parameter value on the Directrix at which the sweeping operation ends. If no value is provided the end of the sweeping operation is at the end of the Directrix..

IFC2x4 CHANGE The attribute has been changed to OPTIONAL with upward compatibility for file-based exchange.

void setEndParam(double v)
::Ifc2x3::IfcSurface *ReferenceSurface() const

The surface containing the Directrix.

void setReferenceSurface(::Ifc2x3::IfcSurface *v)
const IfcParse::entity &declaration() const
IfcSurfaceCurveSweptAreaSolid(IfcEntityInstanceData *e)
IfcSurfaceCurveSweptAreaSolid(::Ifc2x3::IfcProfileDef *v1_SweptArea, ::Ifc2x3::IfcAxis2Placement3D *v2_Position, ::Ifc2x3::IfcCurve *v3_Directrix, double v4_StartParam, double v5_EndParam, ::Ifc2x3::IfcSurface *v6_ReferenceSurface)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceOfLinearExtrusion : public Ifc2x3::IfcSweptSurface

Definition from ISO/CD 10303-42:1992: This surface is a simple swept surface or a generalized cylinder obtained by sweeping a curve in a given direction. The parameterization is as follows where the curve has a parameterization l(u):

V = ExtrusionAxis

The parameterization range for v is -¥ < v < ¥ and for u it is defined by the curve parameterization.

NOTE: Corresponding ISO 10303 entity: surface_of_linear_extrusion. Please refer to ISO/IS 10303-42:1994, p.76 for the final definition of the formal standard. The following adaption has been made. The ExtrusionAxis and the Direction are defined as two separate attributes in correlation to the definition of the extruded_area_solid, and not as a single vector attribute. The vector is derived as ExtrusionAxis.

HISTORY: New entity in IFC Release 2x.

Informal propositions:

The surface shall not self-intersect

Public Functions

::Ifc2x3::IfcDirection *ExtrudedDirection() const

The direction of the extrusion.

void setExtrudedDirection(::Ifc2x3::IfcDirection *v)
double Depth() const

The depth of the extrusion, it determines the parameterization.

void setDepth(double v)
const IfcParse::entity &declaration() const
IfcSurfaceOfLinearExtrusion(IfcEntityInstanceData *e)
IfcSurfaceOfLinearExtrusion(::Ifc2x3::IfcProfileDef *v1_SweptCurve, ::Ifc2x3::IfcAxis2Placement3D *v2_Position, ::Ifc2x3::IfcDirection *v3_ExtrudedDirection, double v4_Depth)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceOfRevolution : public Ifc2x3::IfcSweptSurface

Definition from ISO/CD 10303-42:1992: A surface of revolution (IfcSurfaceOfRevolution) is the surface obtained by rotating a curve one complete revolution about an axis. The data shall be interpreted as below.

The parameterization is as follows where the curve has a parameterization l(u):

C = AxisPosition.LocationV = AxisPosition.Z

In order to produce a single-value surface the a complete revolution, the curve shall be such that when expressed in a cylindrical coordinate system the curve shall be such that when expressed in a cylindrical coordinate system (r,φ ,z) centred at C with an axis V no two distinct parametric points on the curve shall have the same values for (r, z).

For a surface of revolution the parametric range is 0 < u < 360 degree. The parameterization range for v is defined by referenced curve.

NOTE: Corresponding ISO 10303 entity: surface_of_revolution. Please refer to ISO/IS 10303-42:1994, p.76 for the final definition of the formal standard.

HISTORY: New entity in IFC2x.

Informal propositions:

The surface shall not self-intersect The swept curve shall not be coincident with the axis line for any finite part of its legth.

Public Types

typedef IfcTemplatedEntityList<IfcSurfaceOfRevolution> list

Public Functions

::Ifc2x3::IfcAxis1Placement *AxisPosition() const

A point on the axis of revolution and the direction of the axis of revolution.

void setAxisPosition(::Ifc2x3::IfcAxis1Placement *v)
const IfcParse::entity &declaration() const
IfcSurfaceOfRevolution(IfcEntityInstanceData *e)
IfcSurfaceOfRevolution(::Ifc2x3::IfcProfileDef *v1_SweptCurve, ::Ifc2x3::IfcAxis2Placement3D *v2_Position, ::Ifc2x3::IfcAxis1Placement *v3_AxisPosition)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSurfaceSide

Public Types

enum Value

IfcSurfaceSide is a denotion of whether negative, positive or both sides of a surface are being referenced.

ENUMERATION Definition from ISO/CD 10303-46:1992:

POSITIVE: The side of a surface which is in the same direction as the surface normal derived from the mathematical definition.

NEGATIVE: The side of a surface which is in the opposite direction than the surface normal derived from the mathematical definition. BOTH: Both, positive and negative side.

NOTE Corresponding ISO 10303 type: surface_side. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY: New Enumeration in IFC 2.0

Values:

enumerator IfcSurfaceSide_POSITIVE
enumerator IfcSurfaceSide_NEGATIVE
enumerator IfcSurfaceSide_BOTH

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSurfaceStyle : public Ifc2x3::IfcPresentationStyle

IfcSurfaceStyle is an assignment of one or many surface style elements to a surface, defined by subtypes of IfcSurface, IfcFaceBasedSurfaceModel, IfcShellBasedSurfaceModel, or by subtypes of IfcSolidModel. The positive direction of the surface normal relates to the positive side. In case of solids the outside of the solid is to be taken as positive side.

NOTE: The surface style is often referred to as material definition in rendering applications.

NOTE Corresponding ISO 10303 entity: surface_style_usage and surface_side_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard. The surface style definition in regard to support of rendering has been greatly expanded beyond the scope of ISO/IS 10303-46.

HISTORY New Entity in IFC 2.x.

Public Types

typedef IfcTemplatedEntityList<IfcSurfaceStyle> list

Public Functions

::Ifc2x3::IfcSurfaceSide::Value Side() const

An indication of which side of the surface to apply the style.

void setSide(::Ifc2x3::IfcSurfaceSide::Value v)
IfcEntityList::ptr Styles() const

A collection of different surface styles.

void setStyles(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcSurfaceStyle(IfcEntityInstanceData *e)
IfcSurfaceStyle(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcSurfaceSide::Value v2_Side, IfcEntityList::ptr v3_Styles)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceStyleLighting : public IfcUtil::IfcBaseEntity

IfcSurfaceStyleLighting is a container class for properties for calculation of physically exact illuminance related to a particular surface style.

Figure 294 shows the reflection and transmission components from an incident ray. The sum of the components for reflection and transmission is a value of 1.0 denoting that the incident ray is completely decomposed into reflection and transmission components. Each value of reflection and transmission is therefore within the range 0.0 to 1.0.

Figure 294 — Surface style lighting

All these factors can be measured physically and are ratios for the red, green and blue part of the light. These properties are defined in the model as Type IfcColorRGB with a factor for each colour.

EXAMPLE A green glass transmits only green light, so its transmission factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue. A green surface reflects only green light, so the reflectance factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue.

HISTORY New entity in IFC 2x2.

Public Types

typedef IfcTemplatedEntityList<IfcSurfaceStyleLighting> list

Public Functions

::Ifc2x3::IfcColourRgb *DiffuseTransmissionColour() const

The degree of diffusion of the transmitted light. In the case of completely transparent materials there is no diffusion. The greater the diffusing power, the smaller the direct component of the transmitted light, up to the point where only diffuse light is produced.A value of 1 means totally diffuse for that colour part of the light. The factor can be measured physically and has three ratios for the red, green and blue part of the light.

void setDiffuseTransmissionColour(::Ifc2x3::IfcColourRgb *v)
::Ifc2x3::IfcColourRgb *DiffuseReflectionColour() const

The degree of diffusion of the reflected light. In the case of specular surfaces there is no diffusion. The greater the diffusing power of the reflecting surface, the smaller the specular component of the reflected light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light. The factor can be measured physically and has three ratios for the red, green and blue part of the light.

void setDiffuseReflectionColour(::Ifc2x3::IfcColourRgb *v)
::Ifc2x3::IfcColourRgb *TransmissionColour() const

Describes how the light falling on a body is totally or partially transmitted. The factor can be measured physically and has three ratios for the red, green and blue part of the light.

void setTransmissionColour(::Ifc2x3::IfcColourRgb *v)
::Ifc2x3::IfcColourRgb *ReflectanceColour() const

A coefficient that determines the extent that the light falling onto a surface is fully or partially reflected. The factor can be measured physically and has three ratios for the red, green and blue part of the light.

void setReflectanceColour(::Ifc2x3::IfcColourRgb *v)
const IfcParse::entity &declaration() const
IfcSurfaceStyleLighting(IfcEntityInstanceData *e)
IfcSurfaceStyleLighting(::Ifc2x3::IfcColourRgb *v1_DiffuseTransmissionColour, ::Ifc2x3::IfcColourRgb *v2_DiffuseReflectionColour, ::Ifc2x3::IfcColourRgb *v3_TransmissionColour, ::Ifc2x3::IfcColourRgb *v4_ReflectanceColour)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceStyleRefraction : public IfcUtil::IfcBaseEntity

IfcSurfaceStyleRefraction extends the surface style lighting, or the surface style rendering definition for properties for calculation of physically exact illuminance by adding seldomly used properties. Currently this includes the refraction index (by which the light ray refracts when passing through a prism) and the dispersion factor (or Abbe constant) which takes into account the wavelength dependency of the refraction.

NOTE: If such refraction properties are used, the IfcSurfaceStyle should include within its set of Styles (depending on whether rendering or lighting is used) an instance of IfcSurfaceStyleLighting and IfcSurfaceStyleRefraction, or an instance of IfcSurfaceStyleRendering and IfcSurfaceStyleRefraction.

HISTORY: New entity in IFC 2x2.

Public Functions

bool hasRefractionIndex() const

Whether the optional attribute RefractionIndex is defined for this IfcSurfaceStyleRefraction.

double RefractionIndex() const

The index of refraction for all wave lengths of light. The refraction index is the ratio between the speed of light in a vacuum and the speed of light in the medium. E.g. glass has a refraction index of 1.5, whereas water has an index of 1.33.

void setRefractionIndex(double v)
bool hasDispersionFactor() const

Whether the optional attribute DispersionFactor is defined for this IfcSurfaceStyleRefraction.

double DispersionFactor() const

The Abbe constant given as a fixed ratio between the refractive indices of the material at different wavelengths. A low Abbe number means a high dispersive power. In general this translates to a greater angular spread of the emergent spectrum.

void setDispersionFactor(double v)
const IfcParse::entity &declaration() const
IfcSurfaceStyleRefraction(IfcEntityInstanceData *e)
IfcSurfaceStyleRefraction(boost::optional<double> v1_RefractionIndex, boost::optional<double> v2_DispersionFactor)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceStyleRendering : public Ifc2x3::IfcSurfaceStyleShading

IfcSurfaceStyleRendering holds the properties for visualization related to a particular surface side style.

It allows rendering properties to be defined by:

a transparency component (Transparency attribute) a colour component (SurfaceColour attribute inherited from IfcSurfaceStyleShading) a reflectance component, given either by

applying reflectance factors to the surface colour:

diffuse component (SurfaceColour * DiffuseFactor)

transmission component (SurfaceColour * TransmissionFactor) diffuse transmission component (SurfaceColour * DiffuseTransmissionFactor) reflection component (SurfaceColour * ReflectionFactor) specular component (SurfaceColour * SpecularFactor attribute together with SpecularHighlight)

explicitly defining such factors as colours (DiffuseColour, TransmissionColour, DiffuseTransmissionColour, ReflectionColour and SpecularColour)

a displacement component, currently only given by a texture map with the TextureType = bump a coverage component, currently only given by the alpha component of the texture map (2 or 4 component colour texture)

NOTE: The inherited attribute SurfaceColour is treated as the ambient colour and specifies how much ambient light from light sources this surface shall reflect. Ambient light is omnidirectional and depends only on the number of light sources, not their positions with respect to the surface.

NOTE: If the reflectance method, as given by the IfcReflectanceMethodEnum is “GLASS”, the transmission factor controls the level of transparency in the glass, In this case the transparency factor is interpreted as transmission factor.

NOTE: Both Transparency and TransmissionColour (or factor) are included, the following definitions apply:

Transparency is the ratio of the transmitted flux in a solid angle of 2 * PI sr (one hemisphere). It is a simple colour filtration that does not account for refraction. Transmission factor of a material is the ratio of transmitted flux in a given solid angle to the transmitted flux of a completely diffuse material with 100% transmission in the same solid angle. It is the portion of light that goes through the material and may be refracted.

NOTE: IFC 2x2 adds additional capability for presentation of physically accurate illuminance on surfaces. VRML type rendering and rendering based on ISO 10303-46 continues to be supported by a subset of the information. For reflectance equations and further information about the surface style properties and its processing, see:

ISO/IEC 14772-1: 1997: The Virtual Reality Modeling Language

NOTE: The definition of IfcSurfaceStyleRenderingProperties includes the definitions as found in ISO 10303-46:1994, in particular of:

surface_style_rendering_with_properties surface_style_rendering_ambient surface_style_rendering_ambient_diffuse surface_style_rendering_ambient_diffuse_specular surface_style_transparent

In addition to the attributes as defined in ISO 10303-46, (ambient_reflectance, diffuse_reflectance, specular_reflectance, specular_exponent, and specular_colour), the current IFC definition adds other colours, reflectance factors and specular roughness.

HISTORY: New Entity in IFC 2x.

Public Functions

bool hasTransparency() const

Whether the optional attribute Transparency is defined for this IfcSurfaceStyleRendering.

double Transparency() const

Definition from ISO/CD 10303-46: The degree of transparency is indicated by the percentage of light traversing the surface. Definition from VRML97 - ISO/IEC 14772-1:1997: The transparency field specifies how “clear” an object is, with 1.0 being completely transparent, and 0.0 completely opaque. If not given, the value 0.0 (opaque) is assumed.

void setTransparency(double v)
bool hasDiffuseColour() const

Whether the optional attribute DiffuseColour is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcColourOrFactor *DiffuseColour() const

The diffuse part of the reflectance equation can be given as either a colour or a scalar factor. The diffuse colour field reflects all light sources depending on the angle of the surface with respect to the light source. The more directly the surface faces the light, the more diffuse light reflects. The diffuse factor field specifies how much diffuse light from light sources this surface shall reflect. Diffuse light depends on the angle of the surface with respect to the light source. The more directly the surface faces the light, the more diffuse light reflects. The diffuse colour is then defined by surface colour * diffuse factor.

void setDiffuseColour(::Ifc2x3::IfcColourOrFactor *v)
bool hasTransmissionColour() const

Whether the optional attribute TransmissionColour is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcColourOrFactor *TransmissionColour() const

The transmissive part of the reflectance equation can be given as either a colour or a scalar factor. It only applies to materials which Transparency field is greater than zero. The transmissive colour field specifies the colour that passes through a transparant material (like the colour that shines through a glass). The transmissive factor defines the transmissive part, the transmissive colour is then defined by surface colour * transmissive factor.

void setTransmissionColour(::Ifc2x3::IfcColourOrFactor *v)
bool hasDiffuseTransmissionColour() const

Whether the optional attribute DiffuseTransmissionColour is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcColourOrFactor *DiffuseTransmissionColour() const

The diffuse transmission part of the reflectance equation can be given as either a colour or a scalar factor. It only applies to materials whose Transparency field is greater than zero. The diffuse transmission colour specifies how much diffuse light is reflected at the opposite side of the material surface. The diffuse transmission factor field specifies how much diffuse light from light sources this surface shall reflect on the opposite side of the material surface. The diffuse transmissive colour is then defined by surface colour * diffuse transmissive factor.

void setDiffuseTransmissionColour(::Ifc2x3::IfcColourOrFactor *v)
bool hasReflectionColour() const

Whether the optional attribute ReflectionColour is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcColourOrFactor *ReflectionColour() const

The reflection (or mirror) part of the reflectance equation can be given as either a colour or a scalar factor. Applies to “glass” and “mirror” reflection models. The reflection colour specifies the contribution made by light from the mirror direction, i.e. light being reflected from the surface. The reflection factor specifies the amount of contribution made by light from the mirror direction. The reflection colour is then defined by surface colour * reflection factor.

void setReflectionColour(::Ifc2x3::IfcColourOrFactor *v)
bool hasSpecularColour() const

Whether the optional attribute SpecularColour is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcColourOrFactor *SpecularColour() const

The specular part of the reflectance equation can be given as either a colour or a scalar factor. The specular colour determine the specular highlights (e.g., the shiny spots on an apple). When the angle from the light to the surface is close to the angle from the surface to the viewer, the specular colour is added to the diffuse and ambient colour calculations. The specular factor defines the specular part, the specular colour is then defined by surface colour * specular factor.

void setSpecularColour(::Ifc2x3::IfcColourOrFactor *v)
bool hasSpecularHighlight() const

Whether the optional attribute SpecularHighlight is defined for this IfcSurfaceStyleRendering.

::Ifc2x3::IfcSpecularHighlightSelect *SpecularHighlight() const

The exponent or roughness part of the specular reflectance.

void setSpecularHighlight(::Ifc2x3::IfcSpecularHighlightSelect *v)
::Ifc2x3::IfcReflectanceMethodEnum::Value ReflectanceMethod() const

Identifies the predefined types of reflectance method from which the method required may be set.

void setReflectanceMethod(::Ifc2x3::IfcReflectanceMethodEnum::Value v)
const IfcParse::entity &declaration() const
IfcSurfaceStyleRendering(IfcEntityInstanceData *e)
IfcSurfaceStyleRendering(::Ifc2x3::IfcColourRgb *v1_SurfaceColour, boost::optional<double> v2_Transparency, ::Ifc2x3::IfcColourOrFactor *v3_DiffuseColour, ::Ifc2x3::IfcColourOrFactor *v4_TransmissionColour, ::Ifc2x3::IfcColourOrFactor *v5_DiffuseTransmissionColour, ::Ifc2x3::IfcColourOrFactor *v6_ReflectionColour, ::Ifc2x3::IfcColourOrFactor *v7_SpecularColour, ::Ifc2x3::IfcSpecularHighlightSelect *v8_SpecularHighlight, ::Ifc2x3::IfcReflectanceMethodEnum::Value v9_ReflectanceMethod)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceStyleShading : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: The surface style rendering allows the realistic visualization of surfaces referring to rendering techniques based on the laws of physics and mathematics.

The entity IfcSurfaceStyleShading allows for colour information used for shading, whereas subtypes provide data for more sophisticated rendering techniques. The surface colour is used for colouring or simple shading of the assigned surfaces.

NOTE Corresponding ISO 10303 entity: surface_style_rendering. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard. No rendering method is defined for each surface style (such as constant, colour, dot or normal shading), therefore the attribute rendering_method has been omitted.

HISTORY: New entity in IFC 2x.

Subclassed by Ifc2x3::IfcSurfaceStyleRendering

Public Types

typedef IfcTemplatedEntityList<IfcSurfaceStyleShading> list

Public Functions

::Ifc2x3::IfcColourRgb *SurfaceColour() const

The colour used to render the surface. The surface colour for visualisation is defined by specifying the intensity of red, green and blue.

void setSurfaceColour(::Ifc2x3::IfcColourRgb *v)
const IfcParse::entity &declaration() const
IfcSurfaceStyleShading(IfcEntityInstanceData *e)
IfcSurfaceStyleShading(::Ifc2x3::IfcColourRgb *v1_SurfaceColour)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceStyleWithTextures : public IfcUtil::IfcBaseEntity

The entity IfcSurfaceStyleWithTextures allows to include image textures in surface styles. These image textures can be applied repeating across the surface or mapped with a particular scale upon the surface.

The entity IfcSurfaceStyleWithTextures is part of the surface style table for presentation information assigned to surfaces for shading, rendering and lighting with textures. The mapping of the texture onto the surface or the solid is determined by the texture coordinates, in absense of an IfcTextureCoordinate assigned to each surface texture, a default mapping of the texture to the geometric face or surface applies.

Surface textures included in the IfcSurfaceStyleWithTextures are two dimensional map formats. They define 2D images that contain an array of colour values describing the texture. Depending on the number of IfcSurfaceTextures being included in the list of Textures the IfcSurfaceStyleWithTextures either describes a single texture, or a multi texture.

single texture: a single surface texture is applied to the styled geometric item (entirely or partly) with optional repetition and texture transformation multi texture: two or more surface textures are applied to the styled geometric item (entirely or partly) with optional repetition, texture transformation or texture coordinate mapping being specific for each texture.

Informal proposition

Only one instance of IfcSurfaceStyleWithTextures shall be referenced by an IfcStyledItem and be assigned to an IfcGeometricRepresentationItem

NOTE The definitions of texturing within this standard have been developed in dependence on the texture component of X3D. See ISO/IEC 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1, 18 Texturing component for the definitions in the international standard.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE inverse attribute HasTextureCoordinates deleted.

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcSurfaceTexture>::ptr Textures() const

The textures applied to the surface. In case of more than one surface texture is included, the IfcSurfaceStyleWithTexture defines a multi texture.

void setTextures(IfcTemplatedEntityList<::Ifc2x3::IfcSurfaceTexture>::ptr v)
const IfcParse::entity &declaration() const
IfcSurfaceStyleWithTextures(IfcEntityInstanceData *e)
IfcSurfaceStyleWithTextures(IfcTemplatedEntityList<::Ifc2x3::IfcSurfaceTexture>::ptr v1_Textures)

Public Static Functions

const IfcParse::entity &Class()
class IfcSurfaceTexture : public IfcUtil::IfcBaseEntity

An IfcSurfaceTexture provides a 2-dimensional image-based texture map. It can either be given by referencing an external image file through an URL reference (IfcImageTexture), including the image file as a blob (long binary) into the data set (IfcBlobTexture), or by explicitly including an array of pixels (IfcPixelTexture). The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

Texture: An image used in a texture map to create visual appearance effects when applied to geometry nodes. Texture map: A texture plus the general parameters necessary for mapping the texture to geometry.

Texture are defined by 2D images that contain an array of colour values describing the texture. The texture values are interpreted differently depending on the number of components in the texture and the specifics of the image format. In general, texture may be described using one of the following forms:

Intensity textures (one-component) Intensity plus alpha opacity textures (two-component) Full RGB textures (three-component) Full RGB plus alpha opacity textures (four-component)

NOTE Image formats specify an alpha opacity, not transparency (where alpha = 1 - transparency).

Figure 295 illustrates the texture coordinate system.

Figure 295 — Surface texture coordinates

The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) on texture coordinates apply:

Texture maps are defined in a 2D coordinate system (s,t) that ranges from [0.0, 1.0] in both directions. The bottom edge of the image corresponds to the S-axis of the texture map, and left edge of the image corresponds to the T-axis of the texture map. The lower-left pixel of the image corresponds to s=0, t=0, and the top-right pixel of the image corresponds to s=1, t=1. Texture maps may be viewed as two dimensional colour functions that, given an (s,t) coordinate, return a colour value colour(s,t).

If multiple surface textures are included in the IfcSurfaceStyleWithTextures applying them to a geometric item, a mode and optional parameters can be included that blending operations. The RepeatS and RepeatT Boolean flags control whether the texture map is repeated outside the [0.0, 1.0] texture coordinate range, when applied to a geometric surface, or clamped to lie within the [0.0, 1.0] range. The TextureTransform applies a 2D non-uniform transformation to the texture before it is applied to a geometric surface. The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

These parameters support changes to the size, orientation, and position of textures on shapes. Note that these operations appear reversed when viewed on the surface of geometry. For example, a scale value of (2 2) will scale the texture coordinates and have the net effect of shrinking the texture size by a factor of 2 (texture coordinates are twice as large and thus cause the texture to repeat). A translation of (0.5 0.0) translates the texture coordinates +.5 units along the S-axis and has the net effect of translating the texture −0.5 along the S-axis on the geometry’s surface. A rotation of π/2 of the texture coordinates results in a −π/2 rotation of the texture on the geometry. The center field specifies a translation offset in texture coordinate space about which the rotation and scale fields are applied. The scale field specifies a scaling factor in S and T of the texture coordinates about the center point. scale values shall be in the range (−∞,∞). The rotation field specifies a rotation in radians of the texture coordinates about the center point after the scale has been applied. A positive rotation value makes the texture coordinates rotate counterclockwise about the centre, thereby rotating the appearance of the texture itself clockwise. The translation field specifies a translation of the texture coordinates. The following conventions apply:

center = TextureTransform.LocalOrigin; rotation = TextureTransform.Axis1 scale S = TextureTransform.Scale scale T = TextureTransform.Scale2

NOTE The definitions of texturing within this standard have been developed in dependence on the texture component of X3D. See ISO/IEC 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1, 18 Texturing component for the definitions in the international standard.

HISTORY New entity in IFC 2x2.

IFC2x4 CHANGE Attribute TextureType replaces by Mode, attributes Parameter and MapsTo aded, new inverse attribute UsedInStyle.

Subclassed by Ifc2x3::IfcBlobTexture, Ifc2x3::IfcImageTexture, Ifc2x3::IfcPixelTexture

Public Types

typedef IfcTemplatedEntityList<IfcSurfaceTexture> list

Public Functions

bool RepeatS() const

The RepeatS field specifies how the texture wraps in the S direction. If RepeatS is TRUE (the default), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the S direction so that it fills the shape. If RepeatS is FALSE, the texture coordinates are clamped in the S direction to lie within the [0.0, 1.0] range.

void setRepeatS(bool v)
bool RepeatT() const

The RepeatT field specifies how the texture wraps in the T direction. If RepeatT is TRUE (the default), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the T direction so that it fills the shape. If RepeatT is FALSE, the texture coordinates are clamped in the T direction to lie within the [0.0, 1.0] range.

void setRepeatT(bool v)
::Ifc2x3::IfcSurfaceTextureEnum::Value TextureType() const
void setTextureType(::Ifc2x3::IfcSurfaceTextureEnum::Value v)
bool hasTextureTransform() const

Whether the optional attribute TextureTransform is defined for this IfcSurfaceTexture.

::Ifc2x3::IfcCartesianTransformationOperator2D *TextureTransform() const

The TextureTransform defines a 2D transformation that is applied to the texture coordinates. It affects the way texture coordinates are applied to the surfaces of geometric representation itesm. The 2D transformation supports changes to the size, orientation, and position of textures on shapes.

Mirroring is not allowed to be used in the IfcCarteesianTransformationOperator

void setTextureTransform(::Ifc2x3::IfcCartesianTransformationOperator2D *v)
const IfcParse::entity &declaration() const
IfcSurfaceTexture(IfcEntityInstanceData *e)
IfcSurfaceTexture(bool v1_RepeatS, bool v2_RepeatT, ::Ifc2x3::IfcSurfaceTextureEnum::Value v3_TextureType, ::Ifc2x3::IfcCartesianTransformationOperator2D *v4_TextureTransform)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSurfaceTextureEnum

Public Types

enum Value

Values:

enumerator IfcSurfaceTexture_BUMP
enumerator IfcSurfaceTexture_OPACITY
enumerator IfcSurfaceTexture_REFLECTION
enumerator IfcSurfaceTexture_SELFILLUMINATION
enumerator IfcSurfaceTexture_SHININESS
enumerator IfcSurfaceTexture_SPECULAR
enumerator IfcSurfaceTexture_TEXTURE
enumerator IfcSurfaceTexture_TRANSPARENCYMAP
enumerator IfcSurfaceTexture_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSweptAreaSolid : public Ifc2x3::IfcSolidModel

Definition from ISO/CD 10303-42:1992: The swept area solid entity collects the entities which are defined procedurally by sweeping action on planar bounded surfaces. The position is space of the swept solid will be dependent upon the position of the swept area. The swept area will be a face of the resulting swept area solid, except for the case of a revolved area solid with angle equal to 2π (or 360 degrees).

The swept area is defined by a cross section (also referred to as profile), which is given as a closed two-dimensional boundary on an implicit plane. The swept area is defined in the xy plane of the position coordinate system, which is given for the swept area solid.

NOTE Corresponding ISO 10303-42 entity: swept_area_solid, The data type of SweptArea is modified and given by a profile definition (IfcProfileDef). A position coordinate system is defined by the Position attribute has been added. Please refer to ISO/IS 10303-42:1994, p. 183 for the final definition of the formal standard.

HISTORY New entity in IFC Release 1.5, the capabilities have been enhanced in IFC Release 2x.

Subclassed by Ifc2x3::IfcExtrudedAreaSolid, Ifc2x3::IfcRevolvedAreaSolid, Ifc2x3::IfcSurfaceCurveSweptAreaSolid

Public Types

typedef IfcTemplatedEntityList<IfcSweptAreaSolid> list

Public Functions

::Ifc2x3::IfcProfileDef *SweptArea() const

The surface defining the area to be swept. It is given as a profile definition within the xy plane of the position coordinate system.

void setSweptArea(::Ifc2x3::IfcProfileDef *v)
::Ifc2x3::IfcAxis2Placement3D *Position() const

Position coordinate system for the swept area, provided by a profile definition within the XY plane of the Position.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
const IfcParse::entity &declaration() const
IfcSweptAreaSolid(IfcEntityInstanceData *e)
IfcSweptAreaSolid(::Ifc2x3::IfcProfileDef *v1_SweptArea, ::Ifc2x3::IfcAxis2Placement3D *v2_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcSweptDiskSolid : public Ifc2x3::IfcSolidModel

Definition from ISO 10303-42:2002: A swept disk solid is the solid produced by sweeping a circular disk along a three dimensional curve. During the sweeping operation the normal to the plane of the circular disk is in the direction of the tangent to the directrix curve and the center of the disk lies on the directrix. The circular disk may, optionally, have a central hole, in this case the resulting solid has a through hole, or, an internal void when the directrix forms a close curve. The StartParam and EndParam parameter are optional, if not provided they default to the start and end of the Directrix. Only if the Directrix is given by a bounded or by a closed curve, it is permissible to omit the values of StartParam and EndParam. If the transitions between consecutive segments of the Directrix are not tangent continuous, the resulting solid is created by a miter at half angle between the two segments. Informal proposition restricts the permissible angle between two non-tangent continuous segments.

Figure 272 illustrates an example.

Directrix given as IfcCompositeCurve being tangent continuous between its segments Directrix being a bounded and open curve No StartParam and EndParam are provided, start and end default to start and end of the bounded curve of the Directrix

NOTE Although the example shows a Directrix as a composite curve on a planar reference surface, the definition of IfcSweptDiskSolid is not restricted to be based on planer curves. However view definitions or implementer agreements may provide restrictions.

Figure 272 — Swept disk solid geometry

NOTE Corresponding ISO 10303-42 entity: swept_disk_solid. Please refer to ISO/FDIS 10303-42:2002, p. 282 for the definition of the formal standard.

HISTORY New entity in IFC Release 2x2.

IFC2x4 CHANGE The attribute StartParam and EndParam have been made optional.

Informal proposition

If the Directrix curve definition is not tangent continuous, the transition between the segments has to be within an acceptable limit of tangent discontinuity. Very sharp edges may result in nearly impossible miter. Implementer agreements may define acceptable limits for tangent discontinuity. The segments of the Directrix shall be long enough to apply the Radius. In case of an arc segment forming part of the Directrix ,its radius shall be greater then the disk Radius The Directrix shall not be based on an intersecting curve.

Public Types

typedef IfcTemplatedEntityList<IfcSweptDiskSolid> list

Public Functions

::Ifc2x3::IfcCurve *Directrix() const

The curve used to define the sweeping operation. The solid is generated by sweeping a circular disk along the Directrix.

void setDirectrix(::Ifc2x3::IfcCurve *v)
double Radius() const

The Radius of the circular disk to be swept along the directrix. Denotes the outer radius, if an InnerRadius is applied.

void setRadius(double v)
bool hasInnerRadius() const

Whether the optional attribute InnerRadius is defined for this IfcSweptDiskSolid.

double InnerRadius() const

This attribute is optional, if present it defines the radius of a circular hole in the centre of the disk.

void setInnerRadius(double v)
double StartParam() const

The parameter value on the Directrix at which the sweeping operation commences. If no value is provided the start of the sweeping operation is at the start of the Directrix..

IFC2x4 CHANGE The attribute has been changed to OPTIONAL with upward compatibility for file-based exchange.

void setStartParam(double v)
double EndParam() const

The parameter value on the Directrix at which the sweeping operation ends. If no value is provided the end of the sweeping operation is at the end of the Directrix..

IFC2x4 CHANGE The attribute has been changed to OPTIONAL with upward compatibility for file-based exchange.

void setEndParam(double v)
const IfcParse::entity &declaration() const
IfcSweptDiskSolid(IfcEntityInstanceData *e)
IfcSweptDiskSolid(::Ifc2x3::IfcCurve *v1_Directrix, double v2_Radius, boost::optional<double> v3_InnerRadius, double v4_StartParam, double v5_EndParam)

Public Static Functions

const IfcParse::entity &Class()
class IfcSweptSurface : public Ifc2x3::IfcSurface

Definition from ISO/CD 10303-42:1992: A swept surface is one that is constructed by sweeping a curve along another curve.

NOTE: Corresponding ISO 10303 entity: swept_surface. Please refer to ISO/IS 10303-42:1994, p.76 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 2x.

Subclassed by Ifc2x3::IfcSurfaceOfLinearExtrusion, Ifc2x3::IfcSurfaceOfRevolution

Public Types

typedef IfcTemplatedEntityList<IfcSweptSurface> list

Public Functions

::Ifc2x3::IfcProfileDef *SweptCurve() const

The curve to be swept in defining the surface. The curve is defined as a profile within the position coordinate system.

void setSweptCurve(::Ifc2x3::IfcProfileDef *v)
::Ifc2x3::IfcAxis2Placement3D *Position() const

Position coordinate system for the placement of the profile within the xy plane of the axis placement.

void setPosition(::Ifc2x3::IfcAxis2Placement3D *v)
const IfcParse::entity &declaration() const
IfcSweptSurface(IfcEntityInstanceData *e)
IfcSweptSurface(::Ifc2x3::IfcProfileDef *v1_SweptCurve, ::Ifc2x3::IfcAxis2Placement3D *v2_Position)

Public Static Functions

const IfcParse::entity &Class()
class IfcSwitchingDeviceType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcSwitchingDeviceType defines commonly shared information for occurrences of switching devices. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a switching device specification (i.e. the specific product information, that is common to all occurrences of that product type). Switching Device types may be exchanged without being already assigned to occurrences. Occurrences of IfcSwitchingDeviceType are represented by instances of IfcSwitchingDevice.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_SwitchingDeviceTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ElectricalDeviceCommon Pset_SwitchingDeviceTypeContactor (CONTACTOR) Pset_SwitchingDeviceTypeDimmerSwitch (DIMMERSWITCH) Pset_SwitchingDeviceTypeEmergencyStop (EMERGENCYSTOP) Pset_SwitchingDeviceTypeKeypad (KEYPAD) Pset_SwitchingDeviceTypeMomentarySwitch (MOMENTARYSWITCH) Pset_SwitchingDeviceTypeSelectorSwitch (SELECTORSWITCH) Pset_SwitchingDeviceTypeStarter (STARTER) Pset_SwitchingDeviceTypeSwitchDisconnector (SWITCHDISCONNECTOR) Pset_SwitchingDeviceTypeToggleSwitch (TOGGLESWITCH)

Material Use Definition The material of the IfcSwitchingDeviceType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed. ‘Conductor’: Material from which the conductors are constructed. ‘Surface’: Material from which the switch surface is constructed.

Port Use Definition The distribution ports relating to the IfcSwitchingDeviceType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcSwitchingDevice for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcSwitchingDeviceType> list

Public Functions

::Ifc2x3::IfcSwitchingDeviceTypeEnum::Value PredefinedType() const

Identifies the predefined types of switch from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcSwitchingDeviceTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcSwitchingDeviceType(IfcEntityInstanceData *e)
IfcSwitchingDeviceType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcSwitchingDeviceTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcSwitchingDeviceTypeEnum

Public Types

enum Value

The IfcSwitchingDeviceTypeEnum defines the range of different types of switch that can be specified. HISTORY: New type in IFC 2x2 Enumeration

CONTACTOR: An electrical device used to control the flow of power in a circuit on or off. DIMMERSWITCH: A dimmer switch has variable positions, and may adjust electrical power or other setting (according to the switched port type). EMERGENCYSTOP: An emergency stop device acts to remove as quickly as possible any danger that may have arisen unexpectedly. KEYPAD: A set of buttons or switches, each potentially applicable to a different device.

MOMENTARYSWITCH: A momentary switch has no position, and may trigger some action to occur.

SELECTORSWITCH: A selector switch has multiple positions, and may switch connectivity or other setting.

STARTER: A starter is a switch which in the closed position controls the application of power to an electrical device. SWITCHDISCONNECTOR: A switch disconnector is a switch which in the open position satisfies the isolating requirements specified for a disconnector. SELECTORSWITCH: A selector switch has multiple positions, and may change the source or level of power or other setting (according to the switched port type). TOGGLESWITCH: A toggle switch has two positions, and may enable or isolate electrical power or other setting (according to the switched port type). USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcSwitchingDeviceType_CONTACTOR
enumerator IfcSwitchingDeviceType_EMERGENCYSTOP
enumerator IfcSwitchingDeviceType_STARTER
enumerator IfcSwitchingDeviceType_SWITCHDISCONNECTOR
enumerator IfcSwitchingDeviceType_TOGGLESWITCH
enumerator IfcSwitchingDeviceType_USERDEFINED
enumerator IfcSwitchingDeviceType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcSymbolStyle : public Ifc2x3::IfcPresentationStyle

Definition from ISO/CD 10303-46:1992: The symbol style is the presentation style that indicates the presentation of annotation symbols.

NOTE: Corresponding ISO 10303 name: symbol_style. Please refer to ISO/IS 10303-46:1994, p. 124 for the final definition of the formal standard.

HISTORY: New entity in Release IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcSymbolStyle> list

Public Functions

::Ifc2x3::IfcSymbolStyleSelect *StyleOfSymbol() const

The style applied to the symbol for its visual appearance.

void setStyleOfSymbol(::Ifc2x3::IfcSymbolStyleSelect *v)
const IfcParse::entity &declaration() const
IfcSymbolStyle(IfcEntityInstanceData *e)
IfcSymbolStyle(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcSymbolStyleSelect *v2_StyleOfSymbol)

Public Static Functions

const IfcParse::entity &Class()
class IfcSystem : public Ifc2x3::IfcGroup

Definition from IAI: Organized combination of related parts within an AEC product, composed for a common purpose or function or to provide a service. System is essentially a functionally related aggregation of products. The grouping relationship to one or several instances of IfcProduct (the system members) is handled by IfcRelAssignsToGroup.

NOTE: The use of IfcSystem often applies to the representation of building services related systems, such as the piping system, cold water system, etc. Members within such a system may or may not be connected using the connectivity related entities (e.g. through IfcPort).

HISTORY: New entity in IFC Release 1.0

Subclassed by Ifc2x3::IfcElectricalCircuit, Ifc2x3::IfcStructuralAnalysisModel

Public Types

typedef IfcTemplatedEntityList<IfcSystem> list

Public Functions

IfcTemplatedEntityList<IfcRelServicesBuildings>::ptr ServicesBuildings() const
const IfcParse::entity &declaration() const
IfcSystem(IfcEntityInstanceData *e)
IfcSystem(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcSystemFurnitureElementType : public Ifc2x3::IfcFurnishingElementType

The furnishing element type IfcSystemFurnitureElementType defines commonly shared information for occurrences of furniture elements. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements applicable assignment of process types

It is used to define a furniture element specification (i.e. the specific product information, that is common to all occurrences of that product type). Furniture Element types may be exchanged without being already assigned to occurrences. Occurrences of IfcSystemFurnitureElementType are represented by instances of IfcSystemFurnitureElement.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFurnishingElementType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_SystemFurnitureElementTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_SystemFurnitureElementTypePanel (PANEL) Pset_SystemFurnitureElementTypeWorkSurface (WORKSURFACE)

Material Use Definition The material of the IfcSystemFurnitureElementType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Finish’: The finish, typically at visible aspects of the furniture. ‘Frame’: The frame from which the object is constructed. ‘Hardware’: Finish hardware such as knobs or handles. ‘Padding’: Padding such as cushions. ‘Panel’: Panels such as glass.

Public Functions

const IfcParse::entity &declaration() const
IfcSystemFurnitureElementType(IfcEntityInstanceData *e)
IfcSystemFurnitureElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType)

Public Static Functions

const IfcParse::entity &Class()
class IfcTable : public IfcUtil::IfcBaseEntity

An IfcTable is a data structure for the provision of information in the form of rows and columns. Each instance may have IfcTableColumn instances that define the name, description and units for each column. The rows of information are stored as a list of IfcTableRow objects.

Limitation: For backwards compatibility, the rows of an IfcTable object are constrained to have the same number of cells. The first Row of the table provides the number of cells. All other rows are forced to include the same number of cells. This is enforced by the WR2.

Figure 335 illustrates table use.

Figure 335 — Table use

Figure 336 depicts how tables were structured prior to IFC2x4.

Figure 336 — Table use alternative

HISTORY New entity in IFC R1.5.

IFC2x4 CHANGE Columns attribute added.

Public Types

typedef IfcTemplatedEntityList<IfcTable> list

Public Functions

std::string Name() const

A unique name which is intended to describe the usage of the Table.

void setName(std::string v)
IfcTemplatedEntityList<::Ifc2x3::IfcTableRow>::ptr Rows() const

Reference to information content of rows.

void setRows(IfcTemplatedEntityList<::Ifc2x3::IfcTableRow>::ptr v)
const IfcParse::entity &declaration() const
IfcTable(IfcEntityInstanceData *e)
IfcTable(std::string v1_Name, IfcTemplatedEntityList<::Ifc2x3::IfcTableRow>::ptr v2_Rows)

Public Static Functions

const IfcParse::entity &Class()
class IfcTableRow : public IfcUtil::IfcBaseEntity

IfcTableRow contains data for a single row within an IfcTable.

Limitation: For backward compatibility, all IfcTableRow objects referenced by an IfcTable shall have the same number of Row Cells. The actual number of Cells shall be taken from the number of cells of the first IfcTableRow for that table. The number of Cells is calculated by the derived attribute NumberOfCellsInRow in the associated IfcTable.

Figure 337 illustrates table row use.

Figure 337 — Table row use

Figure 338 depicts how table rows were structured prior to IFC2x4 with the use of the IsHeading flag. Note that the use of the IfcTableColumn constructs should be used instead of the IsHeading flag (which remains for backward compatibility only):

Figure 338 — Table row use alternative

HISTORY New entity in IFC R1.5.

Public Types

typedef IfcTemplatedEntityList<IfcTableRow> list

Public Functions

IfcEntityList::ptr RowCells() const

The data value of the table cell..

void setRowCells(IfcEntityList::ptr v)
bool IsHeading() const

Flag which identifies if the row is a heading row or a row which contains row values. NOTE - If the row is a heading, the flag takes the value = TRUE.

void setIsHeading(bool v)
IfcTemplatedEntityList<IfcTable>::ptr OfTable() const
const IfcParse::entity &declaration() const
IfcTableRow(IfcEntityInstanceData *e)
IfcTableRow(IfcEntityList::ptr v1_RowCells, bool v2_IsHeading)

Public Static Functions

const IfcParse::entity &Class()
class IfcTankType : public Ifc2x3::IfcFlowStorageDeviceType

The flow storage device type IfcTankType defines commonly shared information for occurrences of tanks. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a tank specification (i.e. the specific product information, that is common to all occurrences of that product type). Tank types may be exchanged without being already assigned to occurrences. Occurrences of IfcTankType are represented by instances of IfcTank.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowStorageDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_TankTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_TankTypeExpansion (EXPANSION) Pset_TankTypePreformed (PREFORMED) Pset_TankTypePressureVessel (PRESSUREVESSEL) Pset_TankTypeSectional (SECTIONAL)

Material Use Definition The material of the IfcTankType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed.

Port Use Definition The distribution ports relating to the IfcTankType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcTank for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcTankType> list

Public Functions

::Ifc2x3::IfcTankTypeEnum::Value PredefinedType() const

Defines the type of tank.

void setPredefinedType(::Ifc2x3::IfcTankTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcTankType(IfcEntityInstanceData *e)
IfcTankType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcTankTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTankTypeEnum

Public Types

enum Value

Enumeration defining the typical types of tanks.

The IfcTankTypeEnum contains the following:

BASIN: An arbitrary open tank type.

BREAKPRESSURE: An open container that breaks the hydraulic pressure in a distribution system, typically located between the fluid reservoir and the fluid supply points. A typical break pressure tank allows the flow to discharge into the atmosphere, thereby reducing its hydrostatic pressure to zero.

EXPANSION: A closed container used in a closed fluid distribution system to mitigate the effects of thermal expansion or water hammer. The tank is typically constructed with a diaphragm dividing the tank into two sections, with fluid on one side of the diaphragm and air on the other. One example application is when connected to the primary circuit of a hot water system to accommodate the increase in volume of the water when it is heated.

FEEDANDEXPANSION: An open tank that is used for both storage and thermal expansion. A typical example is a tank used to store make-up water at ambient pressure for supply to a hot water system, simultaneously accommodating increases in volume of the water when heated.

PRESSUREVESSEL: A closed container used for storing fluids or gases at a pressure different from the ambient pressure. A pressure vessel is typically rated by an authority having jurisdiction for the operational pressure.

STORAGE: An open or closed containter used for storing a fluid at ambient pressure and from which it can be supplied to the fluid distribution system. There are many examples of storage tanks, such as potable water storage tanks, fuel storage tanks, etc.

VESSEL: An arbitrary closed tank type.

USERDEFINED: User-defined tank type.

NOTDEFINED: Undefined tank type.

HISTORY: New enumeration in IFC 2x2. BASIN and VESSEL added in IFC2x4.

Values:

enumerator IfcTankType_PREFORMED
enumerator IfcTankType_SECTIONAL
enumerator IfcTankType_EXPANSION
enumerator IfcTankType_PRESSUREVESSEL
enumerator IfcTankType_USERDEFINED
enumerator IfcTankType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTask : public Ifc2x3::IfcProcess

An IfcTask is an identifiable unit of work to be carried out in a construction project.

A task is typically used to describe an activity for the construction or installation of products, but is not limited to these types. For example it might be used to describe design processes, move operations and other design, construction and operation related activities as well.

HISTORY New entity in IFC 1.0. Renamed from IfcWorkTask in IFC 2x.

IFC2x4 CHANGE Attributes TaskTime and PredefinedType added. IfcMove and IfcOrderRequest has been removed in IFC2x4 and are now represented by IfcTask. Further information can be found in the description below.

Type use definition

IfcTask defines the anticipated or actual occurrence of any task; common information about task types is handled by IfcTaskType. The IfcTaskType (if present) may establish the common type name, usage (or predefined) type, common set of properties, and common product assignment using IfcRelAssignsToProduct. The IfcTaskType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. Special type information relating to a task occurrence is asserted using IfcTask.ObjectType (inherited from IfcObject). Examples that may be used include fixed duration, fixed unit or fixed work. IfcTask can be aggregated to a task type in order to specify a task sequence or any time related information, e.g. the duration of a task. Please see the documentation of IfcTaskType for further information.

Attribute use definition

Each occurrence of IfcTask is given a name that is indicative of its content (IfcRoot.Name). A textual description of the task may be provided and this may be further elaborated by a narrative long description (IfcProcess.LongDescription). A work method may be declared for the method of work used in carrying out a task. A task is identified as being either a milestone task or not. A milestone task is defined by the marker IsMilestone. and has no duration. A status and priority for each task may also be set.

Property set use definition

The property sets relating to IfcTask are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the inverse IsDefinedBy relationship. Such property sets may define task parameters. No property sets for IfcTask are currently defined by IFC.

Connectivity Use Definition

The relationship IfcRelSequence is used to indicate control flow. An IfcTask as a successor to an IfcTask indicates logical sequence how these tasks should be performed. IfcTask’s can be triggered or can trigger IfcEvent’s, which is also defined through the relationship IfcRelSequence.

Composition use definition

IfcTask may be contained within an IfcTask using the IfcRelNests relationship. An IfcTask may in turn nest other IfcTask, IfcProcedure or IfcEvent entities. Such nesting indicates decomposed level of detail. From IFC2x4 onwards it is required to have a summary task (root of all tasks), which is used to define a link to the work plan or work schedule. All subtasks of the summary tasks are then implicitly linked to this work plan or work schedule. Please note that the summary task is used for data organization and not meant to store typical task information as defined by the user. It is therefore recommended that the summary task is hidden from the user to avoid confusion. Please also note that IfcRelNests is used to show the dependency between regular tasks and recurring task definitions (please see the section about time and duration use definitions).

As shown in Figure 13, the installation of a number of items of equipment within a particular space may be the subject of a single task which is identified as ‘fix equipment in space 123’. IfcTask represents the occurrence of a work performance of a type of process in a construction plan.

Figure 13 — Task visualization

A task may nest other tasks as sub-items; the nesting relationship is modeled by IfcRelNests as shown in Figure 14. For example, the construction of a stud wall may be designated as a nesting task named ‘install wall #1’ including other tasks such as ‘install dry wall’, ‘install studs’, ‘wall taping’, and ‘erect wall’ as sub-processes. A value that indicates the relative tree view position of the task (in comparison to the tree view position of other tasks and the task hierarchy defined by IfcRelNests). The task order information that is used for viewing purposes is derived from the order defined by the IfcRelNests relationship and thus is independent of the logical task order defined through IfcRelSequence. The hierarchy and order defined through IfcRelNests enables to order the tasks in a tree view or list view structure.

Figure 14 — Task nesting relationships

Time and duration use definition

Compared to previous IFC releases, basic task time information (scheduled start time, scheduled finish time, duration) is now directly attached to IfcTask through the TaskTime attribute. Regular tasks are defined through IfcTaskTime. Recurring tasks are defined through IfcTaskTimeRecurring. In case a regular task is derived from a recurring task both tasks should be linked together through a IfcRelNests relationship, where IfcRelNests.IsNestedBy points to the recurring task and IfcRelNests.Nests points to all regular tasks that have been derived from the recurring task.

Assignment use definition

Occurrences of IfcTask may be assigned to an IfcWorkControl (either a work plan or a work schedule) through IfcRelAssignsToControl. From IFC2x4 onwards it is suggested to use the ‘summary task’ (root element of the task hierarchy that is required for task management purposes) to assign all subtask to a work plan or work schedule. Resources used by tasks are assigned by IfcRelAssignsToProcess. Quantities of resources consumed by the task are dealt with by defining the IfcElementQuantity for the resource and not at the instance of IfcTask. Please note that the IfcRelAssignsTasks relationship class has been removed in IFC2x4 and is no longer available.

An IfcTask may be assigned a Work Breakdown Structure (WBS) code. A WBS code is dealt with as a classification of task and is associated to a task occurrence using the IfcRelAssociatesClassification relationship class. As well as being to designate the code, the classification structure of the IFC model also enables the source of the work breakdown structure classification to be identified.

Constraint use definition

Constraints may be applied to a task to indicate fixed task duration, fixed start or fixed finish (see Figure 15). The relationship IfcRelAssociatesConstraint is used where RelatingConstraint points to an IfcMetric and RelatedObjects includes the IfcTask. IfcRelAssociatesConstraint.Name identifies the attribute to be constrained using a period (“.”) to dereference; for example, “TaskTime.ScheduleStart” refers to the ScheduleStart attribute on the IfcTaskTime entity referenced on the TaskTime attribute. The following attributes may be constrained:

‘TaskTime.ScheduleDuration’: Indicate fixed duration of task with ConstraintGrade=HARD and Benchmark=EQUALTO such that changes to an assigned IfcConstructionResource.ResourceTime.ScheduleWork should impact IfcConstructionResource.ResourceTime.ScheduleUsage, and vice-versa.

‘TaskTime.ScheduleStart’: Indicate constrained start date with ConstraintGrade=HARD and Benchmark of EQUALTO, GREATERTHANOREQUALTO, or LESSTHANOREQUALTO to indicate “must start on”, “start no earlier than” or “start no later than” respectively where IfcMetric.DataValue indicates the specific IfcDateTime. Use SOFT constraint having LESSTHAN benchmark to indicate “start as soon as possible”.

‘TaskTime.ScheduleFinish’: Indicate constrained finish date with ConstraintGrade=HARD and Benchmark of EQUALTO, GREATERTHANOREQUALTO, or LESSTHANOREQUALTO to indicate “must finish on”, “finish no earlier than” or “finish no later than” respectively where IfcMetric.DateValue indicates the specific IfcDateTime. Use SOFT constraint having GREATERTHAN benchmark to indicate “finish as late as

possible”.

A “manual scheduled task” is indicated with ConstraintGrade=HARD and Benchmark=EQUALTO for both TaskTime.ScheduleStart and TaskTime.ScheduleFinish.

Figure 15 — Task constraints

Use Definition to represent other activities

The use definitions for IfcTask have been generalised to represent other activities as well, including actitities that had been defined by own entities in previous IFC releases. This includes

Order actions Move operations

IfcTask represents an order that might be carried out by a Helpdesk acting the role of interface for the organization between the facility user and the functional requirement of fulfilling their needs. The actual task represented by the IfcTask entity is turning a request into an order and initiating the action that will enable the order to be completed. The IfcProjectOrder or one of its subtypes including maintenance work order, is related to the IfcTask using IfcRelAssignsToControl.

IfcTask can also be used to describe an activity that moves people, groups within an organization or complete organizations together with their associated furniture and equipment from one place to another. It thus replaces the previous IFC entity IfcMove. The functionality is represented in IfcTask as follows:

Move from: The place from which actors and their associated equipment are moving. Use IfcRelAssignsToProcess where RelatingProcess points to the task and RelatedObjects holds the location(s) from which to move. Move to: The place to which actors and their associated equipment are moving. Use IfcRelAssignsToProduct where RelatedObjects points to the task(s) and RelatingProduct points to the location to which to move. Punch list: A list of points concerning a move that require attention. Use LongDescription or else identify sub-tasks to track punch list items individually via IfcRelNests.

Subclassed by Ifc2x3::IfcMove, Ifc2x3::IfcOrderAction

Public Types

typedef IfcTemplatedEntityList<IfcTask> list

Public Functions

std::string TaskId() const
void setTaskId(std::string v)
bool hasStatus() const

Whether the optional attribute Status is defined for this IfcTask.

std::string Status() const

Current status of the task.

NOTE: Particular values for status are not specified, these should be determined and agreed by local usage. Examples of possible status values include ‘Not Yet Started’, ‘Started’, ‘Completed’.

void setStatus(std::string v)
bool hasWorkMethod() const

Whether the optional attribute WorkMethod is defined for this IfcTask.

std::string WorkMethod() const

The method of work used in carrying out a task.

NOTE: This attribute should not be used if the work method is specified for the IfcTaskType

void setWorkMethod(std::string v)
bool IsMilestone() const

Identifies whether a task is a milestone task (=TRUE) or not (= FALSE).

NOTE: In small project planning applications, a milestone task may be understood to be a task having no duration. As such, it represents a singular point in time.

void setIsMilestone(bool v)
bool hasPriority() const

Whether the optional attribute Priority is defined for this IfcTask.

int Priority() const

A value that indicates the relative priority of the task (in comparison to the priorities of other tasks).

void setPriority(int v)
const IfcParse::entity &declaration() const
IfcTask(IfcEntityInstanceData *e)
IfcTask(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_TaskId, boost::optional<std::string> v7_Status, boost::optional<std::string> v8_WorkMethod, bool v9_IsMilestone, boost::optional<int> v10_Priority)

Public Static Functions

const IfcParse::entity &Class()
class IfcTelecomAddress : public Ifc2x3::IfcAddress

Definition: Address to which telephone, electronic mail and other forms of telecommunications should be addressed.

HISTORY New entity in IFC Release 2x.

IFC 2x4 change: Added attribute MessagingIDs. Type of attribute WWWHomePageURL compatibly changed from IfcLabel to IfcURIReference.

Public Types

typedef IfcTemplatedEntityList<IfcTelecomAddress> list

Public Functions

bool hasTelephoneNumbers() const

Whether the optional attribute TelephoneNumbers is defined for this IfcTelecomAddress.

std::vector<std::string> TelephoneNumbers() const

The list of telephone numbers at which telephone messages may be received.

void setTelephoneNumbers(std::vector<std::string> v)
bool hasFacsimileNumbers() const

Whether the optional attribute FacsimileNumbers is defined for this IfcTelecomAddress.

std::vector<std::string> FacsimileNumbers() const

The list of fax numbers at which fax messages may be received.

void setFacsimileNumbers(std::vector<std::string> v)
bool hasPagerNumber() const

Whether the optional attribute PagerNumber is defined for this IfcTelecomAddress.

std::string PagerNumber() const

The pager number at which paging messages may be received.

void setPagerNumber(std::string v)
bool hasElectronicMailAddresses() const

Whether the optional attribute ElectronicMailAddresses is defined for this IfcTelecomAddress.

std::vector<std::string> ElectronicMailAddresses() const

The list of Email addresses at which Email messages may be received.

void setElectronicMailAddresses(std::vector<std::string> v)
bool hasWWWHomePageURL() const

Whether the optional attribute WWWHomePageURL is defined for this IfcTelecomAddress.

std::string WWWHomePageURL() const

The world wide web address at which the preliminary page of information for the person or organization can be located. NOTE: Information on the world wide web for a person or organization may be separated into a number of pages and across a number of host sites, all of which may be linked together. It is assumed that all such information may be referenced from a single page that is termed the home page for that person or organization.

void setWWWHomePageURL(std::string v)
const IfcParse::entity &declaration() const
IfcTelecomAddress(IfcEntityInstanceData *e)
IfcTelecomAddress(boost::optional<::Ifc2x3::IfcAddressTypeEnum::Value> v1_Purpose, boost::optional<std::string> v2_Description, boost::optional<std::string> v3_UserDefinedPurpose, boost::optional<std::vector<std::string>> v4_TelephoneNumbers, boost::optional<std::vector<std::string>> v5_FacsimileNumbers, boost::optional<std::string> v6_PagerNumber, boost::optional<std::vector<std::string>> v7_ElectronicMailAddresses, boost::optional<std::string> v8_WWWHomePageURL)

Public Static Functions

const IfcParse::entity &Class()
class IfcTemperatureGradientMeasure : public IfcUtil::IfcBaseType

The temperature gradient measures the difference of a temperature per lenght, as for instance used in an external wall or its layers. It is usually measured in K/m.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTemperatureGradientMeasure(IfcEntityInstanceData *e)
IfcTemperatureGradientMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTendon : public Ifc2x3::IfcReinforcingElement

Public Types

typedef IfcTemplatedEntityList<IfcTendon> list

Public Functions

::Ifc2x3::IfcTendonTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc2x3::IfcTendonTypeEnum::Value v)
double NominalDiameter() const
void setNominalDiameter(double v)
double CrossSectionArea() const
void setCrossSectionArea(double v)
bool hasTensionForce() const

Whether the optional attribute TensionForce is defined for this IfcTendon.

double TensionForce() const
void setTensionForce(double v)
bool hasPreStress() const

Whether the optional attribute PreStress is defined for this IfcTendon.

double PreStress() const
void setPreStress(double v)
bool hasFrictionCoefficient() const

Whether the optional attribute FrictionCoefficient is defined for this IfcTendon.

double FrictionCoefficient() const
void setFrictionCoefficient(double v)
bool hasAnchorageSlip() const

Whether the optional attribute AnchorageSlip is defined for this IfcTendon.

double AnchorageSlip() const
void setAnchorageSlip(double v)
bool hasMinCurvatureRadius() const

Whether the optional attribute MinCurvatureRadius is defined for this IfcTendon.

double MinCurvatureRadius() const
void setMinCurvatureRadius(double v)
const IfcParse::entity &declaration() const
IfcTendon(IfcEntityInstanceData *e)
IfcTendon(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_SteelGrade, ::Ifc2x3::IfcTendonTypeEnum::Value v10_PredefinedType, double v11_NominalDiameter, double v12_CrossSectionArea, boost::optional<double> v13_TensionForce, boost::optional<double> v14_PreStress, boost::optional<double> v15_FrictionCoefficient, boost::optional<double> v16_AnchorageSlip, boost::optional<double> v17_MinCurvatureRadius)

Public Static Functions

const IfcParse::entity &Class()
class IfcTendonAnchor : public Ifc2x3::IfcReinforcingElement

Public Types

typedef IfcTemplatedEntityList<IfcTendonAnchor> list

Public Functions

const IfcParse::entity &declaration() const
IfcTendonAnchor(IfcEntityInstanceData *e)
IfcTendonAnchor(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_SteelGrade)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTendonTypeEnum

Public Types

enum Value

Values:

enumerator IfcTendonType_STRAND
enumerator IfcTendonType_WIRE
enumerator IfcTendonType_BAR
enumerator IfcTendonType_COATED
enumerator IfcTendonType_USERDEFINED
enumerator IfcTendonType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTerminatorSymbol : public Ifc2x3::IfcAnnotationSymbolOccurrence

Subclassed by Ifc2x3::IfcDimensionCurveTerminator

Public Types

typedef IfcTemplatedEntityList<IfcTerminatorSymbol> list

Public Functions

::Ifc2x3::IfcAnnotationCurveOccurrence *AnnotatedCurve() const
void setAnnotatedCurve(::Ifc2x3::IfcAnnotationCurveOccurrence *v)
const IfcParse::entity &declaration() const
IfcTerminatorSymbol(IfcEntityInstanceData *e)
IfcTerminatorSymbol(::Ifc2x3::IfcRepresentationItem *v1_Item, IfcTemplatedEntityList<::Ifc2x3::IfcPresentationStyleAssignment>::ptr v2_Styles, boost::optional<std::string> v3_Name, ::Ifc2x3::IfcAnnotationCurveOccurrence *v4_AnnotatedCurve)

Public Static Functions

const IfcParse::entity &Class()
class IfcText : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A text is an alphanumeric string of characters which is intended to be read and understood by a human being. It is for information purposes only.

Type: STRING

NOTE Corresponding STEP name: text, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 2x.

Per ISO 10303-11, the set of characters that may appear in STRINGs is defined in ISO 10646. The encoding of characters in case of file-based exchange is defined in ISO 10303-21 (STEP physical files) and ISO 10303-28 (XML files). Among else, these specifications define the encoding of 8-bit characters from ISO 8859-1…-16 and of 2-byte Unicode characters.

Note that while IfcText is not formally restricted in length, the size of a string in ISO 10303-21:2002 conforming exchange files must not exceed 32767 octets after encoding and escaping.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcText(IfcEntityInstanceData *e)
IfcText(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTextAlignment : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation):This property describes how text is aligned within the element. The actual justification algorithm used is user agent and human language dependent. If ‘justify’ is not supported, the user agent will supply a replacement. Typically, this will be ‘left’ for western languages. Values are:

left right center justify

NOTE Corresponding CSS1 definition is text-align.

HISTORY New type in IFC2x3.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTextAlignment(IfcEntityInstanceData *e)
IfcTextAlignment(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTextDecoration : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): This property describes decorations that are added to the text of an element. A value of ‘blink’ causes the text to blink.. Values are:

none underline overline line-through blink

User agents must recognize the keyword ‘blink’, but are not required to support the blink effect.

NOTE Corresponding CSS1 definition is text-decoration.

HISTORY New type in IFC2x3.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTextDecoration(IfcEntityInstanceData *e)
IfcTextDecoration(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTextFontName : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): The value is a font family name and/or generic family name. Values are:

The name of a font family of choice. For example, “gill” and “helvetica” are font families.

In the example above, the last value is a generic family name. The following generic families are defined:

‘serif’ (Example: Times) ‘sans-serif’ (Example: Helvetica) ‘cursive’ (Example: Zapf-Chancery) ‘fantasy’ (Example: Western) ‘monospace’ (Example: Courier)

It is encouraged to offer a generic font family as a last alternative.

NOTE Corresponding CSS1 definitions are font-family.

HISTORY New type in IFC2x2 Addendum 2.

IFC2x2 Addendum 2 CHANGE: The IfcFontFamily has been added.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTextFontName(IfcEntityInstanceData *e)
IfcTextFontName(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTextLiteral : public Ifc2x3::IfcGeometricRepresentationItem

The text literal is a geometric representation item which describes a text string using a string literal and additional position and path information.

NOTE The IfcTextLiteral is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange.

NOTE Corresponding ISO 10303 name: text_literal. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard. The attributes font and alignment have been removed as those should be handled by the text style.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The IfcTextLiteral has been changed by removing Font and Alignment.

Subclassed by Ifc2x3::IfcTextLiteralWithExtent

Public Types

typedef IfcTemplatedEntityList<IfcTextLiteral> list

Public Functions

std::string Literal() const

The text literal to be presented.

void setLiteral(std::string v)
::Ifc2x3::IfcAxis2Placement *Placement() const

An IfcAxis2Placement that determines the placement and orientation of the presented string. When used with a text style based on IfcTextStyleWithBoxCharacteristics then the y-axis is taken as the reference direction for the box rotation angle and the box slant angle.

void setPlacement(::Ifc2x3::IfcAxis2Placement *v)
::Ifc2x3::IfcTextPath::Value Path() const

The writing direction of the text literal.

void setPath(::Ifc2x3::IfcTextPath::Value v)
const IfcParse::entity &declaration() const
IfcTextLiteral(IfcEntityInstanceData *e)
IfcTextLiteral(std::string v1_Literal, ::Ifc2x3::IfcAxis2Placement *v2_Placement, ::Ifc2x3::IfcTextPath::Value v3_Path)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextLiteralWithExtent : public Ifc2x3::IfcTextLiteral

The text literal with extent is a text literal with the additional explicit information of the planar extent (or surrounding text box). An alignment attribute defines, how the text box is aligned to the placement and how it may expand.

NOTE The IfcTextLiteralWithExtent is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name: text_literal_with_extent. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The IfcTextLiteralWithExtent has been changed by adding BoxAlignment.

Public Functions

::Ifc2x3::IfcPlanarExtent *Extent() const

The extent in the x and y direction of the text literal.

void setExtent(::Ifc2x3::IfcPlanarExtent *v)
std::string BoxAlignment() const

The alignment of the text literal relative to its position.

void setBoxAlignment(std::string v)
const IfcParse::entity &declaration() const
IfcTextLiteralWithExtent(IfcEntityInstanceData *e)
IfcTextLiteralWithExtent(std::string v1_Literal, ::Ifc2x3::IfcAxis2Placement *v2_Placement, ::Ifc2x3::IfcTextPath::Value v3_Path, ::Ifc2x3::IfcPlanarExtent *v4_Extent, std::string v5_BoxAlignment)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTextPath

Public Types

enum Value

The text path determines the direction of the text characters in respect to each other.

NOTE: The IfcTextPath is an entity that had been adopted from ISO 10303, Industrial automation systems and integration&#151;Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

NOTE Corresponding ISO 10303 name:text_path . Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Values:

enumerator IfcTextPath_LEFT
enumerator IfcTextPath_RIGHT
enumerator IfcTextPath_UP
enumerator IfcTextPath_DOWN

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTextStyle : public Ifc2x3::IfcPresentationStyle

Definition from ISO/CD 10303-46:1992: The text style is a presentation style for annotation text.

The IfcTextStyle provides the text style table for presentation information assigned to text literals. The style is defined by color, text font characteristics, and text box characteristics. The definitions are based upon:

definitions from ISO/IS 10303-46:1994 for (old) vector based and monospace text. definitions from Cascading Style Sheets, level 1, W3C Recommendation 17 Dec 1996, revised 11 Jan 1999, CSS1, for all true type text. The use of the CSS1 definitions is the preferred way to represent text styles.

An IfcTextStyle, when representing (old) vector based and monospace text, is instantiated with:

TextCharacterAppearance:: IfcTextStyleForDefinedFont (with BackgroundColour = NIL) TextStyle:: IfcTextStyleWithBoxCharacteristics TextFontStyle:: IfcDraughtingPreDefinedTextFont or IfcExternallyDefinedTextFont

An IfcTextStyle, when representing (new) true type text, based on CSS1 definitions, is instantiated with:

TextCharacterAppearance:: IfcTextStyleForDefinedFont TextStyle:: IfcTextStyleTextModel TextFontStyle:: IfcTextStyleFontModel

An IfcTextStyle can be assigned to IfcTextLiteral via the IfcPresentationStyleAssignment through an intermediate IfcAnnotationTextOccurrence.

NOTE Corresponding ISO 10303 name: text_style. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard. In order to avoid ANDOR subtype relationships, the IfcTextBlockStyleSelect has been introduced that allows the combination of a text style as having box characteristic, and/or having spacing, or having none of those additional properties.

NOTE Corresponding CSS1 definitions are: Font properties (font-family, font-style, font-variant, font-weight, font-size), Color and background properties (color, background-color) and Text properties (word-spacing, letter-spacing, text-decoration, text-transform, text-align, text-indent, line-height).

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The IfcTextStyle has been changed by adding TextFontStyle and different data types for TextStyle and IfcCharacterStyleSelect.

Public Types

typedef IfcTemplatedEntityList<IfcTextStyle> list

Public Functions

bool hasTextCharacterAppearance() const

Whether the optional attribute TextCharacterAppearance is defined for this IfcTextStyle.

::Ifc2x3::IfcCharacterStyleSelect *TextCharacterAppearance() const

A character style to be used for presented text.

void setTextCharacterAppearance(::Ifc2x3::IfcCharacterStyleSelect *v)
bool hasTextStyle() const

Whether the optional attribute TextStyle is defined for this IfcTextStyle.

::Ifc2x3::IfcTextStyleSelect *TextStyle() const

The style applied to the text block for its visual appearance. It defines the text block characteristics, either for vector based or monospace text fonts (see select item IfcTextStyleWithBoxCharacteristics), or for true type text fonts (see select item IfcTextStyleTextModel.

IFC2x Edition 3 CHANGE The attribute TextBlockStyle has been changed from SET[1:?] to a non-aggregated optional, it has been renamed from TextStyles.

void setTextStyle(::Ifc2x3::IfcTextStyleSelect *v)
::Ifc2x3::IfcTextFontSelect *TextFontStyle() const

The style applied to the text font for its visual appearance. It defines the font family, font style, weight and size.

IFC2x Edition 2 Addendum 2 CHANGE The attribute TextFontStyle is a new attribute attached to IfcTextStyle.

void setTextFontStyle(::Ifc2x3::IfcTextFontSelect *v)
const IfcParse::entity &declaration() const
IfcTextStyle(IfcEntityInstanceData *e)
IfcTextStyle(boost::optional<std::string> v1_Name, ::Ifc2x3::IfcCharacterStyleSelect *v2_TextCharacterAppearance, ::Ifc2x3::IfcTextStyleSelect *v3_TextStyle, ::Ifc2x3::IfcTextFontSelect *v4_TextFontStyle)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextStyleFontModel : public Ifc2x3::IfcPreDefinedTextFont

Definition from CSS1 (W3C Recommendation): Setting font properties will be among the most common uses of style sheets. Unfortunately, there exists no well-defined and universally accepted taxonomy for classifying fonts, and terms that apply to one font family may not be appropriate for others. For example, ‘italic’ is commonly used to label slanted text, but slanted text may also be labeled as being Oblique, Slanted, Incline, Cursive or Kursiv. Therefore it is not a simple problem to map typical font selection properties to a specific font.

Font matching Because there is no accepted, universal taxonomy of font properties, matching of properties to font faces must be done carefully. The properties are matched in a well-defined order to ensure that the results of this matching process are as consistent as possible across user agents (assuming that the same library of font faces is presented to each of them).

The user agent makes (or accesses) a database of relevant CSS1 properties of all the fonts of which the UA is aware. The UA may be aware of a font because it has been installed locally or it has been previously downloaded over the web. If there are two fonts with exactly the same properties, one of them is ignored. At a given element and for each character in that element, the UA assembles the font-properties applicable to that element. Using the complete set of properties, the UA uses the ‘font-family’ property to choose a tentative font family. The remaining properties are tested against the family according to the matching criteria described with each property. If there are matches for all the remaining properties, then that is the matching font face for the given element. If there is no matching font face within the ‘font-family’ being processed by step 2, and if there is a next alternative ‘font-family’ in the font set, then repeat step 2 with the next alternative ‘font-family’. If there is a matching font face, but it doesn’t contain a glyph for the current character, and if there is a next alternative ‘font-family’ in the font sets, then repeat step 2 with the next alternative ‘font-family’. If there is no font within the family selected in 2, then use a UA-dependent default ‘font-family’ and repeat step 2, using the best match that can be obtained within the default font.

(The above algorithm can be optimized to avoid having to revisit the CSS1 properties for each character.)

The per-property matching rules from (2) above are as follows:

‘font-style’ is tried first. ‘italic’ will be satisfied if there is either a face in the UA’s font database labeled with the CSS keyword ‘italic’ (preferred) or ‘oblique’. Otherwise the values must be matched exactly or font-style will fail. ‘font-variant’ is tried next. ‘normal’ matches a font not labeled as ‘small-caps’; ‘small-caps’ matches (1) a font labeled as ‘small-caps’, (2) a font in which the small caps are synthesized, or (3) a font where all lowercase letters are replaced by upper case letters. A small-caps font may be synthesized by electronically scaling uppercase letters from a normal font. ‘font-weight’ is matched next, it will never fail. (See ‘font-weight’ below.) ‘font-size’ must be matched within a UA-dependent margin of tolerance. (Typically, sizes for scalable fonts are rounded to the nearest whole pixel, while the tolerance for bitmapped fonts could be as large as 20%.) Further computations, are based on the ‘font-size’ value that is used, not the one that is specified.

The inherited Name attribute is used to define the font name, particularly in cases, where no (list of) font families are provided.

NOTE Corresponding CSS1 definitions are Font properties (‘font-family’, ‘font-style’, ‘font-variant’, ‘font-weight’).

HISTORY New entity in IFC2x3.

Public Types

typedef IfcTemplatedEntityList<IfcTextStyleFontModel> list

Public Functions

bool hasFontFamily() const

Whether the optional attribute FontFamily is defined for this IfcTextStyleFontModel.

std::vector<std::string> FontFamily() const

The value is a prioritized list of font family names and/or generic family names. The first list entry has the highest priority, if this font fails, the next list item shall be used. The last list item should (if possible) be a generic family.

void setFontFamily(std::vector<std::string> v)
bool hasFontStyle() const

Whether the optional attribute FontStyle is defined for this IfcTextStyleFontModel.

std::string FontStyle() const

The font style property selects between normal (sometimes referred to as “roman” or “upright”), italic and oblique faces within a font family.

void setFontStyle(std::string v)
bool hasFontVariant() const

Whether the optional attribute FontVariant is defined for this IfcTextStyleFontModel.

std::string FontVariant() const

The font variant property selects between normal and small-caps. NOTE It has been introduced for later compliance to full CSS1 support.

void setFontVariant(std::string v)
bool hasFontWeight() const

Whether the optional attribute FontWeight is defined for this IfcTextStyleFontModel.

std::string FontWeight() const

The font weight property selects the weight of the font. NOTE Values other then ‘normal’ and ‘bold’ have been introduced for later compliance to full CSS1 support.

void setFontWeight(std::string v)
::Ifc2x3::IfcSizeSelect *FontSize() const

The font size provides the size or height of the text font. NOTE The following values are allowed, <IfcLengthMeasure, with positive values, the length unit is globally defined at IfcUnitAssignment.

void setFontSize(::Ifc2x3::IfcSizeSelect *v)
const IfcParse::entity &declaration() const
IfcTextStyleFontModel(IfcEntityInstanceData *e)
IfcTextStyleFontModel(std::string v1_Name, boost::optional<std::vector<std::string>> v2_FontFamily, boost::optional<std::string> v3_FontStyle, boost::optional<std::string> v4_FontVariant, boost::optional<std::string> v5_FontWeight, ::Ifc2x3::IfcSizeSelect *v6_FontSize)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextStyleForDefinedFont : public IfcUtil::IfcBaseEntity

Definition from ISO/CD 10303-46:1992: A text style for defined font is a character glyph style for pre-defined or externally defined text fonts.

Definition from CSS1 (W3C Recommendation): These properties describe the color (often called foreground color) and background of an element (i.e. the surface onto which the content is rendered). One can set a background color.

NOTE The CSS1 definition allows also for a background image. This has not been incorporated into IFC.

The IfcTextStyleForDefinedFont combines the text font color with an optional background color, that fills the text box, defined by the planar extent given to the text literal.

NOTE Corresponding ISO 10303 name: text_style_for_defined_font. Please refer to ISO/IS 10303-46:1994, p.122 for the final definition of the formal standard. The attribute BackgroundColour has been added.

NOTE Corresponding CSS1 definitions are Color and background properties (color, background-color).

HISTORY New entity in IFC2x3.

IFC2x3 CHANGE The IfcTextStyleForDefinedFont has been added and replaces IfcColour at the IfcCharacterStyleSelect.

Public Functions

::Ifc2x3::IfcColour *Colour() const

This property describes the text color of an element (often referred to as the foreground color).

void setColour(::Ifc2x3::IfcColour *v)
bool hasBackgroundColour() const

Whether the optional attribute BackgroundColour is defined for this IfcTextStyleForDefinedFont.

::Ifc2x3::IfcColour *BackgroundColour() const

This property sets the background color of an element.

void setBackgroundColour(::Ifc2x3::IfcColour *v)
const IfcParse::entity &declaration() const
IfcTextStyleForDefinedFont(IfcEntityInstanceData *e)
IfcTextStyleForDefinedFont(::Ifc2x3::IfcColour *v1_Colour, ::Ifc2x3::IfcColour *v2_BackgroundColour)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextStyleTextModel : public IfcUtil::IfcBaseEntity

Definition from CSS1 (W3C Recommendation): The properties defined in the text model affect the visual presentation of characters, spaces, words, and paragraphs.

The IfcTextStyleTextModel combines all text style properties, that affect the presentation of a text literal within a given extent. It includes the spacing between characters and words, the horizontal and vertical alignment of the text within the planar box of the extent, decorations (like underline), transformations of the literal (like uppercase), and the height of each text line within a multi-line text block.

NOTE Corresponding CSS1 definitions are Text properties (word-spacing, letter-spacing, text-decoration, vertical-align, text-transform, text-align, text-indent, line-height).

HISTORY New entity in IFC2x3.

Public Types

typedef IfcTemplatedEntityList<IfcTextStyleTextModel> list

Public Functions

bool hasTextIndent() const

Whether the optional attribute TextIndent is defined for this IfcTextStyleTextModel.

::Ifc2x3::IfcSizeSelect *TextIndent() const

The property specifies the indentation that appears before the first formatted line. NOTE It has been introduced for later compliance to full CSS1 support.

void setTextIndent(::Ifc2x3::IfcSizeSelect *v)
bool hasTextAlign() const

Whether the optional attribute TextAlign is defined for this IfcTextStyleTextModel.

std::string TextAlign() const

This property describes how text is aligned horizontally within the element. The actual justification algorithm used is dependent on the rendering algorithm.

void setTextAlign(std::string v)
bool hasTextDecoration() const

Whether the optional attribute TextDecoration is defined for this IfcTextStyleTextModel.

std::string TextDecoration() const

This property describes decorations that are added to the text of an element.

void setTextDecoration(std::string v)
bool hasLetterSpacing() const

Whether the optional attribute LetterSpacing is defined for this IfcTextStyleTextModel.

::Ifc2x3::IfcSizeSelect *LetterSpacing() const

The length unit indicates an addition to the default space between characters. Values can be negative, but there may be implementation-specific limits. The user agent is free to select the exact spacing algorithm. The letter spacing may also be influenced by justification (which is a value of the ‘align’ property). NOTE The following values are allowed, IfcDescriptiveMeasure with value=’normal’, or IfcLengthMeasure, the length unit is globally defined at IfcUnitAssignment.

void setLetterSpacing(::Ifc2x3::IfcSizeSelect *v)
bool hasWordSpacing() const

Whether the optional attribute WordSpacing is defined for this IfcTextStyleTextModel.

::Ifc2x3::IfcSizeSelect *WordSpacing() const

The length unit indicates an addition to the default space between words. Values can be negative, but there may be implementation-specific limits. The user agent is free to select the exact spacing algorithm. The word spacing may also be influenced by justification (which is a value of the ‘text-align’ property). NOTE It has been introduced for later compliance to full CSS1 support.

void setWordSpacing(::Ifc2x3::IfcSizeSelect *v)
bool hasTextTransform() const

Whether the optional attribute TextTransform is defined for this IfcTextStyleTextModel.

std::string TextTransform() const

This property describes how text characters may transform to upper case, lower case, or capitalized case, independent of the character case used in the text literal. NOTE It has been introduced for later compliance to full CSS1 support.

void setTextTransform(std::string v)
bool hasLineHeight() const

Whether the optional attribute LineHeight is defined for this IfcTextStyleTextModel.

::Ifc2x3::IfcSizeSelect *LineHeight() const

The property sets the distance between two adjacent lines’ baselines. When a ratio value is specified, the line height is given by the font size of the current element multiplied with the numerical value. A value of ‘normal’ sets the line height to a reasonable value for the element’s font. It is suggested that user agents set the ‘normal’ value to be a ratio number in the range of 1.0 to 1.2. NOTE The following values are allowed: IfcDescriptiveMeasure with value=’normal’, or IfcLengthMeasure, with non-negative values, the length unit is globally defined at IfcUnitAssignment, or IfcRatioMeasure.

void setLineHeight(::Ifc2x3::IfcSizeSelect *v)
const IfcParse::entity &declaration() const
IfcTextStyleTextModel(IfcEntityInstanceData *e)
IfcTextStyleTextModel(::Ifc2x3::IfcSizeSelect *v1_TextIndent, boost::optional<std::string> v2_TextAlign, boost::optional<std::string> v3_TextDecoration, ::Ifc2x3::IfcSizeSelect *v4_LetterSpacing, ::Ifc2x3::IfcSizeSelect *v5_WordSpacing, boost::optional<std::string> v6_TextTransform, ::Ifc2x3::IfcSizeSelect *v7_LineHeight)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextStyleWithBoxCharacteristics : public IfcUtil::IfcBaseEntity

The text style with box characteristics allows the presentation of annotated text by specifying the characteristics of the character boxes of the text and the spacing between the character boxes.

NOTE The IfcTextStyleWithBoxCharacteristics is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

The IfcTextStyleWithBoxCharacteristics is mainly used to provide some compatibility with ISO10303. Its usage is restricted to monospace text fonts (having uniform character boxes) and simple vector based text fonts. For true text fonts however the use of IfcTextStyleTextModel is required.

Figure 296 (from ISO 10303-46, page 91) illustrates angles. Figure 297 illustrates attribute use.

Figure 296 — Text style box angles Figure 297 — Text style box attributes

NOTE Corresponding ISO 10303 name: text_style_with_box_characteristics. Please refer to ISO/IS 10303-46:1994, p. 123 for the final definition of the formal standard. The four optional attributes BoxHeight, BoxWidth, BoxSlantAngle, BoxRotateAngle are included directly at the entity, and are not handled through the box_characteristic_select selecting box_height, box_width, box_slant_angle, box_rotate_angle, each being defined types. The CharacterSpacing attribute has been added from ISO/IS 10303-46:1994 entity text_style_with_spacing.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The attribute item CharacterSpacing has been added.

Public Functions

bool hasBoxHeight() const

Whether the optional attribute BoxHeight is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxHeight() const

It is the height scaling factor in the definition of a character glyph.

void setBoxHeight(double v)
bool hasBoxWidth() const

Whether the optional attribute BoxWidth is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxWidth() const

It is the width scaling factor in the definition of a character glyph.

void setBoxWidth(double v)
bool hasBoxSlantAngle() const

Whether the optional attribute BoxSlantAngle is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxSlantAngle() const

It indicated that the box of a character glyph shall be represented as a parallelogram, with the angle being between the character up line and an axis perpendicular to the character base line.

void setBoxSlantAngle(double v)
bool hasBoxRotateAngle() const

Whether the optional attribute BoxRotateAngle is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxRotateAngle() const

It indicated that the box of a character glyph shall be presented at an angle to the base line of a text string within which the glyph occurs, the angle being that between the base line of the glyph and an axis perpendicular to the baseline of the text string.

void setBoxRotateAngle(double v)
bool hasCharacterSpacing() const

Whether the optional attribute CharacterSpacing is defined for this IfcTextStyleWithBoxCharacteristics.

::Ifc2x3::IfcSizeSelect *CharacterSpacing() const

The distance between the character boxes of adjacent characters.

void setCharacterSpacing(::Ifc2x3::IfcSizeSelect *v)
const IfcParse::entity &declaration() const
IfcTextStyleWithBoxCharacteristics(IfcEntityInstanceData *e)
IfcTextStyleWithBoxCharacteristics(boost::optional<double> v1_BoxHeight, boost::optional<double> v2_BoxWidth, boost::optional<double> v3_BoxSlantAngle, boost::optional<double> v4_BoxRotateAngle, ::Ifc2x3::IfcSizeSelect *v5_CharacterSpacing)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextTransformation : public IfcUtil::IfcBaseType

Definition from CSS1 (W3C Recommendation): This property describes how the cases of characters are handled. Values are:

capitalize: uppercases the first character of each word uppercase: uppercases all letters of the element lowercase: lowercases all letters of the element none

NOTE Corresponding CSS1 definition is text-transform.

HISTORY New type in IFC2x3.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTextTransformation(IfcEntityInstanceData *e)
IfcTextTransformation(std::string v)
operator std::string() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTextureCoordinate : public IfcUtil::IfcBaseEntity

The IfcTextureCoordinate a an abstract supertype of the different kinds to apply texture coordinates to geometries. For vertex based geometries an explicit assignment of 2D texture vertices to the 3D geometry points is supported by the subtype IfcTextureMap, in addition there can be a procedural description of how texture coordinates shall be applied to geometric items. If no IfcTextureCoordinate is provided for the IfcSurfaceTexture, the default mapping shall be used.

See relevant subtypes of IfcGeometricRepresentationItem for default texture mapping description.

NOTE The definitions of texturing within this standard have been developed in dependence on the texture component of X3D. See ISO/IEC 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1, 18 Texturing component for the definitions in the international standard.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The attribute Texture is deleted.

IFC2x4 CHANGE The inverse attribute AnnotatedSurface is deleted, and the inverse AppliesTextures is added.

Subclassed by Ifc2x3::IfcTextureCoordinateGenerator, Ifc2x3::IfcTextureMap

Public Types

typedef IfcTemplatedEntityList<IfcTextureCoordinate> list

Public Functions

IfcTemplatedEntityList<IfcAnnotationSurface>::ptr AnnotatedSurface() const
const IfcParse::entity &declaration() const
IfcTextureCoordinate(IfcEntityInstanceData *e)
IfcTextureCoordinate()

Public Static Functions

const IfcParse::entity &Class()
class IfcTextureCoordinateGenerator : public Ifc2x3::IfcTextureCoordinate

The IfcTextureCoordinateGenerator describes a procedurally defined mapping function with input parameter to map 2D texture coordinates to 3D geometry vertices. The allowable Mode values and input Parameter need to be agreed upon in view definitions and implementer agreements.

It is recommended to use the texture coordinate generation modes as defined in X3D.

The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

The TextureCoordinateGenerator supports the automatic generation of texture coordinates for geometric shapes. The mode field describes the algorithm used to compute texture coordinates.

SPHERE, CAMERASPACENORMAL, CAMERASPACEPOSITION, CAMERASPACEREFLECTIONVECTOR, SPHERE-LOCAL, COORD, COORD-EYE, NOISE, NOISE-EYE, SPHERE-REFLECT, SPHERE-REFLECT-LOCAL

NOTE The definitions of texturing within this standard have been developed in dependence on the texture component of X3D. See ISO/IEC 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1, 18 Texturing component for the definitions in the international standard.

HISTORY New entity in IFC2x2.

IFC2x2 Addendum 2 CHANGE The attribute Texturehas been deleted.

Public Functions

std::string Mode() const

The Mode attribute describes the algorithm used to compute texture coordinates.

NOTE The applicable values for the Mode attribute are determined by view definitions or implementer agreements. It is recommended to use the modes described in ISO/IES 19775-1.2:2008 X3D Architecture and base components Edition 2, Part 1. See 18.4.8 TextureCoordinateGenerator for recommended values.

void setMode(std::string v)
IfcEntityList::ptr Parameter() const

The parameters used as arguments by the function as specified by Mode.

IFC2x4 CHANGE Made optional data type restricted to REAL.

void setParameter(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcTextureCoordinateGenerator(IfcEntityInstanceData *e)
IfcTextureCoordinateGenerator(std::string v1_Mode, IfcEntityList::ptr v2_Parameter)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextureMap : public Ifc2x3::IfcTextureCoordinate

An IfcTextureMap provides the mapping of the 2-dimensional texture coordinates to the surface onto which it is mapped. It is used for mapping the texture to surfaces of vertex based geometry models, such as

IfcFacetedBrep IfcFacetedBrepWithVoids IfcFaceBasedSurfaceModel IfcShellBasedSurfaceModel

The IfcTextureMap has a list of TextureVertex, that corresponds to the points of the face bound of the vertex based geometry item. The corresponding pair of lists is:

the list of Polygon of type IfcCartesianPoint, and the list of Vertices of type IfcTextureVertex.

Each IfcTextureVertex (given as S, T coordinates of the 2-dimension texture coordinate system) corresponds to the geometric coordinates of the IfcCartesianPoint (given as 3-dimension X, Y, and Z coordinates within the object coordinate system of the geometric item). The following definitions from ISO/IEC 19775-1 X3D Architecture and base components (X3D Specification) apply:

The TextureCoordinate node is a geometry property node that specifies a set of 2D texture coordinates used by vertex-based geometry nodes to map textures to vertices.

NOTE In contrary to the X3D vertext based geometry, for example IndexedFaceSet and ElevationGrid, the vertext based geometry in IFC may include inner loops. The areas of inner loops have to be cut-out from the texture applied to the outer loop.

Figure 301 illustrates applying a texture map to a vertex based geometry.

Figure 301 — Texture map

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The attribute Texture is deleted, and the attribute TextureMaps is added.

IFC2x4 CHANGE The attribute TextureMap is replaced by Vertices, and the attribute AppliedTo is added.

Informal propositions:

The FaceBound referenced in AppliedTo shall be used by the vertex based geometry, to which this texture map is assigned to by through the IfcStyledItem.

Public Types

typedef IfcTemplatedEntityList<IfcTextureMap> list

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcVertexBasedTextureMap>::ptr TextureMaps() const
void setTextureMaps(IfcTemplatedEntityList<::Ifc2x3::IfcVertexBasedTextureMap>::ptr v)
const IfcParse::entity &declaration() const
IfcTextureMap(IfcEntityInstanceData *e)
IfcTextureMap(IfcTemplatedEntityList<::Ifc2x3::IfcVertexBasedTextureMap>::ptr v1_TextureMaps)

Public Static Functions

const IfcParse::entity &Class()
class IfcTextureVertex : public IfcUtil::IfcBaseEntity

An IfcTextureVertex is a list of 2 (S, T) texture coordinates.

The following additional definitions from ISO 19775 apply:

Each vertex-based geometry node uses a set of 2D texture coordinates that map textures to vertices. Texture map values ( ImageTexture, PixelTexture) range from [0.0, 1.0] along the S-axis and T-axis. However, texture coordinate values may be in the range (-∞,∞). Texture coordinates identify a location (and thus a colour value) in the texture map. The horizontal coordinate S is specified first, followed by the vertical coordinate T. If the texture map is repeated in a given direction (S-axis or T-axis), a texture coordinate C (s or t) is mapped into a texture map that has N pixels in the given direction as follows:

Texture map location = (C - floor(C)) × N

If the texture map is not repeated, the texture coordinates are clamped to the 0.0 to 1.0 range as follows:

Texture map location = N, if C > 1.0, = 0.0, if C < 0.0, = C × N, if 0.0 ≤ C ≤ 1.0.

Texture coordinates may be transformed (scaled, rotated, translated) by supplying a TextureTransform as a component of the texture’s definition.

HISTORY: New entity in IFC 2x2.

Public Types

typedef IfcTemplatedEntityList<IfcTextureVertex> list

Public Functions

std::vector<double> Coordinates() const

The first coordinate[1] is the S, the second coordinate[2] is the T parameter value.

void setCoordinates(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcTextureVertex(IfcEntityInstanceData *e)
IfcTextureVertex(std::vector<double> v1_Coordinates)

Public Static Functions

const IfcParse::entity &Class()
class IfcThermalAdmittanceMeasure : public IfcUtil::IfcBaseType

IfcThermalAdmittanceMeasure is the measure of the ability of a surface to smooth out temperature variations. Usually measured in Watt / m2 Kelvin. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermalAdmittanceMeasure(IfcEntityInstanceData *e)
IfcThermalAdmittanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcThermalConductivityMeasure : public IfcUtil::IfcBaseType

IfcThermalConductivityMeasure is a measure of thermal conductivity. Usually measured in Watt / m Kelvin. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermalConductivityMeasure(IfcEntityInstanceData *e)
IfcThermalConductivityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcThermalExpansionCoefficientMeasure : public IfcUtil::IfcBaseType

IfcThermalExpansionCoeffientMeasure is a measure of the thermal expansion coefficient of a material, which expresses its elongation (as a ratio) per temperature difference. It is usually measured in 1/K. A positive elongation per (positive) rise of temperature is expressed by a positive value. Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermalExpansionCoefficientMeasure(IfcEntityInstanceData *e)
IfcThermalExpansionCoefficientMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
struct IfcThermalLoadSourceEnum

Public Types

enum Value

Values:

enumerator IfcThermalLoadSource_PEOPLE
enumerator IfcThermalLoadSource_LIGHTING
enumerator IfcThermalLoadSource_EQUIPMENT
enumerator IfcThermalLoadSource_VENTILATIONINDOORAIR
enumerator IfcThermalLoadSource_VENTILATIONOUTSIDEAIR
enumerator IfcThermalLoadSource_RECIRCULATEDAIR
enumerator IfcThermalLoadSource_EXHAUSTAIR
enumerator IfcThermalLoadSource_AIREXCHANGERATE
enumerator IfcThermalLoadSource_DRYBULBTEMPERATURE
enumerator IfcThermalLoadSource_RELATIVEHUMIDITY
enumerator IfcThermalLoadSource_INFILTRATION
enumerator IfcThermalLoadSource_USERDEFINED
enumerator IfcThermalLoadSource_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcThermalLoadTypeEnum

Public Types

enum Value

Values:

enumerator IfcThermalLoadType_SENSIBLE
enumerator IfcThermalLoadType_LATENT
enumerator IfcThermalLoadType_RADIANT
enumerator IfcThermalLoadType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcThermalMaterialProperties : public Ifc2x3::IfcMaterialProperties

Public Functions

bool hasSpecificHeatCapacity() const

Whether the optional attribute SpecificHeatCapacity is defined for this IfcThermalMaterialProperties.

double SpecificHeatCapacity() const
void setSpecificHeatCapacity(double v)
bool hasBoilingPoint() const

Whether the optional attribute BoilingPoint is defined for this IfcThermalMaterialProperties.

double BoilingPoint() const
void setBoilingPoint(double v)
bool hasFreezingPoint() const

Whether the optional attribute FreezingPoint is defined for this IfcThermalMaterialProperties.

double FreezingPoint() const
void setFreezingPoint(double v)
bool hasThermalConductivity() const

Whether the optional attribute ThermalConductivity is defined for this IfcThermalMaterialProperties.

double ThermalConductivity() const
void setThermalConductivity(double v)
const IfcParse::entity &declaration() const
IfcThermalMaterialProperties(IfcEntityInstanceData *e)
IfcThermalMaterialProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<double> v2_SpecificHeatCapacity, boost::optional<double> v3_BoilingPoint, boost::optional<double> v4_FreezingPoint, boost::optional<double> v5_ThermalConductivity)

Public Static Functions

const IfcParse::entity &Class()
class IfcThermalResistanceMeasure : public IfcUtil::IfcBaseType

IfcThermalResistanceMeasure is a measure of the resistance offered by a body to the flow of energy. Usually measured in m2 Kelvin/Watt.

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermalResistanceMeasure(IfcEntityInstanceData *e)
IfcThermalResistanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcThermalTransmittanceMeasure : public IfcUtil::IfcBaseType

IfcThermalTransmittanceMeasure is a measure of the rate at which energy is transmitted through a body. Usually measured in Watts/m2 Kelvin. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermalTransmittanceMeasure(IfcEntityInstanceData *e)
IfcThermalTransmittanceMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcThermodynamicTemperatureMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A thermodynamic temperature measure is the value for the degree of heat of a body. Usually measured in degrees Kelvin (K). Type: REAL

NOTE Corresponding ISO 10303 name: thermodynamic_temperature_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcThermodynamicTemperatureMeasure(IfcEntityInstanceData *e)
IfcThermodynamicTemperatureMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTimeMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A time measure is the value of the duration of periods. Measured in seconds (s) or days (d) or other units of time. Type: REAL

NOTE Corresponding ISO 10303 name: time_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTimeMeasure(IfcEntityInstanceData *e)
IfcTimeMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTimeSeries : public IfcUtil::IfcBaseEntity

A time series is a set of a time-stamped data entries. It allows a natural association of data collected over intervals of time. Time series can be regular or irregular. In regular time series data arrive predictably at predefined intervals. In irregular time series some or all time stamps do not follow a repetitive pattern and unpredictable bursts of data may arrive at unspecified points in time.

The modeling of buildings and their performance involves data that are generated and recorded over a period of time. Such data cover a large spectrum, from weather data to schedules of all kinds to status measurements to reporting to everything else that has a time related aspect. Their correct placement in time is essential for their proper understanding and use, and the IfcTimeSeries subtypes provide the appropriate data structures to accommodate these types of data.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc2x3::IfcIrregularTimeSeries, Ifc2x3::IfcRegularTimeSeries

Public Types

typedef IfcTemplatedEntityList<IfcTimeSeries> list

Public Functions

std::string Name() const

An unique name for the time series.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcTimeSeries.

std::string Description() const

A text description of the data that the series represents.

void setDescription(std::string v)
::Ifc2x3::IfcDateTimeSelect *StartTime() const

The start time of a time series.

void setStartTime(::Ifc2x3::IfcDateTimeSelect *v)
::Ifc2x3::IfcDateTimeSelect *EndTime() const

The end time of a time series.

void setEndTime(::Ifc2x3::IfcDateTimeSelect *v)
::Ifc2x3::IfcTimeSeriesDataTypeEnum::Value TimeSeriesDataType() const

The time series data type.

void setTimeSeriesDataType(::Ifc2x3::IfcTimeSeriesDataTypeEnum::Value v)
::Ifc2x3::IfcDataOriginEnum::Value DataOrigin() const

The orgin of a time series data.

void setDataOrigin(::Ifc2x3::IfcDataOriginEnum::Value v)
bool hasUserDefinedDataOrigin() const

Whether the optional attribute UserDefinedDataOrigin is defined for this IfcTimeSeries.

std::string UserDefinedDataOrigin() const

Value of the data origin if DataOrigin attribute is USERDEFINED.

void setUserDefinedDataOrigin(std::string v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcTimeSeries.

::Ifc2x3::IfcUnit *Unit() const

The unit to be assigned to all values within the time series. Note that mixing units is not allowed. If the value is not given, the global unit for the type of IfcValue, as defined at IfcProject.UnitsInContext is used.

void setUnit(::Ifc2x3::IfcUnit *v)
IfcTemplatedEntityList<IfcTimeSeriesReferenceRelationship>::ptr DocumentedBy() const
const IfcParse::entity &declaration() const
IfcTimeSeries(IfcEntityInstanceData *e)
IfcTimeSeries(std::string v1_Name, boost::optional<std::string> v2_Description, ::Ifc2x3::IfcDateTimeSelect *v3_StartTime, ::Ifc2x3::IfcDateTimeSelect *v4_EndTime, ::Ifc2x3::IfcTimeSeriesDataTypeEnum::Value v5_TimeSeriesDataType, ::Ifc2x3::IfcDataOriginEnum::Value v6_DataOrigin, boost::optional<std::string> v7_UserDefinedDataOrigin, ::Ifc2x3::IfcUnit *v8_Unit)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTimeSeriesDataTypeEnum

Public Types

enum Value

IfcTimeSeriesDataTypeEnum describes a type of time series data and is used to determine a value during the time series which is not explicitly specified:

CONTINUOUS: The time series data is continuous. DISCRETE: The time series data is discrete. DISCRETEBINARY: The time series data is discrete binary. PIECEWISEBINARY: The time series data is piecewise binary. PIECEWISECONSTANT: The time series data is piecewise constant. PIECEWISECONTINUOUS: The time series data is piecewise continuous. NOTDEFINED: The time series data is not defined.

HISTORY: New enumeration in IFC2x2.

Values:

enumerator IfcTimeSeriesDataType_CONTINUOUS
enumerator IfcTimeSeriesDataType_DISCRETE
enumerator IfcTimeSeriesDataType_DISCRETEBINARY
enumerator IfcTimeSeriesDataType_PIECEWISEBINARY
enumerator IfcTimeSeriesDataType_PIECEWISECONSTANT
enumerator IfcTimeSeriesDataType_PIECEWISECONTINUOUS
enumerator IfcTimeSeriesDataType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTimeSeriesReferenceRelationship : public IfcUtil::IfcBaseEntity

Public Functions

::Ifc2x3::IfcTimeSeries *ReferencedTimeSeries() const
void setReferencedTimeSeries(::Ifc2x3::IfcTimeSeries *v)
IfcEntityList::ptr TimeSeriesReferences() const
void setTimeSeriesReferences(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcTimeSeriesReferenceRelationship(IfcEntityInstanceData *e)
IfcTimeSeriesReferenceRelationship(::Ifc2x3::IfcTimeSeries *v1_ReferencedTimeSeries, IfcEntityList::ptr v2_TimeSeriesReferences)

Public Static Functions

const IfcParse::entity &Class()
class IfcTimeSeriesSchedule : public Ifc2x3::IfcControl

Public Types

typedef IfcTemplatedEntityList<IfcTimeSeriesSchedule> list

Public Functions

bool hasApplicableDates() const

Whether the optional attribute ApplicableDates is defined for this IfcTimeSeriesSchedule.

IfcEntityList::ptr ApplicableDates() const
void setApplicableDates(IfcEntityList::ptr v)
::Ifc2x3::IfcTimeSeriesScheduleTypeEnum::Value TimeSeriesScheduleType() const
void setTimeSeriesScheduleType(::Ifc2x3::IfcTimeSeriesScheduleTypeEnum::Value v)
::Ifc2x3::IfcTimeSeries *TimeSeries() const
void setTimeSeries(::Ifc2x3::IfcTimeSeries *v)
const IfcParse::entity &declaration() const
IfcTimeSeriesSchedule(IfcEntityInstanceData *e)
IfcTimeSeriesSchedule(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<IfcEntityList::ptr> v6_ApplicableDates, ::Ifc2x3::IfcTimeSeriesScheduleTypeEnum::Value v7_TimeSeriesScheduleType, ::Ifc2x3::IfcTimeSeries *v8_TimeSeries)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTimeSeriesScheduleTypeEnum

Public Types

enum Value

Values:

enumerator IfcTimeSeriesScheduleType_ANNUAL
enumerator IfcTimeSeriesScheduleType_MONTHLY
enumerator IfcTimeSeriesScheduleType_WEEKLY
enumerator IfcTimeSeriesScheduleType_DAILY
enumerator IfcTimeSeriesScheduleType_USERDEFINED
enumerator IfcTimeSeriesScheduleType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTimeSeriesValue : public IfcUtil::IfcBaseEntity

A time series value is a list of values that comprise the time series. At least one value must be supplied. Applications are expected to normalize values by applying the following three rules:

All time (universal, local, daylight savings, and solar) is normalized against the ISO 8601 standard GMT/UTC (Universal Coordinated Time). Any rollover is handled by the application providing the data. Rollover occurs, for example, when the measurement device resets itself while measuring and the recording data do not include the data measured before the reset. The normalized data refer to the preceding time unit. The time series example shown in Figure 241 below contains four time points: Time “a” indicates the beginning of the time series and the associated datum has no relevance. Data at time points “b,” “c” and “d” are associated with values 1, 2 and 3, respectively.

Figure 241 — Time series value

HISTORY New entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcTimeSeriesValue> list

Public Functions

IfcEntityList::ptr ListValues() const

A list of time-series values. At least one value is required.

void setListValues(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcTimeSeriesValue(IfcEntityInstanceData *e)
IfcTimeSeriesValue(IfcEntityList::ptr v1_ListValues)

Public Static Functions

const IfcParse::entity &Class()
class IfcTimeStamp : public IfcUtil::IfcBaseType

IfcTimeStamp is an indication of date and time by measuring the number of seconds which have elapsed since the beginning of the year 1970. Type: INTEGER

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTimeStamp(IfcEntityInstanceData *e)
IfcTimeStamp(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTopologicalRepresentationItem : public Ifc2x3::IfcRepresentationItem

Definition from ISO/CD 10303-42:1992: The topological representation item is the supertype for all the topological representation items in the geometry resource.

NOTE Corresponding ISO 10303 entity: topological_representation_item. Please refer to ISO/IS 10303-42:1994, p.129 for the final definition of the formal standard.

HISTORY: New entity in IFC Release 1.5

Subclassed by Ifc2x3::IfcConnectedFaceSet, Ifc2x3::IfcEdge, Ifc2x3::IfcFace, Ifc2x3::IfcFaceBound, Ifc2x3::IfcLoop, Ifc2x3::IfcPath, Ifc2x3::IfcVertex

Public Functions

const IfcParse::entity &declaration() const
IfcTopologicalRepresentationItem(IfcEntityInstanceData *e)
IfcTopologicalRepresentationItem()

Public Static Functions

const IfcParse::entity &Class()
class IfcTopologyRepresentation : public Ifc2x3::IfcShapeModel

IfcTopologyRepresentation represents the concept of a particular topological representation of a product or a product component within a representation context. This representation context does not need to be (but may be) a geometric representation context. Several representation types for shape representation are included as predefined types:

Vertex topological vertex representation (with or without assigned geometry)

Edge topological edge representation (with or without assigned geometry)

Path topological path representation (with or without assigned geometry)

Face topological face representation (with or without assigned geometry)

Shell topological shell representation (with or without assigned geometry)

Undefined no constraints imposed

The representation type is given as a string value at the inherited attribute ‘RepresentationType’.

HISTORY: New entity in IFC 2x2.

Public Functions

const IfcParse::entity &declaration() const
IfcTopologyRepresentation(IfcEntityInstanceData *e)
IfcTopologyRepresentation(::Ifc2x3::IfcRepresentationContext *v1_ContextOfItems, boost::optional<std::string> v2_RepresentationIdentifier, boost::optional<std::string> v3_RepresentationType, IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationItem>::ptr v4_Items)

Public Static Functions

const IfcParse::entity &Class()
class IfcTorqueMeasure : public IfcUtil::IfcBaseType

IfcTorqueMeasure is a measure of the torque or moment of a couple. Usually measured in N m. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcTorqueMeasure(IfcEntityInstanceData *e)
IfcTorqueMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcTransformerType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcTransformerType defines commonly shared information for occurrences of transformers. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a transformer specification (i.e. the specific product information, that is common to all occurrences of that product type). Transformer types may be exchanged without being already assigned to occurrences. Occurrences of IfcTransformerType are represented by instances of IfcTransformer.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ElectricalDeviceCommon Pset_TransformerTypeCommon

Material Use Definition The material of the IfcTransformerType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Casing’: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcTransformerType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcTransformer for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcTransformerType> list

Public Functions

::Ifc2x3::IfcTransformerTypeEnum::Value PredefinedType() const

Identifies the predefined types of transformer from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcTransformerTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcTransformerType(IfcEntityInstanceData *e)
IfcTransformerType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcTransformerTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTransformerTypeEnum

Public Types

enum Value

The IfcTransformerTypeEnum defines the range of different types of transformer that can be specified. HISTORY: New type in IFC 2x2 Enumeration

CURRENT: A transformer that changes the current between circuits. FREQUENCY: A transformer that changes the frequency between circuits. INVERTER: A transformer that converts from direct current (DC) to alternating current (AC). RECTIFIER: A transformer that converts from alternating current (AC) to direct current (DC).

VOLTAGE: A transformer that changes the voltage between circuits.

USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcTransformerType_CURRENT
enumerator IfcTransformerType_FREQUENCY
enumerator IfcTransformerType_VOLTAGE
enumerator IfcTransformerType_USERDEFINED
enumerator IfcTransformerType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcTransitionCode

Public Types

enum Value

Definition from ISO/CD 10303-42:1992: This type conveys the continuity properties of a composite curve or surface. The continuity referred to is geometric, not parametric continuity. For example, in ContSameGradient the tangent vectors of successive segments will have the same direction, but may have different magnitude.

NOTE Corresponding ISO 10303 type: transition_code, please refer to ISO/IS 10303-42:1994, p. 14 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.0

Figure 273 (quoted from ISO/CD 10303-42:1992, p.55) illustrates transition types.

Figure 273 — Transition code

ENUMERATION

DISCONTINUOUS: The segments do not join. This is permitted only at the boundary of the curve or surface to indicate that it is not closed. CONTINUOUS: The segments join but no condition on their tangents is implied. CONTSAMEGRADIENT: The segments join and their tangent vectors or tangent planes are parallel and have the same direction at the joint: equality of derivatives is not required. CONTSAMEGRADIENTSAMECURVATURE: For a curve, the segments join, their tangent vectors are parallel and in the same direction and their curvatures are equal at the joint: equality of derivatives is not required. For a surface this implies that the principle curvatures are the same and the principle directions are coincident along the common boundary.

Values:

enumerator IfcTransitionCode_DISCONTINUOUS
enumerator IfcTransitionCode_CONTINUOUS
enumerator IfcTransitionCode_CONTSAMEGRADIENT
enumerator IfcTransitionCode_CONTSAMEGRADIENTSAMECURVATURE

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTransportElement : public Ifc2x3::IfcElement

Definition from IAI: Generalization of all transport related objects that move people, animals or goods within a building or building complex. The IfcTransportElement defines the occurrence of a transport element, that (if given), is expressed by the IfcTransportElementType. EXAMPLE Transportation elements include elevator (lift), escalator, moving walkway, etc. NOTE More detailed equipment that may be a part of a transportation device, like a lifting hook, is defined as IfcDiscreteAccessory Depending on local classification systems transport elements and transportation systems in buildings are either considered as part of a building system, or as part of a building service system. Within IFC they are considered as part of a building system and may have to be mapped appropriately. HISTORY New entity in IFC Release 2x. IFC2x PLATFORM CHANGE The attribute PredefinedType (previously OperationType) is made optional. Type Use Definition IfcTransportElement defines the occuurence of any transportation device, common information about transportation device types (or styles) is handled by IfcTransportElementType. The IfcTransportElementType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcTransportElementType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcTransportElementType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Property Set Use Definition: The property sets relating to the IfcTransportElement are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcTransportElement are part of this IFC release:

Pset_TransportElementCommon: common property set for all transport element occurrences

Pset_TransportElementElevator: specific property set for all occurrences of transport elements with the PredefinedType: ELEVATOR

Containment Use Definition The IfcTransportElement, as any subtype of IfcElement, may have a hierarchical spatial containment relationships that is mandatory in most implementation scenarios.

The IfcTransportElement is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuilding being the default container.

Geometry Use Definitions: The geometric representation of IfcTransportElement is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Local Placement The local placement for IfcTransportElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) to the local placement of the same IfcSpatialStructureElement , which is used in the ContainedInStructure inverse attribute, or to a spatial structure element at a higher level, referenced by that. If the relative placement is not used, the absolute placement is defined within the world coordinate system.

SurfaceModel Representation Any IfcTransportElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple surface models, based on either shell or face based models. Then the following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SurfaceModel’

Brep Representation Any IfcTransportElement (so far no further constraints are defined at the level of its subtypes) may be represented as a single or multiple Boundary Representation elements (which are restricted to faceted Brep with or without voids). Then the following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Brep’

MappedRepresentation The mapped item, IfcMappedItem, should be used if appropriate as it allows for reusing the geometry definition of the property element type at occurrences of the same equipement type. Then the following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘MappedRepresentation’

Public Types

typedef IfcTemplatedEntityList<IfcTransportElement> list

Public Functions

bool hasOperationType() const

Whether the optional attribute OperationType is defined for this IfcTransportElement.

::Ifc2x3::IfcTransportElementTypeEnum::Value OperationType() const
void setOperationType(::Ifc2x3::IfcTransportElementTypeEnum::Value v)
bool hasCapacityByWeight() const

Whether the optional attribute CapacityByWeight is defined for this IfcTransportElement.

double CapacityByWeight() const

Capacity of the transport element measured by weight.

void setCapacityByWeight(double v)
bool hasCapacityByNumber() const

Whether the optional attribute CapacityByNumber is defined for this IfcTransportElement.

double CapacityByNumber() const

Capacity of the transportation element measured in numbers of person.

void setCapacityByNumber(double v)
const IfcParse::entity &declaration() const
IfcTransportElement(IfcEntityInstanceData *e)
IfcTransportElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc2x3::IfcTransportElementTypeEnum::Value> v9_OperationType, boost::optional<double> v10_CapacityByWeight, boost::optional<double> v11_CapacityByNumber)

Public Static Functions

const IfcParse::entity &Class()
class IfcTransportElementType : public Ifc2x3::IfcElementType

Definition from IAI: The element type IfcTransportElementType defines commonly shared information for occurrences of transport elements. The set of shared information may include:

common properties within shared property sets common material information common shape representations

It is used to define a transport element specification (i.e. the specific product information that is common to all occurrences of that beam type). Transport element types (or the instantiable subtypes) may be exchanged without being already assigned to occurrences. The occurrences of the IfcTransportElementType are represented by instances of IfcTransportElement (or its subtypes).

HISTORY: New entity in Release IFC2x Edition 2.

Property Set Use Definition: The shared property sets relating to the IfcTransportElementType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcTransportElementType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcTransportElementType and those that are only assignable to IfcTransportElement. If the same property is assigned to the IfcTransportElementType and the IfcTransportElement being an occurrence of the IfcTransportElementType, then the occurrence property overrides the type property.

Pset_TransportElementCommon: common property set for all transport element types

Pset_TransportElementElevator: specific property set for all types of transport elements with the PredefinedType: ELEVATOR

Geometry Use Definition: The IfcTransportElementType may define the shared geometric representation for all transport element occurrences. The RepresentationMaps attribute refers to a list of IfcRepresentationMap’s, that allow for multiple geometric representations (e.g. with IfcShaperepresentation’s having an RepresentationIdentifier ‘Box’, ‘FootPrint’, or ‘Body’). NOTE The product shape representations are defined as RepresentationMaps (attribute of the supertype IfcTypeProduct), which get assigned by an element occurrence instance through the IfcShapeRepresentation.Item[n] being an IfcMappedItem. See IfcTypeProduct for further information. NOTE The values of attributes RepresentationIdentifier and RepresentationType of IfcShapeRepresentation are restricted in the same way as those for IfcTransportElementType.

Public Types

typedef IfcTemplatedEntityList<IfcTransportElementType> list

Public Functions

::Ifc2x3::IfcTransportElementTypeEnum::Value PredefinedType() const

Predefined types to define the particular type of the transport element. There may be property set definitions available for each predefined type.

void setPredefinedType(::Ifc2x3::IfcTransportElementTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcTransportElementType(IfcEntityInstanceData *e)
IfcTransportElementType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcTransportElementTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTransportElementTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration is used to identify primary transport element types. The IfcTransportElementTypeEnum contains the following:

ELEVATOR: Elevator or lift being a transport device to move people of good vertically. ESCALATOR: Escalator being a transport device to move people. It consists of individual linked steps that move up and down on tracks while keeping the threads horizontal. MOVINGWALKWAY: Moving walkway being a transport device to move people horizontally or on an incline. It is a slow conveyor belt that transports people. CRANEWAY: A crane way system, normally including the crane rails, fasteners and the crane. It is primarily used to move heavy goods in a factory or other industry buildings. LIFTINGGEAR: A device used for lifting or lowering heavy goods. It may be manually operated or electrically or pneumatically driven.

HISTORY New enumeration in IFC Release 2x. IFC2x4 CHANGE New enumerators CRANEWAY and LIFTINGGEAR added in IFC2x4.

Values:

enumerator IfcTransportElementType_ELEVATOR
enumerator IfcTransportElementType_ESCALATOR
enumerator IfcTransportElementType_MOVINGWALKWAY
enumerator IfcTransportElementType_USERDEFINED
enumerator IfcTransportElementType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTrapeziumProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcTrapeziumProfileDef defines a trapezium as the profile definition used by the swept surface geometry or the swept area solid. It is given by its Top X and Bottom X extent and its Y extent as well as by the offset of the Top X extend, and placed within the 2D position coordinate system, established by the Position attribute. It is placed centric within the position coordinate system, that is, in the center of the bounding box.

HISTORY New class in IFC 1.5. The use definition has changed in IFC2x.

Figure 325 illustrates parameters of the trapezium profile definition.

Position

The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept surface or swept area solid that uses the profile definition. It is the xy plane of either:

IfcSweptSurface.Position IfcSweptAreaSolid.Position

or in case of sectioned spines the xy plane of each list member of IfcSectionedSpine.CrossSectionPositions.

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile. Explicit coordinate offsets are used to define cardinal points (e.g. upper-left bound). Parameter

The IfcTrapeziumProfileDef is defined within the position coordinate system, where the BottomDim defines the length measure for the bottom line (half along the positive x-axis) and the YDim defines the length measure for the parallel distance of bottom and top line (half along the positive y-axis). The top line starts with a distance of TopXOffset from [-BottomLine/2,YDim] (which can be negative, zero, or positive) and has a length of TopXDim along the positive x-axis.

Figure 325 — Trapezium profile

Public Types

typedef IfcTemplatedEntityList<IfcTrapeziumProfileDef> list

Public Functions

double BottomXDim() const

The extent of the bottom line measured along the implicit x-axis.

void setBottomXDim(double v)
double TopXDim() const

The extent of the top line measured along the implicit x-axis.

void setTopXDim(double v)
double YDim() const

The extent of the distance between the parallel bottom and top lines measured along the implicit y-axis.

void setYDim(double v)
double TopXOffset() const

Offset from the beginning of the top line to the bottom line, measured along the implicit x-axis.

void setTopXOffset(double v)
const IfcParse::entity &declaration() const
IfcTrapeziumProfileDef(IfcEntityInstanceData *e)
IfcTrapeziumProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_BottomXDim, double v5_TopXDim, double v6_YDim, double v7_TopXOffset)

Public Static Functions

const IfcParse::entity &Class()
class IfcTrimmedCurve : public Ifc2x3::IfcBoundedCurve

Definition from ISO/CD 10303-42:1992: A trimmed curve is a bounded curve which is created by taking a selected portion, between two identified points, of the associated basis curve. The basis curve itself is unaltered and more than one trimmed curve may reference the same basis curve. Trimming points for the curve may be identified by: parametric value geometric position both of the above At least one of these shall be specified at each end of the curve. The SenseAgreement makes it possible to unambiguously define any segment of a closed curve such as a circle. The combinations of sense and ordered end points make it possible to define four distinct directed segments connecting two different points on a circle or other closed curve. For this purpose cyclic properties of the parameter range are assumed; for example, 370 degrees is equivalent to 10 degrees. The IfcTrimmedCurve has a parameterization which is inherited from the particular basis curve reference. More precisely the parameter s of the trimmed curve is derived from the parameter of the basis curve as follows: if SenseAgreement is TRUE: s = t - t1 if SenseAgreement is FALSE: s = t2 - t In the above equations t1 is the value given by Trim1 or the parameter value corresponding to point 1 and t2 is the value given by Trim2 or the parameter value corresponding to point 2. The resultant IfcTrimmedCurve has a parameter ranging from 0 at the first trimming point to |t2

  • t1| at the second trimming point. NOTE In case of a closed curve, it may be necessary to increment t1 or t2 by the parametric length for consistency with the sense flag.

NOTE Corresponding ISO 10303 entity: trimmed_curve; As a further IFC restriction, an IfcTrimmedCurve should only trim a IfcLine or IfcConic. Please refer to ISO/IS 10303-42:1994, p. 54 for the final definition of the formal standard.

HISTORY New class in IFC Release 1.0

Informal Propositions: Where both the parameter value and the Cartesian point exist for Trim1 and Trim2 they shall be consistent. (i.e., the BasisCurve evaluated at the parameter value shall coincide with the specified point). When a Cartesian point is specified by Trim1 or by Trim2 it shall lie on the BasisCurve. Except the case of a closed BasisCurve where both parameter 1 and parameter 2 exist, they shall be consistent with the sense flag, i.e., (sense = parameter 1 < parameter 2). Or, for every open curve where both parameter 1 and parameter 2 exist, they shall be consistent with the SenseAgreement, i.e., SenseAgreement = (parameter 1 < parameter 2). If both parameter 1 and parameter 2 exist, then parameter 1 <> parameter 2. For a closed base curve, e.g. IfcCircle or IfcEllipse, this also applies to the cyclic properties, as 360’ is equal to 0’, parameter 1 = 360’ and parameter 2 = 0’ are treated as being equal and therefore violating this proposition. When a parameter value is specified by Trim1 or Trim2 it shall lie within the parametric range of the BasisCurve. Additional illustration from IAI: The figure above shows the four arcs (dashed blue and green lines with arrow showing different orientations) that can be defined by the same BasisCurve (of type IfcCircle) and the same trimming points (given by Cartesian points and parameter values) by using different assignments to Trim1 and Trim2 and SenseAgreement.

Note: Since the BasisCurve is closed (type

IfcCircle), the exception of the informal proposition IP3 applies, i.e. the sense flag is not required to be consistent with the parameter values of Trim1 and Trim1, so the rule (sense = parameter 1 < parameter 2) may not be fulfilled.

Public Types

typedef IfcTemplatedEntityList<IfcTrimmedCurve> list

Public Functions

::Ifc2x3::IfcCurve *BasisCurve() const

The curve to be trimmed. For curves with multiple representations any parameter values given as Trim1 or Trim2 refer to the master representation of the BasisCurve only.

void setBasisCurve(::Ifc2x3::IfcCurve *v)
IfcEntityList::ptr Trim1() const

The first trimming point which may be specified as a Cartesian point, as a real parameter or both.

void setTrim1(IfcEntityList::ptr v)
IfcEntityList::ptr Trim2() const

The second trimming point which may be specified as a Cartesian point, as a real parameter or both.

void setTrim2(IfcEntityList::ptr v)
bool SenseAgreement() const

Flag to indicate whether the direction of the trimmed curve agrees with or is opposed to the direction of the basis curve.

void setSenseAgreement(bool v)
::Ifc2x3::IfcTrimmingPreference::Value MasterRepresentation() const

Where both parameter and point are present at either end of the curve this indicates the preferred form.

void setMasterRepresentation(::Ifc2x3::IfcTrimmingPreference::Value v)
const IfcParse::entity &declaration() const
IfcTrimmedCurve(IfcEntityInstanceData *e)
IfcTrimmedCurve(::Ifc2x3::IfcCurve *v1_BasisCurve, IfcEntityList::ptr v2_Trim1, IfcEntityList::ptr v3_Trim2, bool v4_SenseAgreement, ::Ifc2x3::IfcTrimmingPreference::Value v5_MasterRepresentation)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTrimmingPreference

Public Types

enum Value

Definition from ISO/CD 10303-42:1992: This type is used to describe the preferred way of trimming a parametric curve where the trimming is multiply defined.

NOTE Corresponding ISO 10303 type: trimming_preference, please refer to ISO/IS 10303-42:1994, p. 18 for the final definition of the formal standard.

HISTORY New Type in IFC Release 1.0

ENUMERATION

CARTESIAN: Indicates that trimming by Cartesian point is preferred. PARAMETER: Indicates the preference for the parameter value. UNSPECIFIED: Indicates that no preference is communicated.

Values:

enumerator IfcTrimmingPreference_CARTESIAN
enumerator IfcTrimmingPreference_PARAMETER
enumerator IfcTrimmingPreference_UNSPECIFIED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcTShapeProfileDef defines a section profile that provides the defining parameters of a T-shaped section to be used by the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The centre of the position coordinate system is in the profile’s centre of the bounding box.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE All profile origins are now in the center of the bounding box.

IFC2x4 CHANGE Type of FilletRadius, FlangeEdgeRadius, and WebEdgeRadius relaxed to allow for zero radius. Trailing attribute CentreOfGravityInY deleted, use respective property in IfcExtendedProfileProperties instead.

Figure 326 illustrates parameters of the T-shape profile definition.

Position The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

by using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile.

Figure 326 — T-shape profile

Public Types

typedef IfcTemplatedEntityList<IfcTShapeProfileDef> list

Public Functions

double Depth() const

Web lengths, see illustration above (= h).

void setDepth(double v)
double FlangeWidth() const

Flange lengths, see illustration above (= b).

void setFlangeWidth(double v)
double WebThickness() const

Constant wall thickness of web (= ts).

void setWebThickness(double v)
double FlangeThickness() const

Constant wall thickness of flange (= tg).

void setFlangeThickness(double v)
bool hasFilletRadius() const

Whether the optional attribute FilletRadius is defined for this IfcTShapeProfileDef.

double FilletRadius() const

Fillet radius according the above illustration (= r1).

void setFilletRadius(double v)
bool hasFlangeEdgeRadius() const

Whether the optional attribute FlangeEdgeRadius is defined for this IfcTShapeProfileDef.

double FlangeEdgeRadius() const

Edge radius according the above illustration (= r2).

void setFlangeEdgeRadius(double v)
bool hasWebEdgeRadius() const

Whether the optional attribute WebEdgeRadius is defined for this IfcTShapeProfileDef.

double WebEdgeRadius() const

Edge radius according the above illustration (= r3).

void setWebEdgeRadius(double v)
bool hasWebSlope() const

Whether the optional attribute WebSlope is defined for this IfcTShapeProfileDef.

double WebSlope() const

Slope of flange of the profile.

void setWebSlope(double v)
bool hasFlangeSlope() const

Whether the optional attribute FlangeSlope is defined for this IfcTShapeProfileDef.

double FlangeSlope() const

Slope of web of the profile.

void setFlangeSlope(double v)
bool hasCentreOfGravityInY() const

Whether the optional attribute CentreOfGravityInY is defined for this IfcTShapeProfileDef.

double CentreOfGravityInY() const
void setCentreOfGravityInY(double v)
const IfcParse::entity &declaration() const
IfcTShapeProfileDef(IfcEntityInstanceData *e)
IfcTShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Depth, double v5_FlangeWidth, double v6_WebThickness, double v7_FlangeThickness, boost::optional<double> v8_FilletRadius, boost::optional<double> v9_FlangeEdgeRadius, boost::optional<double> v10_WebEdgeRadius, boost::optional<double> v11_WebSlope, boost::optional<double> v12_FlangeSlope, boost::optional<double> v13_CentreOfGravityInY)

Public Static Functions

const IfcParse::entity &Class()
class IfcTubeBundleType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcTubeBundleType defines commonly shared information for occurrences of tube bundles. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a tube bundle specification (i.e. the specific product information, that is common to all occurrences of that product type). Tube Bundle types may be exchanged without being already assigned to occurrences. Occurrences of IfcTubeBundleType are represented by instances of IfcTubeBundle.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_TubeBundleTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_TubeBundleTypeFinned (FINNED)

Material Use Definition The material of the IfcTubeBundleType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: Material used for construction of the tubes.

Port Use Definition The distribution ports relating to the IfcTubeBundleType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcTubeBundle for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcTubeBundleType> list

Public Functions

::Ifc2x3::IfcTubeBundleTypeEnum::Value PredefinedType() const

Defines the type of tube bundle.

void setPredefinedType(::Ifc2x3::IfcTubeBundleTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcTubeBundleType(IfcEntityInstanceData *e)
IfcTubeBundleType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcTubeBundleTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcTubeBundleTypeEnum

Public Types

enum Value

Enumeration defining the typical types of tube bundles. The IfcTubeBundleTypeEnum contains the following:

FINNED: Finned tube bundle type. USERDEFINED: User-defined tube bundle type. NOTDEFINED: Undefined tube bundle type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcTubeBundleType_FINNED
enumerator IfcTubeBundleType_USERDEFINED
enumerator IfcTubeBundleType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcTwoDirectionRepeatFactor : public Ifc2x3::IfcOneDirectionRepeatFactor

Definition from ISO/CD 10303-46:1992: A two direction repeat factor combines two vectors which are used in the fill area style tiles entity for determining the shape and relative location of tiles. Given the initial position of any tile, the two direction repeat factor determines eight new positions according to the equation:

k1* R1 + k2* R2 k X{-1,1}

NOTE Corresponding ISO 10303 name: two_direction_repeat_factor. Please refer to ISO/IS 10303-46:1994 for the final definition of the formal standard.

HISTORY New entity in IFC2x2.

Public Functions

::Ifc2x3::IfcVector *SecondRepeatFactor() const

A vector which specifies the relative positioning of tiles in the second direction.

void setSecondRepeatFactor(::Ifc2x3::IfcVector *v)
const IfcParse::entity &declaration() const
IfcTwoDirectionRepeatFactor(IfcEntityInstanceData *e)
IfcTwoDirectionRepeatFactor(::Ifc2x3::IfcVector *v1_RepeatFactor, ::Ifc2x3::IfcVector *v2_SecondRepeatFactor)

Public Static Functions

const IfcParse::entity &Class()
class IfcTypeObject : public Ifc2x3::IfcObjectDefinition

The object type defines the specific information about a type, being common to all occurrences of this type. It refers to the specific level of the well recognized generic - specific - occurrance modeling paradigm. The IfcTypeObject gets assigned to the individual object instances (the occurrences) via the IfcRelDefinesByType relationship. NOTE The terms ‘Type’ and ‘Style’ are often used interchangeably. The object type is represented by a set of property set definitions. The attached property sets describe the available alpha-numeric information about the object type. and are used to define all common properties that apply to all object occurrences of that type. NOTE If a property having having the same name is used within the IfcPropertySet assigned to an IfcTypeObject (and subtypes) and to an occurrence of that type, then the occurrence property overrides the type property. See IfcRelDefinesByType for an explanatory figure. Object types may be exchanged without being already assigned to objects. An object type may have an indication of the library (or catalogue) from which its definition originates. This association is handled by the inherited HasAssociations relationship pointing to IfcRelAssociatesLibrary.

HISTORY New entity in IFC Release 2x

IFC2x3 CHANGE The IfcTypeObject is now subtyped from the new supertype IfcObjectDefinition, and the attribute HasPropertySets has been changed from a LIST into a SET.

IFC2x4 CHANGE (1) The entity IfcTypeObject shall not be instantiated from IFC2x4 onwards. It will be changed into an ABSTRACT supertype in future releases of IFC. (2) The inverse attribute Types has been renamed from ObjectTypeOf.

Subclassed by Ifc2x3::IfcTypeProduct

Public Types

typedef IfcTemplatedEntityList<IfcTypeObject> list

Public Functions

bool hasApplicableOccurrence() const

Whether the optional attribute ApplicableOccurrence is defined for this IfcTypeObject.

std::string ApplicableOccurrence() const

The attribute optionally defines the data type of the occurrence object, to which the assigned type object can relate. If not present, no instruction is given to which occurrence object the type object is applicable. The following conventions are used:

The IFC entity name of the applicable occurrence using the IFC naming convention, CamelCase with IFC prefix It can be optionally followed by the predefined type after the separator “/” (forward slash), using Uupper case If one type object is applicable to many occurrence objects, then those occurrence object names should be separate by comma “,” forming a comma separated string.

EXAMPLE Refering to a furniture as applicable occurrence entity would be expressed as ‘IfcFurnishingElement’, refering to a brace as applicable entity would be expressed as ‘IfcMember/BRACE’, refering to a wall and wall standard case would be expressed as ‘IfcWall, IfcWallStandardCase’.

void setApplicableOccurrence(std::string v)
bool hasHasPropertySets() const

Whether the optional attribute HasPropertySets is defined for this IfcTypeObject.

IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr HasPropertySets() const

Set list of unique property sets, that are associated with the object type and are common to all object occurrences referring to this object type.

IFC2x3 CHANGE The attribute aggregate type has been changed from LIST to SET.

void setHasPropertySets(IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr v)
IfcTemplatedEntityList<IfcRelDefinesByType>::ptr ObjectTypeOf() const
const IfcParse::entity &declaration() const
IfcTypeObject(IfcEntityInstanceData *e)
IfcTypeObject(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets)

Public Static Functions

const IfcParse::entity &Class()
class IfcTypeProduct : public Ifc2x3::IfcTypeObject

IfcTypeProduct defines a type definition of a product without being already inserted into a project structure (without having a placement), and not being included into the geometric representation context of the project.It is used to define a product specification, that is, the specific product information that is common to all occurrences of that product type.

An IfcTypeProduct may have a list of property set attached and an optional set of product representations. Values of these properties and the representation maps are common to all occurrencesof that product type.The type occurrence relationship is realized using the objectified relationship IfcRelDefinesByType.

NOTE 1 The product representations are defined as representation maps, which gets assigned by a product instance through the representation item(s) being an IfcShapeRepresentation and having Items of typeIfcMappedItem. NOTE 2 The representations at the occurrence level (represented by subtypes of IfcProduct) can override the specific representations at the type level,

for geometric representations: a Cartesian transformation operator can be applied at the occurrence level, and for property sets: A property within an occurrence property set, assigned at the product occurrence, overrides the same property assigned to the product type.

An IfcTypeProduct may be exchanged without being already assigned to subtypes of IfcProduct.

HISTORY New entity in IFC Release 2x.

IFC2x4 CHANGE The entity IfcTypeProduct shall not be instantiated from IFC2x4 onwards. It will be changed into an ABSTRACT supertype in future releases of IFC.

Geometry use definition The RepresentationMaps define the type product shape and multiple geometric representations can be assigned. If a product occurrence is assigned to the type by using the IfcRelDefinesByType relationship, then these occurrences have to reference the representation maps. The reference is created by one or multiple IfcShapeRepresentation’s having an IfcMappedItem as Items, that places the IfcRepresentationMap of the type product into the spatial contexts, i.e. by using an Cartesian transformation operator to transform the IfcRepresentationMap into the object coordinate system of the product occurrence.

Figure 10 illustrates an example of referencing a representation map by the shape representation of a product occurrence. Here the Cartesian transformation operator only uses translation, but no rotation, mirroring, or scaling.

Figure 10 — Product type geometry with single placement

Figure 11 illustrates an example of referencing a representation multiple times map by the shape representation of a product occurrence. Here the Cartesian transformation operator only uses translation, but no rotation, mirroring, or scaling. The different translation values determine the pattern of the multiple placement.

Figure 11 — Product type geometry with multiple placement

Subclassed by Ifc2x3::IfcDoorStyle, Ifc2x3::IfcElementType, Ifc2x3::IfcWindowStyle

Public Types

typedef IfcTemplatedEntityList<IfcTypeProduct> list

Public Functions

bool hasRepresentationMaps() const

Whether the optional attribute RepresentationMaps is defined for this IfcTypeProduct.

IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr RepresentationMaps() const

List of unique representation maps. Each representation map describes a block definition of the shape of the product style. By providing more than one representation map, a multi-view block definition can be given.

void setRepresentationMaps(IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr v)
bool hasTag() const

Whether the optional attribute Tag is defined for this IfcTypeProduct.

std::string Tag() const

The tag (or label) identifier at the particular type of a product, e.g. the article number (like the EAN). It is the identifier at the specific level.

void setTag(std::string v)
const IfcParse::entity &declaration() const
IfcTypeProduct(IfcEntityInstanceData *e)
IfcTypeProduct(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcUnitaryEquipmentType : public Ifc2x3::IfcEnergyConversionDeviceType

The energy conversion device type IfcUnitaryEquipmentType defines commonly shared information for occurrences of unitary equipments. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a unitary equipment specification (i.e. the specific product information, that is common to all occurrences of that product type). Unitary Equipment types may be exchanged without being already assigned to occurrences. Occurrences of IfcUnitaryEquipmentType are represented by instances of IfcUnitaryEquipment.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcEnergyConversionDeviceType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_UnitaryEquipmentTypeCommon

Material Use Definition The material of the IfcUnitaryEquipmentType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute.

Composition Use Definition The

IfcUnitaryEquipmentType may be aggregated into components using IfcRelAggregates where RelatingObject refers to the enclosing IfcUnitaryEquipmentType and RelatedObjects contains one or more components. Components are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Aggregation use is defined for the following predefined types:

(All Types): May contain IfcDistributionElement components. Unitary equipment (air handlers in particular) may elaborate contained elements such as dampers, fans, coils, sensors, actuators, and controllers. Such breakdown provides access to component information and tracking of performance history for embedded elements.

Port Use Definition The distribution ports relating to the IfcUnitaryEquipmentType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcUnitaryEquipment for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcUnitaryEquipmentType> list

Public Functions

::Ifc2x3::IfcUnitaryEquipmentTypeEnum::Value PredefinedType() const

The type of unitary equipment.

void setPredefinedType(::Ifc2x3::IfcUnitaryEquipmentTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcUnitaryEquipmentType(IfcEntityInstanceData *e)
IfcUnitaryEquipmentType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcUnitaryEquipmentTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcUnitaryEquipmentTypeEnum

Public Types

enum Value

Enumeration defining the functional type of unitary equipment. The IfcUnitaryEquipmentTypeEnum contains the following:

AIRHANDLER: A unitary air handling unit typically containing a fan, economizer, and coils. AIRCONDITIONINGUNIT: A unitary packaged air-conditioning unit typically used in residential or light commercial applications. DEHUMIDIFIER: A unitary packaged dehumidification unit. Note: units supporting multiple modes (dehumidification, cooling, and/or heating) should use AIRCONDITIONINGUNIT. SPLITSYSTEM: A system which separates the compressor from the evaporator, but acts as a unitary component typically within residential or light commercial applications. ROOFTOPUNIT: A packaged assembly that is either field-erected or manufactured atop the roof of a large residential or commercial building and acts as a unitary component. USERDEFINED: User-defined unitary equipment type. NOTDEFINED: Undefined unitary equipment type.

HISTORY: New enumeration in IFC R2x. DEHUMIDIFIER added in IFC 2x4

Values:

enumerator IfcUnitaryEquipmentType_AIRHANDLER
enumerator IfcUnitaryEquipmentType_AIRCONDITIONINGUNIT
enumerator IfcUnitaryEquipmentType_SPLITSYSTEM
enumerator IfcUnitaryEquipmentType_ROOFTOPUNIT
enumerator IfcUnitaryEquipmentType_USERDEFINED
enumerator IfcUnitaryEquipmentType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcUnitAssignment : public IfcUtil::IfcBaseEntity

IfcUnitAssignment indicates a set of units which may be assigned. Within an IfcUnitAssigment each unit definition shall be unique; that is, there shall be no redundant unit definitions for the same unit type such as length unit or area unit. For currencies, there shall be only a single IfcMonetaryUnit within an IfcUnitAssignment.

NOTE A project (IfcProject) has a unit assignment which establishes a set of units which will be used globally within the project, if not otherwise defined. Other objects may have local unit assignments if there is a requirement for them to make use of units which do not fall within the project unit assignment.

HISTORY New entity in IFC Release 1.5.1.

Public Types

typedef IfcTemplatedEntityList<IfcUnitAssignment> list

Public Functions

IfcEntityList::ptr Units() const

Units to be included within a unit assignment.

void setUnits(IfcEntityList::ptr v)
const IfcParse::entity &declaration() const
IfcUnitAssignment(IfcEntityInstanceData *e)
IfcUnitAssignment(IfcEntityList::ptr v1_Units)

Public Static Functions

const IfcParse::entity &Class()
struct IfcUnitEnum

Public Types

enum Value

IfcUnitEnum is an enumeration type for allowed unit types of IfcNamedUnit.

ENUMERATION

ABSORBEDDOSEUNIT AMOUNTOFSUBSTANCEUNIT AREAUNIT DOSEEQUIVALENTUNIT ELECTRICCAPACITANCEUNIT ELECTRICCHARGEUNIT ELECTRICCONDUCTANCEUNIT ELECTRICCURRENTUNIT ELECTRICRESISTANCEUNIT ELECTRICVOLTAGEUNIT ENERGYUNIT FORCEUNIT FREQUENCYUNIT ILLUMINANCEUNIT INDUCTANCEUNIT LENGTHUNIT LUMINOUSFLUXUNIT LUMINOUSINTENSITYUNIT MAGNETICFLUXDENSITYUNIT MAGNETICFLUXUNIT MASSUNIT PLANEANGLEUNIT POWERUNIT PRESSUREUNIT RADIOACTIVITYUNIT SOLIDANGLEUNIT THERMODYNAMICTEMPERATUREUNIT TIMEUNIT VOLUMEUNIT USERDEFINED: User defined unit type. The type of unit is only implied by its name or the usage context.

HISTORY New type in IFC Release 1.5.1.

Values:

enumerator IfcUnit_ABSORBEDDOSEUNIT
enumerator IfcUnit_AMOUNTOFSUBSTANCEUNIT
enumerator IfcUnit_AREAUNIT
enumerator IfcUnit_DOSEEQUIVALENTUNIT
enumerator IfcUnit_ELECTRICCAPACITANCEUNIT
enumerator IfcUnit_ELECTRICCHARGEUNIT
enumerator IfcUnit_ELECTRICCONDUCTANCEUNIT
enumerator IfcUnit_ELECTRICCURRENTUNIT
enumerator IfcUnit_ELECTRICRESISTANCEUNIT
enumerator IfcUnit_ELECTRICVOLTAGEUNIT
enumerator IfcUnit_ENERGYUNIT
enumerator IfcUnit_FORCEUNIT
enumerator IfcUnit_FREQUENCYUNIT
enumerator IfcUnit_ILLUMINANCEUNIT
enumerator IfcUnit_INDUCTANCEUNIT
enumerator IfcUnit_LENGTHUNIT
enumerator IfcUnit_LUMINOUSFLUXUNIT
enumerator IfcUnit_LUMINOUSINTENSITYUNIT
enumerator IfcUnit_MAGNETICFLUXDENSITYUNIT
enumerator IfcUnit_MAGNETICFLUXUNIT
enumerator IfcUnit_MASSUNIT
enumerator IfcUnit_PLANEANGLEUNIT
enumerator IfcUnit_POWERUNIT
enumerator IfcUnit_PRESSUREUNIT
enumerator IfcUnit_RADIOACTIVITYUNIT
enumerator IfcUnit_SOLIDANGLEUNIT
enumerator IfcUnit_THERMODYNAMICTEMPERATUREUNIT
enumerator IfcUnit_TIMEUNIT
enumerator IfcUnit_VOLUMEUNIT
enumerator IfcUnit_USERDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcUShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcUShapeProfileDef defines a section profile that provides the defining parameters of a U-shape (channel) section to be used by the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The centre of the position coordinate system is in the profile’s centre of the bounding box.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE All profile origins are now in the center of the bounding box.

IFC2x4 CHANGE Type of FilletRadius and EdgeRadius relaxed to allow for zero radius. Trailing attribute CentreOfGravityInX deleted, use respective property in IfcExtendedProfileProperties instead.

Figure 327 illustrates parameters of the U-shape profile definition.

Position The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile.

Figure 327 — U-shape profile

Public Types

typedef IfcTemplatedEntityList<IfcUShapeProfileDef> list

Public Functions

double Depth() const

Web lengths, see illustration above (= h).

void setDepth(double v)
double FlangeWidth() const

Flange lengths, see illustration above (= b).

void setFlangeWidth(double v)
double WebThickness() const

Constant wall thickness of web (= ts).

void setWebThickness(double v)
double FlangeThickness() const

Constant wall thickness of flange (= tg).

void setFlangeThickness(double v)
bool hasFilletRadius() const

Whether the optional attribute FilletRadius is defined for this IfcUShapeProfileDef.

double FilletRadius() const

Fillet radius according the above illustration (= r1).

void setFilletRadius(double v)
bool hasEdgeRadius() const

Whether the optional attribute EdgeRadius is defined for this IfcUShapeProfileDef.

double EdgeRadius() const

Edge radius according the above illustration (= r2).

void setEdgeRadius(double v)
bool hasFlangeSlope() const

Whether the optional attribute FlangeSlope is defined for this IfcUShapeProfileDef.

double FlangeSlope() const

Slope of flange of the profile.

void setFlangeSlope(double v)
bool hasCentreOfGravityInX() const

Whether the optional attribute CentreOfGravityInX is defined for this IfcUShapeProfileDef.

double CentreOfGravityInX() const
void setCentreOfGravityInX(double v)
const IfcParse::entity &declaration() const
IfcUShapeProfileDef(IfcEntityInstanceData *e)
IfcUShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Depth, double v5_FlangeWidth, double v6_WebThickness, double v7_FlangeThickness, boost::optional<double> v8_FilletRadius, boost::optional<double> v9_EdgeRadius, boost::optional<double> v10_FlangeSlope, boost::optional<double> v11_CentreOfGravityInX)

Public Static Functions

const IfcParse::entity &Class()
class IfcValveType : public Ifc2x3::IfcFlowControllerType

The flow controller type IfcValveType defines commonly shared information for occurrences of valves. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a valve specification (i.e. the specific product information, that is common to all occurrences of that product type). Valve types may be exchanged without being already assigned to occurrences. Occurrences of IfcValveType are represented by instances of IfcValve.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowControllerType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_ValveTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_ValveTypeAirRelease (AIRRELEASE) Pset_ValveTypeDrawOffCock (DRAWOFFCOCK) Pset_ValveTypeFaucet (FAUCET) Pset_ValveTypeFlushing (FLUSHING) Pset_ValveTypeGasTap (GASTAP) Pset_ValveTypeIsolating (ISOLATING) Pset_ValveTypeMixing (MIXING) Pset_ValveTypePressureReducing (PRESSUREREDUCING) Pset_ValveTypePressureRelief (PRESSURERELIEF)

Material Use Definition The material of the IfcValveType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed. ‘Operation’: Material from which the operating mechanism (gate, globe, plug, needle, clack etc.) of the valve is constructed.

Port Use Definition The distribution ports relating to the IfcValveType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcValve for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcValveType> list

Public Functions

::Ifc2x3::IfcValveTypeEnum::Value PredefinedType() const

The type of valve.

void setPredefinedType(::Ifc2x3::IfcValveTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcValveType(IfcEntityInstanceData *e)
IfcValveType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcValveTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcValveTypeEnum

Public Types

enum Value

The IfcValveTypeEnum defines the range of different types of valve that can be specified. These are typically used in conjunction with Pset_ValveTypeCommon, which contains common properties for all valve types. The IfcValveTypeEnum contains:

AIRRELEASE: Valve used to release air from a pipe or fitting.

ANTIVACUUM: Valve that opens to admit air if the pressure falls below atmospheric pressure (BS6100 330 4104) CHANGEOVER: Valve that enables flow to be switched between pipelines (3 or 4 port). CHECK: Valve that permits water to flow in one direction only and is enclosed when there is no flow (2 port). COMMISSIONING: Valve used to facilitate commissioning of a system (2 port). DIVERTING: Valve that enables flow to be diverted from one branch of a pipeline to another (3 port). DOUBLECHECK: An assembly that incorporates two valves used to prevent backflow (BS6100 330 4106). DOUBLEREGULATING: Valve used to facilitate regulation of fluid flow in a system. DRAWOFFCOCK: A valve used to remove fluid from a piping system. FAUCET: Faucet valve typically used as a flow discharge. FLUSHING: Valve that flushes a predetermined quantity of water to cleanse a toilet, urinal, etc. GASCOCK: Valve that is used for controlling the flow of gas. GASTAP: Gas tap typically used for venting or discharging gas from a system. ISOLATING: Valve that closes off flow in a pipeline. MIXING: Valve that enables flow from two branches of a pipeline to be mixed together (3 port). PRESSUREREDUCING: Valve that reduces the pressure of a fluid immediately downstream of its position in a pipeline to a preselected value or by a predetermined ratio. PRESSURERELIEF: Spring or weight loaded valve that automatically discharges to a safe place fluid that has built up to excessive pressure in pipes or fittings REGULATING: Valve used to facilitate regulation of fluid flow in a system. SAFETYCUTOFF: Valve that closes under the action of a safety mechanism such as a drop weight, solenoid etc. STEAMTRAP: Valve that restricts flow of steam while allowing condensate to pass through. STOPCOCK: An isolating valve used on a domestic water service. USERDEFINED: User-defined valve type. NOTDEFINED: Undefined valve type.

HISTORY: New type in IFC R2.0

Values:

enumerator IfcValveType_AIRRELEASE
enumerator IfcValveType_ANTIVACUUM
enumerator IfcValveType_CHANGEOVER
enumerator IfcValveType_CHECK
enumerator IfcValveType_COMMISSIONING
enumerator IfcValveType_DIVERTING
enumerator IfcValveType_DRAWOFFCOCK
enumerator IfcValveType_DOUBLECHECK
enumerator IfcValveType_DOUBLEREGULATING
enumerator IfcValveType_FAUCET
enumerator IfcValveType_FLUSHING
enumerator IfcValveType_GASCOCK
enumerator IfcValveType_GASTAP
enumerator IfcValveType_ISOLATING
enumerator IfcValveType_MIXING
enumerator IfcValveType_PRESSUREREDUCING
enumerator IfcValveType_PRESSURERELIEF
enumerator IfcValveType_REGULATING
enumerator IfcValveType_SAFETYCUTOFF
enumerator IfcValveType_STEAMTRAP
enumerator IfcValveType_STOPCOCK
enumerator IfcValveType_USERDEFINED
enumerator IfcValveType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcVaporPermeabilityMeasure : public IfcUtil::IfcBaseType

IfcVaporPermeabilityMeasure is a measure of vapor permeability. Usually measured in kg / s m Pascal. Type: REAL

HISTORY New type in IFC Release 2x.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcVaporPermeabilityMeasure(IfcEntityInstanceData *e)
IfcVaporPermeabilityMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcVector : public Ifc2x3::IfcGeometricRepresentationItem

Definition from ISO/CD 10303-42:1992: The vector is defined in terms of the direction and magnitude of the vector. The value of the magnitude attribute defines the magnitude of the vector.

NOTE: The magnitude of the vector can not be reliable calculated from the components of the Orientation attribute. This form of representation was selected to reduce problems with numerical instability. For example a vector of magnitude 2.0 mm and equally inclined to the coordinate axes could be represented with Orientation attribute of (1.0,1.0,1.0).

NOTE: Corresponding ISO 10303 entity: vector. Please refer to ISO/IS 10303-42:1994, p.27 for the final definition of the formal standard. The derived attribute Dim has been added (see also note at IfcGeometricRepresentationItem).

HISTORY: New entity in IFC Release 1.0

Public Types

typedef IfcTemplatedEntityList<IfcVector> list

Public Functions

::Ifc2x3::IfcDirection *Orientation() const

The direction of the vector.

void setOrientation(::Ifc2x3::IfcDirection *v)
double Magnitude() const

The magnitude of the vector. All vectors of Magnitude 0.0 are regarded as equal in value regardless of the orientation attribute.

void setMagnitude(double v)
const IfcParse::entity &declaration() const
IfcVector(IfcEntityInstanceData *e)
IfcVector(::Ifc2x3::IfcDirection *v1_Orientation, double v2_Magnitude)

Public Static Functions

const IfcParse::entity &Class()
class IfcVertex : public Ifc2x3::IfcTopologicalRepresentationItem

Definition from ISO/CD 10303-42:1992: A vertex is the topological construct corresponding to a point. It has dimensionality 0 and extent 0. The domain of a vertex, if present, is a point in m dimensional real space RM; this is represented by the vertex point subtype.

NOTE Corresponding ISO 10303 entity: vertex. Please refer to ISO/IS 10303-42:1994, p. 129 for the final definition of the formal standard.

HISTORY New Entity in IFC Release 2.0

Informal proposition:

The vertex has dimensionality 0. This is a fundamental property of the vertex. The extent of a vertex is defined to be zero.

Subclassed by Ifc2x3::IfcVertexPoint

Public Types

typedef IfcTemplatedEntityList<IfcVertex> list

Public Functions

const IfcParse::entity &declaration() const
IfcVertex(IfcEntityInstanceData *e)
IfcVertex()

Public Static Functions

const IfcParse::entity &Class()
class IfcVertexBasedTextureMap : public IfcUtil::IfcBaseEntity

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcTextureVertex>::ptr TextureVertices() const
void setTextureVertices(IfcTemplatedEntityList<::Ifc2x3::IfcTextureVertex>::ptr v)
IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr TexturePoints() const
void setTexturePoints(IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v)
const IfcParse::entity &declaration() const
IfcVertexBasedTextureMap(IfcEntityInstanceData *e)
IfcVertexBasedTextureMap(IfcTemplatedEntityList<::Ifc2x3::IfcTextureVertex>::ptr v1_TextureVertices, IfcTemplatedEntityList<::Ifc2x3::IfcCartesianPoint>::ptr v2_TexturePoints)

Public Static Functions

const IfcParse::entity &Class()
class IfcVertexLoop : public Ifc2x3::IfcLoop

Definition from ISO/CD 10303-42:1992: A vertex_loop is a loop of zero genus consisting of a single vertex. A vertex can exist independently of a vertex loop. The topological data shall satisfy the following constraint:

Informal propositions:

A vertex loop has zero extent and dimensionality. The vertex loop has genus 0.

NOTE Corresponding ISO 10303 entity: vertex_loop. Please refer to ISO/IS 10303-42:1994, p. 121 for the final definition of the formal standard.

HISTORY New Entity in IFC2x2.

Public Types

typedef IfcTemplatedEntityList<IfcVertexLoop> list

Public Functions

::Ifc2x3::IfcVertex *LoopVertex() const

The vertex which defines the entire loop.

void setLoopVertex(::Ifc2x3::IfcVertex *v)
const IfcParse::entity &declaration() const
IfcVertexLoop(IfcEntityInstanceData *e)
IfcVertexLoop(::Ifc2x3::IfcVertex *v1_LoopVertex)

Public Static Functions

const IfcParse::entity &Class()
class IfcVertexPoint : public Ifc2x3::IfcVertex

Definition from ISO/CD 10303-42:1992: A vertex point is a vertex which has its geometry defined as a point.

NOTE Corresponding ISO 10303 entity: vertex_point. Please refer to ISO/IS 10303-42:1994, p. 130 for the final definition of the formal standard. Due to the general IFC model specification rule not to use multiple inheritance, the subtype relationship to geometric_representation_item is not included.

HISTORY New Entity in IFC2x.

Informal proposition:

The domain of the vertex is formally defined to be the domain of its vertex point.

Public Types

typedef IfcTemplatedEntityList<IfcVertexPoint> list

Public Functions

::Ifc2x3::IfcPoint *VertexGeometry() const

The geometric point, which defines the position in geometric space of the vertex.

void setVertexGeometry(::Ifc2x3::IfcPoint *v)
const IfcParse::entity &declaration() const
IfcVertexPoint(IfcEntityInstanceData *e)
IfcVertexPoint(::Ifc2x3::IfcPoint *v1_VertexGeometry)

Public Static Functions

const IfcParse::entity &Class()
class IfcVibrationIsolatorType : public Ifc2x3::IfcDiscreteAccessoryType

The element component type IfcVibrationIsolatorType defines commonly shared information for occurrences of vibration isolators. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements applicable assignment of process types

It is used to define a vibration isolator specification (i.e. the specific product information, that is common to all occurrences of that product type). Vibration Isolator types may be exchanged without being already assigned to occurrences. Occurrences of IfcVibrationIsolatorType are represented by instances of IfcVibrationIsolator.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcElementComponentType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_VibrationIsolatorTypeCommon

Material Use Definition The material of the IfcVibrationIsolatorType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Damping’: Material from which the damping element of the vibration isolator is constructed.

Public Functions

::Ifc2x3::IfcVibrationIsolatorTypeEnum::Value PredefinedType() const

Defines the type of vibration isolator.

void setPredefinedType(::Ifc2x3::IfcVibrationIsolatorTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcVibrationIsolatorType(IfcEntityInstanceData *e)
IfcVibrationIsolatorType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcVibrationIsolatorTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcVibrationIsolatorTypeEnum

Public Types

enum Value

Enumeration defining the typical types of vibration isolators. The IfcVibrationIsolatorTypeEnum contains the following:

COMPRESSION: Compression type vibration isolator. SPRING: Spring type vibration isolator. USERDEFINED: User-defined vibration isolator type. NOTDEFINED: Undefined vibration isolator type.

HISTORY: New enumeration in IFC 2x2.

Values:

enumerator IfcVibrationIsolatorType_COMPRESSION
enumerator IfcVibrationIsolatorType_SPRING
enumerator IfcVibrationIsolatorType_USERDEFINED
enumerator IfcVibrationIsolatorType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcVirtualElement : public Ifc2x3::IfcElement

A virtual element is a special element used to provide imaginary boundaries, such as between two adjacent, but not separated, spaces. Virtual elements are usually not displayed and does not have quantities and other measures. Therefore IfcVirtualElement does not have material information and quantities attached.

NOTE The main purpose of IfcVirtualElement is the provision of a virtual space boundary. The IfcVirtualElement may provide the 2D curve or 3D surface representation of the virtual space connection and is referenced by two instances of IfcRelSpaceBoundary, each pointing to one of the two adjacent IfcSpaces.

HISTORY New entity in IFC Release 2x2 Addendum. IFC2x2 CHANGE: The entity IfcVirtualElement has been added. Upward compatibility for file based exchange is guaranteed.

Space Boundary Use Definition The IfcVirtualElement is mainly used to define a virtual boundary between two spaces. Figure 63 describes how to use IfcRelSpaceBoundary in conjunction with IfcVirtualElement to define space boundaries.

Figure 63 — Virtual element space boundaries

Geometry Use Definition The geometric representation of any IfcVirtualElement is given by the IfcProductDefinitionShape and IfcLocalPlacement allowing multiple geometric representations. Included are: Local Placement The local placement for IfcVirtualElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

Geometric Representation Currently, the use of ‘FootPrint’ and ‘Surface’ representation is supported. FootPrint Representation The 2D geometric representation of IfcVirtualElement is defined using the ‘FootPrint’ representation.

IfcShapeRepresentation.RepresentationIdentifier = ‘FootPrint’. IfcShapeRepresentation.RepresentationType = ‘Curve2D’ or ‘GeometricCurveSet’ .

The following constraints apply to the 2D FootPrint representation:

‘Curve2D’: IfcPolyline, IfcTrimmedCurve or IfcCompositeCurve ‘GeometricCurveSet’: a list of 2D curves within the constraints shown above.

Surface Representation The 3D geometric representation of IfcVirtualElement is defined using a surface geometry.

IfcShapeRepresentation.RepresentationIdentifier = ‘Surface’. IfcShapeRepresentation.RepresentationType = ‘Surface3D’ or ‘GeometricSet .

The following constraints apply to the 3D surface representation:

‘Surface3D’: IfcSurfaceOfLinearExtrusion, IfcCurveBoundedPlane, IfcCurveBoundedSurface, IfcRectangularTrimmedSurface in case of an IfcSurfaceOfLinearExtrusion

Profile: IfcArbitraryOpenProfileDef Extrusion: The extrusion direction shall be vertically, i.e., along the positive Z Axis of the co-ordinate system of the containing spatial structure element.

in case of an IfcCurveBoundedPlane, IfcCurveBoundedSurface, IfcRectangularTrimmedSurface

Extrusion: The BasisSurface shall be a surface that is upright, i.e. standing perpendicular to the xy place of the co-ordinate system of the containing spatial structure element.

‘GeometricSet’: a list of 3D surfaces within the constraints shown above.

Public Types

typedef IfcTemplatedEntityList<IfcVirtualElement> list

Public Functions

const IfcParse::entity &declaration() const
IfcVirtualElement(IfcEntityInstanceData *e)
IfcVirtualElement(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcVirtualGridIntersection : public IfcUtil::IfcBaseEntity

IfcVirtualGridIntersection defines the derived location of the intersection between two grid axes. Offset values may be given to set an offset distance to the grid axis for the calculation of the virtual grid intersection.

The two intersecting axes (IntersectingAxes) define the intersection point, which exact location (in terms of the Cartesian point representing the intersection) has to be calculated from the geometric representation of the two participating curves.

NOTE The IfcGrid local placement, that can be provided relative to the local placement of another spatial structure element, has to be taken into account for calculating the absolute placement of the IfcVirtualGridIntersection. Where rules and informal rules ensure, that the IntersectingAxes belong to the same IfcGrid

Offset values may be given (OffsetDistances). If given, the position within the list of OffsetDistances corresponds with the position within the list of IntersectingAxes. Therefore:

OffsetDistances[1] sets the offset to IntersectingAxes[1], OffsetDistances[2] sets the offset to IntersectingAxes[2], and OffsetDistances[3] sets the offset to the virtual intersection in direction of the orientation of the cross product of IntersectingAxes[1] and the orthogonal complement of the IntersectingAxes[1] (which is the positive or negative direction of the z axis of the design grid position).

HISTORY New entity in IFC Release 1.5. The entity name was changed from IfcConstraintRelIntersection in IFC Release 2x.

Informal Propositions:

Both, IntersectingAxes[1] and IntersectingAxes[2] shall be two IfcGridAxis defined by the same IfcGrid. IntersectingAxes[1] and IntersectingAxes[2] shall not be part of the same row of grid axes, i.e. both shall not be within the same set of IfcGrid.UAxes or IfcGrid.VAxes of the corresponding IfcGrid.

Geometry use definitions: The following figures explain the usage of the OffsetDistances and IntersectingAxes attributes.

Figure 246 illustrates two offset distances given where the virtual intersection is defined in the xy plane of the grid axis placement.

Figure 246 — Virtual grid intersection with two offsets

Figure 247 illustrates three offset distances given where the virtual intersection is defined by an offset (in direction of the z-axis of the design grid placement) to the virtual intersection in the xy plane of the grid axis placement.

Figure 247 — Virtual grid intersection with three offsets

The distance of the offset curve (OffsetDistances[n]) is measured from the basis curve. The distance may be positive, negative or zero. A positive value of distance defines an offset in the direction which is normal to the curve in the sense of an anti-clockwise rotation through 90 degrees from the tangent vector T at the given point. (This is in the direction of orthogonal complement(T).) This can be reverted by the SameSense attribute at IfcGridAxis which may switch the sense of the AxisCurve. Illustration

Figure 248 illustrates an example of a negative offset where the figure shows the side of the offset.

IntersectingAxes[1].AxisCurve is an IfcTrimmedCurve with an IfcCircle as BasisCurve and SenseAgreement = TRUE. IntersectingAxes[1].SameSense = TRUE. OffsetDistances[1] is a negative length measure

Figure 248 — Virtual grid intersection negative offset

Public Functions

IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr IntersectingAxes() const

Two grid axes which intersects at exactly one intersection (see also informal proposition at IfcGrid). If attribute OffsetDistances is omitted, the intersection defines the placement or ref direction of a grid placement directly. If OffsetDistances are given, the intersection is defined by the offset curves to the grid axes.

void setIntersectingAxes(IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v)
std::vector<double> OffsetDistances() const

Offset distances to the grid axes. If given, it defines virtual offset curves to the grid axes. The intersection of the offset curves specify the virtual grid intersection.

void setOffsetDistances(std::vector<double> v)
const IfcParse::entity &declaration() const
IfcVirtualGridIntersection(IfcEntityInstanceData *e)
IfcVirtualGridIntersection(IfcTemplatedEntityList<::Ifc2x3::IfcGridAxis>::ptr v1_IntersectingAxes, std::vector<double> v2_OffsetDistances)

Public Static Functions

const IfcParse::entity &Class()
class IfcVolumeMeasure : public IfcUtil::IfcBaseType

Definition from ISO/CD 10303-41:1992: A volume measure is the value of the solid content of a body. Usually measured in cubic metre (m3). Type: REAL

NOTE Corresponding ISO 10303 name: volume_measure, please refer to ISO/IS 10303-41 for the final definition of the formal standard.

HISTORY New type in IFC Release 1.5.1.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcVolumeMeasure(IfcEntityInstanceData *e)
IfcVolumeMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcVolumetricFlowRateMeasure : public IfcUtil::IfcBaseType

IfcVolumetricFlowRateMeasure is a measure of the volume of a medium flowing per unit time. Usually measured in m3/s. Type: REAL

HISTORY New type in IFC Release 2.0.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcVolumetricFlowRateMeasure(IfcEntityInstanceData *e)
IfcVolumetricFlowRateMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcWall : public Ifc2x3::IfcBuildingElement

Definition from ISO 6707-1:1989: Vertical construction usually in masonry or in concrete which bounds or subdivides a construction works and fulfils a load bearing or retaining function. Definition from IAI: The wall represents a vertical construction that bounds or subdivides spaces. Wall are usually vertical, or nearly vertical, planar elements, often designed to bear structural loads. A wall is howevernot required to be load bearing. NOTE NOTE There is a representation of walls for structural analysis provided by a proper subtype of IfcStructuralMember being part of the IfcStructuralAnalysisModel.

NOTE An arbitrary planar element to which this semantic information is not applicable, e.g. is not predominantly vertical, shall be modeled as IfcPlate A wall may have openings, such as wall openings, openings used for windows or doors, or niches and recesses. They are defined by an IfcOpeningElement attached to the wall using the inverse relationship HasOpenings pointing to IfcRelVoidsElement. The IFC specification provides two entities for wall occurrences:

IfcWallStandardCase used for all occurrences of walls, that have a non-changing thickness along the wall path and where the thickness parameter can be fully described by a material layer set. These walls are always represented geometrically by an ‘Axis’ and a ‘SweptSolid’ shape representation (or by a ‘Clipping’ geometry based on ‘SweptSolid’), if a 3D geometric representation is assigned. In addition they have to have a corresponding IfcMaterialProfileSetUsage assigned. IfcWallElementedCase used for occurrences of walls which are aggregated from subordinate elements, following specific decomposition rules expressed by the mandatory use of IfcRelAggregates relationship. IfcWall used for all other occurrences of wall, particularly for walls with changing thickness along the wall path (e.g. polygonal walls), or walls with a non-rectangular cross sections (e.g. L-shaped retaining walls), and walls having an extrusion axis that is unequal to the global Z axis of the project (i.e. non-vertical walls), or walls having only ‘Brep’, or ‘SurfaceModel’ geometry.

HISTORY New entity in IFC Release 1.0 Type Use Definition IfcWall defines the occurrence of any wall, common information aboutwall types (or styles) is handled by IfcWallType. The IfcWallType (if present) may establish the commontype name, usage (or predefined) type, common material layer set, common set of properties and common shape representations (using IfcRepresentationMap). The IfcWallType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute. If no IfcWallType is attached(i.e. if only occurrence information is given) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value can be provided by the ObjectType attribute. Material Use Definition The material of the IfcWall is defined by IfcMaterialLayerSet and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Multi-layer walls can be represented by referring to several IfcMaterialLayer’s within the IfcMaterialLayerSet. Note: It is illegal to assign an IfcMaterialLayerSetUsage to an IfcWall. Only the subtype IfcWallStandardCase supports this concept. Material information can also be given at the IfcWallType, defining the common attribute data for all occurrences of the same type.It is then in addition accessible by the inverse IsTypedBy relationship pointing to IfcWallType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial. Property Set Use Definition The property sets relating to the IfcWall are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcWall are part of this IFC release:

Pset_WallCommon: common property set for all wall occurrences

Property sets can also be given at the IfcWallType, defining the common property data for all occurrences of the same type.It is then accessible by the inverse IsTypedBy relationship pointing to IfcWallType.HasPropertySets. If both are given, then the properties directly assigned to IfcWall overrides the properties assigned to IfcWallType. Quantity Use Definition The quantities relating to the IfcWall and IfcWallStandardCase are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to Name and a value provided for MethodOfMeasurement. Quantities shall never be assigned to the IfcWallType.

Qto_WallBaseQuantities: base quantities for all wall occurrences.

Containment Use Definition The IfcWall (and the subtype IfcWallStandardCase) as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierarchical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcWall is places within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. TheIfcWall may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Any subtype of IfcElement can be an element assembly, with IfcElementAssembly as a special focus subtype. In this case the wall should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

TheIfcWallmay also be an aggregate i.e. being composed by other elements and acting as an assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.IsDecomposedBy. Components of a wall are described by instances of IfcBuildingElementPart that are aggregated to form a complex wall. In this case, the containedIfcBuildingElementPart’s should not be additionally contained in the project spatial hierarchy, i.e. the inverse attribute SELF\IfcElement.ContainedInStructure of IfcBuildingElementPart should be NIL. Geometry Use Definition The geometric representation of IfcWall is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Included are: Local Placement The local placement for IfcWall is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point (if given) 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.

Geometric Representation Currently, the ‘Axis’, ‘Surface’, ‘FootPrint’, ‘Body’, and ‘Box’ representations are supported. The ‘Box’ representation includes the representation type ‘BoundingBox’ and is explained at IfcBuildingElement. Axis Representation The axis geometric representation of IfcWall is defined using the ‘Axis’ representation.

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

NOTE The ‘Axis’ is not used to locate the material layer set, only the subtype IfcWallStandardCase provides this capability. Surface Representation The surfacic geometric representation of IfcWall is defined using the ‘Surface’ representation.

RepresentationIdentifier : ‘Surface’ RepresentationType : ‘Surface3D’

NOTE The ‘Surface’ can be used to define a surfacic model of the building (e.g. for analytical purposes, or for reduced Level of Detail representation). Body Representation The body representation of IfcWall can be represented using the representation types ‘SweptSolid’, ‘Clipping’, ‘SurfaceModel’, and ‘Brep’. The representation types ‘SurfaceModel’ and ‘Brep’ are explained at IfcBuildingElement. SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used: If the wall body can be described by a vertical extrusion of a polygonal footprint with constant thickness along the axis (where vertical = into the direction of the global Z axis), the subtype IfcWallStandardCase should be used. If the extrusion is not equal to global Z, then the IfcWall should be used.

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcArbitraryClosedProfileDef is required. Extrusion:All extrusion directions shall be supported.

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The same additional constraints apply as defined for the ‘SweptSolid’ representation. Connection Geometry The connection between two walls is represented by the IfcRelConnectsPathElements. The use of the parameter of that relationship object is defined at the level of the subtypes of IfcWall and at the IfcRelConnectsPathElements.

Subclassed by Ifc2x3::IfcWallStandardCase

Public Types

typedef IfcTemplatedEntityList<IfcWall> list

Public Functions

const IfcParse::entity &declaration() const
IfcWall(IfcEntityInstanceData *e)
IfcWall(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcWallStandardCase : public Ifc2x3::IfcWall

The IfcWallStandardCase defines a wall with certain constraints for the provision of parameters and with certain constraints for the geometric representation. The IfcWallStandardCase handles all cases of walls, that are extruded vertically:

along the positive z axis of the wall object coordinate system, and along the positve z axis of the global (world) coordinate system

and have a single thickness along the path for each wall layer, i.e.:

parallel sides for straight walls co-centric sides for curved walls.

and have either:

a straight line axis (straight wall), or a circular arc axis (round wall).

and shall not have

aggregated components, that is, parts aggregated to a wall by IfcRelAggregates shape representation for ‘Body’ not being an extrusion, or clipped extrusion

The following parameter have to be provided:

Wall height, taken from the depth of extrusion, provided by the geometric representation. Wall thickness, taken from the material layer set usage, attached to the wall Wall offset from axis, taken from the material layer set usage, attached to the wall

The IfcWallStandardCase requires the provision of the wall axis either a straight line that is parallel to the x-axis of the object coordinate system, or a circular arc where the tangent at start is parallel to the x-axis of the object coordinate system. The direction of the wall axis shall be the positive direction of that x-axis. The material of the wall is defined by the IfcMaterialLayerSetUsage and is attached by the IfcRelAssociatesMaterial objectified relationship. It is accessible by the inverse HasAssociations relationship. The material layer set usage has to be given (enforced by where rule). HISTORY New entity in IFC Release 2x.

Type Use Definition The type information relating to the IfcWallStandardCase is defined at the supertype IfcWall. As an additional use agreement for standard walls, the IfcWallType should have a unique IfcMaterialLayerSet, that is referenced by theIfcMaterialLayerSetUsage assigned to all occurrences of this IfcWallType.

Figure 134 illustrates assignment of IfcMaterialLayerSetUsage and IfcMaterialLayerSet to the wall type and the wall occurrence.

Figure 134

Material Use Definition The material of the IfcWallStandardCase is defined by IfcMaterialLayerSetUsage and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Multi-layer walls can be represented by refering to several IfcMaterialLayer’s within the IfcMaterialLayerSet that is referenced from the IfcMaterialLayerSetUsage. Material information can also be given at the IfcWallType, defining the common attribute data for all occurrences of the same type.It is then accessible by the inverse IsDefinedBy relationship pointing to IfcSlabType.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial. See Type Use Definition for additional agreements for standard slabs.

Figure 134 illustrates material layer usage, where the following conventions shall be met:

The reference coordinate system is the local coordinate system established by the ObjectPlacement of the IfcWallStandardCase. The reference axis is the axis defined by the IfcShapeRepresentation with RepresentationType=’Axis’ as one of the Representation.Representations of the IfcWallStandardCase. The IfcMaterialLayerSetUsage.OffsetFromReferenceLine is given as a distance from this axis. The IfcMaterialLayerSetUsage.OffsetFromReferenceLine is the distance parallel to the reference axis and always within the base (XY) plane of the reference coordinate system. A positve value of IfcMaterialLayerSetUsage.OffsetFromReferenceLine would then point into the positive y-axis of the reference coordinate system. The IfcMaterialLayerSetUsage.DirectionSense defines how the IfcMaterialLayer’s are assigned to the reference axis. POSITIVE means in direction to the positive y-axis of the reference coordinate system. The Thickness of each IfcMaterialLayer is provided starting from the OffsetFromReferenceLine and in the direction given by DirectionSense. It is applied without any gap or overlap between two consecutive layers. The TotalThickness of the IfcMaterialLayerSet is the sum of all layer thicknesses. The IfcMaterialLayerSetUsage.LayerSetDirection is always AXIS2.

Figure 134 — Wall material layers

Property Set Use Definition: The property sets relating to the IfcWallStandardCase are defined at the supertype IfcWall. Quantity Use Definition: The quantities relating to the IfcWallStandardCase are defined at the supertype IfcWall. Geometry Use Definitions: The geometric representation of IfcWallStandardCase is given by the IfcProductDefinitionShape, allowing multiple geometric representation. Included are: Local Placement The use of local placement defining the wall object coordinate system is defined at the supertype IfcWall. Geometric Representation The standard geometric representation of IfcWallStandardCase is defined using the following multiple shape representations for its definition:

Axis: A two-dimensional open curve (IfcBoundedCurve) defining the axis for the standard wall. The material layer offset is measured from the wall axis. Body: A Swept Solid Representation or a CSG representation defining the 3D shape of the standard wall

NOTE It is invalid to exhange a ‘SurfaceModel’, or ‘Brep’ or ‘MappedRepresentation’ representation for the ‘Body’ shape representation of an IfcWallStandardCase. Axis Representation The wall axis is represented by a two-dimensional open curve within a particular shape representation. The wall axis is used to apply the material layer set usage parameter to the wall geometry. The following attribute values shall be used

RepresentationIdentifier : ‘Axis’ RepresentationType : ‘Curve2D’

Figure 135 illustrates an axis representation for a straight wall. In case of a straight wall, the set of items shall include a single geometric representation item of type IfcPolyline or IfcTrimmedCurve with the BasisCurve being an IfcLine. The IfcPolyline or IfcTrimmedCurve shall be parallel (here in a special case co-linear) to the x-axis of the object coordinate system. The direction shall be identical to the direction of the x-axis.

Figure 136 illustrates an axis representation for a curved wall. In case of a curved wall, the set of items shall include a single geometric representation item of type IfcTrimmedCurve. The curve shall have a BasisCurve of type IfcCircle. The tangent of the IfcTrimmedCurve shall be parallel at start to the x-axis of the object coordinate system. The direction shall be identical to the direction of the x-axis.

Figure 135 — Wall axis straight Figure 136 — Wall axis curved

Body Representation The body representation of IfcWallStandardCase is defined by using ‘SweptSolid’ representation for walls without clippings or ‘Clipping’ representation for walls with clippings (e.g. under sloped roof slabs). SweptSolid Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’

The following additional constraints apply to the ‘SweptSolid’ representation:

Solid: IfcExtrudedAreaSolid is required, Profile: IfcArbitraryClosedProfileDef and IfcRectangleProfileDef shall be supported. Extrusion: The profile shall be extruded vertically, i.e., in the direction of the z-axis of the co-ordinate system of the referred spatial structure element. It might be further constraint to be in the direction of the global z-axis in implementers agreements. The extrusion axis shall be perpendicular to the swept profile, i.e. pointing into the direction of the z-axis of the Position of the IfcExtrudedAreaSolid.

The profile of a wall is described in the ground view and extruded vertically. The profile (also identical with the foot print of the wall) is defined by the IfcArbitraryClosedProfileDef (excluding its subtypes). The profile is given with all wall connections already resolved.

Figure 137 illustrates a body representation for a straight wall. In case of a straight wall, the two sides of the profile shall be parallel to the wall axis, that is, the wall has a single unchanged thickness.

Figure 138 illustrates a body representation for a curved wall. In case of a curved wall, the two sides of the profile shall be parallel (with defined offset) to the wall axis, that is, the wall has a single unchanged thickness.

Figure 137 — Wall body extrusion straight Figure 138 — Wall body extrusion curved

Clipping Representation Type The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘Clipping’

The following constraints apply to the ‘Clipping’ representation:

Solid: see standard geometric representation Profile: see standard geometric representation Extrusion: see standard geometric representation Boolean result: The IfcBooleanClippingResult shall be supported, allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid (or subtypes).

Figure 139 illustrates a clipping for a straight wall using an IfcPolygonalBoundedHalfSpace as SecondOperand in the IfcBooleanClippingResult.

Figure 140 illustrates a clipping for a curved wall using an IfcHalfSpaceSolid as SecondOperand in the IfcBooleanClippingResult.

Figure 139 — Wall body clipping straight Figure 140 — Wall body clipping curved

Public Types

typedef IfcTemplatedEntityList<IfcWallStandardCase> list

Public Functions

const IfcParse::entity &declaration() const
IfcWallStandardCase(IfcEntityInstanceData *e)
IfcWallStandardCase(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag)

Public Static Functions

const IfcParse::entity &Class()
class IfcWallType : public Ifc2x3::IfcBuildingElementType

Definition from IAI: The element type IfcWallType defines commonly shared information for occurrences of walls. The set of shared information may include:

common properties within shared property sets common material information common material layer definitions common shape representations

NOTE It is illegal to share shape representations as representation maps for occurrences of IfcWallStandardcase.

It is used to define a wall specification (i.e. the specific product information, that is common to all occurrences of that product type). Wall types may be exchanged without being already assigned to occurrences.

NOTE: The product representations are defined as representation maps (at the level of the supertype IfcTypeProduct, which gets assigned by an element occurrence instance through the IfcShapeRepresentation.Item[1] being an IfcMappedItem.

Occurrences of the IfcWallType within building models are represented by instances of IfcWallStandardCase if the IfcBeamType has a single associated IfcMaterialLayerSet; otherwise they are represented by instances of IfcWall, or IfcWallElementedCase. Occurrences of the IfcWallType within structural analysis models are represented by instances of IfcStructuralSurfaceMember, or its applicable subtypes. HISTORY: New entity in Release IFC2x Editon 2. Informal proposition:

The material assignment, if provided using the IfcRelAssociatesMaterial relationship, shall not reference the IfcMaterialLayerSetUsage.

Material Use Definition The material of the IfcWallType is defined by the IfcMaterialLayerSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Note: It is illegal to assign an IfcMaterial to an IfcWallType, if there is at least one occurrences. of IfcWallStandardCase for this type. Layer Set Use Definition: The shared material layer set definition is defined by assigning an IfcMaterialLayerSet (see material use definition above). The IfcMaterialLayer refers to one or several of IfcMaterialLayer that is the common for all wall occurrence, if used. It is only applicable if the IfcWallType has only occurrences of type IfcWallStandardCase (see definition of IfcWallStandardCase for further information). NOTE Since each individual instance of IfcWallStandardCase defines its own IfcMaterialLayerSetUsage including the offset from the wall axis, the same IfcWallType can be used independently of the axis alignment of its occurrences. Property Set Use Definition: The shared property sets relating to the IfcWallType are defined by the IfcPropertySet and are attached by the HasPropertySets attribute. The following property set definitions specific to the IfcWallType are part of this IFC release: NOTE There is no differentiation between properties within the property set that are only assignable to IfcWallType and those that are only assignable to IfcWall. If the same property is assigned to the IfcWallType and the IfcWall being an occurrence of the IfcWallType, then the occurrence property overrides the type property.

Pset_WallCommon: common property set for all wall types.

Public Types

typedef IfcTemplatedEntityList<IfcWallType> list

Public Functions

::Ifc2x3::IfcWallTypeEnum::Value PredefinedType() const

Identifies the predefined types of a wall element from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcWallTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcWallType(IfcEntityInstanceData *e)
IfcWallType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcWallTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcWallTypeEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the different types of walls an IfcWallType object can fulfill:

STANDARD: A standard wall, extruded vertically with a constant thickness along the wall path. POLYGONAL: A polygonal wall, extruded vertically, where the wall thickness varies along the wall path. SHEAR: A wall having a non-rectangular cross section along the wall path.

NOTE The potentially misleading term shall not impose a particular resistance against shear forces, but a particular shape.

ELEMENTEDWALL: A stud wall framed with studs and faced with sheatings, sidings, wallboard, or plasterwork. PLUMBINGWALL: A pier, or enclosure, or encasement, normally used to enclose plumbing in sanitary rooms. MOVABLE: A movable wall that is either movable, e.g. a folding wall, or a sliding wall, or can be easily removed as a removable partitioning or mounting wall. Movable walls do normally not define space boundaries and often belong to the furnishing system. USERDEFINED: User-defined wall element. NOTDEFINED: Undefined wall element

HISTORY New Enumeration in Release IFC2x Edition 2. IFC2x2 ADDENDUM CHANGE The enumerator POLYGON has been changed to POLYGONAL. IFC2x3 CHANGE The enumerators ELEMENTEDWALL and PLUMBINGWALL have been added. IFC2x4 CHANGE New enumerator MOVABLE has been added.

Values:

enumerator IfcWallType_STANDARD
enumerator IfcWallType_POLYGONAL
enumerator IfcWallType_SHEAR
enumerator IfcWallType_ELEMENTEDWALL
enumerator IfcWallType_PLUMBINGWALL
enumerator IfcWallType_USERDEFINED
enumerator IfcWallType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcWarpingConstantMeasure : public IfcUtil::IfcBaseType

IfcWarpingConstantMeasure is a measure for the warping constant or warping resistance of a cross section under torsional loading. It is usually measured in m^6.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcWarpingConstantMeasure(IfcEntityInstanceData *e)
IfcWarpingConstantMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcWarpingMomentMeasure : public IfcUtil::IfcBaseType

The warping moment measure is a measure for the warping moment, which occurs in warping torsional analysis. It is usually measured in kN*m^2.

Type: REAL

HISTORY New type in IFC2x2.

Public Functions

const IfcParse::type_declaration &declaration() const
IfcWarpingMomentMeasure(IfcEntityInstanceData *e)
IfcWarpingMomentMeasure(double v)
operator double() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcWasteTerminalType : public Ifc2x3::IfcFlowTerminalType

The flow terminal type IfcWasteTerminalType defines commonly shared information for occurrences of waste terminals. The set of shared information may include:

common properties with shared property sets common representations of shape common materials common composition of elements common ports applicable assignment of process types

It is used to define a waste terminal specification (i.e. the specific product information, that is common to all occurrences of that product type). Waste Terminal types may be exchanged without being already assigned to occurrences. Occurrences of IfcWasteTerminalType are represented by instances of IfcWasteTerminal.

HISTORY: New entity in IFC2x2

Property Set Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the HasPropertySets attribute. Refer to the documentation at the supertype IfcFlowTerminalType and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_WasteTerminalTypeCommon

The following property set definitions are applicable to this entity according to the PredefinedType attribute:

Pset_WasteTerminalTypeFloorTrap (FLOORTRAP) Pset_WasteTerminalTypeFloorWaste (FLOORWASTE) Pset_WasteTerminalTypeGullySump (GULLYSUMP) Pset_WasteTerminalTypeGullyTrap (GULLYTRAP) Pset_WasteTerminalTypeRoofDrain (ROOFDRAIN) Pset_WasteTerminalTypeWasteDisposalUnit (WASTEDISPOSALUNIT) Pset_WasteTerminalTypeWasteTrap (WASTETRAP)

Material Use Definition The material of the IfcWasteTerminalType is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Body’: The primary material from which the object is constructed. ‘Cover’: Material from which the cover or grating is constructed.

Port Use Definition The distribution ports relating to the IfcWasteTerminalType type are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. Ports are reflected at occurrences of this type using the IfcRelDefinesByObject relationship. Refer to the documentation at IfcWasteTerminal for standard port definitions.

Public Types

typedef IfcTemplatedEntityList<IfcWasteTerminalType> list

Public Functions

::Ifc2x3::IfcWasteTerminalTypeEnum::Value PredefinedType() const

Identifies the predefined types of waste terminal from which the type required may be set.

void setPredefinedType(::Ifc2x3::IfcWasteTerminalTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcWasteTerminalType(IfcEntityInstanceData *e)
IfcWasteTerminalType(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, boost::optional<std::string> v9_ElementType, ::Ifc2x3::IfcWasteTerminalTypeEnum::Value v10_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcWasteTerminalTypeEnum

Public Types

enum Value

The IfcWasteTerminalTypeEnum defines the range of different types of waste terminal that can be specified. HISTORY: New type in IFC 2x2. GREASEINTERCEPTOR, OILINTERCEPTOR, PETROLINTERCEPTOR moved to IfcInterceptorTypeEnum in IFC2x4.

Enumeration

FLOORTRAP: Pipe fitting, set into the floor, that retains liquid to prevent the passage of foul air FLOOORWASTE: Pipe fitting, set into the floor, that collects waste water and discharges it to a separate trap. GULLYSUMP: Pipe fitting or assembly of fittings to receive surface water or waste water, fitted with a grating or sealed cover. GULLYTRAP: Pipe fitting or assembly of fittings to receive surface water or waste water, fitted with a grating or sealed cover and discharging through a trap (BS6100 330 3504 modified). ROOFDRAIN: Pipe fitting, set into the roof, that collects rainwater for discharge into the rainwater system.

WASTEDISPOSALUNIT: Electrically operated device that reduces kitchen or other waste into fragments small enough to be flushed into a drainage system. WASTETRAP: Pipe fitting, set adjacent to a sanitary terminal, that retains liquid to prevent the passage of foul air. USERDEFINED: User-defined type. NOTDEFINED: Undefined type.

Values:

enumerator IfcWasteTerminalType_FLOORTRAP
enumerator IfcWasteTerminalType_FLOORWASTE
enumerator IfcWasteTerminalType_GULLYSUMP
enumerator IfcWasteTerminalType_GULLYTRAP
enumerator IfcWasteTerminalType_GREASEINTERCEPTOR
enumerator IfcWasteTerminalType_OILINTERCEPTOR
enumerator IfcWasteTerminalType_PETROLINTERCEPTOR
enumerator IfcWasteTerminalType_ROOFDRAIN
enumerator IfcWasteTerminalType_WASTEDISPOSALUNIT
enumerator IfcWasteTerminalType_WASTETRAP
enumerator IfcWasteTerminalType_USERDEFINED
enumerator IfcWasteTerminalType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcWaterProperties : public Ifc2x3::IfcMaterialProperties

Public Types

typedef IfcTemplatedEntityList<IfcWaterProperties> list

Public Functions

bool hasIsPotable() const

Whether the optional attribute IsPotable is defined for this IfcWaterProperties.

bool IsPotable() const
void setIsPotable(bool v)
bool hasHardness() const

Whether the optional attribute Hardness is defined for this IfcWaterProperties.

double Hardness() const
void setHardness(double v)
bool hasAlkalinityConcentration() const

Whether the optional attribute AlkalinityConcentration is defined for this IfcWaterProperties.

double AlkalinityConcentration() const
void setAlkalinityConcentration(double v)
bool hasAcidityConcentration() const

Whether the optional attribute AcidityConcentration is defined for this IfcWaterProperties.

double AcidityConcentration() const
void setAcidityConcentration(double v)
bool hasImpuritiesContent() const

Whether the optional attribute ImpuritiesContent is defined for this IfcWaterProperties.

double ImpuritiesContent() const
void setImpuritiesContent(double v)
bool hasPHLevel() const

Whether the optional attribute PHLevel is defined for this IfcWaterProperties.

double PHLevel() const
void setPHLevel(double v)
bool hasDissolvedSolidsContent() const

Whether the optional attribute DissolvedSolidsContent is defined for this IfcWaterProperties.

double DissolvedSolidsContent() const
void setDissolvedSolidsContent(double v)
const IfcParse::entity &declaration() const
IfcWaterProperties(IfcEntityInstanceData *e)
IfcWaterProperties(::Ifc2x3::IfcMaterial *v1_Material, boost::optional<bool> v2_IsPotable, boost::optional<double> v3_Hardness, boost::optional<double> v4_AlkalinityConcentration, boost::optional<double> v5_AcidityConcentration, boost::optional<double> v6_ImpuritiesContent, boost::optional<double> v7_PHLevel, boost::optional<double> v8_DissolvedSolidsContent)

Public Static Functions

const IfcParse::entity &Class()
class IfcWindow : public Ifc2x3::IfcBuildingElement

Definition form ISO 6707-1:1989: Construction for closing a vertical or near vertical opening in a wall or pitched roof that will admit light and may admit fresh air. The window is a building element that is predominately used to provide natural light and fresh air. It includes vertical and horizontal opening (e.g. 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. The IfcWindow defines a particular occurrence of a window inserted in the spatial context of a project. A window can:

be inserted into an IfcOpeningElement using the IfcRelFillsElement relationship, , then the IfcDoor has an inverse attribute FillsVoids provided,

NOTE View definitions or implementer agreements may restrict the relationship to only include one window (or door) into one opening.

be part of an element assembly, often an IfcCurtainWall, using the IfcRelAggregates relationship, then the inverse attribute Decomposes is provided. or be a “free standing” window, then the IfcWindow has no inverse attributes FillsVoids or Decomposes provided.

The IFC specification provides two entities for window occurrences:

IfcWindowStandardCase used for all occurrences of windows, that have a ‘Profile’ shape representation defined to which a set of shape parameters for lining and framing properties apply. Additionally it requires the provision of an IfcWindowType that references one IfcWindowLiningProperties and on to many IfcWindowPanelProperties.

NOTE see IfcWindowStandardCase for all specific constraints imposed by this subtype.

IfcWindow used for all other occurrences of windows, particularly for windows having only ‘Brep’, or ‘SurfaceModel’ geometry without applying shape parameters.

The actual parameter of the window and/or its shape is defined at the IfcWindow as the occurrence definition (or project instance), or by the IfcWindowType as the specific definition (or project type). The following parameters are given:

at the IfcWindow or IfcWindowStandardCase for occurrence specific parameters. The IfcWindow specifies:

the window width and height the window opening direction (by the y-axis of the ObjectPlacement)

at the IfcWindowType to which the IfcWindow is related by the inverse relationship IsDefinedBy pointing to IfcRelDefinesByType, for type parameters common to all occurrences of the same type.

the partitioning type (single panel, double panel, tripel panel, more panels) the operation type (swing, tilt and turn, pivot revolve, fixed case ment, etc.) the window panel hinge side (by using two different styles for right and left opening windows) the construction material type the particular attributes for the lining by the IfcWindowLiningProperties the particular attributes for the panels by the IfcWindowPanelProperties

HISTORY New entity in IFC Release 1.0. IFC2x4 CHANGE The attributes PredefinedType and OperationType are added, the applicable type object has been changed to IfcDoorType.

Material Use Definition The material of the IfcWindow is defined by the IfcMaterialConstituentSet or as fall back by IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

‘Lining’ - to indicate that the material constituent applies to to the window lining ‘Framing’ - to indicate that the material constituent applies to to the window panel(s), if not provided, the ‘Lining’ material information applied to panel(s) as well ‘Glazing’ - to indicate that the material constituent applies to to the glazing part

If the fall back single IfcMaterial is referenced, it applies to the lining and framing of the window. Property Set Use Definition: The property sets relating to the IfcWindow are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcWindow are part of this IFC release:

Pset_WindowCommon: common property set for all window occurrences Pset_DoorWindowGlazingType: specific property set for the glazing properties of the window glazing, if available Pset_DoorWindowShadingType: specific property set for the shading properties of the window glazing, if available

Quantity Use Definition The quantities relating to the IfcWindow are defined by the IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following base quantities are defined and should be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities can be defined being subjected to local standard of measurement with another string value assigned to MethodOfMeasurement. Quanties shall be never assigned to the IfcWindowStyle.

Qto_WindowBaseQuantities: base quantities for all window occurrences.

Containment Use Definition

The IfcWindow, as any subtype of IfcBuildingElement, may participate in two different containment relationships. The first (and in most implementation scenarios mandatory) relationship is the hierachical spatial containment, the second (optional) relationship is the aggregation within anelement assembly.

The IfcWindow is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, refering to it by its inverse attribute SELF\IfcElement.ContainedInStructure. Subtypes ofIfcSpatialStructureElement are valid spatial containers, with IfcBuildingStorey being the default container. The IfcWindow may be aggregated into an element assembly using the objectified relationship IfcRelAggregates, refering to it by its inverse attribute SELF\IfcObjectDefinition.Decomposes. Windows may be part of an IfcCurtainWall as a special focus subtype. In this case it should not be additionally contained in the project spatial hierarchy, i.e.SELF\IfcElement.ContainedInStructure should be NIL.

Figure 141 illustrates window containment. NOTE The containment shall be defined independently of the filling relationship, that is, even if the IfcWindow is a filling of an opening established by IfcRelFillsElement, it is also contained in the spatial structure by an IfcRelContainedInSpatialStructure.

Figure 141 — Window containment

Geometry Use Definitions: The geometric representation of IfcWindow is given by the IfcProductDefinitionShape, allowing multiple geometric representation. The IfcWindow, in case of an occurrence object, gets its parameter and shape from the IfcWindowType. If an IfcRepresentationMap (a block definition) is defined for the IfcWindowType, then the IfcWindow inserts it through the IfcMappedItem (refered to by IfcShapeRepresentation.Items). Local Placement The local placement for IfcWindow is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.

The PlacementRelTo relationship of IfcLocalPlacement shall point to the local placement of the same element (if given), 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 shall point (if given) 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.

Geometric Representation Thegeometric representation of IfcWindow is defined using the following (potentiallymultiple) IfcShapeRepresentation’s for its IfcProductDefinitionShape:

Profile: A’Curve3D’ consisting of a single losed curve defining the outer boundary of the window (lining). Thewindow parametric representation uses this profile in order to apply thewindow lining and panel parameter. If not provided, the profile of the IfcOpeningElement is taken. FootPrint: A ‘GeometricCurveSet’, or ‘Annotation2D’ representation defining the 2D shape of thewindow Body: A ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’ representation defining the 3D shape of thewindow.

In addition the parametric representation of a (limited)window shape is available by applying the parameters fromIfcWindowType referencingIfcWindowLiningProperties andIfcWindowPanelProperties. The purpose of the parameter is described at those entities and below (parametric representation). Profile -‘Curve3D’ representation Thewindow profile is represented by a three-dimensional closed curve within a particular shape representation. The profile is used to apply the parameter of the parametricwindow representation.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Profile’ RepresentationType : ‘Curve3D’, only a single closed curve shall be contained in the set of IfcShapeRepresentation.Items.

A ‘Profile’ representation has to be provided if:

a parametric representation shall be applied to the windowAND

the window is ‘free standing’, or the opening into which the window is inserted is not extruded horizontally (i.e. where the opening profile does not match the window profile)

FootPrint -‘GeometricCurveSet’ or ‘Annotation2D’ representation Thewindow foot print is represented by a set of two-dimensionalcurves (or in case of ‘Annotation2D’ additional hatching and text) within a particular shape representation. The foot print is used for the plan view representation of thewindow.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’ RepresentationType : ‘GeometricCurveSet’, or ‘Annotation2D’

Body - ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’ representation Thewindow body is either represented parameterically (see parametric representation) or by explicit 3D shape. The 3D shape is given by using extrusion geometry, or surface models, or Brep models within a particular shape representation. The body is used for the model view representation of thewindow.The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘Body’ RepresentationType : ‘SweptSolid’, ‘SurfaceModel’, or ‘Brep’

MappedRepresentation The ‘FootPrint’ and ‘Body’ geometric representation ofIfcWindow can be shared among several identicalwindows using the ‘MappedRepresentation’. The following attribute values for the IfcShapeRepresentation holding this geometric representation shall be used:

RepresentationIdentifier : ‘FootPrint’, ‘Body’ RepresentationType : ‘MappedRepresentation’

The same constraints, as given for the ‘FootPrint’, ‘Body’ representation identifiers, shall apply to the MappedRepresentation of the IfcRepresentationMap. Parameteric Representation using parameters at IfcWindowType The parameters, which define the shape of the IfcWindow, are given at the IfcWindowType and the property sets, which are included in the IfcWindowType. The IfcWindow only defines the local placement. The overall size of the IfcWindow to be used to apply the lining or panel parameter provided by the IfcWindowType is determined by the IfcShapeRepresentation with the RepresentationIdentifier = ‘Profile’. Only in case of an IfcWindow inserted into an IfcOpeningElement using the IfcRelFillsElement relatioship, having a horizontal extrusion (along the y-axis of the IfcDoor), the overall size is determined by the extrusion profile of the IfcOpeningElement.

Figure 142 illustrates the insertion of a window into the IfcOpeningElement by creating an instance of IfcWindow with PartitioningType = DoublePanelHorizontal. The parameters OverallHeight and OverallWidth show the extent of the window in the positive Z and X axis of the local placement of the window. The lining and the transom are created by the given parameters.

Figure 142 — Window placement

Figure 143 illustrates the final window (DoublePanelHorizontal) with first panel having PanelPosition = TOP, OperationType = BOTTOMHUNG and second panel having PanelPosition = BOTTOM and OperationType = TILTANDTURNLEFTHAND.

Figure 143 — Window planes

Window opening operation by window type The parameters that defines the shape of the IfcWindow, are given 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 of the IfcWindow is determined by itsIfcWindowType.PartitioningType. Each window panel has its own operation type, provided by IfcWindowPanelProperties.OperationType. All window panels are assumed to open into the same direction (if relevant for the particular window panel operation. The hindge side (whether a window opens to the left or to the right) is determined by the IfcWindowPanelProperties.OperationType. NOTE There are different conventions in different countries on how to show the symbolic presentation of the window panel operation (the “triangles”). Either as seen from the exterior, or from the interior side. The following figures show the symbolics from the exterior side (the convention as used predominately in Europe).

Figure 144 illustrates window operation types.

The window panel (for side hung windows) opens always into the direction of the positive Y axis of the local placement. The determination of whether the window opens to the left or to the right is done at IfcWindowPanelProperties.OperationType. Here it is a left side opening window given byOperationType = SideHungLeftHand.

If the window should open to the other side, then the local placement has to be changed. It is still a left hung window, given by IfcWindowPanelProperties.OperationType =SideHungLeftHand.

If the window panel (for side hung windows) opens to the right, a separate window panel style needs to be used (here IfcWindowPanelProperties.OperationType =SideHungRightHand) and it always opens into the direction of the positive Y axis of the local placement.

If the window should open to the other side, then the local placement has to be changed. It is still a right hung window, given by IfcWindowPanelProperties.OperationType =SideHungRightHand. Figure 144 — Window operations

Public Types

typedef IfcTemplatedEntityList<IfcWindow> list

Public Functions

bool hasOverallHeight() const

Whether the optional attribute OverallHeight is defined for this IfcWindow.

double OverallHeight() const

Overall measure of the height, it reflects the Z Dimension of a bounding box, enclosing the body of the window opening. If omitted, the OverallHeight should be taken from the geometric representation of the IfcOpening in which the window is inserted.

NOTE The body of the window might be taller then the window opening (e.g. in cases where the window lining includes a casing). In these cases the OverallHeight shall still be given as the window opening height, and not as the total height of the window lining.

void setOverallHeight(double v)
bool hasOverallWidth() const

Whether the optional attribute OverallWidth is defined for this IfcWindow.

double OverallWidth() const

Overall measure of the width, it reflects the X Dimension of a bounding box, enclosing the body of the window opening. If omitted, the OverallWidth should be taken from the geometric representation of the IfcOpening in which the window is inserted.

NOTE The body of the window might be wider then the window opening (e.g. in cases where the window lining includes a casing). In these cases the OverallWidth shall still be given as the window opening width, and not as the total width of the window lining.

void setOverallWidth(double v)
const IfcParse::entity &declaration() const
IfcWindow(IfcEntityInstanceData *e)
IfcWindow(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, ::Ifc2x3::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc2x3::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<double> v9_OverallHeight, boost::optional<double> v10_OverallWidth)

Public Static Functions

const IfcParse::entity &Class()
class IfcWindowLiningProperties : public Ifc2x3::IfcPropertySetDefinition

The window lining is the outer frame which enables the window to be fixed in position. The window lining is used to hold the window panels or other casements. The parameter of the IfcWindowLiningProperties define the geometrically relevant parameter of the lining.

NOTE The IfcWindowLiningProperties shall only be applied to construct the 3D shape of a window, if the attribute IfcWindowStyle.ParameterTakesPrecedence is set TRUE.

The IfcWindowLiningProperties are included in the set of properties of IfcWindowStyle.HasPropertySets. More information about the window lining can be included in the same set of the IfcWindowStyle using another IfcPropertySet for dynamic extensions.

HISTORY New Entity in IFC Release 2.0. Has been renamed from IfcWindowLining in IFC Release 2x.

IFC2x4 CHANGE The following attributes have been added LiningOffset, LiningToPanelOffsetX, LiningToPanelOffsetY. The attribute ShapeAspectStyle is deprecated and shall no longer be used. Supertype changed to new IfcPreDefinedPropertySet.

Geometry use definitions The IfcWindowLiningProperties does not hold a geometric representation. However it defines parameters which can be used to create the shape of the window style (which is inserted by the IfcWindow into the spatial context of the project) as shown in Figure 175. The parameters at the IfcWindowLiningProperties define a standard window lining, including (if given) a mullion and a transom (for horizontal and vertical splits). The outer boundary of the lining is determined by the occurrence parameter assigned to the IfcWindow, which inserts the IfcWindowStyle.

The lining is applied to all faces of the opening reveal. The parameter are:

LiningDepth LiningThickness LiningOffset LiningToPanelOffsetX LiningToPanelOffsetY

NOTE Parameters added in IFC2x4.

Inner side is defined as the direction of the window panel opening operation.

If the OperationType of the window style is

DoublePanelVertical (shown) TriplePanelBottom TriplePanelTop TriplePanelLeft TriplePanelRight

the following additional parameter apply:

MullionThickness FirstMullionOffset - measured as offset to the Z axis (in XZ plane)

If the OperationType of the window style is

DoublePanelHorizontal TriplePanelBottom TriplePanelTop TriplePanelLeft TriplePanelRight

the following additional parameter apply

TransomThickness FirstTransomOffset measured as offset to the X axis (in XZ plane)

If the OperationType of the window style is

TriplePanelVertical

the following additional parameter apply

SecondMullionOffset

If the OperationType of the window style is

TriplePanelHorizontal

the following additional parameter apply

SecondTransomOffset

Figure 175 — Window lining properties

NOTE

All offsets are given as a normalized ratio measure.

Public Functions

bool hasLiningDepth() const

Whether the optional attribute LiningDepth is defined for this IfcWindowLiningProperties.

double LiningDepth() const

Depth of the window lining (dimension measured perpendicular to window elevation plane).

void setLiningDepth(double v)
bool hasLiningThickness() const

Whether the optional attribute LiningThickness is defined for this IfcWindowLiningProperties.

double LiningThickness() const

Thickness of the window lining (measured parallel to the window elevation plane).

void setLiningThickness(double v)
bool hasTransomThickness() const

Whether the optional attribute TransomThickness is defined for this IfcWindowLiningProperties.

double TransomThickness() const

Thickness of the transom (horizontal separator of window panels within a window), measured parallel to the window elevation plane. The transom is part of the lining and the transom depth is assumed to be identical to the lining depth.

void setTransomThickness(double v)
bool hasMullionThickness() const

Whether the optional attribute MullionThickness is defined for this IfcWindowLiningProperties.

double MullionThickness() const

Thickness of the mullion (vertical separator of window panels within a window), measured parallel to the window elevation plane. The mullion is part of the lining and the mullion depth is assumed to be identical to the lining depth.

void setMullionThickness(double v)
bool hasFirstTransomOffset() const

Whether the optional attribute FirstTransomOffset is defined for this IfcWindowLiningProperties.

double FirstTransomOffset() const

Offset of the transom centerline, measured along the z-axis of the window placement co-ordinate system. An offset value = 0.5 indicates that the transom is positioned in the middle of the window.

void setFirstTransomOffset(double v)
bool hasSecondTransomOffset() const

Whether the optional attribute SecondTransomOffset is defined for this IfcWindowLiningProperties.

double SecondTransomOffset() const

Offset of the transom centerline for the second transom, measured along the x-axis of the window placement co-ordinate system. An offset value = 0.666 indicates that the second transom is positioned at two/third of the window.

void setSecondTransomOffset(double v)
bool hasFirstMullionOffset() const

Whether the optional attribute FirstMullionOffset is defined for this IfcWindowLiningProperties.

double FirstMullionOffset() const

Offset of the mullion centerline, measured along the x-axis of the window placement co-ordinate system. An offset value = 0.5 indicates that the mullion is positioned in the middle of the window.

void setFirstMullionOffset(double v)
bool hasSecondMullionOffset() const

Whether the optional attribute SecondMullionOffset is defined for this IfcWindowLiningProperties.

double SecondMullionOffset() const

Offset of the mullion centerline for the second mullion, measured along the x-axis of the window placement co-ordinate system. An offset value = 0.666 indicates that the second mullion is positioned at two/third of the window.

void setSecondMullionOffset(double v)
bool hasShapeAspectStyle() const

Whether the optional attribute ShapeAspectStyle is defined for this IfcWindowLiningProperties.

::Ifc2x3::IfcShapeAspect *ShapeAspectStyle() const

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 lining.

IFC2x4 CHANGE The attribute is deprecated and shall no longer be used, i.e. the value shall be NIL ($).

void setShapeAspectStyle(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcWindowLiningProperties(IfcEntityInstanceData *e)
IfcWindowLiningProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<double> v5_LiningDepth, boost::optional<double> v6_LiningThickness, boost::optional<double> v7_TransomThickness, boost::optional<double> v8_MullionThickness, boost::optional<double> v9_FirstTransomOffset, boost::optional<double> v10_SecondTransomOffset, boost::optional<double> v11_FirstMullionOffset, boost::optional<double> v12_SecondMullionOffset, ::Ifc2x3::IfcShapeAspect *v13_ShapeAspectStyle)

Public Static Functions

const IfcParse::entity &Class()
struct IfcWindowPanelOperationEnum

Public Types

enum Value

This enumeration defines the basic ways to describe how window panels operate, as shown in Figure 168.

HISTORY New Enumeration in IFC Release 2.0

Enumerator Description Figure

SideHungRightHand panel that opens to the right when viewed from the outside

SideHungLeftHand panel that opens to the left when viewed from the outside

TiltAndTurnRightHand panel that opens to the right and is bottom hung

TiltAndTurnLeftHand panel that opens to the left and is bottom hung

TopHung panel is top hung

BottomHung panel is bottom hung

PivotHorizontal panel is swinging horizontally (hinges are in the middle)

PivotVertical panel is swinging vertically (hinges are in the middle)

SlidingHorizontal panel is sliding horizontally

SlidingVertical panel is sliding vertically

RemovableCasement panel is removable

FixedCasement panel is fixed

OtherOperation user defined operation type

NotDefined

Figure 168 — Window panel operations

The opening direction of the window panels is given by the local placement of the IfcWindow. The positive y-axis determines the direction as shown in Figure 169. NOTE

Figures are shown as viewed from the outside (in direction of the positive y-axis). Figures (symbolic representation) depend on the national building code These figures are only shown as illustrations

Figure 169 — Window panel directions

Values:

enumerator IfcWindowPanelOperation_SIDEHUNGRIGHTHAND
enumerator IfcWindowPanelOperation_SIDEHUNGLEFTHAND
enumerator IfcWindowPanelOperation_TILTANDTURNRIGHTHAND
enumerator IfcWindowPanelOperation_TILTANDTURNLEFTHAND
enumerator IfcWindowPanelOperation_TOPHUNG
enumerator IfcWindowPanelOperation_BOTTOMHUNG
enumerator IfcWindowPanelOperation_PIVOTHORIZONTAL
enumerator IfcWindowPanelOperation_PIVOTVERTICAL
enumerator IfcWindowPanelOperation_SLIDINGHORIZONTAL
enumerator IfcWindowPanelOperation_SLIDINGVERTICAL
enumerator IfcWindowPanelOperation_REMOVABLECASEMENT
enumerator IfcWindowPanelOperation_FIXEDCASEMENT
enumerator IfcWindowPanelOperation_OTHEROPERATION
enumerator IfcWindowPanelOperation_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcWindowPanelPositionEnum

Public Types

enum Value

This enumeration defines the basic configuration of the window type in terms of the location of window panels. The window configurations are given for windows with one, two or three panels (including fixed panels) as shown in Figure 170. It corresponds to the OperationType of the IfcWindowStyle definition, which references the IfcWindowPanelProperties.

Windows which are subdivided into more than three panels have to be defined by the geometry only. The type of such windows is given by an IfcWindowStyle.OperationType = USERDEFINED or NOTDEFINED (see IfcWindowStyleOperationEnum for details).

HISTORY New Enumeration in IFC Release 2.0.

Enumerator from IfcWindowStyleOperationEnum Use of enumerators from IfcWindowPanelPositionEnum Figure

DoublePanelVertical first IfcWindowPanelProperties with PanelPosition = LEFTsecond IfcWindowPanelProperties with PanelPosition = RIGHT

DoublePanelHorizontal first IfcWindowPanelProperties with PanelPosition = TOPsecond IfcWindowPanelProperties with PanelPosition = BOTTOM

TriplePanelVertical first IfcWindowPanelProperties with PanelPosition = LEFTsecond IfcWindowPanelProperties with PanelPosition = MIDDLEthird IfcWindowPanelProperties with PanelPosition = RIGHT

TriplePanelHorizontal

first

IfcWindowPanelProperties with PanelPosition = TOPsecond IfcWindowPanelProperties with PanelPosition = MIDDLEthird IfcWindowPanelProperties with PanelPosition = BOTTOM

TriplePanelBottom first IfcWindowPanelProperties with PanelPosition = LEFTsecond IfcWindowPanelProperties with PanelPosition = RIGHTthird IfcWindowPanelProperties with PanelPosition = BOTTOM

TriplePanelTop first IfcWindowPanelProperties with PanelPosition = TOPsecond IfcWindowPanelProperties with PanelPosition = LEFTthird IfcWindowPanelProperties with PanelPosition = RIGHT

TriplePanelLeft first IfcWindowPanelProperties with PanelPosition = LEFTsecond IfcWindowPanelProperties with PanelPosition = TOPthird IfcWindowPanelProperties with PanelPosition = BOTTOM

TriplePanelRight first IfcWindowPanelProperties with PanelPosition = TOPsecond IfcWindowPanelProperties with PanelPosition = BOTTOMthird IfcWindowPanelProperties with PanelPosition = RIGHT

Figure 170 — Window panel positions

NOTE

The figures are shown as elevations in the XZ plane of the local placement of the window, looking into the direction of the positive Y axis. These figures are only shown as illustrations.

Values:

enumerator IfcWindowPanelPosition_LEFT
enumerator IfcWindowPanelPosition_MIDDLE
enumerator IfcWindowPanelPosition_RIGHT
enumerator IfcWindowPanelPosition_BOTTOM
enumerator IfcWindowPanelPosition_TOP
enumerator IfcWindowPanelPosition_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcWindowPanelProperties : public Ifc2x3::IfcPropertySetDefinition

A window panel is a casement, that is, a component, fixed or opening, consisting essentially of a frame and the infilling. The infilling of a window panel is normally glazing. The way of operation is defined in the operation type. The IfcWindowPanelProperties are used to parametrically describe the shape and operation of window panels. The parametric definition can be added solely or additionally to the explicit shape representation of the window. The IfcWindowStyle can define windows consisting of more then one panel. In this case, one instance of IfcWindowPanelProperties has to be included for each window panel. The PanelPosition attribute, in conjunction with the IfcWindowStyle.OperationType attribute, determines to which panel the IfcWindowPanelProperties apply. The IfcWindowPanelProperties are included in the list of properties (HasPropertySets) of the IfcWindowStyle. More information about the window panel can be included in the same list of the IfcWindowStyle using the IfcPropertySet for dynamic extensions.

HISTORY New entity in IFC Release 2.0, it had been renamed from IfcWindowPanel in IFC Release 2x.

IFC2x4 CHANGE Supertype changed to new IfcPreDefinedPropertySet.

Geometry use definitions The IfcWindowPanelProperties does not hold an own geometric representation. However it defines parameter, which can be used to create the shape of the IfcWindowStyle (which is inserted by the IfcWindow into the spatial context of the project). The parameters at the IfcWindowPanelProperties define a standard window panel. The outer boundary of the panel is determined by the occurrence parameter assigned to the IfcWindow, which inserts the IfcWindowStyle. It has to take the lining parameter into account as well. The position of the window panel within the overall window is determined by the PanelPosition attribute.

As shown in Figure 176, the panel is applied to the position within the lining as defined by the panel position attribute. The following parameter apply to that panel: FrameDepth, FrameThickness.

Figure 176 — Window panel properties

Public Functions

::Ifc2x3::IfcWindowPanelOperationEnum::Value OperationType() const

Types of window panel operations. Also used to assign standard symbolic presentations according to national building standards.

void setOperationType(::Ifc2x3::IfcWindowPanelOperationEnum::Value v)
::Ifc2x3::IfcWindowPanelPositionEnum::Value PanelPosition() const

Position of this panel within the overall window style.

void setPanelPosition(::Ifc2x3::IfcWindowPanelPositionEnum::Value v)
bool hasFrameDepth() const

Whether the optional attribute FrameDepth is defined for this IfcWindowPanelProperties.

double FrameDepth() const

Depth of panel frame, measured from front face to back face horizontally (i.e. perpendicular to the window (elevation) plane.

void setFrameDepth(double v)
bool hasFrameThickness() const

Whether the optional attribute FrameThickness is defined for this IfcWindowPanelProperties.

double FrameThickness() const

Width of panel frame, measured from inside of panel (at glazing) to outside of panel (at lining), i.e. parallel to the window (elevation) plane.

void setFrameThickness(double v)
bool hasShapeAspectStyle() const

Whether the optional attribute ShapeAspectStyle is defined for this IfcWindowPanelProperties.

::Ifc2x3::IfcShapeAspect *ShapeAspectStyle() const

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 panel.

IFC2x4 CHANGE The attribute is deprecated and shall no longer be used, i.e. the value shall be NIL ($).

void setShapeAspectStyle(::Ifc2x3::IfcShapeAspect *v)
const IfcParse::entity &declaration() const
IfcWindowPanelProperties(IfcEntityInstanceData *e)
IfcWindowPanelProperties(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc2x3::IfcWindowPanelOperationEnum::Value v5_OperationType, ::Ifc2x3::IfcWindowPanelPositionEnum::Value v6_PanelPosition, boost::optional<double> v7_FrameDepth, boost::optional<double> v8_FrameThickness, ::Ifc2x3::IfcShapeAspect *v9_ShapeAspectStyle)

Public Static Functions

const IfcParse::entity &Class()
class IfcWindowStyle : public Ifc2x3::IfcTypeProduct

Definition: The window style defines a particular style of windows, which may be included into the spatial context of the building model through instances of IfcWindow. A window style defines the overall parameter of the window style and refers to the particular parameter of the lining and one (or several) panels through IfcWindowLiningProperties and IfcWindowPanelProperties.

The window entity (IfcWindow) defines a particular occurrence of a window inserted in the spatial context of a project. The actual parameter of the window and/or its shape is defined at the IfcWindowStyle, to which the IfcWindow related by the inverse relationship IsDefinedBy pointing to IfcRelDefinesByType. The IfcWindowStyle also defines the particular attributes for the lining (IfcWindowLiningProperties) and panels (IfcWindowPanelProperties).

HISTORY New entity in IFC Release 2x.

IFC2x4 CHANGE The entity has been deprecated and shall not be used. The new entity IfcWindowType shall be used instead.

Geometry use definitions The IfcWindowStyle defines the baseline geometry, or the representation map, for all occurrences of the window style, given by the IfcWindow, pointing to this style. The representation of the window style may be given by the agreed set of minimal parameters, defined for the window lining and the window panel(s), or it may be given by a geometric representation used by the IfcRepresentationMap. The attribute ParameterTakesPrecedence decides, whether the set of parameters can be used to exactly represent the shape of the window style (TRUE), or whether the attached IfcRepresentationMap holds the exact representation (FALSE).

The IfcWindowStyleOperationTypeEnum defines the general layout of the window style. Depending on the enumerator, the appropriate instances of IfcWindowLiningProperties and IfcWindowPanelProperties are attached in the list of HasPropertySets. See geometry use definitions there.

Public Types

typedef IfcTemplatedEntityList<IfcWindowStyle> list

Public Functions

::Ifc2x3::IfcWindowStyleConstructionEnum::Value ConstructionType() const

Type defining the basic construction and material type of the window.

void setConstructionType(::Ifc2x3::IfcWindowStyleConstructionEnum::Value v)
::Ifc2x3::IfcWindowStyleOperationEnum::Value OperationType() const

Type defining the general layout and operation of the window style.

void setOperationType(::Ifc2x3::IfcWindowStyleOperationEnum::Value v)
bool ParameterTakesPrecedence() const

The Boolean value reflects, whether the parameter given in the attached lining and panel properties exactly define the geometry (TRUE), or whether the attached style shape take precedence (FALSE). In the last case the parameter have only informative value.

void setParameterTakesPrecedence(bool v)
bool Sizeable() const

The Boolean indicates, whether the attached ShapeStyle can be sized (using scale factor of transformation), or not (FALSE). If not, the ShapeStyle should be inserted by the IfcWindow (using IfcMappedItem) with the scale factor = 1.

void setSizeable(bool v)
const IfcParse::entity &declaration() const
IfcWindowStyle(IfcEntityInstanceData *e)
IfcWindowStyle(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ApplicableOccurrence, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPropertySetDefinition>::ptr> v6_HasPropertySets, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcRepresentationMap>::ptr> v7_RepresentationMaps, boost::optional<std::string> v8_Tag, ::Ifc2x3::IfcWindowStyleConstructionEnum::Value v9_ConstructionType, ::Ifc2x3::IfcWindowStyleOperationEnum::Value v10_OperationType, bool v11_ParameterTakesPrecedence, bool v12_Sizeable)

Public Static Functions

const IfcParse::entity &Class()
struct IfcWindowStyleConstructionEnum

Public Types

enum Value

Definition from IAI: This enumeration defines the basic types of construction of windows. The construction type relates to the main material (or material combination) used for making the window.

HISTORY New Enumeration in IFC Release 2x .

Values:

enumerator IfcWindowStyleConstruction_ALUMINIUM
enumerator IfcWindowStyleConstruction_HIGH_GRADE_STEEL
enumerator IfcWindowStyleConstruction_STEEL
enumerator IfcWindowStyleConstruction_WOOD
enumerator IfcWindowStyleConstruction_ALUMINIUM_WOOD
enumerator IfcWindowStyleConstruction_PLASTIC
enumerator IfcWindowStyleConstruction_OTHER_CONSTRUCTION
enumerator IfcWindowStyleConstruction_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
struct IfcWindowStyleOperationEnum

Public Types

enum Value

This enumeration defines the basic configuration of the window type in terms of the number of window panels and the subdivision of the total window. The window configurations are given for windows with one, two or three panels (including fixed panels) as shown in Figure 171. Windows which are subdivided into more than three panels have to be defined by the geometry only. The type of such windows is USERDEFINED. HISTORY New Enumeration in IFC Release 2.0.

Enumerator Description Figure

SinglePanel Window with one panel.

DoublePanelVertical Window with two panels. The configuration of the panels is vertically.

DoublePanelHorizontal Window with two panels. The configuration of the panels is horizontally.

TriplePanelVertical Window with three panels. The configuration of the panels is vertically.

TriplePanelHorizontal

Window with three panels. The configuration of the panels is horizontally.

TriplePanelBottom Window with three panels. The configuration of two panels is vertically and the third one is horizontally at the bottom.

TriplePanelTop Window with three panels. The configuration of two panels is vertically and the third one is horizontally at the top.

TriplePanelLeft Window with three panels. The configuration of two panels is horizontally and the third one is vertically at the left hand side.

TriplePanelRight Window with three panels. The configuration of two panels is horizontally and the third one is vertically at the right hand side.

UserDefined user defined operation type

NotDefined

Figure 171 — Window style operations

NOTE

The way how each panel operates is defined at the IfcWindowPanelProperties.OperationType. The reference from the window panel to the location of that panel in the window style configuration is handled by the IfcWindowPanelProperties.PanelPosition. The figures are shown as elevations in the XZ plane of the local placement of the window, looking into the direction of the positive Y axis. These figures are only shown as illustrations

Values:

enumerator IfcWindowStyleOperation_SINGLE_PANEL
enumerator IfcWindowStyleOperation_DOUBLE_PANEL_VERTICAL
enumerator IfcWindowStyleOperation_DOUBLE_PANEL_HORIZONTAL
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_VERTICAL
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_BOTTOM
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_TOP
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_LEFT
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_RIGHT
enumerator IfcWindowStyleOperation_TRIPLE_PANEL_HORIZONTAL
enumerator IfcWindowStyleOperation_USERDEFINED
enumerator IfcWindowStyleOperation_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcWorkControl : public Ifc2x3::IfcControl

An IfcWorkControl is an abstract supertype which captures information that is common to both IfcWorkPlan and IfcWorkSchedule.

HISTORY New class in IFC 2x

CHANGE IFC2x4 Corrected assignment of resources to work control in documentation. Assignment of tasks to work control updated based on changes of task time definitions and the introduction of a summary task. Identifier has been renamed (now Identification) and promoted to supertype IfcControl

A work control may have resources assigned to it, this is handled by the IfcRelAssignsToControl relationship. A work control should also define a context that gives further information about its usage. If no special context information is required then the IfcProject instance as a global context should be used instead. An explicit link between the work control and the IfcProject via IfcRelDeclares should then be provided.

From IFC2x4 onwards the assignment of tasks to the work control is handled by the IfcRelAssignsToControl relationship. IfcRelAssignsTasks as used in previous IFC releases has been deleted and can not be used any longer. Another change in IFC2x4 is that it is not necessary to assign each task to a work control as it is regarded to be sufficient if the summary task (root task in the task hierarchy defined through IfcRelNests relationships) is assigned to a work control.

The attribute IfcWorkControl.Purpose is used to define the purpose of either a work schedule or a work plan. In the case of IfcWorkPlan, the purpose attribute can be used to determine if the work plan is for cost estimating, task scheduling or some other defined purpose.

Property set use definition

The property sets relating to the IfcWorkControl are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definition specific to the IfcWorkControl and its subtype are part of this IFC release:

Pset_WorkControlCommon: common property set for work control

Subclassed by Ifc2x3::IfcWorkPlan, Ifc2x3::IfcWorkSchedule

Public Types

typedef IfcTemplatedEntityList<IfcWorkControl> list

Public Functions

std::string Identifier() const
void setIdentifier(std::string v)
::Ifc2x3::IfcDateTimeSelect *CreationDate() const

The date that the plan is created.

void setCreationDate(::Ifc2x3::IfcDateTimeSelect *v)
bool hasCreators() const

Whether the optional attribute Creators is defined for this IfcWorkControl.

IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr Creators() const

The authors of the work plan.

void setCreators(IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr v)
bool hasPurpose() const

Whether the optional attribute Purpose is defined for this IfcWorkControl.

std::string Purpose() const

A description of the purpose of the work schedule.

void setPurpose(std::string v)
bool hasDuration() const

Whether the optional attribute Duration is defined for this IfcWorkControl.

double Duration() const

The total duration of the entire work schedule.

void setDuration(double v)
bool hasTotalFloat() const

Whether the optional attribute TotalFloat is defined for this IfcWorkControl.

double TotalFloat() const

The total time float of the entire work schedule.

void setTotalFloat(double v)
::Ifc2x3::IfcDateTimeSelect *StartTime() const

The start time of the schedule.

void setStartTime(::Ifc2x3::IfcDateTimeSelect *v)
bool hasFinishTime() const

Whether the optional attribute FinishTime is defined for this IfcWorkControl.

::Ifc2x3::IfcDateTimeSelect *FinishTime() const

The finish time of the schedule.

void setFinishTime(::Ifc2x3::IfcDateTimeSelect *v)
bool hasWorkControlType() const

Whether the optional attribute WorkControlType is defined for this IfcWorkControl.

::Ifc2x3::IfcWorkControlTypeEnum::Value WorkControlType() const
void setWorkControlType(::Ifc2x3::IfcWorkControlTypeEnum::Value v)
bool hasUserDefinedControlType() const

Whether the optional attribute UserDefinedControlType is defined for this IfcWorkControl.

std::string UserDefinedControlType() const
void setUserDefinedControlType(std::string v)
const IfcParse::entity &declaration() const
IfcWorkControl(IfcEntityInstanceData *e)
IfcWorkControl(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_Identifier, ::Ifc2x3::IfcDateTimeSelect *v7_CreationDate, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr> v8_Creators, boost::optional<std::string> v9_Purpose, boost::optional<double> v10_Duration, boost::optional<double> v11_TotalFloat, ::Ifc2x3::IfcDateTimeSelect *v12_StartTime, ::Ifc2x3::IfcDateTimeSelect *v13_FinishTime, boost::optional<::Ifc2x3::IfcWorkControlTypeEnum::Value> v14_WorkControlType, boost::optional<std::string> v15_UserDefinedControlType)

Public Static Functions

const IfcParse::entity &Class()
struct IfcWorkControlTypeEnum

Public Types

enum Value

Values:

enumerator IfcWorkControlType_ACTUAL
enumerator IfcWorkControlType_BASELINE
enumerator IfcWorkControlType_PLANNED
enumerator IfcWorkControlType_USERDEFINED
enumerator IfcWorkControlType_NOTDEFINED

Public Static Functions

IFC_PARSE_API const char *ToString(Value v)
IFC_PARSE_API Value FromString(const std::string &s)
class IfcWorkPlan : public Ifc2x3::IfcWorkControl

An IfcWorkPlan represents work plans in a construction or a facilities management project.

HISTORY: New Entity in IFC 2.0

A work plan contains a set of work schedules for different purposes (including construction and facilities management). Contained work schedules are defined through the IfcRelAggregates relationship. Through inheritance from IfcWorkControl it is also possible to define references to activities (for example, IfcTask) and resources used in the work plan.

A work plan has information such as start date, finish date, total free float, and so on. IfcWorkPlan can also refer to the construction project represented by the single IfcProject instance (please also check the definition of IfcWorkControl).

Figure 18 shows the backbone structure of a work plan that defines (1) contained work schedules through IfcRelAggregates and (2), if not assigned otherwise to contained work schedules, assigned tasks and resources through IfcRelAssignsToControl.

Figure 18 — Work plan relationships

Public Types

typedef IfcTemplatedEntityList<IfcWorkPlan> list

Public Functions

const IfcParse::entity &declaration() const
IfcWorkPlan(IfcEntityInstanceData *e)
IfcWorkPlan(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_Identifier, ::Ifc2x3::IfcDateTimeSelect *v7_CreationDate, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr> v8_Creators, boost::optional<std::string> v9_Purpose, boost::optional<double> v10_Duration, boost::optional<double> v11_TotalFloat, ::Ifc2x3::IfcDateTimeSelect *v12_StartTime, ::Ifc2x3::IfcDateTimeSelect *v13_FinishTime, boost::optional<::Ifc2x3::IfcWorkControlTypeEnum::Value> v14_WorkControlType, boost::optional<std::string> v15_UserDefinedControlType)

Public Static Functions

const IfcParse::entity &Class()
class IfcWorkSchedule : public Ifc2x3::IfcWorkControl

An IfcWorkSchedule represents a task schedule of a work plan, which in turn can contain a set of schedules for different purposes.

HISTORY: New Entity in IFC Release 2.0

Assignment Use Definition

An IfcWorkSchedule controls a set of tasks and resources defined through IfcRelAssignsToControl. Additionally, through the IfcWorkControl abstract supertype, the actors creating the schedule can be specified and schedule time information such as start time, finish time, and total float of the schedule can also be specified.

Declaration Use Definition

IfcWorkSchedule can reference a project (the single IfcProject instance) via IfcRelDeclares. The documents of the IfcWorkSchedule can be referenced by the IfcRelAssociatesDocuments relationship.

Composition Use Definition A work schedule can include other work schedules as sub-items through IfcRelNests relationship. If not included in another work schedule it might be a part of a work plan (IfcWorkPlan) defined through IfcRelAggregates relationship.

Figure 19 shows the backbone structure of a work schedule that defines (1) a context through IfcRelDeclares (not necessarily the project) and (2) controls tasks (typically the schedule summary task) and resources. Please note that a work calendar shall be assigned to the summary task and not the work schedule.

Figure 19 — Work schedule relationships

Public Types

typedef IfcTemplatedEntityList<IfcWorkSchedule> list

Public Functions

const IfcParse::entity &declaration() const
IfcWorkSchedule(IfcEntityInstanceData *e)
IfcWorkSchedule(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, std::string v6_Identifier, ::Ifc2x3::IfcDateTimeSelect *v7_CreationDate, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcPerson>::ptr> v8_Creators, boost::optional<std::string> v9_Purpose, boost::optional<double> v10_Duration, boost::optional<double> v11_TotalFloat, ::Ifc2x3::IfcDateTimeSelect *v12_StartTime, ::Ifc2x3::IfcDateTimeSelect *v13_FinishTime, boost::optional<::Ifc2x3::IfcWorkControlTypeEnum::Value> v14_WorkControlType, boost::optional<std::string> v15_UserDefinedControlType)

Public Static Functions

const IfcParse::entity &Class()
class IfcYearNumber : public IfcUtil::IfcBaseType

Public Functions

const IfcParse::type_declaration &declaration() const
IfcYearNumber(IfcEntityInstanceData *e)
IfcYearNumber(int v)
operator int() const

Public Static Functions

const IfcParse::type_declaration &Class()
class IfcZone : public Ifc2x3::IfcGroup

Definition from IAI: A zone isa group of spaces, partial spaces or other zones. Zone structures may not be hierarchical (in contrary to the spatial structure of a project - see IfcSpatialStructureElement), i.e. one individual IfcSpace may be associated with zero, one, or several IfcZone’s. IfcSpace’s are grouped into an IfcZone by using the objectified relationship IfcRelAssignsToGroup as specified at the supertype IfcGroup. NOTE Certain use cases may restrict the freedom of non hierarchical relationships. In some building service use cases the zone denotes aview based delimited volume for the purpose of analysis and calculation. This type of zone cannot overlap with respect to that analysis, but may overlap otherwise. An IfcZone is a spatial system under which individual IfcSpace’s (and other IfcZone’s) are grouped. In contrary to the IfcSpatialZone entity, IfcZone is a mere grouping, it can not define an own geometric representation and placement. Therefore it cannot be used for spatial zones having a different shape and size compared to the shape and size of aggregated spaces. NOTE The IfcZone is regarded as the spatial system (as compared to the building service, electrical, or analytical system), the name remains IfcZone for compatibility reasons, instead of using a proper naming convention, like IfcSpatialSystem. NOTE One of the purposes of a zone is to define a fire compartmentation. In this case it defines the geometric information about the fire compartment (through the contained spaces) and information, whether this compartment is ventilated or sprinkler protected. In addition the fire risk code and the hazard type can be added, the coding is normally defined within a national fire regulation. All that information is available within the relevant property sets. Again, if an independent shape has to be provided to the fire compartment, then the entity IfcSpatialZone shall be used. RECOMMENDATION In case of a zone denoting a (fire) compartment, the following types should be used, if applicable, as values of the ObjectType attribute:

FireCompartment - a zone of spaces, collected to represent a single fire compartment. ElevatorShaft - a collection of spaces within an elevator, potentially going through many storeys. RisingDuct RunningDuct

Additional classifications of the IfcZone, as provided by a national classification system, can be assigned by using the IfcRelAssociatesClassification relationship, accessible via the inverse attribute HasAssociations. The IfcZone can be assigned to a spatial structure element, it refers to, e.g. to a particular IfcBuildingStorey by using the IfcRelServicesBuildings relationship, accessible via the inverse attribute ServicesBuilding. HISTORY New entity in IFC Release 1.0 IFC2x4 CHANGE The entity is now subtyped from IfcSystem (not its supertype IfcGroup) with upward compatibility for file based exchange. Property Set Use Definition: The property sets relating to the IfcZone are defined by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. It is accessible by the inverse IsDefinedBy relationship. The following property set definitions specific to the IfcZone are part of this IFC release:

Pset_ZoneCommon: common property set for all types of zone Pset_SpaceFireSafetyRequirements: common property set for all types of zones to capture the fire safety requirements Pset_SpaceLightingRequirements: common property set for all types of zones to capture the lighting requirements Pset_SpaceOccupancyRequirements: common property set for all types of zones to capture the occupancy requirements Pset_SpaceThermalRequirements: common property set for all types of zones to capture the thermal requirements

Public Types

typedef IfcTemplatedEntityList<IfcZone> list

Public Functions

const IfcParse::entity &declaration() const
IfcZone(IfcEntityInstanceData *e)
IfcZone(std::string v1_GlobalId, ::Ifc2x3::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType)

Public Static Functions

const IfcParse::entity &Class()
class IfcZShapeProfileDef : public Ifc2x3::IfcParameterizedProfileDef

IfcZShapeProfileDef defines a section profile that provides the defining parameters of a Z-shape section to be used by the swept area solid. Its parameters and orientation relative to the position coordinate system are according to the following illustration. The centre of the position coordinate system is in the profile’s centre of the bounding box.

HISTORY New entity in IFC2x2.

IFC2x Edition 4 CHANGE Type of FilletRadius and EdgeRadius relaxed to allow for zero radius.

Figure 328 illustrates parameters of the Z-shape profile definition.

Position The parameterized profile defines its own position coordinate system. The underlying coordinate system is defined by the swept area solid that uses the profile definition. It is the xy plane of:

IfcSweptAreaSolid.Position

By using offsets of the position location, the parameterized profile can be positioned centric (using x,y offsets = 0.), or at any position relative to the profile.

Figure 328 — Z-shape profile

Public Types

typedef IfcTemplatedEntityList<IfcZShapeProfileDef> list

Public Functions

double Depth() const

Web length, see illustration above (= h).

void setDepth(double v)
double FlangeWidth() const

Flange length, see illustration above (= b).

void setFlangeWidth(double v)
double WebThickness() const

Constant wall thickness of web, see illustration above (= ts).

void setWebThickness(double v)
double FlangeThickness() const

Constant wall thickness of flange, see illustration above (= tg).

void setFlangeThickness(double v)
bool hasFilletRadius() const

Whether the optional attribute FilletRadius is defined for this IfcZShapeProfileDef.

double FilletRadius() const

Fillet radius according the above illustration (= r1).

void setFilletRadius(double v)
bool hasEdgeRadius() const

Whether the optional attribute EdgeRadius is defined for this IfcZShapeProfileDef.

double EdgeRadius() const

Edge radius according the above illustration (= r2).

void setEdgeRadius(double v)
const IfcParse::entity &declaration() const
IfcZShapeProfileDef(IfcEntityInstanceData *e)
IfcZShapeProfileDef(::Ifc2x3::IfcProfileTypeEnum::Value v1_ProfileType, boost::optional<std::string> v2_ProfileName, ::Ifc2x3::IfcAxis2Placement2D *v3_Position, double v4_Depth, double v5_FlangeWidth, double v6_WebThickness, double v7_FlangeThickness, boost::optional<double> v8_FilletRadius, boost::optional<double> v9_EdgeRadius)

Public Static Functions

const IfcParse::entity &Class()