FB_TcAlarm
![FB_TcAlarm 1:](Images/png/5031418891__Web.png)
This function block represents an alarm of the TwinCAT 3 EventLogger.
Syntax
Definition:
FUNCTION_BLOCK FB_TcAlarm EXTENDS FB_TcEventBase
Methods
Name | Definition location | Description |
---|---|---|
Inherited from FB_TcEventBase | Compares the event with another instance. | |
Inherited from FB_TcEventBase | Compares the event class of the event with another event class. | |
Inherited from FB_TcEventBase | Compares the event class, the event ID and the severity of the event with those of another event. | |
Inherited from FB_TcEventBase | Compares the event definition of the event with another event definition. | |
Inherited from FB_TcEventBase | Returns the Json attribute. | |
Inherited from FB_TcEventBase | Releases the instance created by the EventLogger again. | |
Inherited from FB_TcEventBase | Requests the name of the event class. | |
Inherited from FB_TcEventBase | Returns the text for the event. | |
Local | Sets the alarm state to "Not Raised". | |
Local | Confirms the alarm. | |
Local | Creates an alarm instance in the EventLogger. | |
Local | Creates an alarm instance in the EventLogger from an event definition. | |
Local | Sets the alarm state to "Raised". | |
Local | Sets the Json attribute. |
Properties
Name | Type | Access | Definition location | Description |
---|---|---|---|---|
eSeverity | Get | Inherited from FB_TcEventBase | Returns the severity. | |
EventClass | GUID | Get | Inherited from FB_TcEventBase | Returns the GUID of the event class. |
Get | Inherited from FB_TcEventBase | Returns the interface pointer for the arguments. | ||
Get | Inherited from FB_TcEventBase | The SourceInfo is created internally as the default behavior. It then contains the symbol name of the function block that instances FB_TcMessage as SourceName and the object ID of the PLC instance as SourceID. If the instance of FB_TcMessage is hidden with the attribute "hide", no symbol name can be created internally for the default behavior. | ||
nEventId | nEventId | Get | Inherited from FB_TcEventBase | Returns the ID of the event. |
stEventEntry | Get | Inherited from FB_TcEventBase | Returns the event definition. | |
bRaised | BOOL | Get | Local | Returns TRUE if the alarm is in the "raised" state. |
bActive | BOOL | Get | Local | Returns TRUE if the alarm is in the "Raised" or "Wait For Confirmation" state. |
eConfirmationState | Get | Local | Returns the confirmation state. | |
nTimeCleared | ULINT | Get | Local | Returns the time of the Clear. |
nTimeConfirmed | ULINT | Get | Local | Returns the time of the Confirm. |
nTimeRaised | ULINT | Get | Local | Returns the time of the Raise. |
Requirements
Development environment | Target platform | PLC libraries to include |
---|---|---|
TwinCAT v3.1.4022.20 | PC or CX (x64, x86, ARM) | Tc3_EventLogger |