Class Ifc4x1::IfcEvent

Nested Relationships

This class is a nested type of Struct Ifc4x1.

Inheritance Relationships

Base Type

Class Documentation

class Ifc4x1::IfcEvent : public Ifc4x1::IfcProcess

An IfcEvent is something that happens that triggers an action or response.

HISTORY New entity in IFC2x4

Use definitions

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

Type use definition

IfcEvent defines the anticipated or actual occurrence of any event; common information about event types is handled by IfcEventType. The IfcEventType (if present) may establish the common type name, usage (or predefined) type, common set of properties, and common product assignment using IfcRelAssignsToProduct. The IfcEventType is attached using the IfcRelDefinesByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.

Property set use definition

The property sets relating to IfcEvent are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the inverse IsDefinedBy relationship. Such property sets may define event parameters. No property sets for IfcEvent are currently defined by IFC.

Connectivity use definition

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 preceeding 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.

Composition use definition

IfcEvent may 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 may 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.

Assignment use definition

An IfcEvent may 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.

For building operation scenarios, IfcEvent may be assigned to a product (IfcElement subtype) using IfcRelAssignsToProduct to indicate a specific product occurrence that sources the event. For example, an IfcSensor for a motion sensor may 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.

Public Types

typedef IfcTemplatedEntityList<IfcEvent> list

Public Functions

bool hasPredefinedType() const

Whether the optional attribute PredefinedType is defined for this IfcEvent.

::Ifc4x1::IfcEventTypeEnum::Value PredefinedType() const

Identifies the predefined types of an event from which the type required may be set.

void setPredefinedType(::Ifc4x1::IfcEventTypeEnum::Value v)
bool hasEventTriggerType() const

Whether the optional attribute EventTriggerType is defined for this IfcEvent.

::Ifc4x1::IfcEventTriggerTypeEnum::Value EventTriggerType() const

Identifies the predefined types of event trigger from which the type required may be set.

void setEventTriggerType(::Ifc4x1::IfcEventTriggerTypeEnum::Value v)
bool hasUserDefinedEventTriggerType() const

Whether the optional attribute UserDefinedEventTriggerType is defined for this IfcEvent.

std::string UserDefinedEventTriggerType() const

A user defined event trigger type, the value of which is asserted when the value of an event trigger type is declared as USERDEFINED.

void setUserDefinedEventTriggerType(std::string v)
bool hasEventOccurenceTime() const

Whether the optional attribute EventOccurenceTime is defined for this IfcEvent.

::Ifc4x1::IfcEventTime *EventOccurenceTime() const

The date and/or time at which an event occurs.

void setEventOccurenceTime(::Ifc4x1::IfcEventTime *v)
const IfcParse::entity &declaration() const
IfcEvent(IfcEntityInstanceData *e)
IfcEvent(std::string v1_GlobalId, ::Ifc4x1::IfcOwnerHistory *v2_OwnerHistory, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, boost::optional<std::string> v5_ObjectType, boost::optional<std::string> v6_Identification, boost::optional<std::string> v7_LongDescription, boost::optional<::Ifc4x1::IfcEventTypeEnum::Value> v8_PredefinedType, boost::optional<::Ifc4x1::IfcEventTriggerTypeEnum::Value> v9_EventTriggerType, boost::optional<std::string> v10_UserDefinedEventTriggerType, ::Ifc4x1::IfcEventTime *v11_EventOccurenceTime)

Public Static Functions

const IfcParse::entity &Class()