/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X2_IFCPROCEDURE_AUTO_IMPL_H #define _IFC4X2_IFCPROCEDURE_AUTO_IMPL_H #include "IfcProcessAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X2 express schema definitions. */ namespace OdIfc4x2 { /** \details An IfcProcedure is a logical set of actions to be taken in response to an event or to cause an event to occur. - 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 can describe a set of tasks and their order of occurrence in response to or to cause an event. As shown on the image below, 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. - Object Typing - The Object Typing concept template applies to this entity as IfcProcedureType under RelatingType. IfcProcedure defines the anticipated or actual occurrence of any procedure; common information about procedure types is handled by IfcProcedureType. - Nesting - The IfcProcedure can be contained within an IfcTask or IfcProcedure using the IfcRelNests relationship. An IfcProcedure can in turn nest other IfcProcedure or IfcEvent entities. Such nesting indicates decomposed level of detail. - Sequential Connectivity - 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 triggered 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. - Process Assignment - 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. - Control Assignment - An IfcProcedure can be assigned to an IfcWorkCalendar to indicate times when such procedure can 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. - Product Assignment - For building operation scenarios, IfcProcedure can be assigned to a product (IfcElement subtype) using IfcRelAssignsToProduct to indicate a specific product occurrence that performs the procedure. * EXAMPLE: An IfcActuator can 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. \changes * IFC4 changes: Name of the attribute ProcedureType changed to PredefinedType and made optional (upward compatible). */ class IFC4X2_EXPORT IfcProcedure : public IfcProcess { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcProcedure); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of PredefinedType attribute. This attribute represents the predefined types of a procedure from which the required type can be set. \returns Returns the value of PredefinedType attribute. */ IfcProcedureTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents the predefined types of a procedure from which the required type can be set. \param PredefinedType [in] Predefined type to set. */ void setPredefinedType(IfcProcedureTypeEnum PredefinedType); public: /** \details Default constructor for the IfcProcedure class. */ IfcProcedure(); /** \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::Enum m_PredefinedType; // IfcProcedureTypeEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcProcedure object. */ typedef OdSmartPtr IfcProcedurePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCPROCEDURE_AUTO_IMPL_H