///////////////////////////////////////////////////////////////////////////////
// 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 _IFC2X_FINAL_IFCCHANGEORDER_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCHANGEORDER_AUTO_IMPL_H
#include "IfcProjectOrderAutoImpl.h"
#include "IfcDateAndTimeAutoImpl.h"
#include "IfcCostScheduleAutoImpl.h"
#include "IfcWorkPlanAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X_FINAL express schema definitions.
*/
namespace OdIfc2x_final {
/** \details
The IfcChangeOrder represents a change order in a construction project.
A change order can reference to the building elements such as walls to be changed
through the control relationship (IfcRelAssignedToControl) provided through IfcObject.
A change order can also reference to the design documents that are to be changed.
*/
class IFC2X_FINAL_EXPORT IfcChangeOrder : public IfcProjectOrder
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcChangeOrder);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of ChangeDescription attribute.
This attribute represents a general description of the change.
\returns
Returns the value of ChangeDescription attribute.
*/
const OdAnsiString& getChangeDescription() const;
/** \details
Sets the value of ChangeDescription attribute.
This attribute represents a general description of the change.
\param ChangeDescription [in] ChangeDescription attribute to set.
*/
void setChangeDescription(const OdAnsiString& ChangeDescription);
/** \details
Returns the value of ReasonForChange attribute.
This attribute represents a description of the problem for why a change is needed.
\returns
Returns the value of ReasonForChange attribute.
*/
const OdAnsiString& getReasonForChange() const;
/** \details
Sets the value of ReasonForChange attribute.
This attribute represents a description of the problem for why a change is needed.
\param ReasonForChange [in] ReasonForChange attribute to set.
*/
void setReasonForChange(const OdAnsiString& ReasonForChange);
/** \details
Returns the value of RequestedStartTime attribute.
This attribute represents the start date requested for the change to be carried out.
\returns
Returns the value of RequestedStartTime attribute.
*/
const OdDAIObjectId& getRequestedStartTime() const;
/** \details
Sets the value of RequestedStartTime attribute.
This attribute represents the start date requested for the change to be carried out.
\param RequestedStartTime [in] RequestedStartTime attribute to set.
*/
void setRequestedStartTime(const OdDAIObjectId& RequestedStartTime);
/** \details
Returns the value of RequestedFinishTime attribute.
This attribute represents the finish date requested for the change to be carried out.
\returns
Returns the value of RequestedFinishTime attribute.
*/
const OdDAIObjectId& getRequestedFinishTime() const;
/** \details
Sets the value of RequestedFinishTime attribute.
This attribute represents the finish date requested for the change to be carried out.
\param RequestedFinishTime [in] RequestedFinishTime attribute to set.
*/
void setRequestedFinishTime(const OdDAIObjectId& RequestedFinishTime);
/** \details
Returns the value of CostEstimate attribute.
This attribute represents the cost estimate for the change.
\returns
Returns the value of CostEstimate attribute.
*/
const OdDAIObjectId& getCostEstimate() const;
/** \details
Sets the value of CostEstimate attribute.
This attribute represents the cost estimate for the change.
\param CostEstimate [in] CostEstimate attribute to set.
*/
void setCostEstimate(const OdDAIObjectId& CostEstimate);
/** \details
Returns the value of WorkPlan attribute.
This attribute represents the work plan for the change.
\returns
Returns the value of WorkPlan attribute.
*/
const OdDAIObjectId& getWorkPlan() const;
/** \details
Sets the value of WorkPlan attribute.
This attribute represents the work plan for the change.
\param WorkPlan [in] WorkPlan attribute to set.
*/
void setWorkPlan(const OdDAIObjectId& WorkPlan);
/** \details
Returns the value of Name attribute.
This attribute represents the status of the change order.
\returns
Returns the value of Name attribute.
*/
IfcChangeOrderStatusEnum getStatus() const;
/** \details
Sets the value of Name attribute.
This attribute represents the status of the change order.
\param Status [in] Name attribute to set.
*/
void setStatus(IfcChangeOrderStatusEnum Status);
/** \details
Returns the value of ActualStartTime attribute.
This attribute represents the start date on which the change was actually commenced.
\returns
Returns the value of ActualStartTime attribute.
*/
const OdDAIObjectId& getActualStartTime() const;
/** \details
Sets the value of ActualStartTime attribute.
This attribute represents the start date on which the change was actually commenced.
\param ActualStartTime [in] ActualStartTime attribute to set.
*/
void setActualStartTime(const OdDAIObjectId& ActualStartTime);
/** \details
Returns the value of ActualFinishTime attribute.
This attribute represents the finish date on which the change was actually completed.
\returns
Returns the value of ActualFinishTime attribute.
*/
const OdDAIObjectId& getActualFinishTime() const;
/** \details
Sets the value of ActualFinishTime attribute.
This attribute represents the finish date on which the change was actually completed.
\param ActualFinishTime [in] ActualFinishTime attribute to set.
*/
void setActualFinishTime(const OdDAIObjectId& ActualFinishTime);
public:
/** \details
Default constructor for the IfcChangeOrder class.
*/
IfcChangeOrder();
/** \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 OdDAI::Entity 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
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 OdIfc::OdIfcEntityType 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_ChangeDescription; // IfcText [optional]
OdAnsiString m_ReasonForChange; // IfcText [optional]
OdDAIObjectId m_RequestedStartTime; // IfcDateAndTime [optional]
OdDAIObjectId m_RequestedFinishTime; // IfcDateAndTime [optional]
OdDAIObjectId m_CostEstimate; // IfcCostSchedule [optional]
OdDAIObjectId m_WorkPlan; // IfcWorkPlan [optional]
OdDAI::Enum m_Status; // IfcChangeOrderStatusEnum
OdDAIObjectId m_ActualStartTime; // IfcDateAndTime [optional]
OdDAIObjectId m_ActualFinishTime; // IfcDateAndTime [optional]
};
/** \details
A data type that represents a smart pointer to a IfcChangeOrder object.
*/
typedef OdSmartPtr IfcChangeOrderPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCCHANGEORDER_AUTO_IMPL_H