ITcAlarm3

This interface represents an alarm.

Syntax

public interface ITcAlarm3 

ITcAlarm3 1: Methods

Name

Modifier

Return type

Description

Confirm

public virtual

void

Confirms the alarm.

GetCauseRemedy

Public virtual

TcCauseRemedyCollection

Returns information on the cause and remedy (if these are defined).

GetDetails

Public virtual

TcDetailCollection

Returns the details.

GetEventClassName

public virtual

string

Returns the event class name.

GetText

public virtual

string

Returns the event text, including the arguments.

IsSourceInfoTypeSupported

public virtual

bool

Query option for the type of source information.

ITcAlarm3 2: Properties

Name

Modifier

Type

Access

Description

ConfirmationState

public virtual

ConfirmationStateEnum

get

Returns the Confirmation State.

EventClass

public virtual

System.Guid

get

Returns the EventClass GUID.

EventId

public virtual

uint

get

Returns the event ID.

EventType

public virtual

EventTypeEnum

get

Returns the type of the event.

FileTimeCleared

public virtual

long

get

Timestamp when the alarm was changed to the Cleared state.

FileTimeConfirmed

public virtual

long

get

Timestamp when the alarm was confirmed.

FileTimeRaised

public virtual

long

get

Timestamp when the alarm was changed to the Raised state.

IsRaised

public virtual

bool

get

Indicates whether the alarm has been changed to the Raised state.

JsonAttribute

public virtual

string

get

The JSON attribute.

SeverityLevel

public virtual

SeverityLevelEnum

get

The Severity Level.

SourceGuid

public virtual

System.Guid

get

Returns the GUID of the source.

SourceId

public virtual

uint

get

Returns the ID of the source.

SourceName

public virtual

string

get

Returns the name of the source.

TimeCleared

public virtual

System.DateTime

get

Timestamp when the alarm was changed to the Cleared state.

TimeConfirmed

public virtual

System.DateTime

get

Timestamp when the alarm was confirmed.

TimeRaised

public virtual

Sytem.DateTime

get

Timestamp when the alarm was changed to the Raised state.