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

#include "IfcMaterialPropertiesAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A container class with material optical properties defined in IFC specification.
*/
class IFC2X3_EXPORT IfcOpticalMaterialProperties : public IfcMaterialProperties
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcOpticalMaterialProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of VisibleTransmittance attribute. 
  This attribute represents the transmittance at normal incidence (visible). 
  Defines the fraction of the visible spectrum of solar radiation that passes through per unit area, perpendicular to the surface.
  \returns
  Returns the value of VisibleTransmittance attribute.
  */
  double getVisibleTransmittance() const;

  /** \details
  Sets the value of VisibleTransmittance attribute. 
  This attribute represents the transmittance at normal incidence (visible). 
  Defines the fraction of the visible spectrum of solar radiation that passes through per unit area, perpendicular to the surface.
  \param VisibleTransmittance [in] VisibleTransmittance attribute to set.
  */
  void setVisibleTransmittance(double VisibleTransmittance);

  /** \details
  Returns the value of SolarTransmittance attribute. 
  This attribute represents the transmittance at normal incidence (solar). 
  Defines the fraction of solar radiation that passes through per unit area, perpendicular to the surface.
  \returns
  Returns the value of SolarTransmittance attribute.
  */
  double getSolarTransmittance() const;

  /** \details
  Sets the value of SolarTransmittance attribute. 
  This attribute represents the transmittance at normal incidence (solar). 
  Defines the fraction of solar radiation that passes through per unit area, perpendicular to the surface.
  \param SolarTransmittance [in] SolarTransmittance attribute to set.
  */
  void setSolarTransmittance(double SolarTransmittance);

  /** \details
  Returns the value of ThermalIrTransmittance attribute. 
  This attribute represents the thermal IR transmittance at normal incidence. 
  Defines the fraction of thermal energy that passes through per unit area, perpendicular to the surface.
  \returns
  Returns the value of ThermalIrTransmittance attribute.
  */
  double getThermalIrTransmittance() const;

  /** \details
  Sets the value of ThermalIrTransmittance attribute. 
  This attribute represents the thermal IR transmittance at normal incidence. 
  Defines the fraction of thermal energy that passes through per unit area, perpendicular to the surface.
  \param ThermalIrTransmittance [in] ThermalIrTransmittance attribute to set.
  */
  void setThermalIrTransmittance(double ThermalIrTransmittance);

  /** \details
  Returns the value of ThermalIrEmissivityBack attribute. 
  This attribute represents the thermal IR emissivity: back side. 
  Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "back" side of the material.
  \returns
  Returns the value of ThermalIrEmissivityBack attribute.
  */
  double getThermalIrEmissivityBack() const;

  /** \details
  Sets the value of ThermalIrEmissivityBack attribute. 
  This attribute represents the thermal IR emissivity: back side. 
  Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "back" side of the material.
  \param ThermalIrEmissivityBack [in] ThermalIrEmissivityBack attribute to set.
  */
  void setThermalIrEmissivityBack(double ThermalIrEmissivityBack);

  /** \details
  Returns the value of ThermalIrEmissivityFront attribute. 
  This attribute represents the thermal IR emissivity: front side. 
  Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "front" side of the material.
  \returns
  Returns the value of ThermalIrEmissivityFront attribute.
  */
  double getThermalIrEmissivityFront() const;

  /** \details
  Sets the value of ThermalIrEmissivityFront attribute. 
  This attribute represents the thermal IR emissivity: front side. 
  Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "front" side of the material.
  \param ThermalIrEmissivityFront [in] ThermalIrEmissivityFront attribute to set.
  */
  void setThermalIrEmissivityFront(double ThermalIrEmissivityFront);

  /** \details
  Returns the value of VisibleReflectanceBack attribute. 
  This attribute represents the reflectance at normal incidence (visible): back side. 
  Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium
  into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \returns
  Returns the value of VisibleReflectanceBack attribute.
  */
  double getVisibleReflectanceBack() const;

  /** \details
  Sets the value of VisibleReflectanceBack attribute. 
  This attribute represents the reflectance at normal incidence (visible): back side. 
  Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium
  into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \param VisibleReflectanceBack [in] VisibleReflectanceBack attribute to set.
  */
  void setVisibleReflectanceBack(double VisibleReflectanceBack);

  /** \details
  Returns the value of VisibleReflectanceFront attribute. 
  This attribute represents the reflectance at normal incidence (visible): front side. 
  Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium
  into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \returns
  Returns the value of VisibleReflectanceFront attribute.
  */
  double getVisibleReflectanceFront() const;

  /** \details
  Sets the value of VisibleReflectanceFront attribute. 
  This attribute represents the reflectance at normal incidence (visible): front side. 
  Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium
  into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \param VisibleReflectanceFront [in] VisibleReflectanceFront attribute to set.
  */
  void setVisibleReflectanceFront(double VisibleReflectanceFront);

  /** \details
  Returns the value of SolarReflectanceFront attribute. 
  This attribute represents the reflectance at normal incidence (solar): front side. 
  Defines the fraction of the solar ray that is reflected and not transmitted 
  when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. 
  Dependent on material and surface characteristics.
  \returns
  Returns the value of SolarReflectanceFront attribute.
  */
  double getSolarReflectanceFront() const;

  /** \details
  Sets the value of SolarReflectanceFront attribute. 
  This attribute represents the reflectance at normal incidence (solar): front side. 
  Defines the fraction of the solar ray that is reflected and not transmitted 
  when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. 
  Dependent on material and surface characteristics.
  \param SolarReflectanceFront [in] SolarReflectanceFront attribute to set.
  */
  void setSolarReflectanceFront(double SolarReflectanceFront);

  /** \details
  Returns the value of SolarReflectanceBack attribute. 
  This attribute represents the reflectance at normal incidence (solar): back side. 
  Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, 
  at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \returns
  Returns the value of SolarReflectanceBack attribute.
  */
  double getSolarReflectanceBack() const;

  /** \details
  Sets the value of SolarReflectanceBack attribute. 
  This attribute represents the reflectance at normal incidence (solar): back side. 
  Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, 
  at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.
  \param SolarReflectanceBack [in] SolarReflectanceBack attribute to set.
  */
  void setSolarReflectanceBack(double SolarReflectanceBack);


public:

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

  /** \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
  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:
  <table>
    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.
  </table>
  */
  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 <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: 
  IfcPositiveRatioMeasure m_VisibleTransmittance;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_SolarTransmittance;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_ThermalIrTransmittance;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_ThermalIrEmissivityBack;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_ThermalIrEmissivityFront;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_VisibleReflectanceBack;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_VisibleReflectanceFront;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_SolarReflectanceFront;   // IfcPositiveRatioMeasure  [optional]
  IfcPositiveRatioMeasure m_SolarReflectanceBack;   // IfcPositiveRatioMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCOPTICALMATERIALPROPERTIES_AUTO_IMPL_H