///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X1_IFCWORKTIME_AUTO_IMPL_H
#define _IFC4X1_IFCWORKTIME_AUTO_IMPL_H
#include "IfcSchedulingTimeAutoImpl.h"
#include "IfcRecurrencePatternAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X1 express schema definitions.
*/
namespace OdIfc4x1 {
/** \details
IfcWorkTime defines time periods that are used by IfcWorkCalendar for either describing working times or non-working exception times.
Besides start and finish dates, a set of time periods can be provided by various types of recurrence patterns.
A work time should have a meaningful name that describes the time periods (for example, working week, holiday name).
Non-recurring time periods should have a start date (IfcWorkTime.Start) and a finish date (IfcWorkTime.Finish).
In that case it is assumed that the time period begins at 0:00 on the start date and ends at 24:00 on the finish date.
*/
class IFC4X1_EXPORT IfcWorkTime : public IfcSchedulingTime
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcWorkTime);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of RecurrencePattern attribute.
This attribute represents recurrence pattern that defines a time period, which (if provided)
is valid within the time period defined byIfcWorkTime.Start and IfcWorkTime.Finish.
\returns
Returns the value of Recurrence pattern attribute.
*/
const OdDAIObjectId& getRecurrencePattern() const;
/** \details
Sets the value of RecurrencePattern attribute.
This attribute represents recurrence pattern that defines a time period, which (if provided)
is valid within the time period defined byIfcWorkTime.Start and IfcWorkTime.Finish.
\param RecurrencePattern [in] Recurrence pattern to set.
*/
void setRecurrencePattern(const OdDAIObjectId& RecurrencePattern);
/** \details
Returns the value of Start attribute.
This attribute represents start date of the work time (0:00),
that can be further restricted by a recurrence pattern.
\returns
Returns the value of Start attribute.
*/
const OdAnsiString& getStart() const;
/** \details
Sets the value of Start attribute.
This attribute represents start date of the work time (0:00),
that can be further restricted by a recurrence pattern.
\param Start [in] Start date to set.
*/
void setStart(const OdAnsiString& Start);
/** \details
Returns the value of Finish attribute.
This attribute represents end date of the work time (24:00),
that can be further restricted by a recurrence pattern.
\returns
Returns the value of Finish attribute.
*/
const OdAnsiString& getFinish() const;
/** \details
Sets the value of Finish attribute.
This attribute represents end date of the work time (24:00),
that can be further restricted by a recurrence pattern.
\param Finish [in] Finish date to set.
*/
void setFinish(const OdAnsiString& Finish);
public:
/** \details
Default constructor for the IfcWorkTime class.
*/
IfcWorkTime();
/** \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:
OdDAIObjectId m_RecurrencePattern; // IfcRecurrencePattern [optional]
OdAnsiString m_Start; // IfcDate [optional]
OdAnsiString m_Finish; // IfcDate [optional]
};
/** \details
A data type that represents a smart pointer to a IfcWorkTime object.
*/
typedef OdSmartPtr IfcWorkTimePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X1_IFCWORKTIME_AUTO_IMPL_H