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

#include "Ifc4BaseClass.h"

#include "Ifc4Enum.h"
#include "Ifc4SelectTypes.h"
#include "Ifc4CollectionTypes.h"
#include "IfcRepresentationContextAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The IfcRepresentation defines the general concept of representing product properties and in particular the product shape.
  
  - Representation Use Definition -
  Each representation, either IfcShapeRepresentation, or IfcTopologyRepresentation have a well defined attributes:
  * ContextOfItems: Reference to an IfcGeometricRepresentationContext as agreed for this representation.
  * RepresentationIdentifier: Name of the representation, for example, 'Body' for 3D shape, 'FootPrint' for 2D ground view, 'Axis' for reference axis.
  * RepresentationType: Name for the geometric, or topological representation type, for example, 'SweptSolid' for 3D swept solids, 'Brep' for boundary representation.

  \remarks
  This definition may not be instantiated.

  \changes
  
  * IFC4 changes: 
    Type of the inverse attribute OfProductRepresentation changed from "SET OF [0:1] IfcProductRepresentation FOR Representations" to "SET OF [0:?] IfcProductRepresentation FOR Representations".
*/
class IFC4_EXPORT IfcRepresentation : public OdIfc4Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4::IfcRepresentation);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ContextOfItems attribute. 
  This attribute represents definition of the representation context for which the different subtypes of representation are valid.
  \returns
  Returns the value of ContextOfItems attribute.
  */
  const OdDAIObjectId& getContextOfItems() const;

  /** \details
  Sets the value of ContextOfItems attribute. 
  This attribute represents definition of the representation context for which the different subtypes of representation are valid.
  \param ContextOfItems [in] ContextOfItems attribute to set.
  */
  void setContextOfItems(const OdDAIObjectId& ContextOfItems);

  /** \details
  Returns the value of RepresentationIdentifier attribute. 
  This attribute represents the optional identifier of the representation as used within a project.
  \returns
  Returns the value of RepresentationIdentifier attribute.
  */
  const OdAnsiString& getRepresentationIdentifier() const;

  /** \details
  Sets the value of RepresentationIdentifier attribute. 
  This attribute represents the optional identifier of the representation as used within a project.
  \param RepresentationIdentifier [in] Representation identifier to set.
  */
  void setRepresentationIdentifier(const OdAnsiString& RepresentationIdentifier);

  /** \details
  Returns the value of RepresentationType attribute. 
  This attribute represents the description of the type of a representation context. 
  The representation type defines the type of geometry or topology used for representing the product representation. 
  More information is given at the subtypes IfcShapeRepresentation and IfcTopologyRepresentation.
  The supported values for context type are to be specified by implementers agreements.
  \returns
  Returns the value of RepresentationType attribute.
  */
  const OdAnsiString& getRepresentationType() const;

  /** \details
  Sets the value of RepresentationType attribute. 
  This attribute represents the description of the type of a representation context. 
  The representation type defines the type of geometry or topology used for representing the product representation. 
  More information is given at the subtypes IfcShapeRepresentation and IfcTopologyRepresentation.
  The supported values for context type are to be specified by implementers agreements.
  \param RepresentationType [in] Representation type to set.
  */
  void setRepresentationType(const OdAnsiString& RepresentationType);

  /** \details
  Gets the value of Items attribute. 
  This attribute represents set of geometric representation items that are defined for this representation.
  \param Items [out] Receives the Items attribute.
  */
  void getItems(OdDAIObjectIds& Items) const;

  /** \details
  Returns the value of Items attribute. 
  This attribute represents set of geometric representation items that are defined for this representation.
  \returns
  Returns the value of Items attribute.
  */
  OdDAI::SetOfOdDAIObjectId& items();

  /** \details
  Returns the value of RepresentationMap attribute. 
  This attribute represents use of the representation within an IfcRepresentationMap.
  If used, this IfcRepresentation can be assigned to many representations as one of its Items using an IfcMappedItem.
  Using IfcRepresentationMap is the way to share one representation (often of type IfcShapeRepresentation) by many products.
  \param RepresentationMap [out] Receives the value of RepresentationMap attribute.
  */
  void getInvRepresentationMap(OdDAIObjectIds& RepresentationMap) const;

  /** \details
  Returns the value of LayerAssignments attribute. 
  This attribute represents assignment of the whole representation to a single or multiple layer(s). 
  The LayerAssigments can be overridden by LayerAssigments of the IfcRepresentationItem's within the list of Items.
  \param LayerAssignments [out] Receives the value of LayerAssignments attribute.
  \remarks
  Implementation agreements can restrict the maximum number of layer assignments to 1.
  */
  void getInvLayerAssignments(OdDAIObjectIds& LayerAssignments) const;

  /** \details
  Returns the value of OfProductRepresentation attribute. 
  This attribute represents reference to the product representations to which this individual representation applies. 
  In most cases it is the reference to one or many product shapes, to which this shape representation is applicable.
  \param OfProductRepresentation [out] Receives the value of OfProductRepresentation attribute.
  */
  void getInvOfProductRepresentation(OdDAIObjectIds& OfProductRepresentation) const;


public:

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

  /** \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: 
  OdDAIObjectId m_ContextOfItems;   // IfcRepresentationContext
  OdAnsiString m_RepresentationIdentifier;   // IfcLabel  [optional]
  OdAnsiString m_RepresentationType;   // IfcLabel  [optional]
  OdDAI::SetOfOdDAIObjectId m_Items; // SET [1:?] of IfcRepresentationItem

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRepresentationMap;
  friend class IfcPresentationLayerAssignment;
  friend class IfcProductRepresentation;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCREPRESENTATION_AUTO_IMPL_H