/////////////////////////////////////////////////////////////////////////////// 
// 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_ADD2_IFCPOINTBYDISTANCEEXPRESSION_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCPOINTBYDISTANCEEXPRESSION_AUTO_IMPL_H

#include "IfcPointAutoImpl.h"
#include "IfcCurveAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcPointByDistanceExpression describes a point relative to a basis curve according to distance along the basis curve. 
  The offsets default to the initial context of the curve relative to it's tangent either specified in IfcProduct.Placement 
  or in the case of a segmented curve to the IfcCurveSegment.SegmentStart where the values correspond to the following:
  * Lateral to the basis curve
  * Offset vertical to the basis curve
  * Optional additional offset parallel to the basis curve that can be used to address locations otherwise unreachable where the basis curve is tangentially discontinuous.
*/
class IFC4X3_EXPORT IfcPointByDistanceExpression : public IfcPoint
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcPointByDistanceExpression);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of DistanceAlong attribute. 
  This attribute represents the distance along the basis curve that is measured as either a IfcLengthMeasure or IfcParameterValue.
  \returns
  Returns the value of DistanceAlong attribute.
  */
  IfcCurveMeasureSelect distanceAlong();

  /** \details
  Returns the value of OffsetLateral attribute. 
  This attribute represents a lateral offset to the basis curve. This horizontal offset is measured perpendicular to the basis curve, 
  where positive values indicate to the left of the basis curve as facing in the positive parametrization direction of the basis curve, 
  and negative values indicate to the right. If DistanceAlong coincides with a point of tangential discontinuity (within precision limits), 
  then the tangent of the previous segment governs.
  \returns
  Returns the value of OffsetLateral attribute.
  */
  double getOffsetLateral() const;

  /** \details
  Sets the value of OffsetLateral attribute. 
  This attribute represents a lateral offset to the basis curve. This horizontal offset is measured perpendicular to the basis curve, 
  where positive values indicate to the left of the basis curve as facing in the positive parametrization direction of the basis curve, 
  and negative values indicate to the right. If DistanceAlong coincides with a point of tangential discontinuity (within precision limits), 
  then the tangent of the previous segment governs.
  \param OffsetLateral [in] OffsetLateral attribute to set.
  */
  void setOffsetLateral(double OffsetLateral);

  /** \details
  Returns the value of OffsetVertical attribute. 
  This attribute represents an offset vertical to the basis curve. 
  This offset is vertical to the basis curve where positive values indicate perpendicular to the tangent 
  at DistanceAlong in the plane of the tangent perpendicular to the global XY plane.
  \returns
  Returns the value of OffsetVertical attribute.
  */
  double getOffsetVertical() const;

  /** \details
  Sets the value of OffsetVertical attribute. 
  This attribute represents an offset vertical to the basis curve. 
  This offset is vertical to the basis curve where positive values indicate perpendicular to the tangent 
  at DistanceAlong in the plane of the tangent perpendicular to the global XY plane.
  \param OffsetVertical [in] OffsetVertical attribute to set.
  */
  void setOffsetVertical(double OffsetVertical);

  /** \details
  Returns the value of OffsetLongitudinal attribute. 
  This attribute represents an offset parallel to the basis curve after applying DistanceAlong, OffsetLateral, and OffsetVertical 
  to reach locations for the case of a tangentially discontinuous basis curve.
  \returns
  Returns the value of OffsetLongitudinal attribute.
  */
  double getOffsetLongitudinal() const;

  /** \details
  Sets the value of OffsetLongitudinal attribute. 
  This attribute represents an offset parallel to the basis curve after applying DistanceAlong, OffsetLateral, and OffsetVertical 
  to reach locations for the case of a tangentially discontinuous basis curve.
  \param OffsetLongitudinal [in] OffsetLongitudinal attribute to set.
  */
  void setOffsetLongitudinal(double OffsetLongitudinal);

  /** \details
  Returns the value of BasisCurve attribute. 
  This attribute represents the basis curve relative to which the point can be offset.
  \returns
  Returns the value of BasisCurve attribute.
  */
  const OdDAIObjectId& getBasisCurve() const;

  /** \details
  Sets the value of BasisCurve attribute. 
  This attribute represents the basis curve relative to which the point can be offset.
  \param BasisCurve [in] Basis curve to set.
  */
  void setBasisCurve(const OdDAIObjectId& BasisCurve);


public:

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

  /** \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: 
  OdDAI::Select m_DistanceAlong;   // IfcCurveMeasureSelect
  double m_OffsetLateral;   // IfcLengthMeasure  [optional]
  double m_OffsetVertical;   // IfcLengthMeasure  [optional]
  double m_OffsetLongitudinal;   // IfcLengthMeasure  [optional]
  OdDAIObjectId m_BasisCurve;   // IfcCurve
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCPOINTBYDISTANCEEXPRESSION_AUTO_IMPL_H