#include <IfcWorkTimeAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcWorkTime:

Public Member Functions
const OdDAIObjectId &	getRecurrencePattern () const

void	setRecurrencePattern (const OdDAIObjectId &RecurrencePattern)

const OdAnsiString &	getStart () const

void	setStart (const OdAnsiString &Start)

const OdAnsiString &	getFinish () const

void	setFinish (const OdAnsiString &Finish)

	IfcWorkTime ()

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 OdIfc4x4::IfcSchedulingTime
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

IfcDataOriginEnum	getDataOrigin () const

void	setDataOrigin (IfcDataOriginEnum DataOrigin)

const OdAnsiString &	getUserDefinedDataOrigin () const

void	setUserDefinedDataOrigin (const OdAnsiString &UserDefinedDataOrigin)

	IfcSchedulingTime ()

Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
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
OdDAIObjectId	m_RecurrencePattern

OdAnsiString	m_Start

OdAnsiString	m_Finish

Protected Attributes inherited from OdIfc4x4::IfcSchedulingTime
OdAnsiString	m_Name

OdDAI::Enum	m_DataOrigin

OdAnsiString	m_UserDefinedDataOrigin

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

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.

\changes

IFC4X3_RC1 changes: Attribute Finish renamed to FinishDate Attribute Start renamed to StartDate

Definition at line 52 of file IFC4X4/IfcWorkTimeAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWorkTime()

OdIfc4x4::IfcWorkTime::IfcWorkTime ( )

Default constructor for the IfcWorkTime class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcWorkTime::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.

Reimplemented from OdIfc4x4::IfcSchedulingTime.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ getFinish()

const OdAnsiString & OdIfc4x4::IfcWorkTime::getFinish ( ) const

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.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ getRecurrencePattern()

const OdDAIObjectId & OdIfc4x4::IfcWorkTime::getRecurrencePattern ( ) const

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.

◆ getStart()

const OdAnsiString & OdIfc4x4::IfcWorkTime::getStart ( ) const

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.

◆ inFields()

virtual OdResult OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ isKindOf()

virtual bool OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ outFields()

virtual OdResult OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ setFinish()

void OdIfc4x4::IfcWorkTime::setFinish ( const OdAnsiString & Finish )

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.

Parameters

Finish [in] Finish date to set.

◆ setRecurrencePattern()

void OdIfc4x4::IfcWorkTime::setRecurrencePattern ( const OdDAIObjectId & RecurrencePattern )

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.

Parameters

RecurrencePattern [in] Recurrence pattern to set.

◆ setStart()

void OdIfc4x4::IfcWorkTime::setStart ( const OdAnsiString & Start )

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.

Parameters

Start [in] Start date to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcWorkTime::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcSchedulingTime.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcWorkTime::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 OdIfc4x4::IfcSchedulingTime.

Member Data Documentation

◆ m_Finish

OdAnsiString OdIfc4x4::IfcWorkTime::m_Finish

protected

Definition at line 248 of file IFC4X4/IfcWorkTimeAutoImpl.h.

◆ m_RecurrencePattern

OdDAIObjectId OdIfc4x4::IfcWorkTime::m_RecurrencePattern

protected

Definition at line 246 of file IFC4X4/IfcWorkTimeAutoImpl.h.

◆ m_Start

OdAnsiString OdIfc4x4::IfcWorkTime::m_Start

protected

Definition at line 247 of file IFC4X4/IfcWorkTimeAutoImpl.h.

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

IFC4X4/IfcWorkTimeAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcWorkTime()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getFinish()

◆ getInstanceType()

◆ getRecurrencePattern()

◆ getStart()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setFinish()

◆ setRecurrencePattern()

◆ setStart()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_Finish

◆ m_RecurrencePattern

◆ m_Start