CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x2_final::IfcCostSchedule Class Reference

#include <IfcCostScheduleAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcCostSchedule:
OdIfc2x2_final::IfcControl OdIfc2x2_final::IfcObject OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

IfcActorSelect submittedBy ()
 
IfcActorSelect preparedBy ()
 
IfcDateTimeSelect submittedOn ()
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
void getTargetUsers (OdArray< OdDAI::Select > &TargetUsers) const
 
void getTargetUsersWrapperArray (OdArray< IfcActorSelect > &TargetUsers) const
 
OdDAI::SetOfSelect & targetUsers ()
 
IfcDateTimeSelect updateDate ()
 
const OdAnsiString & getID () const
 
void setID (const OdAnsiString &ID)
 
IfcCostScheduleTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcCostScheduleTypeEnum PredefinedType)
 
 IfcCostSchedule ()
 
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 OdIfc2x2_final::IfcControl
void getInvControls (OdDAIObjectIds &Controls) const
 
- Public Member Functions inherited from OdIfc2x2_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x2_final::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 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::Select m_SubmittedBy
 
OdDAI::Select m_PreparedBy
 
OdDAI::Select m_SubmittedOn
 
OdAnsiString m_Status
 
OdDAI::SetOfSelect m_TargetUsers
 
OdDAI::Select m_UpdateDate
 
OdAnsiString m_ID
 
OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc2x2_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x2_final::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 IfcCostSchedule brings together instances of IfcCostItem either for the purpose of identifying purely cost information as in an estimate for constructions costs or for including cost information within another presentation form such as a work order.

  • Approval - Approvals can be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcCostSchedule. Approvals can be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.
  • Control Assignment - The Control Assignment concept applies to this entity. The IfcCostSchedule can be assigned to the following entities using relationships as indicated: IfcActor (IfcRelAssignsToActor): Persons and organizations involved in the preparation, submittal, and as target users.

The IfcCostSchedule can have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcCostSchedule and RelatedObjects contains one or more objects of the following types: IfcCostItem: Indicates costs published within this cost schedule, typically a single root cost item forming a hierarchy of nested cost items.

\changes

IFC2X2_FINAL changes: Attribute ScheduleNumber has been renamed to ID

Definition at line 63 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostSchedule()

OdIfc2x2_final::IfcCostSchedule::IfcCostSchedule ( )

Default constructor for the IfcCostSchedule class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getID()

const OdAnsiString & OdIfc2x2_final::IfcCostSchedule::getID ( ) const

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

Returns
Returns the value of Identification attribute.
Remarks
IFC4 CHANGE: Attribute ID renamed to Identification and promoted to supertype IfcControl.

◆ getInstanceType()

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

◆ getPredefinedType()

IfcCostScheduleTypeEnum OdIfc2x2_final::IfcCostSchedule::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a cost schedule that is specified in an enumeration. There can be a property set given specifically for the predefined types.

Returns
Returns the value of PredefinedType attribute.
Remarks
IFC4 CHANGE: The attribute has been made optional.

◆ getStatus()

const OdAnsiString & OdIfc2x2_final::IfcCostSchedule::getStatus ( ) const

Returns the value of Status attribute. This attribute represents the current status of a cost schedule. Examples of status values that might be used for a cost schedule status include: PLANNED APPROVED AGREED ISSUED STARTED

Returns
Returns the value of Status attribute.

◆ getTargetUsers()

void OdIfc2x2_final::IfcCostSchedule::getTargetUsers ( OdArray< OdDAI::Select > & TargetUsers) const

Returns the value of TargetUsers attribute. This attribute represents the actors for whom the cost schedule was prepared.

Parameters
TargetUsers[out] Receives the TargetUsers attribute.
Remarks
IFC4 CHANGE: The attribute has been removed.

◆ getTargetUsersWrapperArray()

void OdIfc2x2_final::IfcCostSchedule::getTargetUsersWrapperArray ( OdArray< IfcActorSelect > & TargetUsers) const

Returns the value of TargetUsers attribute. This attribute represents the actors for whom the cost schedule was prepared.

