CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcBudget Class Reference

#include <IfcBudgetAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcBudget:
OdIfc2x_final::IfcCostSchedule OdIfc2x_final::IfcControl OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getBudgetSource () const
 
void setBudgetSource (const OdAnsiString &BudgetSource)
 
const OdDAIObjectId & getBalance () const
 
void setBalance (const OdDAIObjectId &Balance)
 
 IfcBudget ()
 
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 OdIfc2x_final::IfcCostSchedule
const OdAnsiString & getTitle () const
 
void setTitle (const OdAnsiString &Title)
 
IfcActorSelect submittedBy ()
 
void getApprovedBy (OdArray< OdDAI::Select > &ApprovedBy) const
 
void getApprovedByWrapperArray (OdArray< IfcActorSelect > &ApprovedBy) const
 
OdDAI::SetOfSelect & approvedBy ()
 
const OdDAIObjectId & getPreparedBy () const
 
void setPreparedBy (const OdDAIObjectId &PreparedBy)
 
const OdDAIObjectId & getSubmittedOn () const
 
void setSubmittedOn (const OdDAIObjectId &SubmittedOn)
 
const OdDAIObjectId & getTotalCost () const
 
void setTotalCost (const OdDAIObjectId &TotalCost)
 
void getCostElements (OdDAIObjectIds &CostElements) const
 
OdDAI::ListOfOdDAIObjectId & costElements ()
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
const OdAnsiString & getIntendedUse () const
 
void setIntendedUse (const OdAnsiString &IntendedUse)
 
void getComments (OdArray< OdAnsiString > &Comments) const
 
OdDAI::ListOfOdAnsiString & comments ()
 
void getTargetUsers (OdArray< OdDAI::Select > &TargetUsers) const
 
void getTargetUsersWrapperArray (OdArray< IfcActorSelect > &TargetUsers) const
 
OdDAI::SetOfSelect & targetUsers ()
 
const OdDAIObjectId & getValidFromDate () const
 
void setValidFromDate (const OdDAIObjectId &ValidFromDate)
 
const OdDAIObjectId & getValidToDate () const
 
void setValidToDate (const OdDAIObjectId &ValidToDate)
 
const OdDAIObjectId & getUpdateDate () const
 
void setUpdateDate (const OdDAIObjectId &UpdateDate)
 
const OdAnsiString & getScheduleNumber () const
 
void setScheduleNumber (const OdAnsiString &ScheduleNumber)
 
 IfcCostSchedule ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcControl
void getInvControls (OdDAIObjectIds &Controls) const
 
- Public Member Functions inherited from OdIfc2x_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 OdIfc2x_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

OdAnsiString m_BudgetSource
 
OdDAIObjectId m_Balance
 
- Protected Attributes inherited from OdIfc2x_final::IfcCostSchedule
OdAnsiString m_Title
 
OdDAI::Select m_SubmittedBy
 
OdDAI::SetOfSelect m_ApprovedBy
 
OdDAIObjectId m_PreparedBy
 
OdDAIObjectId m_SubmittedOn
 
OdDAIObjectId m_TotalCost
 
OdDAI::ListOfOdDAIObjectId m_CostElements
 
OdAnsiString m_Status
 
OdAnsiString m_IntendedUse
 
OdDAI::ListOfOdAnsiString m_Comments
 
OdDAI::SetOfSelect m_TargetUsers
 
OdDAIObjectId m_ValidFromDate
 
OdDAIObjectId m_ValidToDate
 
OdDAIObjectId m_UpdateDate
 
OdAnsiString m_ScheduleNumber
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_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 IfcBudget represents a cost budget (i.e. an amount of money available from a source) available for projects. This class also allows tracking the history of the budget uses. The details of budget assignment and usage for multiple projects or plans are not handled in this class.

Definition at line 43 of file IfcBudgetAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBudget()

OdIfc2x_final::IfcBudget::IfcBudget ( )

Default constructor for the IfcBudget class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ getBalance()

const OdDAIObjectId & OdIfc2x_final::IfcBudget::getBalance ( ) const

Returns the value of Balance attribute. This attribute represents the balance available on the budget.

Returns
Returns the value of Balance attribute.

◆ getBudgetSource()

const OdAnsiString & OdIfc2x_final::IfcBudget::getBudgetSource ( ) const

Returns the value of BudgetSource attribute. This attribute represents description of the source of the budget.

Returns
Returns the value of BudgetSource attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ setBalance()

void OdIfc2x_final::IfcBudget::setBalance ( const OdDAIObjectId & Balance)

Sets the value of Balance attribute. This attribute represents the balance available on the budget.

Parameters
Balance[in] Balance attribute to set.

◆ setBudgetSource()

void OdIfc2x_final::IfcBudget::setBudgetSource ( const OdAnsiString & BudgetSource)

Sets the value of BudgetSource attribute. This attribute represents description of the source of the budget.

Parameters
BudgetSource[in] BudgetSource attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcBudget::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcCostSchedule.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcBudget::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 OdIfc2x_final::IfcCostSchedule.

Member Data Documentation

◆ m_Balance

OdDAIObjectId OdIfc2x_final::IfcBudget::m_Balance
protected

Definition at line 198 of file IfcBudgetAutoImpl.h.

◆ m_BudgetSource

OdAnsiString OdIfc2x_final::IfcBudget::m_BudgetSource
protected

Definition at line 197 of file IfcBudgetAutoImpl.h.


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