Class EventLog

This class represents a EventLog domain in the controller.

Inheritance
System.Object
NamedObject
SDKBase
SDKControllerBoundBase
EventLog
Implements
System.IComparable
System.IDisposable
Inherited Members
Namespace: ABB.Robotics.Controllers.EventLogDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public sealed class EventLog : SDKControllerBoundBase, IComparable, INamedObject, IDisposable
Remarks

When the last instance of this class, created for a certain controller, is disposed any EventLogCategory will update its messages.

Methods

ClearAll()

Clears any EventLogMessage in any EventLogCategory.

Declaration
public void ClearAll()
Remarks

This method clears the eventlogs in the controller.

GetAllMessages(Int32, Int32)

Declaration
public List<EventLogMessage> GetAllMessages(int startSequenceNumber, int maxNumberOfEvents = -1)
Parameters
Type Name Description
System.Int32 startSequenceNumber
System.Int32 maxNumberOfEvents
Returns
Type Description
System.Collections.Generic.List<EventLogMessage>

GetCategories()

Gets the available categories of the EventLog.

Declaration
public EventLogCategory[] GetCategories()
Returns
Type Description
EventLogCategory[]

An array of the available categories inside the EventLog domain in the controller.

GetCategory(CategoryType)

Declaration
public EventLogCategory GetCategory(CategoryType type)
Parameters
Type Name Description
CategoryType type

Type of the
Returns
Type Description
EventLogCategory

A EventLogCategory object to represents the Event Log's category. If the category does not exist, the return value is null.
Remarks

This overload takes an CategoryType as parameter. This enumeration can represent the categories predefined by ABB but not categories defined by RobotWare Add-Ins. You can use the overload GetCategory(Int32) to pass an integer that can represent predefined categories as well as categories defined by RobotWare Add-Ins./>

GetCategory(Int32)

Gets the specified event log category.

Declaration
public EventLogCategory GetCategory(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
EventLogCategory

A EventLogCategory object to represents the Event Log's category. If the category does not exist, the return value is null.
See Also

GetCategoryIds()

Declaration
public int[] GetCategoryIds()
Returns
Type Description
System.Int32[]

GetMessageCount(Int32)

Declaration
public int GetMessageCount(int category)
Parameters
Type Name Description
System.Int32 category
Returns
Type Description
System.Int32

GetMessagesByCategory(Int32, Int32, Int32)

Declaration
public List<EventLogMessage> GetMessagesByCategory(int category, int startSequenceNumber, int maxNumberOfEvents = -1)
Parameters
Type Name Description
System.Int32 category
System.Int32 startSequenceNumber
System.Int32 maxNumberOfEvents
Returns
Type Description
System.Collections.Generic.List<EventLogMessage>

Events

MessageWritten

Raised when a new event is written to the log.

Declaration
public event EventHandler<MessageWrittenEventArgs> MessageWritten
Event Type
Type Description
System.EventHandler<MessageWrittenEventArgs>

MessageWrittenNoCache

Raised when a new event is written to the log.

Declaration
public event EventHandler<MessageWrittenEventArgs> MessageWrittenNoCache
Event Type
Type Description
System.EventHandler<MessageWrittenEventArgs>

Implements

System.IComparable
System.IDisposable