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

#include <IfcActionRequestAutoImpl.h>

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

Public Member Functions

IfcActionRequestTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcActionRequestTypeEnum PredefinedType)
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
const OdAnsiString & getLongDescription () const
 
void setLongDescription (const OdAnsiString &LongDescription)
 
 IfcActionRequest ()
 
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::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
 
OdAnsiString m_Status
 
OdAnsiString m_LongDescription
 
- 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)
 
- Protected Member Functions inherited from OdIfc4x2::IfcObjectDefinition
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

A request is the act or instance of asking for something, such as a request for information, bid submission, or performance of work. Requests may take many forms depending on the need including fault reports for maintenance, requests for small works, and purchase requests (where these are to be made through a help desk or buying function).

  • Approval - The Approval Association concept applies to this entity. Approvals may be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcActionRequest. Approvals may 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.
  • Aggregation - As shown in the figure below, an IfcActionRequest may be aggregated into components.

<IMAGE ifcactionrequest-composition>

  • Nesting - An IfcActionRequest entity may be nested into follow-up requests, in order of issue.
  • Control Assignment - As shown in the figure below, an IfcActionRequest may be assigned to the following entities using relationships as indicated: IfcActor (IfcRelAssignsToActor): Person or organization issuing the request such as a tenant or owner.

The IfcActionRequest may have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcActionRequest and RelatedObjects contains one or more objects of the following types: IfcActor: Person or organization(s) fulfilling the request such as a facilities manager or contractor.

<IMAGE ifcactionrequest-assignment>

\changes

IFC4 changes: Attribute RequestID renamed to Identification and promoted to supertype IfcControl;

Definition at line 75 of file Ifc4x2/IfcActionRequestAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcActionRequest()

OdIfc4x2::IfcActionRequest::IfcActionRequest ( )

Default constructor for the IfcActionRequest class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

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

◆ getLongDescription()

const OdAnsiString & OdIfc4x2::IfcActionRequest::getLongDescription ( ) const

Returns the value of LongDescription attribute. This attribute represents detailed description of the permit.

Returns
Returns the value of LongDescription attribute.
Remarks
IFC4 CHANGE: The attribute has been added.

◆ getPredefinedType()

IfcActionRequestTypeEnum OdIfc4x2::IfcActionRequest::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents the predefined type of sources through which a request can be made.

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

◆ getStatus()

const OdAnsiString & OdIfc4x2::IfcActionRequest::getStatus ( ) const

Returns the value of Status attribute. This attribute represents the status currently assigned to the request. Possible values include: Hold: wait to see if further requests are received before deciding on action NoAction: no action is required on this request Schedule: plan action to take place as part of maintenance or other task planning/scheduling Urgent: take action immediately

Returns
Returns the value of Status attribute.
Remarks
IFC4 CHANGE: The attribute has been added.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setLongDescription()

void OdIfc4x2::IfcActionRequest::setLongDescription ( const OdAnsiString & LongDescription)

Sets the value of LongDescription attribute. This attribute represents detailed description of the permit.

Parameters
LongDescription[in] Long description to set.
Remarks
IFC4 CHANGE: The attribute has been added.

◆ setPredefinedType()

void OdIfc4x2::IfcActionRequest::setPredefinedType ( IfcActionRequestTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents the predefined type of sources through which a request can be made.

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

◆ setStatus()

void OdIfc4x2::IfcActionRequest::setStatus ( const OdAnsiString & Status)

Sets the value of Status attribute. This attribute represents the status currently assigned to the request. Possible values include: Hold: wait to see if further requests are received before deciding on action NoAction: no action is required on this request Schedule: plan action to take place as part of maintenance or other task planning/scheduling Urgent: take action immediately

Parameters
Status[in] Status to set.
Remarks
IFC4 CHANGE: The attribute has been added.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_LongDescription

OdAnsiString OdIfc4x2::IfcActionRequest::m_LongDescription
protected

Definition at line 268 of file Ifc4x2/IfcActionRequestAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x2::IfcActionRequest::m_PredefinedType
protected

Definition at line 266 of file Ifc4x2/IfcActionRequestAutoImpl.h.

◆ m_Status

OdAnsiString OdIfc4x2::IfcActionRequest::m_Status
protected

Definition at line 267 of file Ifc4x2/IfcActionRequestAutoImpl.h.


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