#include <IfcEventAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcEvent:

Public Member Functions
IfcEventTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcEventTypeEnum PredefinedType)

IfcEventTriggerTypeEnum	getEventTriggerType () const

void	setEventTriggerType (IfcEventTriggerTypeEnum EventTriggerType)

const OdAnsiString &	getUserDefinedEventTriggerType () const

void	setUserDefinedEventTriggerType (const OdAnsiString &UserDefinedEventTriggerType)

const OdDAIObjectId &	getEventOccurenceTime () const

void	setEventOccurenceTime (const OdDAIObjectId &EventOccurenceTime)

	IfcEvent ()

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 OdIfc4x4::IfcProcess
const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

const OdAnsiString &	getLongDescription () const

void	setLongDescription (const OdAnsiString &LongDescription)

void	getInvIsPredecessorTo (OdDAIObjectIds &IsPredecessorTo) const

void	getInvIsSuccessorFrom (OdDAIObjectIds &IsSuccessorFrom) const

void	getInvOperatesOn (OdDAIObjectIds &OperatesOn) const

	IfcProcess ()

Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::OdIFC4X4Instance
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
OdDAI::Enum	m_PredefinedType

OdDAI::Enum	m_EventTriggerType

OdAnsiString	m_UserDefinedEventTriggerType

OdDAIObjectId	m_EventOccurenceTime

Protected Attributes inherited from OdIfc4x4::IfcProcess
OdAnsiString	m_Identification

OdAnsiString	m_LongDescription

Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x4::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)

Detailed Description

IfcEvent is used to capture information about particular things that happen or that can happen. Particularly used in work plans (or process maps) they identify e.g. a point at which a message containing information can be issued or at which a rule or constraint is invoked.

Nesting - IfcEvent can be contained within an IfcTask using the IfcRelNests relationship. The event is considered active during the time period of the enclosing task (including any assigned IfcWorkCalendar); that is such event can be triggered within the task time period but not outside of it. As an IfcEvent is considered to be atomic, no use is anticipated for nesting processes inside the event.
Sequential Connectivity - The relationship IfcRelSequence is used to indicate control flow. An IfcEvent as a predecessor (IfcRelSequence.RelatingProcess) indicates that the succeeding process (typically IfcProcedure or IfcTask) is triggered in response to the event. An IfcEvent as a successor (IfcRelSequence.RelatedProcess) indicates that the completion of the preceding process causes the event to be triggered. As events have zero duration, the IfcRelSequence.SequenceType attribute has no effect on an IfcEvent but still applies to the opposite end of the relationship if IfcTask is used.
Control Assignment - An IfcEvent can be assigned to an IfcWorkCalendar to indicate times when such event is active using IfcRelAssignsToControl; otherwise the effective calendar is determined by the nearest IfcProcess ancestor with a calendar assigned.
Product Assignment - For building operation scenarios, IfcEvent can be assigned to a product (IfcElement subtype) using IfcRelAssignsToProduct to indicate a specific product occurrence that sources the event. EXAMPLE: An IfcSensor for a motion sensor can have a "Motion Sensed" event. If the IfcEvent is defined by an IfcEventType and the IfcEventType is assigned to a product type (using IfcRelAssignsToProduct), then the IfcEvent must be assigned to one or more occurrences of the specified product type using IfcRelAssignsToProduct.

Definition at line 67 of file IFC4X4/IfcEventAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcEvent()

OdIfc4x4::IfcEvent::IfcEvent ( )

Default constructor for the IfcEvent class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ getEventOccurenceTime()

const OdDAIObjectId & OdIfc4x4::IfcEvent::getEventOccurenceTime ( ) const

Returns the value of EventOccurenceTime attribute. This attribute represents the date and/or time at which an event occurs.

Returns: Returns the value of EventOccurenceTime attribute.

◆ getEventTriggerType()

IfcEventTriggerTypeEnum OdIfc4x4::IfcEvent::getEventTriggerType ( ) const

Returns the value of EventTriggerType attribute. This attribute represents the predefined types of event trigger from which the required type can be set.

Returns: Returns the value of EventTriggerType attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ getPredefinedType()

IfcEventTypeEnum OdIfc4x4::IfcEvent::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents the predefined types of an event from which the required type can be set.

Returns: Returns the value of PredefinedType attribute.

◆ getUserDefinedEventTriggerType()

const OdAnsiString & OdIfc4x4::IfcEvent::getUserDefinedEventTriggerType ( ) const

Returns the value of UserDefinedEventTriggerType attribute. This attribute represents a user defined event trigger type, the value of which is asserted when the value of an event trigger type is declared as USERDEFINED.

Returns: Returns the value of UserDefinedEventTriggerType attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ isKindOf()

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ outFields()

virtual OdResult OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ setEventOccurenceTime()

void OdIfc4x4::IfcEvent::setEventOccurenceTime ( const OdDAIObjectId & EventOccurenceTime )

Sets the value of EventOccurenceTime attribute. This attribute represents the date and/or time at which an event occurs.

Parameters

EventOccurenceTime [in] Event occurrence time to set.

◆ setEventTriggerType()

void OdIfc4x4::IfcEvent::setEventTriggerType ( IfcEventTriggerTypeEnum EventTriggerType )

Sets the value of EventTriggerType attribute. This attribute represents the predefined types of event trigger from which the required type can be set.

Parameters

EventTriggerType [in] Event trigger type to set.

◆ setPredefinedType()

void OdIfc4x4::IfcEvent::setPredefinedType ( IfcEventTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents the predefined types of an event from which the required type can be set.

Parameters

PredefinedType [in] Predefined type to set.

◆ setUserDefinedEventTriggerType()

void OdIfc4x4::IfcEvent::setUserDefinedEventTriggerType ( const OdAnsiString & UserDefinedEventTriggerType )

Sets the value of UserDefinedEventTriggerType attribute. This attribute represents a user defined event trigger type, the value of which is asserted when the value of an event trigger type is declared as USERDEFINED.

Parameters

UserDefinedEventTriggerType [in] User-defined event triggerType to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcEvent::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcProcess.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcEvent::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 OdIfc4x4::IfcProcess.

Member Data Documentation

◆ m_EventOccurenceTime

OdDAIObjectId OdIfc4x4::IfcEvent::m_EventOccurenceTime

protected

Definition at line 275 of file IFC4X4/IfcEventAutoImpl.h.

◆ m_EventTriggerType

OdDAI::Enum OdIfc4x4::IfcEvent::m_EventTriggerType

protected

Definition at line 273 of file IFC4X4/IfcEventAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcEvent::m_PredefinedType

protected

Definition at line 272 of file IFC4X4/IfcEventAutoImpl.h.

◆ m_UserDefinedEventTriggerType

OdAnsiString OdIfc4x4::IfcEvent::m_UserDefinedEventTriggerType

protected

Definition at line 274 of file IFC4X4/IfcEventAutoImpl.h.

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

IFC4X4/IfcEventAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcEvent()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getEventOccurenceTime()

◆ getEventTriggerType()

◆ getInstanceType()

◆ getPredefinedType()

◆ getUserDefinedEventTriggerType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setEventOccurenceTime()

◆ setEventTriggerType()

◆ setPredefinedType()

◆ setUserDefinedEventTriggerType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_EventOccurenceTime

◆ m_EventTriggerType

◆ m_PredefinedType

◆ m_UserDefinedEventTriggerType