/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSTRUCTURALLOADGROUP_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCSTRUCTURALLOADGROUP_AUTO_IMPL_H

#include "IfcGroupAutoImpl.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
  The entity IfcStructuralLoadGroup is used to structure the physical impacts. 
  By using the grouping features inherited from IfcGroup, instances of IfcStructuralAction (or its subclasses) 
  and of IfcStructuralLoadGroup can be used to define load groups, load cases and load combinations. 
  (See also IfcLoadGroupTypeEnum.)

  \changes
  
  * IFC4 changes: 
    Subtype IfcStructuralLoadCase added. Informal propositions and WHERE rule added. Predefined type LOAD_COMBINATION_GROUP made obsolete and removed.
*/
class IFC4X3_EXPORT IfcStructuralLoadGroup : public IfcGroup
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcStructuralLoadGroup);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents selects a predefined type for the load group.
  It can be differentiated between load groups, load cases, load combinations, or user-defined grouping levels.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcLoadGroupTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents selects a predefined type for the load group.
  It can be differentiated between load groups, load cases, load combinations, or user-defined grouping levels.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcLoadGroupTypeEnum PredefinedType);

  /** \details
  Returns the value of ActionType attribute. 
  This attribute represents type of actions in the group. 
  Normally needed if 'PredefinedType' specifies a LOAD_CASE.
  \returns
  Returns the value of ActionType attribute.
  */
  IfcActionTypeEnum getActionType() const;

  /** \details
  Sets the value of ActionType attribute. 
  This attribute represents type of actions in the group. 
  Normally needed if 'PredefinedType' specifies a LOAD_CASE.
  \param ActionType [in] Action type to set.
  */
  void setActionType(IfcActionTypeEnum ActionType);

  /** \details
  Returns the value of ActionSource attribute. 
  This attribute represents source of actions in the group. 
  Normally needed if 'PredefinedType' specifies a LOAD_CASE.
  \returns
  Returns the value of ActionSource attribute.
  */
  IfcActionSourceTypeEnum getActionSource() const;

  /** \details
  Sets the value of ActionSource attribute. 
  This attribute represents source of actions in the group. 
  Normally needed if 'PredefinedType' specifies a LOAD_CASE.
  \param ActionSource [in] Action source to set.
  */
  void setActionSource(IfcActionSourceTypeEnum ActionSource);

  /** \details
  Returns the value of Coefficient attribute. 
  This attribute represents load factor. If omitted, a factor is not yet known or not specified.
  A load factor of 1.0 shall be explicitly exported as Coefficient = 1.0.
  \returns
  Returns the value of Coefficient attribute.
  */
  double getCoefficient() const;

  /** \details
  Sets the value of Coefficient attribute. 
  This attribute represents load factor. If omitted, a factor is not yet known or not specified.
  A load factor of 1.0 shall be explicitly exported as Coefficient = 1.0.
  \param Coefficient [in] Coefficient to set.
  */
  void setCoefficient(double Coefficient);

  /** \details
  Returns the value of Purpose attribute. 
  This attribute represents description of the purpose of this instance. 
  Among else, possible values of the Purpose of load combinations are 
  'SLS', 'ULS', 'ALS' to indicate serviceability, ultimate, or accidental limit state.
  \returns
  Returns the value of Purpose attribute.
  */
  const OdAnsiString& getPurpose() const;

  /** \details
  Sets the value of Purpose attribute. 
  This attribute represents description of the purpose of this instance. 
  Among else, possible values of the Purpose of load combinations are 
  'SLS', 'ULS', 'ALS' to indicate serviceability, ultimate, or accidental limit state.
  \param Purpose [in] Purpose to set.
  */
  void setPurpose(const OdAnsiString& Purpose);

  /** \details
  Returns the value of SourceOfResultGroup attribute. 
  This attribute represents results which were computed using this load group.
  \param SourceOfResultGroup [out] Receives the value of SourceOfResultGroup attribute.
  */
  void getInvSourceOfResultGroup(OdDAIObjectIds& SourceOfResultGroup) const;

  /** \details
  Returns the value of LoadGroupFor attribute. 
  This attribute represents analysis models in which this load group is used.
  \param LoadGroupFor [out] Receives the value of LoadGroupFor attribute.
  */
  void getInvLoadGroupFor(OdDAIObjectIds& LoadGroupFor) const;


public:

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

  /** \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;   // IfcLoadGroupTypeEnum
  OdDAI::Enum m_ActionType;   // IfcActionTypeEnum
  OdDAI::Enum m_ActionSource;   // IfcActionSourceTypeEnum
  double m_Coefficient;   // IfcRatioMeasure  [optional]
  OdAnsiString m_Purpose;   // IfcLabel  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcStructuralResultGroup;
  friend class IfcStructuralAnalysisModel;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCSTRUCTURALLOADGROUP_AUTO_IMPL_H