#include <IfcWorkControlAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcWorkControl:

Public Member Functions
const OdAnsiString &	getIdentifier () const

void	setIdentifier (const OdAnsiString &Identifier)

IfcDateTimeSelect	creationDate ()

void	getCreators (OdDAIObjectIds &Creators) const

OdDAI::SetOfOdDAIObjectId &	creators ()

const OdAnsiString &	getPurpose () const

void	setPurpose (const OdAnsiString &Purpose)

double	getDuration () const

void	setDuration (double Duration)

double	getTotalFloat () const

void	setTotalFloat (double TotalFloat)

IfcDateTimeSelect	startTime ()

IfcDateTimeSelect	finishTime ()

IfcWorkControlTypeEnum	getWorkControlType () const

void	setWorkControlType (IfcWorkControlTypeEnum WorkControlType)

const OdAnsiString &	getUserDefinedControlType () const

void	setUserDefinedControlType (const OdAnsiString &UserDefinedControlType)

	IfcWorkControl ()

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 OdIfc2x3::IfcControl
void	getInvControls (OdDAIObjectIds &Controls) const

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

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

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

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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
OdAnsiString	m_Identifier

OdDAI::Select	m_CreationDate

OdDAI::SetOfOdDAIObjectId	m_Creators

OdAnsiString	m_Purpose

double	m_Duration

double	m_TotalFloat

OdDAI::Select	m_StartTime

OdDAI::Select	m_FinishTime

OdDAI::Enum	m_WorkControlType

OdAnsiString	m_UserDefinedControlType

Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc2x3::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 IfcWorkControl is an abstract supertype which captures information that is common to both IfcWorkPlan and IfcWorkSchedule.

A work control can have resources assigned to it. This is handled by the IfcRelAssignsToControl relationship. A work control should also define a context that gives further information about its usage. If no special context information is required then the IfcProject instance as a global context should be used instead. An explicit link between the work control and the IfcProject via IfcRelDeclares should then be provided.

Control Assignment - From IFC4 the assignment of tasks to the work control is handled by the IfcRelAssignsToControl relationship. IfcRelAssignsTasks as used in previous IFC releases has been deleted and cannot be used anymore. From IFC4 it is not necessary to assign each task to a work control as it is regarded to be sufficient if the summary task (root task in the task hierarchy defined through IfcRelNests relationships) is assigned to a work control.

Definition at line 52 of file Ifc2x3/IfcWorkControlAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWorkControl()

OdIfc2x3::IfcWorkControl::IfcWorkControl ( )

Default constructor for the IfcWorkControl class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

Reimplemented in OdIfc2x3::IfcWorkPlan, and OdIfc2x3::IfcWorkSchedule.

◆ creationDate()

IfcDateTimeSelect OdIfc2x3::IfcWorkControl::creationDate ( )

Returns the value of CreationDate attribute. This attribute represents the date that the plan is created.

Returns: Returns the value of CreationDate attribute.

◆ creators()

OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcWorkControl::creators ( )

Returns the value of Creators attribute. This attribute represents the authors of the work plan.

Returns: Returns the value of Creators attribute.

◆ finishTime()

IfcDateTimeSelect OdIfc2x3::IfcWorkControl::finishTime ( )

Returns the value of FinishTime attribute. This attribute represents the finish time of the schedule.

Returns: Returns the value of FinishTime attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ getCreators()

void OdIfc2x3::IfcWorkControl::getCreators ( OdDAIObjectIds & Creators ) const

Gets the value of Creators attribute. This attribute represents the authors of the work plan.

Parameters

Creators [out] Receives the Creators attribute.

◆ getDuration()

double OdIfc2x3::IfcWorkControl::getDuration ( ) const

Returns the value of Duration attribute. This attribute represents the total duration of the entire work schedule.

Returns: Returns the value of Duration attribute.

◆ getIdentifier()

const OdAnsiString & OdIfc2x3::IfcWorkControl::getIdentifier ( ) const

Returns the value of Identifier attribute. This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level.

Returns: Returns the value of Identifier attribute.

Remarks: IFC4 CHANGE: Attribute Identifier renamed to Identification and promoted to supertype IfcControl.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

Reimplemented in OdIfc2x3::IfcWorkPlan, and OdIfc2x3::IfcWorkSchedule.

◆ getPurpose()

const OdAnsiString & OdIfc2x3::IfcWorkControl::getPurpose ( ) const

Returns the value of Purpose attribute. This attribute represents a description of the purpose of the work schedule.

Returns: Returns the value of Purpose attribute.

◆ getTotalFloat()

double OdIfc2x3::IfcWorkControl::getTotalFloat ( ) const

Returns the value of TotalFloat attribute. This attribute represents the total time float of the entire work schedule.

Returns: Returns the value of TotalFloat attribute.

◆ getUserDefinedControlType()

const OdAnsiString & OdIfc2x3::IfcWorkControl::getUserDefinedControlType ( ) const

Returns the value of UserDefinedControlType attribute. This attribute represents a user-defined work control type.

Returns: Returns the value of UserDefinedControlType attribute.

Remarks: IFC4 CHANGE: The attribute has been removed.

