/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCMATERIALPROFILESETUSAGE_AUTO_IMPL_H
#define _IFC4X2_IFCMATERIALPROFILESETUSAGE_AUTO_IMPL_H

#include "IfcMaterialUsageDefinitionAutoImpl.h"
#include "IfcMaterialProfileSetAutoImpl.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
  IfcMaterialProfileSetUsage determines the usage of IfcMaterialProfileSet in terms of its location relative to the associated element geometry. 
  The location of a material profile set is compatible with the building element geometry (that is, material profiles should fit inside the element geometry). 
  The rules to ensure the compatibility depend on the type of the building element. 
  For building elements with shape representations which are based on extruded solids, 
  this is accomplished by referring to the identical profile definition in the shape model as in the material profile set.
*/
class IFC4X2_EXPORT IfcMaterialProfileSetUsage : public IfcMaterialUsageDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcMaterialProfileSetUsage);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ForProfileSet attribute. 
  This attribute represents the IfcMaterialProfileSet set to which the usage is applied.
  \returns
  Returns the value of ForProfileSet attribute.
  */
  const OdDAIObjectId& getForProfileSet() const;

  /** \details
  Sets the value of ForProfileSet attribute. 
  This attribute represents the IfcMaterialProfileSet set to which the usage is applied.
  \param ForProfileSet [in] ForProfileSet to set.
  */
  void setForProfileSet(const OdDAIObjectId& ForProfileSet);

  /** \details
  Returns the value of CardinalPoint attribute. 
  This attribute represents index reference to a significant point in the section profile. 
  Describes how the section is aligned relative to the longitudinal axis of the member it is associated with. 
  This parametric specification of profile alignment can be provided redundantly 
  to the explicit alignment defined by ForProfileSet.MaterialProfiles[*].Profile.
  \returns
  Returns the value of CardinalPoint attribute.
  */
  int getCardinalPoint() const;

  /** \details
  Sets the value of CardinalPoint attribute. 
  This attribute represents index reference to a significant point in the section profile.
  Describes how the section is aligned relative to the longitudinal axis of the member it is associated with. 
  This parametric specification of profile alignment can be provided redundantly 
  to the explicit alignment defined by ForProfileSet.MaterialProfiles[*].Profile.
  \param CardinalPoint [in] CardinalPoint to set.
  */
  void setCardinalPoint(int CardinalPoint);

  /** \details
  Returns the value of ReferenceExtent attribute. 
  This attribute represents extent of the extrusion of the elements body shape representation to which the IfcMaterialProfileSetUsage applies. 
  It is used as the reference value for the upper offset value (OffsetValues[2]) provided by the IfcMaterialProfileSetWithOffsets subtype for included material profiles.
  \returns
  Returns the value of ReferenceExtent attribute.
  */
  double getReferenceExtent() const;

  /** \details
  Sets the value of ReferenceExtent attribute. 
  This attribute represents extent of the extrusion of the elements body shape representation to which the IfcMaterialProfileSetUsage applies. 
  It is used as the reference value for the upper offset value (OffsetValues[2]) provided by the IfcMaterialProfileSetWithOffsets subtype for included material profiles.
  \param ReferenceExtent [in] Reference extent to set.
  */
  void setReferenceExtent(double ReferenceExtent);


public:

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

  /** \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: 
  OdDAIObjectId m_ForProfileSet;   // IfcMaterialProfileSet
  int m_CardinalPoint;   // IfcCardinalPointReference  [optional]
  IfcPositiveLengthMeasure m_ReferenceExtent;   // IfcPositiveLengthMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X2_IFCMATERIALPROFILESETUSAGE_AUTO_IMPL_H