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

#include "IfcMaterialDefinitionAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcMaterial is a homogeneous or inhomogeneous substance that can be used to form elements (physical products or their components).
  IfcMaterial is the basic entity for material designation and definition; this includes identification by name and classification 
  (via reference to an external classification), as well as association of material properties (isotropic or anisotropic) defined by (subtypes of) IfcMaterialProperties. 
  An instance of IfcMaterial can be associated to an element or element type using the IfcRelAssociatesMaterial relationship. 
  The assignment can either be direct as a single material information, or via
  * Material layer set
  * Material profile set
  * Material constituent set
  
  An IfcMaterial can also have presentation information associated. 
  Such presentation information is provided by IfcMaterialDefinitionRepresentation, associating curve styles, 
  hatching definitions or surface coloring/rendering information to a material.

  \changes
  
  * IFC4 changes: 
    * Attribute ClassifiedAs renamed to IsRelatedWith
    * Type of the ClassifiedAs inverse attribute changed from "SET OF [0:1] IfcMaterialClassificationRelationship FOR ClassifiedMaterial" to "SET OF [0:?] IfcMaterialRelationship FOR RelatedMaterials"
*/
class IFC4X3_RC1_EXPORT IfcMaterial : public IfcMaterialDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcMaterial);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. This attribute represents name of the material.
  For example, a view definition can require Material.Name to uniquely specify e.g. concrete or steel grade, 
  in which case the attribute Material.Category could take the value 'Concrete' or 'Steel'.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute.
  For example, a view definition can require Material.Name to uniquely specify e.g. concrete or steel grade, 
  in which case the attribute Material.Category could take the value 'Concrete' or 'Steel'.
  \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 in more descriptive terms than specified by attributes Name or Category.
  \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 in more descriptive terms than specified by attributes Name or Category.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of Category attribute. 
  This attribute represents the category (group or type) of material, in more general terms than specified by attribute Name.
  For example, a view definition can require each Material.Name to be unique, e.g. for each concrete or steel grade used in a project, 
  in which case Material.Category could take the values 'Concrete' or 'Steel'.
  \returns
  Returns the value of Category attribute.
  */
  const OdAnsiString& getCategory() const;

  /** \details
  Sets the value of Category attribute. 
  This attribute represents the category (group or type) of material, in more general terms than specified by attribute Name.
  For example, a view definition can require each Material.Name to be unique, e.g. for each concrete or steel grade used in a project, 
  in which case Material.Category could take the values 'Concrete' or 'Steel'.
  \param Category [in] Category to set.
  */
  void setCategory(const OdAnsiString& Category);

  /** \details
  Returns the value of HasRepresentation attribute. 
  This attribute represents reference to the IfcMaterialDefinitionRepresentation 
  that provides presentation information relating to IfcMaterial.
  \param HasRepresentation [out] Receives the value of HasRepresentation attribute.
  */
  void getInvHasRepresentation(OdDAIObjectIds& HasRepresentation) const;

  /** \details
  Returns the value of IsRelatedWith attribute. 
  This attribute represents reference to a material relationship indicating that this material is a part (or constituent) in a material composite.
  \param IsRelatedWith [out] Receives the value of IsRelatedWith attribute.
  */
  void getInvIsRelatedWith(OdDAIObjectIds& IsRelatedWith) const;

  /** \details
  Returns the value of RelatesTo attribute. 
  This attribute represents reference to a material relationship indicating that this material composite has parts (or constituents).
  \param RelatesTo [out] Receives the value of RelatesTo attribute.
  */
  void getInvRelatesTo(OdDAIObjectIds& RelatesTo) const;


public:

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

  /** \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
  OdAnsiString m_Description;   // IfcText  [optional]
  OdAnsiString m_Category;   // IfcLabel  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCMATERIAL_AUTO_IMPL_H