◆ getWorkControlType()

IfcWorkControlTypeEnum OdIfc2x3::IfcWorkControl::getWorkControlType ( ) const

Returns the value of WorkControlType attribute. This attribute represents the predefined work control types from which the required type can be set.

Returns: Returns the value of WorkControlType attribute.

Remarks: IFC4 CHANGE: The attribute has been removed.

◆ inFields()

virtual OdResult OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ isKindOf()

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

Reimplemented in OdIfc2x3::IfcWorkPlan, and OdIfc2x3::IfcWorkSchedule.

◆ outFields()

virtual OdResult OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ setDuration()

void OdIfc2x3::IfcWorkControl::setDuration ( double Duration )

Sets the value of Duration attribute. This attribute represents the total duration of the entire work schedule.

Parameters

Duration [in] Duration to set.

◆ setIdentifier()

void OdIfc2x3::IfcWorkControl::setIdentifier ( const OdAnsiString & Identifier )

Sets the value of Identifier attribute. This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level.

Parameters

Identifier [in] Identifier to set.

Remarks: IFC4 CHANGE: Attribute Identifier renamed to Identification and promoted to supertype IfcControl.

◆ setPurpose()

void OdIfc2x3::IfcWorkControl::setPurpose ( const OdAnsiString & Purpose )

Sets the value of Purpose attribute. This attribute represents a description of the purpose of the work schedule.

Parameters

Purpose [in] Purpose to set.

◆ setTotalFloat()

void OdIfc2x3::IfcWorkControl::setTotalFloat ( double TotalFloat )

Sets the value of TotalFloat attribute. This attribute represents the total time float of the entire work schedule.

Parameters

TotalFloat [in] Total float to set.

◆ setUserDefinedControlType()

void OdIfc2x3::IfcWorkControl::setUserDefinedControlType ( const OdAnsiString & UserDefinedControlType )

Sets the value of UserDefinedControlType attribute. This attribute represents a user defined work control type.

Parameters

UserDefinedControlType [in] User-defined control type to set.

Remarks: IFC4 CHANGE: The attribute has been removed.

◆ setWorkControlType()

void OdIfc2x3::IfcWorkControl::setWorkControlType ( IfcWorkControlTypeEnum WorkControlType )

Sets the value of WorkControlType attribute. This attribute represents the predefined work control types from which the required type can be set.

Parameters

WorkControlType [in] Work control type to set.

Remarks: IFC4 CHANGE: The attribute has been removed.

◆ startTime()

IfcDateTimeSelect OdIfc2x3::IfcWorkControl::startTime ( )

Returns the value of StartTime attribute. This attribute represents the start time of the schedule.

Returns: Returns the value of StartTime attribute.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

Reimplemented in OdIfc2x3::IfcWorkPlan, and OdIfc2x3::IfcWorkSchedule.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcWorkControl::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc2x3::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcWorkControl::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 OdIfc2x3::IfcControl.

Member Data Documentation

◆ m_CreationDate

OdDAI::Select OdIfc2x3::IfcWorkControl::m_CreationDate

protected

Definition at line 337 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_Creators

OdDAI::SetOfOdDAIObjectId OdIfc2x3::IfcWorkControl::m_Creators

protected

Definition at line 338 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_Duration

double OdIfc2x3::IfcWorkControl::m_Duration

protected

Definition at line 341 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_FinishTime

OdDAI::Select OdIfc2x3::IfcWorkControl::m_FinishTime

protected

Definition at line 344 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_Identifier

OdAnsiString OdIfc2x3::IfcWorkControl::m_Identifier

protected

Definition at line 336 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc2x3::IfcWorkControl::m_Purpose

protected

Definition at line 340 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_StartTime

OdDAI::Select OdIfc2x3::IfcWorkControl::m_StartTime

protected

Definition at line 343 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_TotalFloat

double OdIfc2x3::IfcWorkControl::m_TotalFloat

protected

Definition at line 342 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_UserDefinedControlType

OdAnsiString OdIfc2x3::IfcWorkControl::m_UserDefinedControlType

protected

Definition at line 346 of file Ifc2x3/IfcWorkControlAutoImpl.h.

◆ m_WorkControlType

OdDAI::Enum OdIfc2x3::IfcWorkControl::m_WorkControlType

protected

Definition at line 345 of file Ifc2x3/IfcWorkControlAutoImpl.h.

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

Ifc2x3/IfcWorkControlAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcWorkControl()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ creationDate()

◆ creators()

◆ finishTime()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCreators()

◆ getDuration()

◆ getIdentifier()

◆ getInstanceType()

◆ getPurpose()

◆ getTotalFloat()

◆ getUserDefinedControlType()

◆ getWorkControlType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setDuration()

◆ setIdentifier()

◆ setPurpose()

◆ setTotalFloat()

◆ setUserDefinedControlType()

◆ setWorkControlType()

◆ startTime()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_CreationDate

◆ m_Creators

◆ m_Duration

◆ m_FinishTime

◆ m_Identifier

◆ m_Purpose

◆ m_StartTime

◆ m_TotalFloat

◆ m_UserDefinedControlType

◆ m_WorkControlType