/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSTRUCTURALANALYSISMODEL_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCSTRUCTURALANALYSISMODEL_AUTO_IMPL_H

#include "IfcSystemAutoImpl.h"
#include "IfcAxis2Placement3DAutoImpl.h"
#include "IfcObjectPlacementAutoImpl.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
  The IfcStructuralAnalysisModel is used to assemble all information needed to represent a structural analysis model. 
  It encompasses certain general properties (such as analysis type), references to all contained structural members, 
  structural supports or connections, as well as loads and the respective load results.
  
  Important functionalities for the description of an analysis model are derived from existing IFC entities:
  * From IfcSystem it inherits the ability to couple the built system via IfcRelReferencedInSpatialStructure to one or more IfcSpatialElement subtypes as necessary. 
  * From IfcGroup it inherits the inverse attribute IsGroupedBy, pointing to the relationship class IfcRelAssignsToGroup. 
    This allows the grouping of structural members (instances of IfcStructuralMember), and supports (instances of IfcStructuralConnection which belong to a specific analysis model.
  * From IfcObjectDefinition it inherits the inverse attribute IsDecomposedBy pointing to the relationship class IfcRelAggregates. 
    It provides the hierarchy between the separate (partial) analysis models.
*/
class IFC4X3_RC1_EXPORT IfcStructuralAnalysisModel : public IfcSystem
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcStructuralAnalysisModel);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents a type of the structural analysis model.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcAnalysisModelTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents a type of the structural analysis model.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcAnalysisModelTypeEnum PredefinedType);

  /** \details
  Returns the value of OrientationOf2DPlane attribute. 
  This attribute defines the upright direction to the focused plane (z-axes) if the selected model type (PredefinedType) describes a 2D system.
  \returns
  Returns the value of OrientationOf2DPlane attribute.
  \remarks
  This attribute is needed because all data for the structural analysis model (structural members, structural activities) are defined by using 3D space. 
  The orientation is given in relation to the coordinate system of the project. With 3D systems this value is not asserted.
  */
  const OdDAIObjectId& getOrientationOf2DPlane() const;

  /** \details
  Sets the value of OrientationOf2DPlane attribute. 
  This attribute defines the upright direction to the focused plane (z-axes) if the selected model type (PredefinedType) describes a 2D system.
  \param OrientationOf2DPlane [in] Orientation of 2D plane to set.
  \remarks
  This attribute is needed because all data for the structural analysis model (structural members, structural activities) are defined by using 3D space. 
  The orientation is given in relation to the coordinate system of the project. With 3D systems this value is not asserted.
  */
  void setOrientationOf2DPlane(const OdDAIObjectId& OrientationOf2DPlane);

  /** \details
  Sets the value of LoadedBy attribute. 
  This attribute represents references to all load groups to be analyzed.
  \param LoadedBy [out] Receives the LoadedBy attribute.
  */
  void getLoadedBy(OdDAIObjectIds& LoadedBy) const;

  /** \details
  Returns the value of LoadedBy attribute. 
  This attribute represents references to all load groups to be analyzed.
  \returns
  Returns the value of LoadedBy attribute.
  */
  OdDAI::SetOfOdDAIObjectId& loadedBy();

  /** \details
  Gets the value of HasResults attribute. 
  This attribute represents references to all result groups available for this structural analysis model.
  \param HasResults [out] Receives the HasResults attribute.
  */
  void getHasResults(OdDAIObjectIds& HasResults) const;

  /** \details
  Returns the value of HasResults attribute. 
  This attribute represents references to all result groups available for this structural analysis model.
  \returns
  Returns the value of HasResults attribute.
  */
  OdDAI::SetOfOdDAIObjectId& hasResults();

  /** \details
  Returns the value of SharedPlacement attribute. 
  This attribute allows easy retrieval of the common object placement.
  \returns
  Returns the value of SharedPlacement attribute.
  */
  const OdDAIObjectId& getSharedPlacement() const;

  /** \details
  Sets the value of SharedPlacement attribute. 
  This attribute allows easy retrieval of the common object placement.
  \param SharedPlacement [in] Shared placement to set.
  */
  void setSharedPlacement(const OdDAIObjectId& SharedPlacement);


public:

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

  /** \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
  Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
  */
  virtual void setInverseCounterParts() 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;   // IfcAnalysisModelTypeEnum
  OdDAIObjectId m_OrientationOf2DPlane;   // IfcAxis2Placement3D  [optional]
  OdDAI::SetOfOdDAIObjectId m_LoadedBy; // SET [1:?] of IfcStructuralLoadGroup [optional]

  OdDAI::SetOfOdDAIObjectId m_HasResults; // SET [1:?] of IfcStructuralResultGroup [optional]

  OdDAIObjectId m_SharedPlacement;   // IfcObjectPlacement  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCSTRUCTURALANALYSISMODEL_AUTO_IMPL_H