CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x1::IfcApproval Class Reference

#include <IfcApprovalAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcApproval:
OdIfc4x1::OdIfc4x1Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getIdentifier () const
 
void setIdentifier (const OdAnsiString &Identifier)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdAnsiString & getTimeOfApproval () const
 
void setTimeOfApproval (const OdAnsiString &TimeOfApproval)
 
const OdAnsiString & getStatus () const
 
void setStatus (const OdAnsiString &Status)
 
const OdAnsiString & getLevel () const
 
void setLevel (const OdAnsiString &Level)
 
const OdAnsiString & getQualifier () const
 
void setQualifier (const OdAnsiString &Qualifier)
 
IfcActorSelect requestingApproval ()
 
IfcActorSelect givingApproval ()
 
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const
 
void getInvApprovedObjects (OdDAIObjectIds &ApprovedObjects) const
 
void getInvApprovedResources (OdDAIObjectIds &ApprovedResources) const
 
void getInvIsRelatedWith (OdDAIObjectIds &IsRelatedWith) const
 
void getInvRelates (OdDAIObjectIds &Relates) const
 
 IfcApproval ()
 
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 OdIfc4x1::OdIfc4x1Instance
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_Identifier
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdAnsiString m_TimeOfApproval
 
OdAnsiString m_Status
 
OdAnsiString m_Level
 
OdAnsiString m_Qualifier
 
OdDAI::Select m_RequestingApproval
 
OdDAI::Select m_GivingApproval
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcExternalReferenceRelationship
 
class IfcRelAssociatesApproval
 
class IfcResourceApprovalRelationship
 
class IfcApprovalRelationship
 

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 IfcApproval represents information about approval processes such as for a plan, a design, a proposal, or a change order in a construction or facilities management project. IfcApproval is referenced by IfcRelAssociatesApproval in IfcControlExtension schema, and thereby can be related to all subtypes of IfcRoot. An approval can also be provided to resource objects using IfcResourceApprovalRelationship.

\changes

IFC4 changes: Attribute ApprovalDateTime renamed to Name Attribute ApprovalDateTime made optional, changed from "False" to "True" Type of the ApprovalDateTime attribute changed from "IfcDateTimeSelect" to "IfcLabel" Attribute ApprovalLevel renamed to TimeOfApproval Type of the ApprovalLevel attribute changed from "IfcLabel" to "IfcDateTime" Attribute ApprovalQualifier renamed to Status Type of the ApprovalQualifier attribute changed from "IfcText" to "IfcLabel" Attribute Identifier renamed to Qualifier Attribute Identifier made optional, changed from "False" to "True" Type of the Identifier attribute changed from "IfcIdentifier" to "IfcText" Attribute Name renamed to Level Attribute Name made optional changed from "False" to "True" Inverse attribute Actors renamed to HasExternalReferences Type of the inverse attribute Actors changed from "SET OF [0:?] IfcApprovalActorRelationship FOR Approval" to "SET OF [0:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects" Attribute IsRelatedWith renamed to ApprovedObjects Type of the inverse attribute IsRelatedWith changed from "SET OF [0:?] IfcApprovalRelationship FOR RelatedApproval" to "SET OF [0:?] IfcRelAssociatesApproval FOR RelatingApproval"

Definition at line 68 of file Ifc4x1/IfcApprovalAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcApproval()

OdIfc4x1::IfcApproval::IfcApproval ( )

Default constructor for the IfcApproval class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcApproval::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ getDescription()

const OdAnsiString & OdIfc4x1::IfcApproval::getDescription ( ) const

Returns the value of Description attribute. This attribute represents a general textual description of a design, work task, plan, etc. that is being approved for.

Returns
Returns the value of Description attribute.

◆ getIdentifier()

const OdAnsiString & OdIfc4x1::IfcApproval::getIdentifier ( ) const

Returns the value of Identifier attribute. This attribute represents a computer-interpretable identifier by which the approval is known.

Returns
Returns the value of Identifier attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcApproval::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.

◆ getInvApprovedObjects()

void OdIfc4x1::IfcApproval::getInvApprovedObjects ( OdDAIObjectIds & ApprovedObjects) const

Returns the value of ApprovedObjects attribute. This attribute represents reference to the IfcRelAssociatesApproval instances associating this approval to objects (subtypes of IfcRoot)

Parameters
ApprovedObjects[out] Receives the value of ApprovedObjects attribute.

◆ getInvApprovedResources()

void OdIfc4x1::IfcApproval::getInvApprovedResources ( OdDAIObjectIds & ApprovedResources) const

Returns the value of ApprovedResources attribute. This attribute represents the set of relationships by which resource objects that are approved by this approval are known.

Parameters
ApprovedResources[out] Receives the value of ApprovedResources attribute.

◆ getInvHasExternalReferences()

void OdIfc4x1::IfcApproval::getInvHasExternalReferences ( OdDAIObjectIds & HasExternalReferences) const

Returns the value of HasExternalReferences attribute. This attribute represents reference to external references, e.g. library, classification, or document information, that are associated to the Approval.

Parameters
HasExternalReferences[out] Receives the value of HasExternalReferences attribute.

◆ getInvIsRelatedWith()

void OdIfc4x1::IfcApproval::getInvIsRelatedWith ( OdDAIObjectIds & IsRelatedWith) const

Returns the value of IsRelatedWith attribute. This attribute represents the set of relationships by which this approval is related to others.

Parameters
IsRelatedWith[out] Receives the value of IsRelatedWith attribute.

◆ getInvRelates()

void OdIfc4x1::IfcApproval::getInvRelates ( OdDAIObjectIds & Relates) const

