/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // This file is generated automatically. #ifndef _IFC4X4_IFCMATERIALLAYERSETUSAGE_AUTO_IMPL_H #define _IFC4X4_IFCMATERIALLAYERSETUSAGE_AUTO_IMPL_H #include "IfcMaterialUsageDefinitionAutoImpl.h" #include "IfcMaterialLayerSetAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X4 express schema definitions. */ namespace OdIfc4x4 { /** \details The 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 is compatible with the building element geometry (that is, material layers should fit inside the element geometry). The rules to ensure the compatibility depend on the type of the building element. The IfcMaterialLayerSetUsage is always assigned to an individual occurrence object (and only to relevant subtypes of IfcElement). The IfcMaterialLayerSet, referenced by ForLayerSet, can however be shared among several occurrence objects. If the element type is available (if an instance of the relevant subtype of IfcElementType exists), then the IfcMaterialLayerSet can be assigned to the element type. The assignment between a subtype of IfcElement and the IfcMaterialLayerSetUsage is handled by IfcRelAssociatesMaterial. - Attribute 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, for example to curved building elements, provided that the material layer thicknesses are constant. The image below shows an example of the use of IfcMaterialLayerSetUsage aligned to a slab: The image below shows an example of the use of IfcMaterialLayerSetUsage aligned to a roof slab with non-perpendicular extrusion: The image below shows an example of material layer set usage for roof slab: */ class IFC4X4_EXPORT IfcMaterialLayerSetUsage : public IfcMaterialUsageDefinition { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcMaterialLayerSetUsage); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of ForLayerSet attribute. This attribute represents the IfcMaterialLayerSet set to which the usage is applied. \returns Returns the value of ForLayerSet attribute. */ const OdDAIObjectId& getForLayerSet() const; /** \details Sets the value of ForLayerSet attribute. This attribute represents the IfcMaterialLayerSet set to which the usage is applied. \param ForLayerSet [in] ForLayerSet to set. */ void setForLayerSet(const OdDAIObjectId& ForLayerSet); /** \details Returns the value of LayerSetDirection attribute. This attribute represents orientation of the material layer set relative to element reference geometry. The meaning of the value of this attribute is specified in the geometry use section for each element. For extruded shape representation, direction can be specified along the extrusion path (e.g. for slabs) or perpendicular to it (e.g. for walls). \returns Returns the value of LayerSetDirection attribute. */ IfcLayerSetDirectionEnum getLayerSetDirection() const; /** \details Sets the value of LayerSetDirection attribute. This attribute represents orientation of the material layer set relative to element reference geometry. The meaning of the value of this attribute is specified in the geometry use section for each element. For extruded shape representation, direction can be specified along the extrusion path (e.g. for slabs) or perpendicular to it (e.g. for walls). \param LayerSetDirection [in] LayerSetDirection to set. */ void setLayerSetDirection(IfcLayerSetDirectionEnum LayerSetDirection); /** \details Returns the value of DirectionSense attribute. This attribute indicates 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. \returns Returns the value of DirectionSense attribute. */ IfcDirectionSenseEnum getDirectionSense() const; /** \details Sets the value of DirectionSense attribute. This attribute indicates 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. \param DirectionSense [in] DirectionSense to set. */ void setDirectionSense(IfcDirectionSenseEnum DirectionSense); /** \details Returns the value of OffsetFromReferenceLine attribute. This attribute represents 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). 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. \returns Returns the value of OffsetFromReferenceLine attribute. */ double getOffsetFromReferenceLine() const; /** \details Sets the value of OffsetFromReferenceLine attribute. This attribute represents 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). 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. \param OffsetFromReferenceLine [in] OffsetFromReferenceLine to set. */ void setOffsetFromReferenceLine(double OffsetFromReferenceLine); /** \details Returns the value of ReferenceExtent attribute. This attribute represents extent of the extrusion of the elements body shape representation to which the IfcMaterialLayerSetUsage applies. It is used as the reference value for the upper OffsetValues[2] provided by the IfcMaterialLayerSetWithOffsets subtype for included material layers. \returns Returns the value of ReferenceExtent attribute. */ double getReferenceExtent() const; /** \details Sets the value of ReferenceExtent attribute. This attribute represents extent of the extrusion of the elements body shape representation to which the IfcMaterialLayerSetUsage applies. It is used as the reference value for the upper OffsetValues[2] provided by the IfcMaterialLayerSetWithOffsets subtype for included material layers. \param ReferenceExtent [in] ReferenceExtent to set. */ void setReferenceExtent(double ReferenceExtent); public: /** \details Default constructor for the IfcMaterialLayerSetUsage class. */ IfcMaterialLayerSetUsage(); /** \details Reads object's data from the specified filer. \param rdFiler [in] Pointer to a filer from which to read the data. \returns A value of OdResult type that contains the result of the method execution. */ virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override; /** \details Writes object's data the the specified filer. \param wrFiler [in] Pointer to a filer to which to write the data. \returns A value of OdResult type that contains the result of the method execution. */ virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override; /** \details Returns a type of a class instance. \returns Pointer to the OdDAI::Entity type that determines an entity definition within a schema. */ virtual OdDAI::Entity* getInstanceType() const override; /** \details Returns an attribute value for the specified attribute name. \param attrName [in] Name of an attribute to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const char * attrName) const override; /** \details Early-bound version of instances comparison. \param pOther [in] Other application instance. \param ordering [out] Receives the ordering (comparison) status. \returns true if comparison was performed, false if method has no implementation, so late-bound version could be applied. \remarks If the method returns true, the ordering parameter can receive one of the following statuses: Name Value Description _kLessThan_ -1 This object < Other Object. _kEqual_ 0 This object = Other Object. _kGreaterThan_ 1 This object > Other Object. _kNotOrderable_ 2 This class is not orderable.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override; /** \details Resets a value for the specified attribute. \param explicitAttrName [in] Explicit name of the attribute to reset. */ virtual void unsetAttr(const char * explicitAttrName) override; /** \details Checks whether the specified attribute is set. \param explicitAttrName [in] Explicit name of the attribute to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const char * explicitAttrName) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrName [in] Explicit name of the attribute to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override; /** \details Checks whether the specified instance is the object derived from or belongs to this class. \param entityType [in] Entity to check. \returns true if the specified instance is the object derived from or belongs to this class, false otherwise. */ virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override; /** \details Returns the type of this entity. \returns A value of the OdIfc::OdIfcEntityType type that represents type of this entity. */ virtual OdIfc::OdIfcEntityType type() const override; /** \details Returns an attribute value for the specified attribute definition. \param attrDef [in] Attribute definition to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override; /** \details Resets a value for the specified attribute. \param explicitAttrDef [in] Explicit definition that represents an attribute to reset. */ virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override; /** \details Checks whether the specified attribute is set. \param explicitAttrDef [in] Attribute definition to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrDef [in] Explicit attribute definition to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override; protected: // Fields declaration: OdDAIObjectId m_ForLayerSet; // IfcMaterialLayerSet OdDAI::Enum m_LayerSetDirection; // IfcLayerSetDirectionEnum OdDAI::Enum m_DirectionSense; // IfcDirectionSenseEnum double m_OffsetFromReferenceLine; // IfcLengthMeasure IfcPositiveLengthMeasure m_ReferenceExtent; // IfcPositiveLengthMeasure [optional] }; /** \details A data type that represents a smart pointer to a IfcMaterialLayerSetUsage object. */ typedef OdSmartPtr IfcMaterialLayerSetUsagePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X4_IFCMATERIALLAYERSETUSAGE_AUTO_IMPL_H