/////////////////////////////////////////////////////////////////////////////// // 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_IFCCOST_AUTO_IMPL_H #define _IFC2X_FINAL_IFCCOST_AUTO_IMPL_H #include "IfcControlAutoImpl.h" #include "IfcCostValueAutoImpl.h" #include "IfcCalendarDateAutoImpl.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 An IfcCost is a cost with context information. It represents goods, services, or the execution of works of a described elemental nature in given conditions. - Details - This entity also has the capability of nesting other costs of the same type through its relationships to IfcRelNests. The IfcRelNests provides a model mechanism to allow IfcCost to contain other items of the same type. It provides the relationships between the nesting IfcCost and nested IfcCost(s). The image below shows how cost elements can be grouped into one cost, represented by costs being nested within another cost (using the IfcRelNests relationship). */ class IFC2X_FINAL_EXPORT IfcCost : public IfcControl { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcCost); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of ContextDescription attribute. This attribute represents the contextual information of the cost such as purchase cost, installation cost, consulting cost, etc. \returns Returns the value of ContextDescription attribute. */ const OdAnsiString& getContextDescription() const; /** \details Sets the value of ContextDescription attribute. This attribute represents the contextual information of the cost such as purchase cost, installation cost, consulting cost, etc. \param ContextDescription [in] ContextDescription attribute to set. */ void setContextDescription(const OdAnsiString& ContextDescription); /** \details Returns the value of ElementCost attribute. This attribute represents the cost of a single item of each 'Quantity'. It can be either a unit cost or an item cost depending on the context of the cost element. \returns Returns the value of ElementCost attribute. */ const OdDAIObjectId& getElementCost() const; /** \details Sets the value of ElementCost attribute. This attribute represents the cost of a single item of each 'Quantity'. It can be either a unit cost or an item cost depending on the context of the cost element. \param ElementCost [in] ElementCost attribute to set. */ void setElementCost(const OdDAIObjectId& ElementCost); /** \details Returns the value of ExtensionCost attribute. This attribute represents the summarized the cost of this cost element. \returns Returns the value of ExtensionCost attribute. */ const OdDAIObjectId& getExtensionCost() const; /** \details Sets the value of ExtensionCost attribute. This attribute represents the summarized the cost of this cost element. \param ExtensionCost [in] ExtensionCost attribute to set. */ void setExtensionCost(const OdDAIObjectId& ExtensionCost); /** \details Returns the value of CostUse attribute. This attribute indicates how the value of the ElementCost and ExtensionCost is provided and thus how they should be used. \returns Returns the value of CostUse attribute. */ IfcCostUseEnum getCostUse() const; /** \details Sets the value of CostUse attribute. This attribute indicates how the value of the ElementCost and ExtensionCost is provided and thus how they should be used. \param CostUse [in] CostUse attribute to set. */ void setCostUse(IfcCostUseEnum CostUse); /** \details Returns the value of PreparedOn attribute. This attribute represents the date that the cost is provided. \returns Returns the value of PreparedOn attribute. */ const OdDAIObjectId& getPreparedOn() const; /** \details Sets the value of PreparedOn attribute. This attribute represents the date that the cost is provided. \param PreparedOn [in] PreparedOn attribute to set. */ void setPreparedOn(const OdDAIObjectId& PreparedOn); /** \details Gets the value of Quantities attribute. This attribute represents the quantities of the items referenced by the cost. \param Quantities [in] Receives the Quantities attribute. */ void getQuantities(OdDAIObjectIds& Quantities) const; /** \details Returns the value of Quantities attribute. This attribute represents the quantities of the items referenced by the cost. \returns Returns the value of Quantities attribute. */ OdDAI::ListOfOdDAIObjectId& quantities(); /** \details Returns the value of CostType attribute. This attribute represents a type of cost that is expressed. \returns Returns the value of CostType attribute. */ const OdAnsiString& getCostType() const; /** \details Sets the value of CostType attribute. This attribute represents a type of cost that is expressed. \param CostType [in] CostType attribute to set. */ void setCostType(const OdAnsiString& CostType); /** \details Returns the value of CostSchedule attribute. This attribute represents a reference to the cost schedule to which the cost element belongs. \returns Returns the value of CostSchedule attribute. */ OdDAIObjectId getInvCostSchedule() const; public: /** \details Default constructor for the IfcCost class. */ IfcCost(); /** \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_ContextDescription; // IfcLabel OdDAIObjectId m_ElementCost; // IfcCostValue [optional] OdDAIObjectId m_ExtensionCost; // IfcCostValue [optional] OdDAI::Enum m_CostUse; // IfcCostUseEnum OdDAIObjectId m_PreparedOn; // IfcCalendarDate [optional] OdDAI::ListOfOdDAIObjectId m_Quantities; // LIST [1:?] of IfcCostQuantity [optional] OdAnsiString m_CostType; // IfcLabel // Declare friend classes for inverse attributes functionality: friend class IfcCostSchedule; }; /** \details A data type that represents a smart pointer to a IfcCost object. */ typedef OdSmartPtr IfcCostPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X_FINAL_IFCCOST_AUTO_IMPL_H