/////////////////////////////////////////////////////////////////////////////// // 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_IFCPROJECTORDER_AUTO_IMPL_H #define _IFC2X_FINAL_IFCPROJECTORDER_AUTO_IMPL_H #include "IfcControlAutoImpl.h" #include "IfcCalendarDateAutoImpl.h" #include "IfcPersonAutoImpl.h" #include "IfcBudgetAutoImpl.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 A project order is a directive to purchase products and/or perform work, such as for construction or facilities management. - Approval - Approvals can 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 can 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. - Property Sets for Objects - This concept can be applied to the following resources: * Pset_ProjectOrderChangeOrder (only applies to CHANGEORDER) * Pset_ProjectOrderMaintenanceWorkOrder (only applies to MAINTENANCEWORKORDER) * Pset_ProjectOrderMoveOrder (only applies to MOVEORDER) * Pset_ProjectOrderPurchaseOrder (only applies to PURCHASEORDER) * Pset_ProjectOrderWorkOrder (only applies to WORKORDER) - Aggregation - The figure below shows the project order composition. As shown on the figure, an IfcProjectOrder can be aggregated into components. - Nesting - The Object Nesting concept template applies to this entity as shown in table below: TypeDescription IfcProjectOrder Can contain subordinate orders, particularly change orders indicating contract amendment in order of issue.
- Control Assignment - The figure below illustrates IfcProjectOrder assignment relationships as indicated: * IfcActor (IfcRelAssignsToActor): Organization issuing the order such as an owner or contractor. The IfcProjectOrder can 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. */ class IFC2X_FINAL_EXPORT IfcProjectOrder : public IfcControl { //DOM-IGNORE-BEGIN OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x_final::IfcProjectOrder); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of OrderNumber attribute. This attribute represents the unique identification of the project order. \returns Returns the value of OrderNumber attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ const OdAnsiString& getOrderNumber() const; /** \details Sets the value of OrderNumber attribute. This attribute represents the unique identification of the project order. \param OrderNumber [in] Order number to set. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void setOrderNumber(const OdAnsiString& OrderNumber); /** \details Returns the value of TransactionCode attribute. This attribute represents the transaction code assigned to the project order. \returns Returns the value of TransactionCode attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ const OdAnsiString& getTransactionCode() const; /** \details Sets the value of TransactionCode attribute. This attribute represents the transaction code assigned to the project order. \param TransactionCode [in] Transaction code to set. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void setTransactionCode(const OdAnsiString& TransactionCode); /** \details Returns the value of IssuingDate attribute. This attribute represents the date that the order is issued. \returns Returns the value of IssuingDate attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ const OdDAIObjectId& getIssuingDate() const; /** \details Sets the value of IssuingDate attribute. This attribute represents the date that the order is issued. \param IssuingDate [in] Issuing date to set. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void setIssuingDate(const OdDAIObjectId& IssuingDate); /** \details Returns the value of IssuedBy attribute. This attribute represents the person issuing the project order. \returns Returns the value of IssuedBy attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ IfcActorSelect issuedBy(); /** \details Returns the value of IssuedTo attribute. This attribute represents the persons or companies receiving the orders. \param IssuedTo [out] Receives the IssuedTo attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void getIssuedTo(OdArray& IssuedTo) const; /** \details Returns the value of IssuedTo attribute. This attribute represents the persons or companies receiving the orders. \param IssuedTo [out] Receives the IssuedTo attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void getIssuedToWrapperArray(OdArray& IssuedTo) const; /** \details Returns the value of IssuedTo attribute. This attribute represents the persons or companies receiving the orders. \returns Returns the value of IssuedTo attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ OdDAI::SetOfSelect& issuedTo(); /** \details Returns the value of AdditionalContacts attribute. This attribute represents an additional contact person regarding the request. \param AdditionalContacts [out] Receives the AdditionalContacts attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void getAdditionalContacts(OdArray& AdditionalContacts) const; /** \details Returns the value of AdditionalContacts attribute. This attribute represents an additional contact person regarding the request. \param AdditionalContacts [out] Receives the AdditionalContacts attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void getAdditionalContactsWrapperArray(OdArray& AdditionalContacts) const; /** \details Returns the value of AdditionalContacts attribute. This attribute represents an additional contact person regarding the request. \returns Returns the value of AdditionalContacts attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ OdDAI::SetOfSelect& additionalContacts(); /** \details Returns the value of Remarks attribute. This attribute represents remarks or comments concerning the project order. \param Remarks [out] Receives the Remarks attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void getRemarks(OdArray& Remarks) const; /** \details Returns the value of Remarks attribute. This attribute represents remarks or comments concerning the project order. \returns Returns the value of Remarks attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ OdDAI::SetOfOdAnsiString& remarks(); /** \details Returns the value of Signoff attribute. This attribute represents the identity of the person responsible for indicating that the project order and any work required in its undertaking have been satisfactorily completed. \returns Returns the value of Signoff attribute. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ const OdDAIObjectId& getSignoff() const; /** \details Sets the value of Signoff attribute. This attribute represents the identity of the person responsible for indicating that the project order and any work required in its undertaking have been satisfactorily completed. \param Signoff [in] Signoff attribute to set. \remarks IFC2x2_Final CHANGE: The attribute has been removed. */ void setSignoff(const OdDAIObjectId& Signoff); /** \details Returns the value of BudgetSource attribute. This attribute represents the budget source requested. \returns Returns the value of BudgetSource attribute. */ const OdDAIObjectId& getBudgetSource() const; /** \details Sets the value of BudgetSource attribute. This attribute represents the budget source requested. \param BudgetSource [in] Budget source to set. */ void setBudgetSource(const OdDAIObjectId& BudgetSource); public: /** \details Default constructor for the IfcProjectOrder class. */ IfcProjectOrder(); /** \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: OdAnsiString m_OrderNumber; // IfcIdentifier OdAnsiString m_TransactionCode; // IfcLabel [optional] OdDAIObjectId m_IssuingDate; // IfcCalendarDate OdDAI::Select m_IssuedBy; // IfcActorSelect OdDAI::SetOfSelect m_IssuedTo; // SET [1:?] of IfcActorSelect [optional] OdDAI::SetOfSelect m_AdditionalContacts; // SET [1:?] of IfcActorSelect [optional] OdDAI::SetOfOdAnsiString m_Remarks; // SET [1:?] of IfcText [optional] OdDAIObjectId m_Signoff; // IfcPerson [optional] OdDAIObjectId m_BudgetSource; // IfcBudget [optional] }; /** \details A data type that represents a smart pointer to a IfcProjectOrder object. */ typedef OdSmartPtr IfcProjectOrderPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X_FINAL_IFCPROJECTORDER_AUTO_IMPL_H