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

#include "IfcStructuralActivityAutoImpl.h"
#include "IfcStructuralReactionAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A structural action is a structural activity that acts upon a structural item or building element.
  Structural actions are grouped into either an IfcStructuralLoadGroup of predefined type LOAD_GROUP or, more often, an IfcStructuralLoadCase. 
  This is accomplished via the inverse relationship HasAssignments and an IfcRelAssignsToGroup relationship object. 
  IfcStructuralLoadGroup.LoadGroupFor or IfcStructuralLoadCase.LoadGroupFor respectively refers to the structural analysis model(s) in which the loads are used.
  
  It is possible to establish relationships between actions in one analysis model and reactions in another analysis model which cause the actions. 
  For example, a support reaction from one structural system can be taken over as a load onto another supporting structural system. 
  This is expressed by means of the inverse relationship ReferencedBy of the action and an IfcRelAssignsToProduct relationship object. 
  IfcRelAssignsToProduct.Name is set to 'Causes' and IfcRelAssignsToProduct.RelatedObjects refers to an instance of a subtype of IfcStructuralReaction.
*/
class IFC2X2_FINAL_EXPORT IfcStructuralAction : public IfcStructuralActivity
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x2_final::IfcStructuralAction);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of DestabilizingLoad attribute. 
  This attribute represents indicates if this action can cause a stability problem. 
  If it is 'FALSE', no further investigations regarding stability problems are necessary.
  \returns
  Returns the value of DestabilizingLoad attribute.
  */
  OdDAI::Boolean getDestabilizingLoad() const;

  /** \details
  Sets the value of DestabilizingLoad attribute. 
  This attribute represents indicates if this action can cause a stability problem. 
  If it is 'FALSE', no further investigations regarding stability problems are necessary.
  \param DestabilizingLoad [in] Destabilizing load to set.
  */
  void setDestabilizingLoad(OdDAI::Boolean DestabilizingLoad);

  /** \details
  Returns the value of ProjectedOrTrue attribute. 
  This attribute indicates whether the load values are specified by using the length of the member on which they act (true length) 
  or by using the projected length resulting from the loaded member and the global project coordinate system. 
  It is only considered if the global project coordinate system is used, and if the action is of type IfcStructuralLinearAction or IfcStructuralPlanarAction.
  \returns
  Returns the value of ProjectedOrTrue attribute.
  */
  IfcProjectedOrTrueLengthEnum getProjectedOrTrue() const;

  /** \details
  Sets the value of ProjectedOrTrue attribute. 
  This attribute indicates whether the load values are specified by using the length of the member on which they act (true length) 
  or by using the projected length resulting from the loaded member and the global project coordinate system. 
  It is only considered if the global project coordinate system is used, and if the action is of type IfcStructuralLinearAction or IfcStructuralPlanarAction.
  \param ProjectedOrTrue [in] ProjectedOrTrue attribute to set.
  */
  void setProjectedOrTrue(IfcProjectedOrTrueLengthEnum ProjectedOrTrue);

  /** \details
  Returns the value of CausedBy attribute. 
  This attribute represents an optional reference to an instance of IfcStructuralReaction representing 
  a result of another structural analysis model which creates this action upon the considered structural analysis model.
  \returns
  Returns the value of CausedBy attribute.
  */
  const OdDAIObjectId& getCausedBy() const;

  /** \details
  Sets the value of CausedBy attribute. 
  This attribute represents an optional reference to an instance of IfcStructuralReaction representing 
  a result of another structural analysis model which creates this action upon the considered structural analysis model.
  \param CausedBy [in] CausedBy attribute to set.
  */
  void setCausedBy(const OdDAIObjectId& CausedBy);


public:

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

  /** \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: 
  OdDAI::Boolean m_DestabilizingLoad;   // BOOLEAN
  OdDAI::Enum m_ProjectedOrTrue;   // IfcProjectedOrTrueLengthEnum
  OdDAIObjectId m_CausedBy;   // IfcStructuralReaction  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCSTRUCTURALACTION_AUTO_IMPL_H