Parameters
TargetUsers[out] Receives the TargetUsers attribute.
Remarks
IFC4 CHANGE: The attribute has been removed.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ preparedBy()

IfcActorSelect OdIfc2x2_final::IfcCostSchedule::preparedBy ( )

Returns the value of PreparedBy attribute. This attribute represents an actor by which a cost schedule is prepared.

Returns
Returns the value of PreparedBy attribute.
Remarks
IFC4 CHANGE: The attribute has been removed.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setID()

void OdIfc2x2_final::IfcCostSchedule::setID ( const OdAnsiString & ID)

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

Parameters
ID[in] ID to set.
Remarks
IFC4 CHANGE: Attribute unified by promoting from various subtypes of IfcControl.

◆ setPredefinedType()

void OdIfc2x2_final::IfcCostSchedule::setPredefinedType ( IfcCostScheduleTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a cost schedule that is specified in an enumeration. There can be a property set given specifically for the predefined types.

Parameters
PredefinedType[in] Predefined type to set.
Remarks
IFC4 CHANGE: The attribute has been made optional.

◆ setStatus()

void OdIfc2x2_final::IfcCostSchedule::setStatus ( const OdAnsiString & Status)

Sets the value of Status attribute. This attribute represents the current status of a cost schedule. Examples of status values that might be used for a cost schedule status include: PLANNED APPROVED AGREED ISSUED STARTED

Parameters
Status[in] Status to set.

◆ submittedBy()

IfcActorSelect OdIfc2x2_final::IfcCostSchedule::submittedBy ( )

Returns the value of SubmittedBy attribute. This attribute represents an actor by which a cost schedule is submitted.

Returns
Returns the value of SubmittedBy attribute.
Remarks
IFC4 CHANGE: The attribute has been removed.

◆ submittedOn()

IfcDateTimeSelect OdIfc2x2_final::IfcCostSchedule::submittedOn ( )

Returns the value of SubmittedOn attribute. This attribute represents the date and time on which the cost schedule was submitted.

Returns
Returns the value of SubmittedOn attribute.

◆ targetUsers()

OdDAI::SetOfSelect & OdIfc2x2_final::IfcCostSchedule::targetUsers ( )

Returns the value of TargetUsers attribute. This attribute represents the actors for whom the cost schedule was prepared.

Returns
Returns the value of TargetUsers attribute.
Remarks
IFC4 CHANGE: The attribute has been removed.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcCostSchedule::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x2_final::IfcControl.

◆ unsetAttr() [2/2]

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

◆ updateDate()

IfcDateTimeSelect OdIfc2x2_final::IfcCostSchedule::updateDate ( )

Returns the value of UpdateDate attribute. This attribute represents the date and time that this cost schedule is updated; this allows tracking the schedule history.

Returns
Returns the value of UpdateDate attribute.

Member Data Documentation

◆ m_ID

OdAnsiString OdIfc2x2_final::IfcCostSchedule::m_ID
protected

Definition at line 326 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc2x2_final::IfcCostSchedule::m_PredefinedType
protected

Definition at line 327 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_PreparedBy

OdDAI::Select OdIfc2x2_final::IfcCostSchedule::m_PreparedBy
protected

Definition at line 320 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_Status

OdAnsiString OdIfc2x2_final::IfcCostSchedule::m_Status
protected

Definition at line 322 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_SubmittedBy

OdDAI::Select OdIfc2x2_final::IfcCostSchedule::m_SubmittedBy
protected

Definition at line 319 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_SubmittedOn

OdDAI::Select OdIfc2x2_final::IfcCostSchedule::m_SubmittedOn
protected

Definition at line 321 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_TargetUsers

OdDAI::SetOfSelect OdIfc2x2_final::IfcCostSchedule::m_TargetUsers
protected

Definition at line 323 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.

◆ m_UpdateDate

OdDAI::Select OdIfc2x2_final::IfcCostSchedule::m_UpdateDate
protected

Definition at line 325 of file Ifc2x2_Final/IfcCostScheduleAutoImpl.h.


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