/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSTRUCTURALCURVEMEMBER_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCSTRUCTURALCURVEMEMBER_AUTO_IMPL_H

#include "IfcStructuralMemberAutoImpl.h"
#include "IfcDirectionAutoImpl.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
  Instances of IfcStructuralCurveMember describe edge members, i.e. structural analysis idealizations of beams, columns, rods etc. 
  Curve members can be straight or curved.
  
  - Coordinate Systems -
  See definitions at IfcStructuralItem. The local coordinate system is established by the reference curve specified by topology representation and by the attribute Axis. 
  The local x axis is parallel with the tangent on the reference curve. 
  The local z axis is located in the surface which is created by sweeping Axis along the reference curve and is directed according to Axis. 
  The local y axis is directed such that x,y,z form a right-handed Cartesian coordinate system.
  
  - Material Profile Set Usage -
  The material of direct instances IfcStructuralCurveMember (in contrast to instances of the subtype IfcStructuralCurveMemberVarying) 
  is defined by IfcMaterialProfileSetUsage and attached by the IfcRelAssociatesMaterial.RelatingMaterial. 
  It is accessible by the inverse HasAssociations relationship. 
  Composite profile beams can be represented by referring to several IfcMaterialProfiles within the IfcMaterialProfileSet 
  that is referenced from the IfcMaterialProfileSetUsage. In case of tapered members, 
  the material profile usage subtype IfcMaterialProfileSetUsageTapering is used 
  which specifies IfcMaterialProfileSets separately at the start and the end of the tapered member.
  
  - Reference Topology -
  The local coordinate system is established by the reference curve specified by topology representation and by the attribute Axis. 
  * The local x axis is parallel with the tangent on the reference curve. 
  * The local z axis is located in the surface which is created by sweeping Axis along the reference curve and is directed according to Axis. 
  * The local y axis is directed such that x,y,z form a right-handed Cartesian coordinate system.
  
  This concept can be applied to the following resources:
  * IfcEdge
  
  - Structural Connectivity -
  This concept can be applied to the following resources:
  * IfcStructuralPointConnection - Point connections at each end of the member.

  \changes
  
  * IFC4 changes: 
    Type of the PredefinedType attribute changed from "IfcStructuralCurveTypeEnum" to "IfcStructuralCurveMemberTypeEnum"
*/
class IFC4X3_RC1_EXPORT IfcStructuralCurveMember : public IfcStructuralMember
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcStructuralCurveMember);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents type of member with respect to its load carrying behavior in this analysis idealization.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcStructuralCurveMemberTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents type of member with respect to its load carrying behavior in this analysis idealization.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcStructuralCurveMemberTypeEnum PredefinedType);

  /** \details
  Returns the value of Axis attribute. 
  This attribute represents direction which is used in the definition of the local z axis.
  Axis is specified relative to the so-called global coordinate system, i.e. the SELF\IfcProduct.ObjectPlacement.
  \returns
  Returns the value of Axis attribute.
  \remarks
  It is desirable and usually possible that many instances of IfcStructuralCurveConnection 
  and IfcStructuralCurveMember share a common instance of IfcDirection as their Axis attribute.
  */
  const OdDAIObjectId& getAxis() const;

  /** \details
  Sets the value of Axis attribute. 
  This attribute represents direction which is used in the definition of the local z axis.
  Axis is specified relative to the so-called global coordinate system, i.e. the SELF\IfcProduct.ObjectPlacement.
  \param Axis [in] Axis to set.
  \remarks
  It is desirable and usually possible that many instances of IfcStructuralCurveConnection 
  and IfcStructuralCurveMember share a common instance of IfcDirection as their Axis attribute.
  */
  void setAxis(const OdDAIObjectId& Axis);


public:

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

  /** \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::Enum m_PredefinedType;   // IfcStructuralCurveMemberTypeEnum
  OdDAIObjectId m_Axis;   // IfcDirection
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCSTRUCTURALCURVEMEMBER_AUTO_IMPL_H