CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcWorkControl Class Reference

#include <IfcWorkControlAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcWorkControl:
OdIfc4x4::IfcControl OdIfc4x4::IfcObject OdIfc4x4::IfcObjectDefinition OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance OdIfc4x4::IfcWorkPlan OdIfc4x4::IfcWorkSchedule

Public Member Functions

const OdAnsiString & getCreationDate () const
 
void setCreationDate (const OdAnsiString &CreationDate)
 
void getCreators (OdDAIObjectIds &Creators) const
 
OdDAI::SetOfOdDAIObjectId & creators ()
 
const OdAnsiString & getPurpose () const
 
void setPurpose (const OdAnsiString &Purpose)
 
const OdAnsiString & getDuration () const
 
void setDuration (const OdAnsiString &Duration)
 
const OdAnsiString & getTotalFloat () const
 
void setTotalFloat (const OdAnsiString &TotalFloat)
 
const OdAnsiString & getStartTime () const
 
void setStartTime (const OdAnsiString &StartTime)
 
const OdAnsiString & getFinishTime () const
 
void setFinishTime (const OdAnsiString &FinishTime)
 
 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 OdIfc4x4::IfcControl
const OdAnsiString & getIdentification () const
 
void setIdentification (const OdAnsiString &Identification)
 
void getInvControls (OdDAIObjectIds &Controls) const
 
 IfcControl ()
 
- Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_CreationDate
 
OdDAI::SetOfOdDAIObjectId m_Creators
 
OdAnsiString m_Purpose
 
OdAnsiString m_Duration
 
OdAnsiString m_TotalFloat
 
OdAnsiString m_StartTime
 
OdAnsiString m_FinishTime
 
- Protected Attributes inherited from OdIfc4x4::IfcControl
OdAnsiString m_Identification
 
- Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x4::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (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.

\changes

IFC4 changes: Assignment of tasks to work control updated based on changes of task time definitions and the introduction of a summary task. Identifier has been renamed (now Identification) and promoted to supertype IfcControl.

Definition at line 58 of file IFC4X4/IfcWorkControlAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWorkControl()

OdIfc4x4::IfcWorkControl::IfcWorkControl ( )

Default constructor for the IfcWorkControl class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

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

◆ creators()

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

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

Returns
Returns the value of Creators attribute.

◆ getAttr() [1/2]

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

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

◆ getAttr() [2/2]

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

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

◆ getCreationDate()

const OdAnsiString & OdIfc4x4::IfcWorkControl::getCreationDate ( ) const

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

Returns
Returns the value of CreationDate attribute.

◆ getCreators()

void OdIfc4x4::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()

const OdAnsiString & OdIfc4x4::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.

◆ getFinishTime()

const OdAnsiString & OdIfc4x4::IfcWorkControl::getFinishTime ( ) const

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

Returns
Returns the value of FinishTime attribute.

◆ getInstanceType()

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

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

◆ getPurpose()

const OdAnsiString & OdIfc4x4::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.

◆ getStartTime()

const OdAnsiString & OdIfc4x4::IfcWorkControl::getStartTime ( ) const

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

Returns
Returns the value of StartTime attribute.

◆ getTotalFloat()

const OdAnsiString & OdIfc4x4::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.

◆ inFields()

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

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

◆ isKindOf()

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

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

◆ outFields()

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

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

◆ putAttr() [1/2]

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

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

◆ putAttr() [2/2]

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

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

◆ setCreationDate()

void OdIfc4x4::IfcWorkControl::setCreationDate ( const OdAnsiString & CreationDate)

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

Parameters
CreationDate[in] Creation date to set.

◆ setDuration()

void OdIfc4x4::IfcWorkControl::setDuration ( const OdAnsiString & Duration)

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

Parameters
Duration[in] Duration to set.

◆ setFinishTime()

void OdIfc4x4::IfcWorkControl::setFinishTime ( const OdAnsiString & FinishTime)

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

Parameters
FinishTime[in] Finish time to set.

◆ setPurpose()

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

◆ setStartTime()

void OdIfc4x4::IfcWorkControl::setStartTime ( const OdAnsiString & StartTime)

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

Parameters
StartTime[in] Start time to set.

◆ setTotalFloat()

void OdIfc4x4::IfcWorkControl::setTotalFloat ( const OdAnsiString & 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.

◆ testAttr() [1/2]

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

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

◆ testAttr() [2/2]

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

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

◆ type()

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

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

◆ unsetAttr() [1/2]

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

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

◆ unsetAttr() [2/2]

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

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

Member Data Documentation

◆ m_CreationDate

OdAnsiString OdIfc4x4::IfcWorkControl::m_CreationDate
protected

Definition at line 306 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_Creators

OdDAI::SetOfOdDAIObjectId OdIfc4x4::IfcWorkControl::m_Creators
protected

Definition at line 307 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_Duration

OdAnsiString OdIfc4x4::IfcWorkControl::m_Duration
protected

Definition at line 310 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_FinishTime

OdAnsiString OdIfc4x4::IfcWorkControl::m_FinishTime
protected

Definition at line 313 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc4x4::IfcWorkControl::m_Purpose
protected

Definition at line 309 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_StartTime

OdAnsiString OdIfc4x4::IfcWorkControl::m_StartTime
protected

Definition at line 312 of file IFC4X4/IfcWorkControlAutoImpl.h.

◆ m_TotalFloat

OdAnsiString OdIfc4x4::IfcWorkControl::m_TotalFloat
protected

Definition at line 311 of file IFC4X4/IfcWorkControlAutoImpl.h.


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