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

#include <IfcApprovalAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcApproval:
OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
IfcDateTimeSelect approvalDateTime ()
 
const OdAnsiString & getApprovalStatus () const
 
void setApprovalStatus (const OdAnsiString &ApprovalStatus)
 
const OdAnsiString & getApprovalLevel () const
 
void setApprovalLevel (const OdAnsiString &ApprovalLevel)
 
const OdAnsiString & getApprovalQualifier () const
 
void setApprovalQualifier (const OdAnsiString &ApprovalQualifier)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getIdentifier () const
 
void setIdentifier (const OdAnsiString &Identifier)
 
void getInvActors (OdDAIObjectIds &Actors) 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 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::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_Description
 
OdDAI::Select m_ApprovalDateTime
 
OdAnsiString m_ApprovalStatus
 
OdAnsiString m_ApprovalLevel
 
OdAnsiString m_ApprovalQualifier
 
OdAnsiString m_Name
 
OdAnsiString m_Identifier
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcApprovalActorRelationship
 
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.

Definition at line 48 of file Ifc2x3/IfcApprovalAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcApproval()

OdIfc2x3::IfcApproval::IfcApproval ( )

Default constructor for the IfcApproval class.

Member Function Documentation

◆ approvalDateTime()

IfcDateTimeSelect OdIfc2x3::IfcApproval::approvalDateTime ( )

◆ comparedToEarlyImpl()

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

◆ getApprovalLevel()

const OdAnsiString & OdIfc2x3::IfcApproval::getApprovalLevel ( ) const

◆ getApprovalQualifier()

const OdAnsiString & OdIfc2x3::IfcApproval::getApprovalQualifier ( ) const

◆ getApprovalStatus()

const OdAnsiString & OdIfc2x3::IfcApproval::getApprovalStatus ( ) const

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::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 OdIfc2x3::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 & OdIfc2x3::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 & OdIfc2x3::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 * OdIfc2x3::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.

◆ getInvActors()

void OdIfc2x3::IfcApproval::getInvActors ( OdDAIObjectIds & Actors) const

◆ getInvIsRelatedWith()

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

◆ getName()

const OdAnsiString & OdIfc2x3::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.

◆ inFields()

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

◆ setApprovalLevel()

void OdIfc2x3::IfcApproval::setApprovalLevel ( const OdAnsiString & ApprovalLevel)

◆ setApprovalQualifier()

void OdIfc2x3::IfcApproval::setApprovalQualifier ( const OdAnsiString & ApprovalQualifier)

◆ setApprovalStatus()

void OdIfc2x3::IfcApproval::setApprovalStatus ( const OdAnsiString & ApprovalStatus)

◆ setDescription()

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

◆ setName()

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

◆ testAttr() [1/2]

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

◆ IfcApprovalActorRelationship

friend class IfcApprovalActorRelationship
friend

Definition at line 267 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ IfcApprovalRelationship

Definition at line 268 of file Ifc2x3/IfcApprovalAutoImpl.h.

Member Data Documentation

◆ m_ApprovalDateTime

OdDAI::Select OdIfc2x3::IfcApproval::m_ApprovalDateTime
protected

Definition at line 259 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_ApprovalLevel

OdAnsiString OdIfc2x3::IfcApproval::m_ApprovalLevel
protected

Definition at line 261 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_ApprovalQualifier

OdAnsiString OdIfc2x3::IfcApproval::m_ApprovalQualifier
protected

Definition at line 262 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_ApprovalStatus

OdAnsiString OdIfc2x3::IfcApproval::m_ApprovalStatus
protected

Definition at line 260 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc2x3::IfcApproval::m_Description
protected

Definition at line 258 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_Identifier

OdAnsiString OdIfc2x3::IfcApproval::m_Identifier
protected

Definition at line 264 of file Ifc2x3/IfcApprovalAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcApproval::m_Name
protected

Definition at line 263 of file Ifc2x3/IfcApprovalAutoImpl.h.


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