///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X2_IFCEVENTTIME_AUTO_IMPL_H
#define _IFC4X2_IFCEVENTTIME_AUTO_IMPL_H
#include "IfcSchedulingTimeAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
IfcEventTime captures the time-related information about an event including
the different types of event dates (i.e. actual, scheduled, early, and late).
IfcEventTime provides a generic mechanism to differentiate between user-provided time values
and time values derived from user-provided time values and other constraints
such as work calendars and assigned resources (derived from the process graph).
*/
class IFC4X2_EXPORT IfcEventTime : public IfcSchedulingTime
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcEventTime);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of ActualDate attribute.
This attribute represents the date on which an event actually occurs.
\returns
Returns the value of ActualDate attribute.
*/
const OdAnsiString& getActualDate() const;
/** \details
Sets the value of ActualDate attribute.
This attribute represents the date on which an event actually occurs.
\param ActualDate [in] Actual date to set.
*/
void setActualDate(const OdAnsiString& ActualDate);
/** \details
Returns the value of EarlyDate attribute.
This attribute represents the earliest date on which an event can occur.
\returns
Returns the value of EarlyDate attribute.
*/
const OdAnsiString& getEarlyDate() const;
/** \details
Sets the value of EarlyDate attribute.
This attribute represents the earliest date on which an event can occur.
\param EarlyDate [in] Early date to set.
*/
void setEarlyDate(const OdAnsiString& EarlyDate);
/** \details
Returns the value of LateDate attribute.
This attribute represents the latest date on which an event can occur.
\returns
Returns the value of LateDate attribute.
*/
const OdAnsiString& getLateDate() const;
/** \details
Sets the value of LateDate attribute.
This attribute represents the latest date on which an event can occur.
\param LateDate [in] Late date to set.
*/
void setLateDate(const OdAnsiString& LateDate);
/** \details
Returns the value of ScheduleDate attribute.
This attribute represents the date on which an event is scheduled to occur.
The value can be measured or somehow calculated, which is defined byScheduleDataOrigin.
\returns
Returns the value of ScheduleDate attribute.
*/
const OdAnsiString& getScheduleDate() const;
/** \details
Sets the value of ScheduleDate attribute.
This attribute represents the date on which an event is scheduled to occur.
The value can be measured or somehow calculated, which is defined byScheduleDataOrigin.
\param ScheduleDate [in] Schedule date to set.
*/
void setScheduleDate(const OdAnsiString& ScheduleDate);
public:
/** \details
Default constructor for the IfcEventTime class.
*/
IfcEventTime();
/** \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_ActualDate; // IfcDateTime [optional]
OdAnsiString m_EarlyDate; // IfcDateTime [optional]
OdAnsiString m_LateDate; // IfcDateTime [optional]
OdAnsiString m_ScheduleDate; // IfcDateTime [optional]
};
/** \details
A data type that represents a smart pointer to a IfcEventTime object.
*/
typedef OdSmartPtr IfcEventTimePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCEVENTTIME_AUTO_IMPL_H