/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC4X2_IFCPROPERTYTABLEVALUE_AUTO_IMPL_H
#define _IFC4X2_IFCPROPERTYTABLEVALUE_AUTO_IMPL_H

#include "IfcSimplePropertyAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {

/** \details
  IfcPropertyTableValue is a property with a value range defined by a property object which has two lists of (numeric or descriptive) values assigned. 
  The values specify a table with two columns. The defining values provide the first column and establish the scope for the defined values (the second column). 
  An optional Expression attribute can give the equation used for deriving the range value, which is for information purposes only.
  
    * If the Unit attribute is not specified, than the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. 
      The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).
    * If the Unit attribute is specified, the unit assigned by the Unit attribute overrides the globally assigned unit.

  \remarks
  The IfcPropertyTableValue only captures properties that can be expressed by a table with two columns. 
  Use IfcPropertyReferenceValue with the PropertyReference being an IfcTable to express all those properties that require a table with tree or more columns.

  \changes
  
  * IFC4 changes: 
    * <b>DefiningValues</b>: The attribute has been made optional with upward compatibility for file-based exchange.
    * <b>DefinedValues</b>: The attribute has been made optional with upward compatibility for file-based exchange.
*/
class IFC4X2_EXPORT IfcPropertyTableValue : public IfcSimpleProperty
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcPropertyTableValue);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of DefiningValues attribute. DefiningValues is list of defining values, which determine the defined values. 
  This list has unique values only.
  \param DefiningValues [out] Receives an array of OdDAI::Select values representing the DefiningValues attribute.
  */
  void getDefiningValues(OdArray<OdDAI::Select >& DefiningValues) const;

  /** \details
  Returns the value of DefiningValues attribute. DefiningValues is list of defining values, which determine the defined values. 
  This list has unique values only.
  \param DefiningValues [out] Receives an array of OdDAI::Select values representing the DefiningValues attribute.
  */
  void getDefiningValuesWrapperArray(OdArray<IfcValue>& DefiningValues) const;

  /** \details
  Returns the value of DefiningValues attribute. DefiningValues is list of defining values, which determine the defined values.
  This list has unique values only.
  \returns
  Returns a list of OdDAI::Select values representing the DefiningValues attribute.
  */
  OdDAI::ListOfSelect& definingValues();

  /** \details
  Returns the value of DefinedValues attribute. DefinedValues is defined values which are applicable for the scope as defined by the defining values.
  \param DefinedValues [out] Receives an array of OdDAI::Select values representing the DefinedValues attribute.
  */
  void getDefinedValues(OdArray<OdDAI::Select >& DefinedValues) const;

  /** \details
  Returns the value of DefinedValues attribute. DefinedValues is defined values which are applicable for the scope as defined by the defining values.
  \param DefinedValues [out] Receives an array of OdDAI::Select values representing the DefinedValues attribute.
  */
  void getDefinedValuesWrapperArray(OdArray<IfcValue>& DefinedValues) const;

  /** \details
  Returns the value of DefinedValues attribute. DefinedValues is defined values which are applicable for the scope as defined by the defining values.
  \returns
  Returns a list of OdDAI::Select values representing the DefinedValues attribute.
  */
  OdDAI::ListOfSelect& definedValues();

  /** \details
  Returns the value of Expression attribute. Expression is expression for the derivation of defined values from the defining values, 
  the expression is given for information only, i.e. no automatic processing can be expected from the expression.
  \returns
  Returns the value of Expression attribute.
  */
  const OdAnsiString& getExpression() const;

  /** \details
  Sets the value of Expression attribute. Expression is expression for the derivation of defined values from the defining values, 
  the expression is given for information only, i.e. no automatic processing can be expected from the expression.
  \param Expression [in] Expression to set.
  */
  void setExpression(const OdAnsiString& Expression);

  /** \details
  Returns the value of DefiningUnit attribute that represents the unit for the defining values. 
  If not specified, the default value for the measure type is used as defined by the global unit assignment at IfcProject.
  \returns
  Returns the value of DefiningUnit attribute.
  */
  IfcUnit definingUnit();

  /** \details
  Returns the value of DefinedUnit attribute that represents the unit for the defined values. 
  If not specified, the default value for the measure type is used as defined by the global unit assignment at IfcProject.
  \returns
  Returns the value of DefinedUnit attribute.
  */
  IfcUnit definedUnit();

  /** \details
  Returns the value of CurveInterpolation attribute. CurveInterpolation is interpolation of the curve between two defining and defined values that are provided. 
  If not provided, a linear interpolation is assumed.
  \returns
  Returns the value from the IfcCurveInterpolationEnum enumeration representing the CurveInterpolation attribute.
  */
  IfcCurveInterpolationEnum getCurveInterpolation() const;

  /** \details
  Sets the value of CurveInterpolation attribute. CurveInterpolation is interpolation of the curve between two defining and defined values that are provided.
  If not provided, a linear interpolation is assumed.
  \param CurveInterpolation [in] value from the IfcCurveInterpolationEnum enumeration representing the CurveInterpolation attribute.
  */
  void setCurveInterpolation(IfcCurveInterpolationEnum CurveInterpolation);


public:

  /** \details
  Default constructor for the IfcPropertyTableValue class.
  */
  IfcPropertyTableValue();

  /** \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 <exref target="OdDAI__Entity.html">OdDAI::Entity</exref> 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 <exref target="OdIfc__OdIfcEntityType.html">OdIfc::OdIfcEntityType</exref> 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::ListOfSelect m_DefiningValues; // LIST [1:?] of IfcValue [optional]

  OdDAI::ListOfSelect m_DefinedValues; // LIST [1:?] of IfcValue [optional]

  OdAnsiString m_Expression;   // IfcText  [optional]
  OdDAI::Select m_DefiningUnit;   // IfcUnit  [optional]
  OdDAI::Select m_DefinedUnit;   // IfcUnit  [optional]
  OdDAI::Enum m_CurveInterpolation;   // IfcCurveInterpolationEnum  [optional]
};

/** \details
  A data type that represents a smart pointer to a <exref target="OdIfc4x2__IfcPropertyTableValue.html">IfcPropertyTableValue</exref> object.
*/
typedef OdSmartPtr<IfcPropertyTableValue> IfcPropertyTableValuePtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X2_IFCPROPERTYTABLEVALUE_AUTO_IMPL_H