/////////////////////////////////////////////////////////////////////////////// // 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 _IFC2X_FINAL_IFCSHAPEASPECT_AUTO_IMPL_H #define _IFC2X_FINAL_IFCSHAPEASPECT_AUTO_IMPL_H #include "Ifc2x_FinalBaseClass.h" #include "Ifc2x_FinalEnum.h" #include "Ifc2x_FinalSelectTypes.h" #include "Ifc2x_FinalCollectionTypes.h" #include "IfcProductDefinitionShapeAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X_FINAL express schema definitions. */ namespace OdIfc2x_final { /** \details IfcShapeAspect provides 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. - Details - The IfcShapeAspect's can have distinct material information or other distinct characteristics that differs from other parts of the product shape representation. The image below indicates the association of material characteristics to shape aspects. */ class IFC2X_FINAL_EXPORT IfcShapeAspect : public OdIfc2x_FinalInstance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcShapeAspect); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Gets the value of ShapeRepresentations attribute. This attribute represents 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. \param ShapeRepresentations [out] Receives the ShapeRepresentations attribute. */ void getShapeRepresentations(OdDAIObjectIds& ShapeRepresentations) const; /** \details Returns the value of ShapeRepresentations attribute. This attribute represents 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. \returns Returns the value of ShapeRepresentations attribute. */ OdDAI::ListOfOdDAIObjectId& shapeRepresentations(); /** \details Returns the value of Name attribute. This attribute represents 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. \returns Returns the value of Name attribute. */ const OdAnsiString& getName() const; /** \details Sets the value of Name attribute. This attribute represents 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. \param Name [in] Name to set. */ void setName(const OdAnsiString& Name); /** \details Returns the value of Description attribute. This attribute represents 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. \returns Returns the value of Description attribute. */ const OdAnsiString& getDescription() const; /** \details Sets the value of Description attribute. This attribute represents 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. \param Description [in] Description to set. */ void setDescription(const OdAnsiString& Description); /** \details Returns the value of ProductDefinitional attribute. This attribute indicates whether the shape aspect is on the physical boundary of the product definition shape. * If the value of this attribute is TRUE, it is asserted that the shape aspect being identified is on such a boundary. * If the value is FALSE, it is asserted that the shape aspect being identified is not on such a boundary. * If the value is UNKNOWN, it is asserted that it is not known whether the shape aspect being identified is on such a boundary. \returns Returns the value of ProductDefinitional attribute. \remarks EXAMPLE: Would be FALSE for a center line, identified as shape aspect; would be TRUE for a cantilever. */ OdDAI::Logical getProductDefinitional() const; /** \details Sets the value of ProductDefinitional attribute. This attribute indicates whether the shape aspect is on the physical boundary of the product definition shape. * If the value of this attribute is TRUE, it is asserted that the shape aspect being identified is on such a boundary. * If the value is FALSE, it is asserted that the shape aspect being identified is not on such a boundary. * If the value is UNKNOWN, it is asserted that it is not known whether the shape aspect being identified is on such a boundary. \param ProductDefinitional [in] ProductdDefinitional attribute to set. \remarks EXAMPLE: Would be FALSE for a center line, identified as shape aspect; would be TRUE for a cantilever. */ void setProductDefinitional(OdDAI::Logical ProductDefinitional); /** \details Returns the value of PartOfProductDefinitionShape attribute. This attribute represents reference to the IfcProductDefinitionShape or the IfcRepresentationMap of which this shape is an aspect. \returns Returns the value of PartOfProductDefinitionShape attribute. */ const OdDAIObjectId& getPartOfProductDefinitionShape() const; /** \details Sets the value of PartOfProductDefinitionShape attribute. This attribute represents reference to the IfcProductDefinitionShape or the IfcRepresentationMap of which this shape is an aspect. \param PartOfProductDefinitionShape [in] PartOfProductDefinitionShape attribute to set. */ void setPartOfProductDefinitionShape(const OdDAIObjectId& PartOfProductDefinitionShape); public: /** \details Default constructor for the IfcShapeAspect class. */ IfcShapeAspect(); /** \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 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: OdDAI::ListOfOdDAIObjectId m_ShapeRepresentations; // LIST [1:?] of IfcShapeRepresentation OdAnsiString m_Name; // IfcLabel [optional] OdAnsiString m_Description; // IfcText [optional] OdDAI::Logical m_ProductDefinitional; // LOGICAL OdDAIObjectId m_PartOfProductDefinitionShape; // IfcProductDefinitionShape }; /** \details A data type that represents a smart pointer to a IfcShapeAspect object. */ typedef OdSmartPtr IfcShapeAspectPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X_FINAL_IFCSHAPEASPECT_AUTO_IMPL_H