C# Class Softing.OPCToolbox.Client.AeCondition

Represents a condition-related event.
Inheritance: Softing.OPCToolbox.Client.AeEvent
Mostrar archivo Open project: SoftingIndustrial/OPC-Classic-SDK

Protected Properties

Property Type Description
m_ackRequired bool
m_activeTime DateTime
m_aeSession AeSession
m_changeMask EnumConditionChange
m_conditionName string
m_cookie uint
m_newState EnumConditionState
m_quality EnumQuality
m_subConditionName string

Public Methods

Method Description
Acknowledge ( string ackId, string ackComment, ExecutionOptions executionOptions ) : int

Acknowledges the current condition.

AeCondition ( ) : System

Initializes a new instance of the AeCondition class.

UpdateConditionState ( Array attributes, ExecutionOptions executionOptions ) : int

Gives specific information on the current condition.

Private Methods

Method Description
AeCondition ( EnumEventType anEventType, uint anEventCategory, uint aSeverity, string aSourcePath, string aMessage, DateTime anOccurenceTime, ArrayList someEventAttributes, string anActorId, EnumConditionChange aChangeMask, EnumConditionState aNewState, bool ackRequired, EnumQuality aQuality, string aConditionName, string aSubConditionName, DateTime anActiveTime, uint aCookie ) : System

Method Details

Acknowledge() public method

Acknowledges the current condition.
public Acknowledge ( string ackId, string ackComment, ExecutionOptions executionOptions ) : int
ackId string An identifier for the client who last acknowledged the condition.
ackComment string A comment string passed in by the client who acknowledged the condition.
executionOptions ExecutionOptions Specifies the modality of execution for acknowledging the condition.
return int

AeCondition() public method

Initializes a new instance of the AeCondition class.
public AeCondition ( ) : System
return System

UpdateConditionState() public method

Gives specific information on the current condition.
public UpdateConditionState ( Array attributes, ExecutionOptions executionOptions ) : int
attributes Array A list with the attributes related to the condition.
executionOptions ExecutionOptions Specifies the modality of execution for getting the condition's state.
return int

Property Details

m_ackRequired protected_oe property

Indicates if an acknowledgement is or not required.
protected bool m_ackRequired
return bool

m_activeTime protected_oe property

The time that the condition become active.
protected DateTime m_activeTime
return DateTime

m_aeSession protected_oe property

The AeSession object that sent the notification about the occurence of the condition-related event.
protected AeSession m_aeSession
return AeSession

m_changeMask protected_oe property

Indicates to the client which properties of the condition have changed.
protected EnumConditionChange m_changeMask
return EnumConditionChange

m_conditionName protected_oe property

The name of the AeCondition object associated with the event.
protected string m_conditionName
return string

m_cookie protected_oe property

A defined cookie associated with the event notification.
protected uint m_cookie
return uint

m_newState protected_oe property

The new state of the condition.
protected EnumConditionState m_newState
return EnumConditionState

m_quality protected_oe property

The quality of the underlying data items upon which this condition is based.
protected EnumQuality m_quality
return EnumQuality

m_subConditionName protected_oe property

The name of the currently active subcondition.
protected string m_subConditionName
return string