/////////////////////////////////////////////////////////////////////////////// // 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_IFCRECURRENCEPATTERN_AUTO_IMPL_H #define _IFC4X2_IFCRECURRENCEPATTERN_AUTO_IMPL_H #include "Ifc4x2BaseClass.h" #include "Ifc4x2Enum.h" #include "Ifc4x2SelectTypes.h" #include "Ifc4x2CollectionTypes.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 IfcRecurrencePattern defines repetitive time periods on the basis of regular recurrences such as each Monday in a week, or every third Tuesday in a month. The population of the remaining attributes such as DayComponent, Position, and Interval depend on the specified recurrence type. IfcRecurrencePattern supports various recurrence patterns that are differentiated by a type definition (IfcRecurrencePattern.RecurrenceType), which is required to provide the meaning of the provided values. It can be further constrained by applicable times through specified IfcTimePeriod instances, thus enabling time periods such as between 7:00 and 12:00 and between 13:00 and 17:00 for each of the applicable days, weeks or months. */ class IFC4X2_EXPORT IfcRecurrencePattern : public OdIfc4x2Instance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcRecurrencePattern); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of RecurrenceType attribute. This attribute represents the recurrence type that gives meaning to the used attributes and decides about possible attribute combinations, i.e. what attributes are needed to fully describe the pattern type. \returns Returns the value of RecurrenceType attribute. */ IfcRecurrenceTypeEnum getRecurrenceType() const; /** \details Sets the value of RecurrenceType attribute. This attribute represents the recurrence type that gives meaning to the used attributes and decides about possible attribute combinations, i.e. what attributes are needed to fully describe the pattern type. \param RecurrenceType [in] Recurrence type to set. */ void setRecurrenceType(IfcRecurrenceTypeEnum RecurrenceType); /** \details Sets the value of DayComponent attribute. This attribute represents the position of the specified day in a month. \param DayComponent [in] Day component to set. */ void getDayComponent(OdArray& DayComponent) const; /** \details Returns the value of DayComponent attribute. This attribute represents the position of the specified day in a month. \returns Returns the value of DayComponent attribute. */ OdDAI::SetOfInt& dayComponent(); /** \details Sets the value of WeekdayComponent attribute. This attribute represents the weekday name of the specified day in a week. \param WeekdayComponent [in] Weekday component to set. */ void getWeekdayComponent(OdArray& WeekdayComponent) const; /** \details Returns the value of WeekdayComponent attribute. This attribute represents the weekday name of the specified day in a week. \returns Returns the value of WeekdayComponent attribute. */ OdDAI::SetOfInt& weekdayComponent(); /** \details Sets the value of MonthComponent attribute. This attribute represents the position of the specified month in a year. \param MonthComponent [in] Month component to set. */ void getMonthComponent(OdArray& MonthComponent) const; /** \details Returns the value of MonthComponent attribute. This attribute represents the position of the specified month in a year. \returns Returns the value of MonthComponent attribute. */ OdDAI::SetOfInt& monthComponent(); /** \details Returns the value of Position attribute. This attribute represents the position of the specified component, e.g. the 3rd (position=3) Tuesday (weekday component) in a month. A negative position value is used to define the last position of the component (-1), the next to last position (-2), etc. \returns Returns the value of Position attribute. */ int getPosition() const; /** \details Sets the value of Position attribute. This attribute represents the position of the specified component, e.g. the 3rd (position=3) Tuesday (weekday component) in a month. A negative position value is used to define the last position of the component (-1), the next to last position (-2), etc. \param Position [in] Position to set. */ void setPosition(int Position); /** \details Returns the value of Interval attribute. This attribute represents an interval can be provided according to the pattern type. An interval value of 2 can for instance every two days, weeks, months, years. An empty interval value is regarded as 1. \returns Returns the value of Interval attribute. */ int getInterval() const; /** \details Sets the value of Interval attribute. This attribute represents an interval can be provided according to the pattern type. An interval value of 2 can for instance every two days, weeks, months, years. An empty interval value is regarded as 1. \param Interval [in] Interval to set. */ void setInterval(int Interval); /** \details Returns the value of Occurrences attribute. This attribute represents the number of occurrences of this pattern, e.g. a weekly event can be defined to occur 5 times before it stops. \returns Returns the value of Occurrences attribute. */ int getOccurrences() const; /** \details Sets the value of Occurrences attribute. This attribute represents the number of occurrences of this pattern, e.g. a weekly event can be defined to occur 5 times before it stops. \param Occurrences [in] Occurrences to set. */ void setOccurrences(int Occurrences); /** \details Sets the value of TimePeriods attribute. This attribute represents list of time periods that are defined by a start and end time of the recurring element (day). The order of the list should reflect the sequence of the time periods. \param TimePeriods [in] Time periods to set. */ void getTimePeriods(OdDAIObjectIds& TimePeriods) const; /** \details Returns the value of TimePeriods attribute. This attribute represents list of time periods that are defined by a start and end time of the recurring element (day). The order of the list should reflect the sequence of the time periods. \returns Returns the value of TimePeriods attribute. */ OdDAI::ListOfOdDAIObjectId& timePeriods(); public: /** \details Default constructor for the IfcRecurrencePattern class. */ IfcRecurrencePattern(); /** \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::Enum m_RecurrenceType; // IfcRecurrenceTypeEnum OdDAI::SetOfInt m_DayComponent; // SET [1:?] of IfcDayInMonthNumber [optional] OdDAI::SetOfInt m_WeekdayComponent; // SET [1:?] of IfcDayInWeekNumber [optional] OdDAI::SetOfInt m_MonthComponent; // SET [1:?] of IfcMonthInYearNumber [optional] int m_Position; // IfcInteger [optional] int m_Interval; // IfcInteger [optional] int m_Occurrences; // IfcInteger [optional] OdDAI::ListOfOdDAIObjectId m_TimePeriods; // LIST [1:?] of IfcTimePeriod [optional] }; /** \details A data type that represents a smart pointer to a IfcRecurrencePattern object. */ typedef OdSmartPtr IfcRecurrencePatternPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X2_IFCRECURRENCEPATTERN_AUTO_IMPL_H