///////////////////////////////////////////////////////////////////////////////
// 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_IFCCOSTMODIFIERVALUE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCOSTMODIFIERVALUE_AUTO_IMPL_H
#include "Ifc2x_FinalBaseClass.h"
#include "Ifc2x_FinalEnum.h"
#include "Ifc2x_FinalSelectTypes.h"
#include "Ifc2x_FinalCollectionTypes.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
IfcCostModifierValue is the value of a cost modifier that can be added to or subtracted from a cost.
*/
class IFC2X_FINAL_EXPORT IfcCostModifierValue : public OdIfc2x_FinalInstance
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcCostModifierValue);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of ModifierAmount attribute.
This attribute represents amount of money (in the currency as given by the currency attribute) used within the cost modifier.
\returns
Returns the value of ModifierAmount attribute.
*/
double getModifierAmount() const;
/** \details
Sets the value of ModifierAmount attribute.
This attribute represents amount of money (in the currency as given by the currency attribute) used within the cost modifier.
\param ModifierAmount [in] ModifierAmount attribute to set.
*/
void setModifierAmount(double ModifierAmount);
/** \details
Returns the value of Currency attribute.
This attribute represents currency for this cost that can override the global currency setting for the project.
\returns
Returns the value of Currency attribute.
\remarks
Currencies are defined by standard three character designations as used by banks and financial institutions.
If not asserted, it is assumed that the currency set globally for the project applies.
*/
IfcCurrencyEnum getCurrency() const;
/** \details
Sets the value of Currency attribute.
This attribute represents currency for this cost that can override the global currency setting for the project.
\param Currency [in] Currency attribute to set.
\remarks
Currencies are defined by standard three character designations as used by banks and financial institutions.
If not asserted, it is assumed that the currency set globally for the project applies.
*/
void setCurrency(IfcCurrencyEnum Currency);
public:
/** \details
Default constructor for the IfcCostModifierValue class.
*/
IfcCostModifierValue();
/** \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:
double m_ModifierAmount; // IfcMonetaryMeasure
OdDAI::Enum m_Currency; // IfcCurrencyEnum [optional]
};
/** \details
A data type that represents a smart pointer to a IfcCostModifierValue object.
*/
typedef OdSmartPtr IfcCostModifierValuePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCCOSTMODIFIERVALUE_AUTO_IMPL_H