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

#include "IfcObjectDefinitionAutoImpl.h"
#include "IfcUnitAssignmentAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcContext is the generalization of a project context in which objects, type objects, property sets, and properties are defined. 
  The IfcProject as subtype of IfcContext provides the context for all information on a construction project, 
  it can include one or several IfcProjectLibrary's as subtype of IfcContext to register the included libraries for the project. 
  A library of products that is referenced is declared within the IfcProjectLibrary as the context of that library.
  
  A context is declared by the IfcRelDeclares object that refers to the corresponding objects within the context. 
  More specific relationships are introduced at the level of subtypes.
*/
class IFC4X4_EXPORT IfcContext : public IfcObjectDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x4::IfcContext);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ObjectType attribute. 
  This attribute represents the object type denotes a particular type that indicates the object further. 
  The use has to be established at the level of instantiable subtypes.
  \returns
  Returns the value of ObjectType attribute.
  \remarks
  Subtypes of IfcContext do not introduce a PredefinedType attribute, 
  therefore the usage of ObjectType is not bound to the selection of USERDEFINED within the PredefinedType enumeration.
  */
  const OdAnsiString& getObjectType() const;

  /** \details
  Sets the value of ObjectType attribute. 
  This attribute represents the object type denotes a particular type that indicates the object further. 
  The use has to be established at the level of instantiable subtypes.
  \param ObjectType [in] Object type to set.
  \remarks
  Subtypes of IfcContext do not introduce a PredefinedType attribute, 
  therefore the usage of ObjectType is not bound to the selection of USERDEFINED within the PredefinedType enumeration.
  */
  void setObjectType(const OdAnsiString& ObjectType);

  /** \details
  Returns the value of LongName attribute. 
  This attribute represents long name for the context as used for reference purposes.
  \returns
  Returns the value of LongName attribute.
  */
  const OdAnsiString& getLongName() const;

  /** \details
  Sets the value of LongName attribute. 
  This attribute represents long name for the context as used for reference purposes.
  \param LongName [in] Long name to set.
  */
  void setLongName(const OdAnsiString& LongName);

  /** \details
  Returns the value of Phase attribute. 
  This attribute represents current project phase, or life-cycle phase of this project. 
  Applicable values have to be agreed upon by view definitions or implementer agreements.
  \returns
  Returns the value of Phase attribute.
  */
  const OdAnsiString& getPhase() const;

  /** \details
  Sets the value of Phase attribute. 
  This attribute represents current project phase, or life-cycle phase of this project. 
  Applicable values have to be agreed upon by view definitions or implementer agreements.
  \param Phase [in] Phase to set.
  */
  void setPhase(const OdAnsiString& Phase);

  /** \details
  Returns the value of RepresentationContexts attribute. 
  This attribute represents context of the representations used within the context. 
  When the context is a project and it includes shape representations for its components, 
  one or several geometric representation contexts need to be included that define 
  e.g. the world coordinate system, the coordinate space dimensions, and/or the precision factor.
  \param RepresentationContexts [out] Receives representation contexts.
  \remarks
  IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.
  */
  void getRepresentationContexts(OdDAIObjectIds& RepresentationContexts) const;

  /** \details
  Returns the value of RepresentationContexts attribute. 
  This attribute represents context of the representations used within the context. 
  When the context is a project and it includes shape representations for its components, 
  one or several geometric representation contexts need to be included that define 
  e.g. the world coordinate system, the coordinate space dimensions, and/or the precision factor.
  \returns
  Returns the value of RepresentationContexts attribute.
  \remarks
  IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.
  */
  OdDAI::SetOfOdDAIObjectId& representationContexts();

  /** \details
  Returns the value of UnitsInContext attribute. 
  This attribute represents units globally assigned to measure types used within the context.
  \returns
  Returns the value of UnitsInContext attribute.
  \remarks
  IFC4 CHANGE: The attribute has been changed to be optional. 
  Change made with upward compatibility for file-based exchange.
  */
  const OdDAIObjectId& getUnitsInContext() const;

  /** \details
  Sets the value of UnitsInContext attribute. 
  This attribute represents units globally assigned to measure types used within the context.
  \param UnitsInContext [in] Units in context to set.
  \remarks
  IFC4 CHANGE: The attribute has been changed to be optional. 
  Change made with upward compatibility for file-based exchange.
  */
  void setUnitsInContext(const OdDAIObjectId& UnitsInContext);

  /** \details
  Returns the value of IsDefinedBy attribute. 
  This attribute represents a set of relationships to property set definitions that are attached to this context. 
  Those statically or dynamically defined properties contain alphanumeric information content that further defines the context.
  \param IsDefinedBy [out] Receives the value of IsDefinedBy attribute.
  \remarks
  IFC4 CHANGE: The data type has been changed from IfcRelDefines to IfcRelDefinesByProperties with upward compatibility for file-based exchange.
  */
  void getInvIsDefinedBy(OdDAIObjectIds& IsDefinedBy) const;

  /** \details
  Returns the value of Declares attribute. 
  This attribute represents reference to the IfcRelDeclares relationship that assigns 
  the uppermost entities of includes hierarchies to this context instance.
  \param Declares [out] Receives the value of Declares attribute.
  \remarks
  The spatial hierarchy is assigned to IfcProject using the IfcRelAggregates relationship.
  */
  void getInvDeclares(OdDAIObjectIds& Declares) const;


public:

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

  /** \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: 
  OdAnsiString m_ObjectType;   // IfcLabel  [optional]
  OdAnsiString m_LongName;   // IfcLabel  [optional]
  OdAnsiString m_Phase;   // IfcLabel  [optional]
  OdDAI::SetOfOdDAIObjectId m_RepresentationContexts; // SET [1:?] of IfcRepresentationContext [optional]

  OdDAIObjectId m_UnitsInContext;   // IfcUnitAssignment  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelDefinesByProperties;
  friend class IfcRelDeclares;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCCONTEXT_AUTO_IMPL_H