/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X3_ADD2_IFCACTIONREQUEST_AUTO_IMPL_H #define _IFC4X3_ADD2_IFCACTIONREQUEST_AUTO_IMPL_H #include "IfcControlAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X3_ADD2 express schema definitions. */ namespace OdIfc4x3_add2 { /** \details 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). - Approval - The Approval Association concept applies to this entity. 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. - Aggregation - As shown in the figure below, an IfcActionRequest may be aggregated into components. - Nesting - An IfcActionRequest entity may be nested into follow-up requests, in order of issue. - Control Assignment - As shown in the figure below, 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. \changes * IFC4 changes: Attribute RequestID renamed to Identification and promoted to supertype IfcControl; */ class IFC4X3_EXPORT IfcActionRequest : public IfcControl { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcActionRequest); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of PredefinedType attribute. This attribute represents the predefined type of sources through which a request can be made. \returns Returns the value of PredefinedType attribute. \remarks IFC4 CHANGE: The attribute has been added. */ IfcActionRequestTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents the predefined type of sources through which a request can be made. \param PredefinedType [in] Predefined type to set. \remarks IFC4 CHANGE: The attribute has been added. */ void setPredefinedType(IfcActionRequestTypeEnum PredefinedType); /** \details Returns the value of Status attribute. This attribute represents the status currently assigned to the request. Possible values include: * Hold: wait to see if further requests are received before deciding on action * NoAction: no action is required on this request * Schedule: plan action to take place as part of maintenance or other task planning/scheduling * Urgent: take action immediately \returns Returns the value of Status attribute. \remarks IFC4 CHANGE: The attribute has been added. */ const OdAnsiString& getStatus() const; /** \details Sets the value of Status attribute. This attribute represents the status currently assigned to the request. Possible values include: * Hold: wait to see if further requests are received before deciding on action * NoAction: no action is required on this request * Schedule: plan action to take place as part of maintenance or other task planning/scheduling * Urgent: take action immediately \param Status [in] Status to set. \remarks IFC4 CHANGE: The attribute has been added. */ void setStatus(const OdAnsiString& Status); /** \details Returns the value of LongDescription attribute. This attribute represents detailed description of the permit. \returns Returns the value of LongDescription attribute. \remarks IFC4 CHANGE: The attribute has been added. */ const OdAnsiString& getLongDescription() const; /** \details Sets the value of LongDescription attribute. This attribute represents detailed description of the permit. \param LongDescription [in] Long description to set. \remarks IFC4 CHANGE: The attribute has been added. */ void setLongDescription(const OdAnsiString& LongDescription); public: /** \details Default constructor for the IfcActionRequest class. */ IfcActionRequest(); /** \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: OdDAI::Enum m_PredefinedType; // IfcActionRequestTypeEnum [optional] OdAnsiString m_Status; // IfcLabel [optional] OdAnsiString m_LongDescription; // IfcText [optional] }; /** \details A data type that represents a smart pointer to a IfcActionRequest object. */ typedef OdSmartPtr IfcActionRequestPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X3_ADD2_IFCACTIONREQUEST_AUTO_IMPL_H