#include <IfcProcedureAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcProcedure:

Public Member Functions
const OdAnsiString &	getProcedureID () const

void	setProcedureID (const OdAnsiString &ProcedureID)

IfcProcedureTypeEnum	getProcedureType () const

void	setProcedureType (IfcProcedureTypeEnum ProcedureType)

const OdAnsiString &	getUserDefinedProcedureType () const

void	setUserDefinedProcedureType (const OdAnsiString &UserDefinedProcedureType)

	IfcProcedure ()

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::IfcProcess
void	getInvOperatesOn (OdDAIObjectIds &OperatesOn) const

void	getInvIsSuccessorFrom (OdDAIObjectIds &IsSuccessorFrom) const

void	getInvIsPredecessorTo (OdDAIObjectIds &IsPredecessorTo) 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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdAnsiString	m_ProcedureID

OdDAI::Enum	m_ProcedureType

OdAnsiString	m_UserDefinedProcedureType

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
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Protected Member Functions inherited from OdIfc2x3::IfcProcess
virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Detailed Description

An IfcProcedure is a logical set of actions to be taken in response to an event or to cause an event to occur.

Use Definitions - IfcProcedure is used to capture information about stepped processes such as calibration, start/stop procedures for equipment items, designated actions to take in the event of an emergency etc. A procedure is not a task, but can describe a set of tasks and their order of occurrence in response to or to cause an event. As shown on the image below, IfcProcedure does not restrict anything but describes specific steps of how something should happen. While a procedure does control/restrict in the sense of indicating "this is how the task should be performed" by nature of describing inner detail, this is not different than parts of a product indicating "this is how the parts should be assembled". Consequently, it doesn't restrict the outer item as a whole but provides inner detail of the item.

Object Typing - The Object Typing concept template applies to this entity as IfcProcedureType under RelatingType. IfcProcedure defines the anticipated or actual occurrence of any procedure; common information about procedure types is handled by IfcProcedureType.
Nesting - The IfcProcedure can be contained within an IfcTask or IfcProcedure using the IfcRelNests relationship. An IfcProcedure can in turn nest other IfcProcedure or IfcEvent entities. Such nesting indicates decomposed level of detail.
Sequential Connectivity - The relationship IfcRelSequence is used to indicate control flow. An IfcProcedure as a successor to an IfcEvent indicates that the procedure should be performed in response to the event. An IfcProcedure as a predecessor to an IfcEvent indicates that the event should be triggered following the procedure. As procedures have arbitrary duration, the IfcRelSequence.SequenceType attribute has no effect on an IfcProcedure but still applies to the opposite end of the relationship if IfcTask is used.
Process Assignment - A particular type of IfcProcedure is a caution, warning or other form of advisory note. Typically, it is anticipated that such a procedure would be assigned to the specific IfcProcess for which it gives advice using IfcRelAssignsToProcess.
Control Assignment - An IfcProcedure can be assigned to an IfcWorkCalendar to indicate times when such procedure can be performed using IfcRelAssignsToControl; otherwise the effective calendar is determined by the nearest IfcProcess ancestor with a calendar assigned. Advisory notes should be assigned to the specific IfcProcess for which it gives advice using IfcRelAssignsToProcess.
Product Assignment - For building operation scenarios, IfcProcedure can be assigned to a product (IfcElement subtype) using IfcRelAssignsToProduct to indicate a specific product occurrence that performs the procedure. EXAMPLE: An IfcActuator can have a "Close" procedure. If the IfcProcedure is defined by an IfcProcedureType and the IfcProcedureType is assigned to a product type (using IfcRelAssignsToProduct), then the IfcProcedure must be assigned to one or more occurrences of the specified product type using IfcRelAssignsToProduct.

Definition at line 84 of file Ifc2x3/IfcProcedureAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcProcedure()

OdIfc2x3::IfcProcedure::IfcProcedure ( )

Default constructor for the IfcProcedure class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcProcedure::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::IfcObject.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcProcedure::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::IfcProcess.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcProcedure::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::IfcProcess.

◆ getProcedureID()

const OdAnsiString & OdIfc2x3::IfcProcedure::getProcedureID ( ) const

Returns the value of ProcedureID attribute. This attribute represents identifying designation given to a procedure.

Returns: Returns the value of ProcedureID attribute.

◆ getProcedureType()

IfcProcedureTypeEnum OdIfc2x3::IfcProcedure::getProcedureType ( ) const

Returns the value of ProcedureType attribute. This attribute represents predefined procedure types that can be set.

Returns: Returns the value of ProcedureType attribute.

◆ getUserDefinedProcedureType()

const OdAnsiString & OdIfc2x3::IfcProcedure::getUserDefinedProcedureType ( ) const

Returns the value of UserDefinedProcedureType attribute. This attribute represents a user-defined procedure type.

Returns: Returns the value of UserDefinedProcedureType attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setProcedureID()

void OdIfc2x3::IfcProcedure::setProcedureID ( const OdAnsiString & ProcedureID )

Sets the value of ProcedureID attribute. This attribute represents identifying designation given to a procedure.

Parameters

ProcedureID [in] Procedure identifier to set.

◆ setProcedureType()

void OdIfc2x3::IfcProcedure::setProcedureType ( IfcProcedureTypeEnum ProcedureType )

Sets the value of ProcedureType attribute. This attribute represents predefined procedure types that can be set.

Parameters

ProcedureType [in] Procedure type to set.

◆ setUserDefinedProcedureType()

void OdIfc2x3::IfcProcedure::setUserDefinedProcedureType ( const OdAnsiString & UserDefinedProcedureType )

Sets the value of UserDefinedProcedureType attribute. This attribute represents a user-defined procedure type.

Parameters

UserDefinedProcedureType [in] Procedure type to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcProcedure::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::IfcProcess.

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_ProcedureID

OdAnsiString OdIfc2x3::IfcProcedure::m_ProcedureID

protected

Definition at line 272 of file Ifc2x3/IfcProcedureAutoImpl.h.

◆ m_ProcedureType

OdDAI::Enum OdIfc2x3::IfcProcedure::m_ProcedureType

protected

Definition at line 273 of file Ifc2x3/IfcProcedureAutoImpl.h.

◆ m_UserDefinedProcedureType

OdAnsiString OdIfc2x3::IfcProcedure::m_UserDefinedProcedureType

protected

Definition at line 274 of file Ifc2x3/IfcProcedureAutoImpl.h.

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

Ifc2x3/IfcProcedureAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcProcedure()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getProcedureID()

◆ getProcedureType()

◆ getUserDefinedProcedureType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setProcedureID()

◆ setProcedureType()

◆ setUserDefinedProcedureType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ProcedureID

◆ m_ProcedureType

◆ m_UserDefinedProcedureType