/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X4_IFCCOSTITEM_AUTO_IMPL_H #define _IFC4X4_IFCCOSTITEM_AUTO_IMPL_H #include "IfcControlAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X4 express schema definitions. */ namespace OdIfc4x4 { /** \details An IfcCostItem describes a cost or financial value together with descriptive information that describes its context in a form that enables it to be used within a cost schedule. An IfcCostItem can be used to represent the cost of goods and services, the execution of works by a process, lifecycle cost and more. Each instance of IfcCostItem can have a name and a description. Depending on the use for which the cost is intended, these values should be asserted on the basis of agreement. For instance, the Name attribute could be used to provide a common value that enables distinct instances to be brought together in a nesting arrangement while the Description attribute can be used to provide text used for item description in a costing schedule. - Classification - The Classification Association concept applies to this entity. Instances of IfcCostItem are used for cost estimates, budgets, and other forms, where a variety of identification codes are used extensively to identify the meaning of the cost. Examples include project phase codes, CSI codes, takeoff sequence numbers, and cost accounts. The model allows for all classes that are ultimately subtypes of IfcObject to inherit the ability to have one or more instances of IfcClassificationReference to be assigned. Where identification codes are required, the generic IfcRelAssociatesClassification facility should be used. - Control Assignment - The Control Assignment concept template applies to this entity as shown in the table below TypeDescription IfcProduct For quantity-based costs based on product occurrences, spatial structures, or other physical artifacts IfcProcess For quantity-based costs based on tasks, procedures, or events IfcResource For quantity-based costs based on resource allocations IfcTypeProduct For cost rates based on product models IfcTypeProcess For cost rates based on process models of historical or projected duration IfcTypeResource For cost rates based on resource models of historical or projected productivity
The figure below illustrates cost item assignment derived from building elements. The IfcRelAssignsToControl relationship indicates building elements for which quantities are derived. Costs can also be derived from building elements by traversing assignment relationships from the assigned IfcProduct to IfcProcess to IfcResource, where all costs ultimately originate at resources. It is also possible for cost items to have assignments from processes or resources directly. */ class IFC4X4_EXPORT IfcCostItem : public IfcControl { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcCostItem); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a cost item that is specified in an enumeration. There can be a property set given specifically for the predefined types. \returns Returns the value of PredefinedType attribute. \remarks IFC4 CHANGE: The attribute has been added. */ IfcCostItemTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a cost item that is specified in an enumeration. There can be a property set given specifically for the predefined types. \param PredefinedType [in] Predefined type to set. \remarks IFC4 CHANGE: The attribute has been added. */ void setPredefinedType(IfcCostItemTypeEnum PredefinedType); /** \details Gets the value of CostValues attribute. This attribute represents component costs for which the total cost for the cost item is calculated, and then multiplied by the total CostQuantities if provided. If CostQuantities is provided then values indicate unit costs, otherwise values indicate total costs. For calculation purposes, the cost values can be directly added unless they have qualifications. Cost values with qualifications (e.g. IfcCostValue.ApplicableDate, IfcCostValue.FixedUntilDate) should be excluded from such calculation if they do not apply. \param CostValues [out] Receives the cost values. \remarks IFC4 CHANGE: The attribute has been added. */ void getCostValues(OdDAIObjectIds& CostValues) const; /** \details Returns the value of CostValues attribute. This attribute represents component costs for which the total cost for the cost item is calculated, and then multiplied by the total CostQuantities if provided. If CostQuantities is provided then values indicate unit costs, otherwise values indicate total costs. For calculation purposes, the cost values can be directly added unless they have qualifications. Cost values with qualifications (e.g. IfcCostValue.ApplicableDate, IfcCostValue.FixedUntilDate) should be excluded from such calculation if they do not apply. \returns Returns the value of CostValues attribute. \remarks IFC4 CHANGE: The attribute has been added. */ OdDAI::ListOfOdDAIObjectId& costValues(); /** \details Gets the value of CostQuantities attribute. This attribute represents component quantities of the same type for which the total quantity for the cost item is calculated as the sum. \param CostQuantities [out] Receives cost quantities. \remarks IFC4 CHANGE: The attribute has been added. */ void getCostQuantities(OdDAIObjectIds& CostQuantities) const; /** \details Returns the value of CostQuantities attribute. This attribute represents component quantities of the same type for which the total quantity for the cost item is calculated as the sum. \returns Returns the value of CostQuantities attribute. \remarks IFC4 CHANGE: The attribute has been added. */ OdDAI::ListOfOdDAIObjectId& costQuantities(); public: /** \details Default constructor for the IfcCostItem class. */ IfcCostItem(); /** \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; // IfcCostItemTypeEnum [optional] OdDAI::ListOfOdDAIObjectId m_CostValues; // LIST [1:?] of IfcCostValue [optional] OdDAI::ListOfOdDAIObjectId m_CostQuantities; // LIST [1:?] of IfcPhysicalQuantity [optional] }; /** \details A data type that represents a smart pointer to a IfcCostItem object. */ typedef OdSmartPtr IfcCostItemPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X4_IFCCOSTITEM_AUTO_IMPL_H