/////////////////////////////////////////////////////////////////////////////// // 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 _IFC2X2_FINAL_IFCAPPLIEDVALUERELATIONSHIP_AUTO_IMPL_H #define _IFC2X2_FINAL_IFCAPPLIEDVALUERELATIONSHIP_AUTO_IMPL_H #include "Ifc2x2_FinalBaseClass.h" #include "Ifc2x2_FinalEnum.h" #include "Ifc2x2_FinalSelectTypes.h" #include "Ifc2x2_FinalCollectionTypes.h" #include "IfcAppliedValueAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X2_FINAL express schema definitions. */ namespace OdIfc2x2_final { /** \details An IfcAppliedValueRelationship is a relationship class that enables applied values of cost or environmental impact to be aggregated together as components of another applied value. - Use Definitions - Dependency relationships can exist between applied values on the basis that one particular value can be determined by operations on one or more other values. This is captured through the IfcAppliedValueRelationship entity. In this relationship, one instance of IfcAppliedValue acts as the principal (IfcAppliedValueRelationship.ComponentOf) whose value can be determined from the instances of IfcAppliedValue that are defined as its components (IfcAppliedValueRelationship.Components). An IfcAppliedValueRelationship has an ArithmeticOperator attribute that specifies the form of arithmetical operation implied by the relationship. - Example - A relationship exists between applied value A and applied values B, C and D such that the value of A is determined by the addition of B, C and D such that: It is possible to develop more complex applied value specifications by creating hierarchies of applied value relationships. In the diagram below, the development of a applied value is shown whereby, because B = E * F and D = G * H * J, then: */ class IFC2X2_FINAL_EXPORT IfcAppliedValueRelationship : public OdIfc2x2_FinalInstance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcAppliedValueRelationship); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of ComponentOfTotal attribute. This attribute represents the applied value (total or subtotal) of which the value being considered is a component. \returns Returns the value of ComponentOfTotal attribute. */ const OdDAIObjectId& getComponentOfTotal() const; /** \details Sets the value of ComponentOfTotal attribute. This attribute represents the applied value (total or subtotal) of which the value being considered is a component. \param ComponentOfTotal [in] ComponentOfTotal attribute to set. */ void setComponentOfTotal(const OdDAIObjectId& ComponentOfTotal); /** \details Sets the value of Components attribute. This attribute represents applied values that are components of another applied value and from which that applied value can be deduced. \param Components [out] Receives the Components attribute. */ void getComponents(OdDAIObjectIds& Components) const; /** \details Returns the value of Components attribute. This attribute represents applied values that are components of another applied value and from which that applied value can be deduced. \returns Returns the value of Components attribute. */ OdDAI::SetOfOdDAIObjectId& components(); /** \details Returns the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied in an applied value relationship. \returns Returns the value of ArithmeticOperator attribute. */ IfcArithmeticOperatorEnum getArithmeticOperator() const; /** \details Sets the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied in an applied value relationship. \param ArithmeticOperator [in] ArithmeticOperator attribute to set. */ void setArithmeticOperator(IfcArithmeticOperatorEnum ArithmeticOperator); /** \details Returns the value of Name attribute. This attribute represents a name used to identify or qualify the applied value relationship. \returns Returns the value of Name attribute. */ const OdAnsiString& getName() const; /** \details Sets the value of Name attribute. This attribute represents a name used to identify or qualify the applied value relationship. \param Name [in] Name attribute to set. */ void setName(const OdAnsiString& Name); /** \details Returns the value of Description attribute. This attribute represents a description that can apply additional information about an applied value relationship. \returns Returns the value of Description attribute. */ const OdAnsiString& getDescription() const; /** \details Sets the value of Description attribute. This attribute represents a description that can apply additional information about an applied value relationship. \param Description [in] Description attribute to set. */ void setDescription(const OdAnsiString& Description); public: /** \details Default constructor for the IfcAppliedValueRelationship class. */ IfcAppliedValueRelationship(); /** \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: OdDAIObjectId m_ComponentOfTotal; // IfcAppliedValue OdDAI::SetOfOdDAIObjectId m_Components; // SET [1:?] of IfcAppliedValue OdDAI::Enum m_ArithmeticOperator; // IfcArithmeticOperatorEnum OdAnsiString m_Name; // IfcLabel [optional] OdAnsiString m_Description; // IfcText [optional] }; /** \details A data type that represents a smart pointer to a IfcAppliedValueRelationship object. */ typedef OdSmartPtr IfcAppliedValueRelationshipPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X2_FINAL_IFCAPPLIEDVALUERELATIONSHIP_AUTO_IMPL_H