Returns the value of Relates attribute. This attribute represents the set of relationships by which other approvals are related to this one.

Parameters
Relates[out] Receives the value of Relates attribute.

◆ getLevel()

const OdAnsiString & OdIfc4x1::IfcApproval::getLevel ( ) const

Returns the value of Level attribute. This attribute represents level of the approval e.g. Draft vs Completed design.

Returns
Returns the value of Level attribute.

◆ getName()

const OdAnsiString & OdIfc4x1::IfcApproval::getName ( ) const

Returns the value of Name attribute. This attribute represents a human-readable name provided to an approval.

Returns
Returns the value of Name attribute.

◆ getQualifier()

const OdAnsiString & OdIfc4x1::IfcApproval::getQualifier ( ) const

Returns the value of Qualifier attribute. This attribute represents textual description of special constraints or conditions for the approval.

Returns
Returns the value of Qualifier attribute.

◆ getStatus()

const OdAnsiString & OdIfc4x1::IfcApproval::getStatus ( ) const

Returns the value of Status attribute. This attribute represents the result or current status of the approval, e.g. Requested, Processed, Approved, Not Approved.

Returns
Returns the value of Status attribute.

◆ getTimeOfApproval()

const OdAnsiString & OdIfc4x1::IfcApproval::getTimeOfApproval ( ) const

Returns the value of TimeOfApproval attribute. This attribute represents date and time when the result of the approval process is produced.

Returns
Returns the value of TimeOfApproval attribute.

◆ givingApproval()

IfcActorSelect OdIfc4x1::IfcApproval::givingApproval ( )

Returns the value of GivingApproval attribute. This attribute represents the actor that is acting in the role specified at IfcOrganization or individually at IfcPerson and giving an approval.

Returns
Returns the value of GivingApproval attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcApproval::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.

◆ isKindOf()

virtual bool OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ outFields()

virtual OdResult OdIfc4x1::IfcApproval::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.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ requestingApproval()

IfcActorSelect OdIfc4x1::IfcApproval::requestingApproval ( )

Returns the value of RequestingApproval attribute. This attribute represents the actor that is acting in the role specified at IfcOrganization or individually at IfcPerson and requesting an approval.

Returns
Returns the value of RequestingApproval attribute.

◆ setDescription()

void OdIfc4x1::IfcApproval::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents a general textual description of a design, work task, plan, etc. that is being approved for.

Parameters
Description[in] Description to set.

◆ setIdentifier()

void OdIfc4x1::IfcApproval::setIdentifier ( const OdAnsiString & Identifier)

Sets the value of Identifier attribute. This attribute represents a computer-interpretable identifier by which the approval is known.

Parameters
Identifier[in] Identifier to set.

◆ setLevel()

void OdIfc4x1::IfcApproval::setLevel ( const OdAnsiString & Level)

Sets the value of Level attribute. This attribute represents level of the approval e.g. Draft vs Completed design.

Parameters
Level[in] Level to set.

◆ setName()

void OdIfc4x1::IfcApproval::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents a human-readable name provided to an approval.

Parameters
Name[in] Name to set.

◆ setQualifier()

void OdIfc4x1::IfcApproval::setQualifier ( const OdAnsiString & Qualifier)

Sets the value of Qualifier attribute. This attribute represents textual description of special constraints or conditions for the approval.

Parameters
Qualifier[in] Qualifier to set.

◆ setStatus()

void OdIfc4x1::IfcApproval::setStatus ( const OdAnsiString & Status)

Sets the value of Status attribute. This attribute represents the result or current status of the approval, e.g. Requested, Processed, Approved, Not Approved.

Parameters
Status[in] Status to set.

◆ setTimeOfApproval()

void OdIfc4x1::IfcApproval::setTimeOfApproval ( const OdAnsiString & TimeOfApproval)

Sets the value of TimeOfApproval attribute. This attribute represents date and time when the result of the approval process is produced.

Parameters
TimeOfApproval[in] Time of approval to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcApproval::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcApproval::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 OdIfc::OdIfcInstance.

Friends And Related Symbol Documentation

◆ IfcApprovalRelationship

Definition at line 365 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ IfcExternalReferenceRelationship

friend class IfcExternalReferenceRelationship
friend

Definition at line 362 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ IfcRelAssociatesApproval

friend class IfcRelAssociatesApproval
friend

Definition at line 363 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ IfcResourceApprovalRelationship

friend class IfcResourceApprovalRelationship
friend

Definition at line 364 of file Ifc4x1/IfcApprovalAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x1::IfcApproval::m_Description
protected

Definition at line 353 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_GivingApproval

OdDAI::Select OdIfc4x1::IfcApproval::m_GivingApproval
protected

Definition at line 359 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_Identifier

OdAnsiString OdIfc4x1::IfcApproval::m_Identifier
protected

Definition at line 351 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_Level

OdAnsiString OdIfc4x1::IfcApproval::m_Level
protected

Definition at line 356 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x1::IfcApproval::m_Name
protected

Definition at line 352 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_Qualifier

OdAnsiString OdIfc4x1::IfcApproval::m_Qualifier
protected

Definition at line 357 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_RequestingApproval

OdDAI::Select OdIfc4x1::IfcApproval::m_RequestingApproval
protected

Definition at line 358 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_Status

OdAnsiString OdIfc4x1::IfcApproval::m_Status
protected

Definition at line 355 of file Ifc4x1/IfcApprovalAutoImpl.h.

◆ m_TimeOfApproval

OdAnsiString OdIfc4x1::IfcApproval::m_TimeOfApproval
protected

Definition at line 354 of file Ifc4x1/IfcApprovalAutoImpl.h.


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