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

#include <IfcCostScheduleAutoImpl.h>

Inheritance diagram for OdIfc4::IfcCostSchedule:
OdIfc4::IfcControl OdIfc4::IfcObject OdIfc4::IfcObjectDefinition OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

IfcCostScheduleTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcCostScheduleTypeEnum PredefinedType)
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
const OdAnsiString & getSubmittedOn () const
 
void setSubmittedOn (const OdAnsiString &SubmittedOn)
 
const OdAnsiString & getUpdateDate () const
 
void setUpdateDate (const OdAnsiString &UpdateDate)
 
 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 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 OdIfc4::IfcControl
const OdAnsiString & getIdentification () const
 
void setIdentification (const OdAnsiString &Identification)
 
void getInvControls (OdDAIObjectIds &Controls) const
 
 IfcControl ()
 
- Public Member Functions inherited from OdIfc4::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 OdIfc4::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 OdIfc4::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 OdIfc4::OdIfc4Instance
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
 
OdAnsiString m_Status
 
OdAnsiString m_SubmittedOn
 
OdAnsiString m_UpdateDate
 
- Protected Attributes inherited from OdIfc4::IfcControl
OdAnsiString m_Identification
 
- Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4::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)
 
- Protected Member Functions inherited from OdIfc4::IfcObjectDefinition
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

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 IFC4 changes: Attribute ID renamed to Identification and promoted to supertype IfcControl PredefinedType attribute is made optional

Definition at line 66 of file Ifc4/IfcCostScheduleAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostSchedule()

OdIfc4::IfcCostSchedule::IfcCostSchedule ( )

Default constructor for the IfcCostSchedule class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

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

◆ getPredefinedType()

IfcCostScheduleTypeEnum OdIfc4::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 & OdIfc4::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.

◆ getSubmittedOn()

const OdAnsiString & OdIfc4::IfcCostSchedule::getSubmittedOn ( ) const

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.

◆ getUpdateDate()

const OdAnsiString & OdIfc4::IfcCostSchedule::getUpdateDate ( ) const

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.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setPredefinedType()

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

◆ setSubmittedOn()

void OdIfc4::IfcCostSchedule::setSubmittedOn ( const OdAnsiString & SubmittedOn)

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

Parameters
SubmittedOn[in] Value of the attribute to set.

◆ setUpdateDate()

void OdIfc4::IfcCostSchedule::setUpdateDate ( const OdAnsiString & UpdateDate)

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

Parameters
UpdateDate[in] Update date to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcCostSchedule::m_PredefinedType
protected

Definition at line 289 of file Ifc4/IfcCostScheduleAutoImpl.h.

◆ m_Status

OdAnsiString OdIfc4::IfcCostSchedule::m_Status
protected

Definition at line 290 of file Ifc4/IfcCostScheduleAutoImpl.h.

◆ m_SubmittedOn

OdAnsiString OdIfc4::IfcCostSchedule::m_SubmittedOn
protected

Definition at line 291 of file Ifc4/IfcCostScheduleAutoImpl.h.

◆ m_UpdateDate

OdAnsiString OdIfc4::IfcCostSchedule::m_UpdateDate
protected

Definition at line 292 of file Ifc4/IfcCostScheduleAutoImpl.h.


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