/////////////////////////////////////////////////////////////////////////////// // 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_IFCWORKCALENDAR_AUTO_IMPL_H #define _IFC4X2_IFCWORKCALENDAR_AUTO_IMPL_H #include "IfcControlAutoImpl.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 An IfcWorkCalendar defines working and non-working time periods for tasks and resources. It enables to define both specific time periods, such as from 7:00 till 12:00 on 25th August 2009, as well as repetitive time periods based on frequently used recurrence patterns, such as each Monday from 7:00 till 12:00 between 1st March 2009 and 31st December 2009. - Details - A work calendar is a subtype of IfcControl and thus inherits the feature for controlling other objects through IfcRelAssignsToControl, which is used to define a work calendar for tasks (IfcTask) and resources (IfcResource). It also inherits a name and description attribute, whereas a name shall be given and a description can be given as an indication of its content and usage. The figure below shows the definition of a work calendar, which is defined by a set of work times and exception times. The work times are defined as recurring patterns with optional boundaries (applying from and/or to a specific date). The shown example defines a simple work calendar with working times Monday to Thursday 8:00 to 12:00 and 13:00 to 17:00, Friday 8:00 to 14:00 and as exception every 1st Monday in a month the work starts one hour later - i.e. the working time on every 1st Monday in a month is overridden to be 9:00 to 12:00 and 13:00 to 17:00. Both the working time and the exception time is valid for the period of 01.09.2010 till 30.08.2011. - Control Assignment - The base calendar of a work calendar is defined by IfcRelAssignsToControl, where IfcRelAssignsToControl.RelatingControl is linked with the base calendar and IfcRelAssignsToControl.RelatedObjects is linked with work calendars that are derived from the base calendar. Although not restricted by the IfcRelAssignsToControl relationship it is only allowed to have one base calendar. */ class IFC4X2_EXPORT IfcWorkCalendar : public IfcControl { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcWorkCalendar); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Gets the value of WorkingTimes attribute. This attribute represents set of times periods that are regarded as an initial set-up of working times. Exception times can then further restrict these working times. \param WorkingTimes [out] Receives the WorkingTimes attribute. */ void getWorkingTimes(OdDAIObjectIds& WorkingTimes) const; /** \details Returns the value of WorkingTimes attribute. This attribute represents set of times periods that are regarded as an initial set-up of working times. Exception times can then further restrict these working times. \returns Returns the value of WorkingTimes attribute. */ OdDAI::SetOfOdDAIObjectId& workingTimes(); /** \details Gets the value of ExceptionTimes attribute. This attribute represents set of times periods that define exceptions (non-working times) for the given working times including the base calendar, if provided. \param ExceptionTimes [out] Receives the Exception attribute. */ void getExceptionTimes(OdDAIObjectIds& ExceptionTimes) const; /** \details Returns the value of ExceptionTimes attribute. This attribute represents set of times periods that define exceptions (non-working times) for the given working times including the base calendar, if provided. \returns Returns the value of ExceptionTimes attribute. */ OdDAI::SetOfOdDAIObjectId& exceptionTimes(); /** \details Returns the value of PredefinedType attribute. This attribute represents the predefined types of a work calendar from which the required type can be set. \returns Returns the value of PredefinedType attribute. */ IfcWorkCalendarTypeEnum getPredefinedType() const; /** \details Sets the value of PredefinedType attribute. This attribute represents the predefined types of a work calendar from which the required type can be set. \param PredefinedType [in] Predefined type to set. */ void setPredefinedType(IfcWorkCalendarTypeEnum PredefinedType); public: /** \details Default constructor for the IfcWorkCalendar class. */ IfcWorkCalendar(); /** \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: OdDAI::SetOfOdDAIObjectId m_WorkingTimes; // SET [1:?] of IfcWorkTime [optional] OdDAI::SetOfOdDAIObjectId m_ExceptionTimes; // SET [1:?] of IfcWorkTime [optional] OdDAI::Enum m_PredefinedType; // IfcWorkCalendarTypeEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcWorkCalendar object. */ typedef OdSmartPtr IfcWorkCalendarPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCWORKCALENDAR_AUTO_IMPL_H