/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCMATERIALCONSTITUENT_AUTO_IMPL_H
#define _IFC4X4_IFCMATERIALCONSTITUENT_AUTO_IMPL_H

#include "IfcMaterialDefinitionAutoImpl.h"
#include "IfcMaterialAutoImpl.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
  IfcMaterialConstituent is a single and identifiable part of an element which is constructed of a number of parts (one or more) each having an individual material. 
  The association of the material constituent to the part is provided by a keyword as value of the Name attribute. 
  To identify and distinguish the part of the shape representation to which the material constituent 
  applies the IfcProductDefinitionShape of the element has to include instances of IfcShapeAspect, using the same keyword for their Name attribute.
*/
class IFC4X4_EXPORT IfcMaterialConstituent : public IfcMaterialDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcMaterialConstituent);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents the name by which the material constituent is known.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents the name by which the material constituent is known.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents definition of the material constituent in descriptive terms.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents definition of the material constituent in descriptive terms.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of Material attribute. 
  This attribute represents reference to the material from which the constituent is constructed.
  \returns
  Returns the value of Material attribute.
  */
  const OdDAIObjectId& getMaterial() const;

  /** \details
  Sets the value of Material attribute. 
  This attribute represents reference to the material from which the constituent is constructed.
  \param Material [in] Material to set.
  */
  void setMaterial(const OdDAIObjectId& Material);

  /** \details
  Returns the value of Fraction attribute. 
  This optional attribute represents fraction of the total amount (volume or weight) 
  that applies to the IfcMaterialConstituentSet that is contributed by this IfcMaterialConstituent.
  \returns
  Returns the value of Fraction attribute.
  */
  double getFraction() const;

  /** \details
  Sets the value of Fraction attribute. 
  This optional attribute represents fraction of the total amount (volume or weight) 
  that applies to the IfcMaterialConstituentSet that is contributed by this IfcMaterialConstituent.
  \param Fraction [in] Fraction to set.
  */
  void setFraction(double Fraction);

  /** \details
  Returns the value of Category attribute. 
  This attribute represents category of the material constituent, e.g. the role it has in the constituent set it belongs to.
  \returns
  Returns the value of Category attribute.
  */
  const OdAnsiString& getCategory() const;

  /** \details
  Sets the value of Category attribute. 
  This attribute represents category of the material constituent, e.g. the role it has in the constituent set it belongs to.
  \param Category [in] Category to set.
  */
  void setCategory(const OdAnsiString& Category);

  /** \details
  Returns the value of ToMaterialConstituentSet attribute. 
  This attribute represents material constituent set in which this material constituent is included.
  \returns
  Returns the value of ToMaterialConstituentSet attribute.
  */
  OdDAIObjectId getInvToMaterialConstituentSet() const;


public:

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

  /** \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: 
  OdAnsiString m_Name;   // IfcLabel  [optional]
  OdAnsiString m_Description;   // IfcText  [optional]
  OdDAIObjectId m_Material;   // IfcMaterial
  IfcNormalisedRatioMeasure m_Fraction;   // IfcNormalisedRatioMeasure  [optional]
  OdAnsiString m_Category;   // IfcLabel  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcMaterialConstituentSet;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCMATERIALCONSTITUENT_AUTO_IMPL_H