CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcProjectOrder Class Reference

#include <IfcProjectOrderAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcProjectOrder:
OdIfc2x3::IfcControl OdIfc2x3::IfcObject OdIfc2x3::IfcObjectDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getID () const
 
void setID (const OdAnsiString &ID)
 
IfcProjectOrderTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcProjectOrderTypeEnum PredefinedType)
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
 IfcProjectOrder ()
 
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 OdIfc2x3::IfcControl
void getInvControls (OdDAIObjectIds &Controls) const
 
- Public Member Functions inherited from OdIfc2x3::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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_ID
 
OdDAI::Enum m_PredefinedType
 
OdAnsiString m_Status
 
- Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x3::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

A project order is a directive to purchase products and/or perform work, such as for construction or facilities management.

  • 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 IfcProjectOrder. 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.
  • Property Sets for Objects - This concept can be applied to the following resources: Pset_ProjectOrderChangeOrder (only applies to CHANGEORDER) Pset_ProjectOrderMaintenanceWorkOrder (only applies to MAINTENANCEWORKORDER) Pset_ProjectOrderMoveOrder (only applies to MOVEORDER) Pset_ProjectOrderPurchaseOrder (only applies to PURCHASEORDER) Pset_ProjectOrderWorkOrder (only applies to WORKORDER)
  • Aggregation - The figure below shows the project order composition.

<IMAGE ifcprojectorder-composition>

As shown on the figure, an IfcProjectOrder can be aggregated into components.

  • Nesting - The Object Nesting concept template applies to this entity as shown in table below:
    Type

Description IfcProjectOrder Can contain subordinate orders, particularly change orders indicating contract amendment in order of issue.

<IMAGE ifcprojectorder-assignment>

The IfcProjectOrder can have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcProjectOrder and RelatedObjects contains one or more objects of the following types: IfcActor: Organization(s) contracted to fulfill the order, typically a single contractor, subcontractor, or supplier.

Definition at line 80 of file Ifc2x3/IfcProjectOrderAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcProjectOrder()

OdIfc2x3::IfcProjectOrder::IfcProjectOrder ( )

Default constructor for the IfcProjectOrder class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getID()

const OdAnsiString & OdIfc2x3::IfcProjectOrder::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 ID attribute.
Remarks
IFC4 CHANGE: Attribute ID renamed to Identification and promoted to supertype IfcControl.

◆ getInstanceType()

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

◆ getPredefinedType()

IfcProjectOrderTypeEnum OdIfc2x3::IfcProjectOrder::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a project order 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 & OdIfc2x3::IfcProjectOrder::getStatus ( ) const

Returns the value of Status attribute. This attribute represents the current status of a project order. Examples of status values that might be used for a project order status include: PLANNED REQUESTED APPROVED ISSUED STARTED DELAYED DONE

Returns
Returns the value of Status attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setID()

void OdIfc2x3::IfcProjectOrder::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] Identification to set.
Remarks
IFC4 CHANGE: Attribute ID renamed to Identification and promoted to supertype IfcControl.

◆ setPredefinedType()

void OdIfc2x3::IfcProjectOrder::setPredefinedType ( IfcProjectOrderTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a project order that is specified in an enumeration. There can be a property set given specifically for the predefined types.IFC4 CHANGE The attribute has been made optional.

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

◆ setStatus()

void OdIfc2x3::IfcProjectOrder::setStatus ( const OdAnsiString & Status)

Sets the value of Status attribute. This attribute represents the current status of a project order. Examples of status values that might be used for a project order status include: PLANNED REQUESTED APPROVED ISSUED STARTED DELAYED DONE

Parameters
Status[in] Status to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcProjectOrder::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcControl.

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_ID

OdAnsiString OdIfc2x3::IfcProjectOrder::m_ID
protected

Definition at line 294 of file Ifc2x3/IfcProjectOrderAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc2x3::IfcProjectOrder::m_PredefinedType
protected

Definition at line 295 of file Ifc2x3/IfcProjectOrderAutoImpl.h.

◆ m_Status

OdAnsiString OdIfc2x3::IfcProjectOrder::m_Status
protected

Definition at line 296 of file Ifc2x3/IfcProjectOrderAutoImpl.h.


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