#include <IfcRecurrencePatternAutoImpl.h>

Inheritance diagram for OdIfc4::IfcRecurrencePattern:

Public Member Functions
IfcRecurrenceTypeEnum	getRecurrenceType () const

void	setRecurrenceType (IfcRecurrenceTypeEnum RecurrenceType)

void	getDayComponent (OdArray< int > &DayComponent) const

OdDAI::SetOfInt &	dayComponent ()

void	getWeekdayComponent (OdArray< int > &WeekdayComponent) const

OdDAI::SetOfInt &	weekdayComponent ()

void	getMonthComponent (OdArray< int > &MonthComponent) const

OdDAI::SetOfInt &	monthComponent ()

int	getPosition () const

void	setPosition (int Position)

int	getInterval () const

void	setInterval (int Interval)

int	getOccurrences () const

void	setOccurrences (int Occurrences)

void	getTimePeriods (OdDAIObjectIds &TimePeriods) const

OdDAI::ListOfOdDAIObjectId &	timePeriods ()

	IfcRecurrencePattern ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override

virtual void	unsetAttr (const char *explicitAttrName) override

virtual bool	testAttr (const char *explicitAttrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

virtual bool	isKindOf (OdIfc::OdIfcEntityType entityType) const override

virtual OdIfc::OdIfcEntityType	type () const override

virtual OdRxValue	getAttr (const OdIfc::OdIfcAttribute attrDef) const override

virtual void	unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override

virtual bool	testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override

virtual bool	putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override

Public Member Functions inherited from OdIfc4::OdIfc4Instance
void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc::OdIfcInstance
	ODRX_DECLARE_MEMBERS (OdIfcInstance)

	OdIfcInstance ()

	~OdIfcInstance ()

bool	isInstanceOf (OdIfcEntityType entityType) const

IfcOpResult	resolved ()

void	resolve (IfcOpResult resolved, void *resPtr)

void	unresolve ()

virtual void	setGsNode (OdGsCache *pGsNode)

virtual OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Enum	m_RecurrenceType

OdDAI::SetOfInt	m_DayComponent

OdDAI::SetOfInt	m_WeekdayComponent

OdDAI::SetOfInt	m_MonthComponent

int	m_Position

int	m_Interval

int	m_Occurrences

OdDAI::ListOfOdDAIObjectId	m_TimePeriods

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

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.

Definition at line 52 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRecurrencePattern()

OdIfc4::IfcRecurrencePattern::IfcRecurrencePattern ( )

Default constructor for the IfcRecurrencePattern class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcRecurrencePattern::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
ordering	[out] Receives the ordering (comparison) status.

Returns: true if comparison was performed, false if method has no implementation, so late-bound version could be applied.

Remarks

If the method returns true, the ordering parameter can receive one of the following statuses:

Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

◆ dayComponent()

OdDAI::SetOfInt & OdIfc4::IfcRecurrencePattern::dayComponent ( )

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.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcRecurrencePattern::getAttr ( const char * attrName ) const

overridevirtual

Returns an attribute value for the specified attribute name.

Parameters

attrName [in] Name of an attribute to query.

Returns: OdRxValue object that represents a generic variant type value.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcRecurrencePattern::getAttr ( const OdIfc::OdIfcAttribute attrDef ) const

overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters

attrDef [in] Attribute definition to query.

Returns: OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc::OdIfcInstance.

◆ getDayComponent()

void OdIfc4::IfcRecurrencePattern::getDayComponent ( OdArray< int > & DayComponent ) const

Sets the value of DayComponent attribute. This attribute represents the position of the specified day in a month.

Parameters

DayComponent [in] Day component to set.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcRecurrencePattern::getInstanceType ( ) const

overridevirtual

Returns a type of a class instance.

Returns: Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

◆ getInterval()

int OdIfc4::IfcRecurrencePattern::getInterval ( ) const

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.

◆ getMonthComponent()

void OdIfc4::IfcRecurrencePattern::getMonthComponent ( OdArray< int > & MonthComponent ) const

Sets the value of MonthComponent attribute. This attribute represents the position of the specified month in a year.

Parameters

MonthComponent [in] Month component to set.

◆ getOccurrences()

int OdIfc4::IfcRecurrencePattern::getOccurrences ( ) const

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.

◆ getPosition()

int OdIfc4::IfcRecurrencePattern::getPosition ( ) const

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.

◆ getRecurrenceType()

IfcRecurrenceTypeEnum OdIfc4::IfcRecurrencePattern::getRecurrenceType ( ) const

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.

◆ getTimePeriods()

void OdIfc4::IfcRecurrencePattern::getTimePeriods ( OdDAIObjectIds & TimePeriods ) const

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.

Parameters

TimePeriods [in] Time periods to set.

◆ getWeekdayComponent()

void OdIfc4::IfcRecurrencePattern::getWeekdayComponent ( OdArray< int > & WeekdayComponent ) const

Sets the value of WeekdayComponent attribute. This attribute represents the weekday name of the specified day in a week.

Parameters

WeekdayComponent [in] Weekday component to set.

◆ inFields()

virtual OdResult OdIfc4::IfcRecurrencePattern::inFields ( OdDAI::OdSpfFilerBase * rdFiler )

overridevirtual

Reads object's data from the specified filer.

Parameters

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.

◆ isKindOf()

virtual bool OdIfc4::IfcRecurrencePattern::isKindOf ( OdIfc::OdIfcEntityType entityType ) const

overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters

entityType [in] Entity to check.

Returns: true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ monthComponent()

OdDAI::SetOfInt & OdIfc4::IfcRecurrencePattern::monthComponent ( )

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.

◆ outFields()

virtual OdResult OdIfc4::IfcRecurrencePattern::outFields ( OdDAI::OdSpfFilerBase * wrFiler )

overridevirtual

Writes object's data the the specified filer.

Parameters

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.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcRecurrencePattern::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrName	[in] Explicit name of the attribute to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcRecurrencePattern::putAttr	(	const OdIfc::OdIfcAttribute	explicitAttrDef,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrDef	[in] Explicit attribute definition to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ setInterval()

void OdIfc4::IfcRecurrencePattern::setInterval ( int Interval )

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.

Parameters

Interval [in] Interval to set.

◆ setOccurrences()

void OdIfc4::IfcRecurrencePattern::setOccurrences ( int Occurrences )

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.

Parameters

Occurrences [in] Occurrences to set.

◆ setPosition()

void OdIfc4::IfcRecurrencePattern::setPosition ( int Position )

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.

Parameters

Position [in] Position to set.

◆ setRecurrenceType()

void OdIfc4::IfcRecurrencePattern::setRecurrenceType ( IfcRecurrenceTypeEnum RecurrenceType )

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.

Parameters

RecurrenceType [in] Recurrence type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcRecurrencePattern::testAttr ( const char * explicitAttrName ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrName [in] Explicit name of the attribute to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcRecurrencePattern::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrDef [in] Attribute definition to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ timePeriods()

OdDAI::ListOfOdDAIObjectId & OdIfc4::IfcRecurrencePattern::timePeriods ( )

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.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcRecurrencePattern::type ( ) const

overridevirtual

Returns the type of this entity.

Returns: A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcRecurrencePattern::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcRecurrencePattern::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrDef [in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

◆ weekdayComponent()

OdDAI::SetOfInt & OdIfc4::IfcRecurrencePattern::weekdayComponent ( )

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.

Member Data Documentation

◆ m_DayComponent

OdDAI::SetOfInt OdIfc4::IfcRecurrencePattern::m_DayComponent

protected

Definition at line 328 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_Interval

int OdIfc4::IfcRecurrencePattern::m_Interval

protected

Definition at line 335 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_MonthComponent

OdDAI::SetOfInt OdIfc4::IfcRecurrencePattern::m_MonthComponent

protected

Definition at line 332 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_Occurrences

int OdIfc4::IfcRecurrencePattern::m_Occurrences

protected

Definition at line 336 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_Position

int OdIfc4::IfcRecurrencePattern::m_Position

protected

Definition at line 334 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_RecurrenceType

OdDAI::Enum OdIfc4::IfcRecurrencePattern::m_RecurrenceType

protected

Definition at line 327 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_TimePeriods

OdDAI::ListOfOdDAIObjectId OdIfc4::IfcRecurrencePattern::m_TimePeriods

protected

Definition at line 337 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

◆ m_WeekdayComponent

OdDAI::SetOfInt OdIfc4::IfcRecurrencePattern::m_WeekdayComponent

protected

Definition at line 330 of file Ifc4/IfcRecurrencePatternAutoImpl.h.

The documentation for this class was generated from the following file:

Ifc4/IfcRecurrencePatternAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcRecurrencePattern()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ dayComponent()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDayComponent()

◆ getInstanceType()

◆ getInterval()

◆ getMonthComponent()

◆ getOccurrences()

◆ getPosition()

◆ getRecurrenceType()

◆ getTimePeriods()

◆ getWeekdayComponent()

◆ inFields()

◆ isKindOf()

◆ monthComponent()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setInterval()

◆ setOccurrences()

◆ setPosition()

◆ setRecurrenceType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ timePeriods()

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

◆ weekdayComponent()

Member Data Documentation

◆ m_DayComponent

◆ m_Interval

◆ m_MonthComponent

◆ m_Occurrences

◆ m_Position

◆ m_RecurrenceType

◆ m_TimePeriods

◆ m_WeekdayComponent