Class Ifc4x1::IfcAlarm

Nested Relationships

This class is a nested type of Struct Ifc4x1.

Inheritance Relationships

Base Type

Class Documentation

class Ifc4x1::IfcAlarm : public Ifc4x1::IfcDistributionControlElement

An alarm is a device that signals the existence of a condition or situation that is outside the boundaries of normal expectation or that activates such a device. Alarms include the provision of break glass buttons and manual pull boxes that are used to activate alarms.

HISTORY New entity in IFC2x4

Type Use Definition IfcAlarm defines the occurrence of any alarm; common information about alarm types is handled by IfcAlarmType. The IfcAlarmType (if present) may establish the common type name, usage (predefined type), properties, materials, ports, composition, assignments, and representations. The IfcAlarmType is attached using the IfcRelDefinesByType objectified relationship and is accessible by the IsTypedBy inverse attribute. If the IfcAlarmType has ports or aggregated elements, such objects are reflected at the IfcAlarm occurrence using the IfcRelDefinesByObject relationship.

Property Use Definition The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. Property sets may also be specified at the IfcAlarmType, defining the common property data for all occurrences of the same type. They are then accessible by the IsTypedBy inverse attribute pointing to IfcAlarmType.HasPropertySets. If both are given, then the properties directly defined at IfcAlarm override the properties defined at IfcAlarmType. Refer to the documentation at the supertype IfcDistributionControlElement and ancestors for inherited property set definitions. The following property set definitions are applicable to this entity: Pset_AlarmPHistory (PSET_PERFORMANCEDRIVEN) Pset_AlarmTypeCommon (PSET_TYPEDRIVENOVERRIDE)

Quantity Use Definition The quantities relating to this entity are defined by IfcElementQuantity and attached by the IfcRelDefinesByProperties relationship. They are accessible by the IsDefinedBy inverse attribute. The following base quantities are defined and shall be exchanged with the IfcElementQuantity.Name = ‘BaseQuantities’. Other quantities, being subjected to local standard of measurement, may be defined with another string value assigned to Name. In this case a valid value for MethodOfMeasurement shall be provided.

Qto_AlarmBaseQuantities

Material Use Definition The material of the IfcAlarm is defined by IfcMaterialConstituentSet or as a fallback by IfcMaterial, and attached by the RelatingMaterial attribute on the IfcRelAssociatesMaterial relationship. It is accessible by the HasAssociations inverse attribute. Material information can also be given at the IfcAlarmType, defining the common attribute data for all occurrences of the same type. The following keywords for IfcMaterialConstituentSet.MaterialConstituents[n].Name shall be used:

Casing: Material from which the casing is constructed.

Port Use Definition The distribution ports relating to the IfcAlarm are defined by IfcDistributionPort and attached by the IfcRelConnectsPortToElement relationship. If the alarm occurrence is defined by IfcAlarmType, then the port occurrences must reflect those defined at the IfcAlarmType using the IfcRelDefinesByObject relationship. Ports are specific to the IfcAlarm PredefinedType as follows indicated by the IfcDistributionPort Name, PredefinedType, and FlowDirection:

Input (SIGNAL, SINK): Receives signal.

Public Types

typedef IfcTemplatedEntityList<IfcAlarm> list

Public Functions

bool hasPredefinedType() const

Whether the optional attribute PredefinedType is defined for this IfcAlarm.

::Ifc4x1::IfcAlarmTypeEnum::Value PredefinedType() const
void setPredefinedType(::Ifc4x1::IfcAlarmTypeEnum::Value v)
const IfcParse::entity &declaration() const
IfcAlarm(IfcEntityInstanceData *e)
IfcAlarm(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, ::Ifc4x1::IfcObjectPlacement *v6_ObjectPlacement, ::Ifc4x1::IfcProductRepresentation *v7_Representation, boost::optional<std::string> v8_Tag, boost::optional<::Ifc4x1::IfcAlarmTypeEnum::Value> v9_PredefinedType)

Public Static Functions

const IfcParse::entity &Class()