/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCOBJECT_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCOBJECT_AUTO_IMPL_H

#include "IfcObjectDefinitionAutoImpl.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
  An IfcObject is the generalization of any semantically treated thing or process. 
  Objects are things as they appear - i.e. occurrences.
  
  Objects are independent pieces of information that might contain or reference other pieces of information. 
  There are several relationships in which objects can be involved:
  * Association to external/internal resource information - an association relationship that refers to external/internal sources of information. 
    See supertype IfcObjectDefinition for more information.
  * Assignment of other objects - an assignment relationship that refers to other types of objects. See supertype IfcObjectDefinition for more information.
  * Aggregation of other objects - an aggregation relationship that establishes a whole/part relation. 
    Objects can either be a whole, or a part, or both. See supertype IfcObjectDefinition for more information.
  * Assignment of a type : IsTypedBy - a definition relationship IfcRelDefinesByType that uses a type definition to define 
    the common characteristics of this occurrences, potentially including the common shape representation and common properties 
    of all object occurrences assigned to this type. It is a specific - occurrence relationship with implied dependencies 
    (as the occurrence properties depend on the properties of the type, but can override them).
  * Assignment of a partial type : IsDeclaredBy, Declares - a definition relationship IfcRelDefinesByObject that uses a component of a type definition 
    (a part of a type, called the "declaring part") to define a component of an occurrence (part of occurrence, called the "reflected part"). 
    This is also referred to as a "deep copy". The common characteristics of all parts in the occurrence are defined by parts in the type. 
    It is a specific - occurrence relationship with implied dependencies (as the occurrence properties depend on the properties of the type, but can override them).
  * Assignment of property sets : IsDefinedBy - a definition relationship IfcRelDefinesByProperties that assigns property set definitions to the object occurrence.

  \changes
  
  * IFC4 changes: 
    * Name of the inverse attribute IsDefinedBy changed to IsDeclaredBy.
    * Type of the inverse attribute IsDefinedBy changed from "SET OF [0:?] IfcRelDefines FOR RelatedObjects" to "SET OF [0:1] IfcRelDefinesByObject FOR RelatedObjects"
*/
class IFC4X3_EXPORT IfcObject : public IfcObjectDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcObject);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ObjectType attribute. 
  This attribute represents the type denotes a particular type that indicates the object further. 
  The use has to be established at the level of instantiable subtypes. 
  In particular it holds the user defined type, if the enumeration of the attribute PredefinedType is set to USERDEFINED.
  \returns
  Returns the value of ObjectType attribute.
  */
  const OdAnsiString& getObjectType() const;

  /** \details
  Sets the value of ObjectType attribute. 
  This attribute represents the type denotes a particular type that indicates the object further. 
  The use has to be established at the level of instantiable subtypes. 
  In particular it holds the user defined type, if the enumeration of the attribute PredefinedType is set to USERDEFINED.
  \param ObjectType [in] Object type to set.
  */
  void setObjectType(const OdAnsiString& ObjectType);

  /** \details
  Returns the value of IsDeclaredBy attribute. 
  This attribute represents link to the relationship object pointing to the declaring object 
  that provides the object definitions for this object occurrence. 
  The declaring object has to be part of an object type decomposition. 
  The associated IfcObject, or its subtypes, contains the specific information (as part of a type, or style, definition), 
  that is common to all reflected instances of the declaring IfcObject, or its subtypes.
  \param IsDeclaredBy [out] Receives the value of IsDeclaredBy attribute.
  \remarks
  IFC4 CHANGE: New inverse relationship, change made with upward compatibility for file-based exchange.
  */
  void getInvIsDeclaredBy(OdDAIObjectIds& IsDeclaredBy) const;

  /** \details
  Returns the value of Declares attribute. 
  This attribute represents link to the relationship object pointing to the reflected object(s) 
  that receives the object definitions. The reflected object has to be part of an object occurrence decomposition. 
  The associated IfcObject, or its subtypes, provides the specific information (as part of a type, or style, definition), 
  that is common to all reflected instances of the declaring IfcObject, or its subtypes.
  \param Declares [out] Receives the value of Declares attribute.
  \remarks
  IFC4 CHANGE: New inverse relationship, change made with upward compatibility for file-based exchange.
  */
  void getInvDeclares(OdDAIObjectIds& Declares) const;

  /** \details
  Returns the value of IsTypedBy attribute. 
  This attribute represents set of relationships to the object type that provides the type definitions for this object occurrence. 
  The then associated IfcTypeObject, or its subtypes, contains the specific information (or type, or style), 
  that is common to all instances of IfcObject, or its subtypes, referring to the same type.
  \param IsTypedBy [out] Receives the value of IsTypedBy attribute.
  \remarks
  IFC4 CHANGE  New inverse relationship, the link to IfcRelDefinesByType had previously be included in the inverse relationship IfcRelDefines. 
  Change made with upward compatibility for file-based exchange.
  */
  void getInvIsTypedBy(OdDAIObjectIds& IsTypedBy) const;

  /** \details
  Returns the value of IsDefinedBy attribute. 
  This attribute represents set of relationships to property set definitions attached to this object. 
  Those statically or dynamically defined properties contain alphanumeric information content that further defines the object.
  \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;


public:

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

  /** \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]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCOBJECT_AUTO_IMPL_H