#include <IfcWorkCalendarAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcWorkCalendar:

Public Member Functions
void	getWorkingTimes (OdDAIObjectIds &WorkingTimes) const

OdDAI::SetOfOdDAIObjectId &	workingTimes ()

void	getExceptionTimes (OdDAIObjectIds &ExceptionTimes) const

OdDAI::SetOfOdDAIObjectId &	exceptionTimes ()

IfcWorkCalendarTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcWorkCalendarTypeEnum PredefinedType)

	IfcWorkCalendar ()

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 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 OdIfc4x1::IfcControl
const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

void	getInvControls (OdDAIObjectIds &Controls) const

	IfcControl ()

Public Member Functions inherited from OdIfc4x1::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4x1::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4x1::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID GlobalId)

const OdDAIObjectId &	getOwnerHistory () const

void	setOwnerHistory (const OdDAIObjectId &OwnerHistory)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcRoot ()

Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
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::SetOfOdDAIObjectId	m_WorkingTimes

OdDAI::SetOfOdDAIObjectId	m_ExceptionTimes

OdDAI::Enum	m_PredefinedType

Protected Attributes inherited from OdIfc4x1::IfcControl
OdAnsiString	m_Identification

Protected Attributes inherited from OdIfc4x1::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x1::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

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

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.

Definition at line 62 of file Ifc4x1/IfcWorkCalendarAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWorkCalendar()

OdIfc4x1::IfcWorkCalendar::IfcWorkCalendar ( )

Default constructor for the IfcWorkCalendar class.

Member Function Documentation

◆ exceptionTimes()

OdDAI::SetOfOdDAIObjectId & OdIfc4x1::IfcWorkCalendar::exceptionTimes ( )

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.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcWorkCalendar::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.

Reimplemented from OdIfc4x1::IfcControl.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ getExceptionTimes()

void OdIfc4x1::IfcWorkCalendar::getExceptionTimes ( OdDAIObjectIds & ExceptionTimes ) const

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.

Parameters

ExceptionTimes [out] Receives the Exception attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcWorkCalendar::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.

Reimplemented from OdIfc4x1::IfcControl.

◆ getPredefinedType()

IfcWorkCalendarTypeEnum OdIfc4x1::IfcWorkCalendar::getPredefinedType ( ) const

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.

◆ getWorkingTimes()

void OdIfc4x1::IfcWorkCalendar::getWorkingTimes ( OdDAIObjectIds & WorkingTimes ) const

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.

Parameters

WorkingTimes [out] Receives the WorkingTimes attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcWorkCalendar::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.

Reimplemented from OdIfc4x1::IfcControl.

◆ isKindOf()

virtual bool OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ outFields()

virtual OdResult OdIfc4x1::IfcWorkCalendar::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.

Reimplemented from OdIfc4x1::IfcControl.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ setPredefinedType()

void OdIfc4x1::IfcWorkCalendar::setPredefinedType ( IfcWorkCalendarTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents the predefined types of a work calendar from which the required type can be set.

Parameters

PredefinedType [in] Predefined type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcWorkCalendar::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x1::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcWorkCalendar::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 OdIfc4x1::IfcControl.

◆ workingTimes()

OdDAI::SetOfOdDAIObjectId & OdIfc4x1::IfcWorkCalendar::workingTimes ( )

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.

Member Data Documentation

◆ m_ExceptionTimes

OdDAI::SetOfOdDAIObjectId OdIfc4x1::IfcWorkCalendar::m_ExceptionTimes

protected

Definition at line 237 of file Ifc4x1/IfcWorkCalendarAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x1::IfcWorkCalendar::m_PredefinedType

protected

Definition at line 239 of file Ifc4x1/IfcWorkCalendarAutoImpl.h.

◆ m_WorkingTimes

OdDAI::SetOfOdDAIObjectId OdIfc4x1::IfcWorkCalendar::m_WorkingTimes

protected

Definition at line 235 of file Ifc4x1/IfcWorkCalendarAutoImpl.h.

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

Ifc4x1/IfcWorkCalendarAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcWorkCalendar()

Member Function Documentation

◆ exceptionTimes()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getExceptionTimes()

◆ getInstanceType()

◆ getPredefinedType()

◆ getWorkingTimes()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

◆ workingTimes()

Member Data Documentation

◆ m_ExceptionTimes

◆ m_PredefinedType

◆ m_WorkingTimes