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

#include "Ifc2x3BaseClass.h"

#include "Ifc2x3Enum.h"
#include "Ifc2x3SelectTypes.h"
#include "Ifc2x3CollectionTypes.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcConstraint is used to define a constraint or limiting value or 
  boundary condition that can be applied to an object or to the value of a property.
  
  Constraints can be subdivided into user-defined constraints and system-defined constraints. 
  User-defined constraints are applied by a user and are restricted to high-level definitions such as object properties. 
  System-defined constraints can apply to any object attribute, are typically defined by an application 
  to enforce data validation or parametric behavior, and are intended to be enforced 
  by applications but not to be directly editable by an end-user.

  \remarks
  This definition may not be instantiated.
*/
class IFC2X3_EXPORT IfcConstraint : public OdIfc2x3Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x3::IfcConstraint);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents a human-readable name that is used for the constraint.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents a human-readable name that is used for the constraint.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents a human-readable description that can apply additional information about a constraint.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents a human-readable description that can apply additional information about a constraint.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of ConstraintGrade attribute. 
  This attribute represents enumeration that qualifies the type of constraint.
  \returns
  Returns the value of ConstraintGrade attribute.
  */
  IfcConstraintEnum getConstraintGrade() const;

  /** \details
  Sets the value of ConstraintGrade attribute. 
  This attribute represents enumeration that qualifies the type of constraint.
  \param ConstraintGrade [in] Constraint grade to set.
  */
  void setConstraintGrade(IfcConstraintEnum ConstraintGrade);

  /** \details
  Returns the value of ConstraintSource attribute. 
  This attribute represents any source material, such as a code or standard, from which the constraint originated.
  \returns
  Returns the value of ConstraintSource attribute.
  */
  const OdAnsiString& getConstraintSource() const;

  /** \details
  Sets the value of ConstraintSource attribute. 
  This attribute represents any source material, such as a code or standard, from which the constraint originated.
  \param ConstraintSource [in] Constraint source to set.
  */
  void setConstraintSource(const OdAnsiString& ConstraintSource);

  /** \details
  Returns the value of CreatingActor attribute. 
  This attribute represents person and/or organization that has created the constraint.
  \returns
  Returns the value of CreatingActor attribute.
  */
  IfcActorSelect creatingActor();

  /** \details
  Returns the value of CreationTime attribute. 
  This attribute represents time when information specifying the constraint instance was created.
  \returns
  Returns the value of CreationTime attribute.
  */
  IfcDateTimeSelect creationTime();

  /** \details
  Returns the value of UserDefinedGrade attribute. 
  This attribute allows specification of user-defined grade of the constraint beyond 
  the enumeration values provided by ConstraintGrade attribute of type IfcConstraintEnum. 
  When a value is provided for attribute UserDefinedGrade in parallel the attribute ConstraintGrade has enumeration value USERDEFINED.
  \returns
  Returns the value of UserDefinedGrade attribute.
  */
  const OdAnsiString& getUserDefinedGrade() const;

  /** \details
  Sets the value of UserDefinedGrade attribute. 
  This attribute allows specification of user-defined grade of the constraint beyond 
  the enumeration values provided by ConstraintGrade attribute of type IfcConstraintEnum.
  When a value is provided for attribute UserDefinedGrade in parallel the attribute ConstraintGrade has enumeration value USERDEFINED.
  \param UserDefinedGrade [in] User-defined grade to set.
  */
  void setUserDefinedGrade(const OdAnsiString& UserDefinedGrade);

  /** \details
  Gets the value of ClassifiedAs attribute. 
  This attribute represents reference to the constraint classifications through objectified relationship.
  \param ClassifiedAs [out] Receives the ClassifiedAs attribute.
  */
  void getInvClassifiedAs(OdDAIObjectIds& ClassifiedAs) const;

  /** \details
  Gets the value of RelatesConstraints attribute. 
  This attribute references to the objectified relationships that relate other constraints with this constraint.
  \param RelatesConstraints [out] Receives the RelatesConstraints attribute.
  */
  void getInvRelatesConstraints(OdDAIObjectIds& RelatesConstraints) const;

  /** \details
  Gets the value of IsRelatedWith attribute. 
  This attribute references to the objectified relationships that relate this constraint with other constraints.
  \param IsRelatedWith [out] Receives the IsRelatedWith attribute.
  */
  void getInvIsRelatedWith(OdDAIObjectIds& IsRelatedWith) const;

  /** \details
  Returns the value of PropertiesForConstraint attribute. 
  This attribute represents reference to the properties to which the constraint is applied.
  \param PropertiesForConstraint [out] Receives the value of PropertiesForConstraint attribute.
  */
  void getInvPropertiesForConstraint(OdDAIObjectIds& PropertiesForConstraint) const;

  /** \details
  Returns the value of PropertiesForConstraint attribute. 
  This attribute represents reference to the relationships that collect other constraints into this aggregate constraint.
  \param Aggregates [out] Receives the value of Aggregates attribute.
  */
  void getInvAggregates(OdDAIObjectIds& Aggregates) const;

  /** \details
  Returns the value of IsAggregatedIn attribute. 
  This attribute represents reference to the relationships that relate this constraint into aggregate constraints.
  \param IsAggregatedIn [out] Receives the value of IsAggregatedIn attribute.
  */
  void getInvIsAggregatedIn(OdDAIObjectIds& IsAggregatedIn) const;


public:

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

  /** \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_Name;   // IfcLabel
  OdAnsiString m_Description;   // IfcText  [optional]
  OdDAI::Enum m_ConstraintGrade;   // IfcConstraintEnum
  OdAnsiString m_ConstraintSource;   // IfcLabel  [optional]
  OdDAI::Select m_CreatingActor;   // IfcActorSelect  [optional]
  OdDAI::Select m_CreationTime;   // IfcDateTimeSelect  [optional]
  OdAnsiString m_UserDefinedGrade;   // IfcLabel  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcConstraintClassificationRelationship;
  friend class IfcConstraintRelationship;
  friend class IfcConstraintRelationship;
  friend class IfcPropertyConstraintRelationship;
  friend class IfcConstraintAggregationRelationship;
  friend class IfcConstraintAggregationRelationship;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCCONSTRAINT_AUTO_IMPL_H