CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x2::IfcWorkPlan Class Reference

#include <IfcWorkPlanAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcWorkPlan:
OdIfc4x2::IfcWorkControl OdIfc4x2::IfcControl OdIfc4x2::IfcObject OdIfc4x2::IfcObjectDefinition OdIfc4x2::IfcRoot OdIfc4x2::OdIfc4x2Instance OdIfc::OdIfcInstance

Public Member Functions

IfcWorkPlanTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcWorkPlanTypeEnum PredefinedType)
 
 IfcWorkPlan ()
 
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 OdIfc4x2::IfcWorkControl
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 ()
 
- Public Member Functions inherited from OdIfc4x2::IfcControl
const OdAnsiString & getIdentification () const
 
void setIdentification (const OdAnsiString &Identification)
 
void getInvControls (OdDAIObjectIds &Controls) const
 
 IfcControl ()
 
- Public Member Functions inherited from OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::OdIfc4x2Instance
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

OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc4x2::IfcWorkControl
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 OdIfc4x2::IfcControl
OdAnsiString m_Identification
 
- Protected Attributes inherited from OdIfc4x2::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x2::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 IfcWorkPlan represents work plans in a construction or a facilities management project.

  • Details - A work plan contains a set of work schedules for different purposes (including construction and facilities management). Contained work schedules are defined through the IfcRelAggregates relationship. Through inheritance from IfcWorkControl it is also possible to define references to activities (for example, IfcTask) and resources used in the work plan.

A work plan has information such as start date, finish date, total free float, and so on. IfcWorkPlan can also refer to the construction project represented by the single IfcProject instance.

Figure below shows the backbone structure of a work plan that defines contained work schedules through IfcRelAggregates and, if not assigned otherwise to contained work schedules, assigned tasks and resources through IfcRelAssignsToControl.

<IMAGE ifcworkplan_instantiation_diagram>

If an assigned IfcTask is a root-level task, such task must be declared on the IfcProject using the IfcRelDeclares relationship.

Definition at line 55 of file Ifc4x2/IfcWorkPlanAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWorkPlan()

OdIfc4x2::IfcWorkPlan::IfcWorkPlan ( )

Default constructor for the IfcWorkPlan class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ getPredefinedType()

IfcWorkPlanTypeEnum OdIfc4x2::IfcWorkPlan::getPredefinedType ( ) const

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

Returns
Returns the value of PredefinedType attribute.

◆ inFields()

virtual OdResult OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ isKindOf()

virtual bool OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ outFields()

virtual OdResult OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ setPredefinedType()

void OdIfc4x2::IfcWorkPlan::setPredefinedType ( IfcWorkPlanTypeEnum PredefinedType)

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

Parameters
PredefinedType[in] Predefined type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcWorkPlan::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x2::IfcWorkControl.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcWorkPlan::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 OdIfc4x2::IfcWorkControl.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4x2::IfcWorkPlan::m_PredefinedType
protected

Definition at line 194 of file Ifc4x2/IfcWorkPlanAutoImpl.h.


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