/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCCRANERAILASHAPEPROFILEDEF_AUTO_IMPL_H
#define _IFC2X3_IFCCRANERAILASHAPEPROFILEDEF_AUTO_IMPL_H

#include "IfcParameterizedProfileDefAutoImpl.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
  The IfcCraneRailAShapeProfileDef defines a section profile that provides the defining parameters of a crane rail to be used by the swept area solid. 
  Its parameters and orientation relative to the position coordinate system are according to the following illustration. 
  The center of the position coordinate system is in the profiles center of the bounding box.
  
  The center of gravity, if given, is located in x direction within the center of the bounding box, 
  and in y-direction along the negative y axis, the offset value is given by the offset parameter CentreOfGravityInY.
*/
class IFC2X3_EXPORT IfcCraneRailAShapeProfileDef : public IfcParameterizedProfileDef
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcCraneRailAShapeProfileDef);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of OverallHeight attribute. 
  This attribute represents Total extent of the height, defined parallel to the y axis of the position coordinate system.
  \returns
  Returns the value of OverallHeight attribute.
  */
  double getOverallHeight() const;

  /** \details
  Sets the value of OverallHeight attribute. 
  This attribute represents Total extent of the height, defined parallel to the y axis of the position coordinate system.
  \param OverallHeight [in] OverallHeight attribute to set.
  */
  void setOverallHeight(double OverallHeight);

  /** \details
  Returns the value of BaseWidth2 attribute. 
  This attribute represents total extent of the width of the base, 
  defined parallel to the x axis of the position coordinate system.
  \returns
  Returns the value of BaseWidth2 attribute.
  */
  double getBaseWidth2() const;

  /** \details
  Sets the value of BaseWidth2 attribute. 
  This attribute represents total extent of the width of the base, 
  defined parallel to the x axis of the position coordinate system.
  \param BaseWidth2 [in] BaseWidth2 attribute to set.
  */
  void setBaseWidth2(double BaseWidth2);

  /** \details
  Returns the value of Radius attribute. 
  This attribute represents an edge radius.
  \returns
  Returns the value of Radius attribute.
  */
  double getRadius() const;

  /** \details
  Sets the value of Radius attribute. 
  This attribute represents an edge radius.
  \param Radius [in] Radius attribute to set.
  */
  void setRadius(double Radius);

  /** \details
  Returns the value of HeadWidth attribute. 
  This attribute represents total extent of the width of the head, defined parallel to the x axis of the position coordinate system.
  \returns
  Returns the value of HeadWidth attribute.
  */
  double getHeadWidth() const;

  /** \details
  Sets the value of HeadWidth attribute. 
  This attribute represents total extent of the width of the head, defined parallel to the x axis of the position coordinate system.
  \param HeadWidth [in] HeadWidth attribute to set.
  */
  void setHeadWidth(double HeadWidth);

  /** \details
  Returns the value of HeadDepth2 attribute. 
  This attribute represents head depth of the A shape crane rail.
  \returns
  Returns the value of HeadDepth2 attribute.
  */
  double getHeadDepth2() const;

  /** \details
  Sets the value of HeadDepth2 attribute. 
  This attribute represents head depth of the A shape crane rail.
  \param HeadDepth2 [in] HeadDepth2 attribute to set.
  */
  void setHeadDepth2(double HeadDepth2);

  /** \details
  Returns the value of HeadDepth3 attribute. 
  This attribute represents head depth of the A shape crane rail.
  \returns
  Returns the value of HeadDepth3 attribute.
  */
  double getHeadDepth3() const;

  /** \details
  Sets the value of HeadDepth3 attribute. 
  This attribute represents head depth of the A shape crane rail.
  \param HeadDepth3 [in] HeadDepth3 attribute to set.
  */
  void setHeadDepth3(double HeadDepth3);

  /** \details
  Returns the value of WebThickness attribute. 
  This attribute represents thickness of the web of the A shape crane rail.
  \returns
  Returns the value of WebThickness attribute.
  */
  double getWebThickness() const;

  /** \details
  Sets the value of WebThickness attribute. 
  This attribute represents thickness of the web of the A shape crane rail.
  \param WebThickness [in] WebThickness attribute to set.
  */
  void setWebThickness(double WebThickness);

  /** \details
  Returns the value of BaseWidth4 attribute. 
  This attribute represents  width of the base where thickness changes, 
  defined parallel to the x axis of the position coordinate system.
  \returns
  Returns the value of BaseWidth4 attribute.
  */
  double getBaseWidth4() const;

  /** \details
  Sets the value of BaseWidth4 attribute. 
  This attribute represents  width of the base where thickness changes, 
  defined parallel to the x axis of the position coordinate system.
  \param BaseWidth4 [in] BaseWidth4 attribute to set.
  */
  void setBaseWidth4(double BaseWidth4);

  /** \details
  Returns the value of BaseDepth1 attribute. 
  This attribute represents  base depth of the A shape crane rail.
  \returns
  Returns the value of BaseDepth1 attribute.
  */
  double getBaseDepth1() const;

  /** \details
  Sets the value of BaseDepth1 attribute. 
  This attribute represents  base depth of the A shape crane rail.
  \param BaseDepth1 [in] BaseDepth1 attribute to set.
  */
  void setBaseDepth1(double BaseDepth1);

  /** \details
  Returns the value of BaseDepth2 attribute. 
  This attribute represents base depth of the A shape crane rail.
  \returns
  Returns the value of BaseDepth2 attribute.
  */
  double getBaseDepth2() const;

  /** \details
  Sets the value of BaseDepth2 attribute. 
  This attribute represents base depth of the A shape crane rail.
  \param BaseDepth2 [in] BaseDepth2 attribute to set.
  */
  void setBaseDepth2(double BaseDepth2);

  /** \details
  Returns the value of BaseDepth2 attribute. 
  This attribute represents depth of the base where thickness changes.
  \returns
  Returns the value of BaseDepth2 attribute.
  */
  double getBaseDepth3() const;

  /** \details
  Sets the value of BaseDepth2 attribute. 
  This attribute represents depth of the base where thickness changes.
  \param BaseDepth3 [in] BaseDepth3 attribute to set.
  */
  void setBaseDepth3(double BaseDepth3);

  /** \details
  Returns the value of CentreOfGravityInY attribute. 
  This attribute represents a location of center of gravity along the y axis measured from the center of the bounding box.
  \returns
  Returns the value of CentreOfGravityInY attribute.
  */
  double getCentreOfGravityInY() const;

  /** \details
  Sets the value of CentreOfGravityInY attribute. 
  This attribute represents a location of center of gravity along the y axis measured from the center of the bounding box.
  \param CentreOfGravityInY [in] CentreOfGravityInY attribute to set.
  */
  void setCentreOfGravityInY(double CentreOfGravityInY);


public:

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

  /** \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: 
  IfcPositiveLengthMeasure m_OverallHeight;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_BaseWidth2;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_Radius;   // IfcPositiveLengthMeasure  [optional]
  IfcPositiveLengthMeasure m_HeadWidth;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_HeadDepth2;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_HeadDepth3;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_WebThickness;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_BaseWidth4;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_BaseDepth1;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_BaseDepth2;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_BaseDepth3;   // IfcPositiveLengthMeasure
  IfcPositiveLengthMeasure m_CentreOfGravityInY;   // IfcPositiveLengthMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCCRANERAILASHAPEPROFILEDEF_AUTO_IMPL_H