.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.TraceBase Class Reference

Defines functions used to write trace output. More...

Static Public Member Functions

static List< TraceEntryGetKnownModules ()
 Gets the known trace modules. More...
 
static int InitializeModule (Type traceClass, string moduleName)
 Called to initialize trace for the specified module name. More...
 
static void SetModuleTraceLevel (string moduleName, TraceLevel level)
 Called to set the trace level for the specified module name. More...
 
static void AddListener (ITraceListener listener)
 Adds a trace listener. More...
 
static void RemoveListener (ITraceListener listener)
 Removes a trace listener. More...
 
static void Close ()
 Closes all listeners. More...
 
static void Output (int moduleId, TraceLevel level, string message, params object[] args)
 Outputs a trace message. More...
 
static void Output (int moduleId, TraceLevel level, uint status, string message, params object[] args)
 Outputs a trace message with a status code. More...
 
static void Output (int moduleId, TraceLevel level, StatusCode status)
 Outputs a trace message with an exception. More...
 
static void Output (int moduleId, TraceLevel level, Exception e, string message, params object[] args)
 Outputs a trace message with an exception. More...
 
static void ApplyGlobalSettings (UaSchema.TraceSettings settings, bool onlyAllowExplicitCalls)
 Applies the trace settings which are used by ALL ApplicationInstances in a single process. More...
 

Properties

static TraceLevel DefaultLevel [get, set]
 The default trace level. More...
 

Detailed Description

Defines functions used to write trace output.

Member Function Documentation

static void UnifiedAutomation.UaBase.TraceBase.AddListener ( ITraceListener  listener)
inlinestatic

Adds a trace listener.

You should only call this method after ApplicationInstance.Start is called if TraceSettings.MasterTraceEnabled is 'true'

Parameters
listenerThe listener to add.
static void UnifiedAutomation.UaBase.TraceBase.ApplyGlobalSettings ( UaSchema.TraceSettings  settings,
bool  onlyAllowExplicitCalls 
)
inlinestatic

Applies the trace settings which are used by ALL ApplicationInstances in a single process.

Parameters
settingsThe settings.
onlyAllowExplicitCallsif set to true the other calls to this function are ignored unless onlyAllowExplicitCalls is true.
static void UnifiedAutomation.UaBase.TraceBase.Close ( )
inlinestatic

Closes all listeners.

static List<TraceEntry> UnifiedAutomation.UaBase.TraceBase.GetKnownModules ( )
inlinestatic

Gets the known trace modules.

Returns
static int UnifiedAutomation.UaBase.TraceBase.InitializeModule ( Type  traceClass,
string  moduleName 
)
inlinestatic

Called to initialize trace for the specified module name.

Parameters
traceClassThe trace class.
moduleNameThe name of the module.
Returns
A unique id for the module.
static void UnifiedAutomation.UaBase.TraceBase.Output ( int  moduleId,
TraceLevel  level,
string  message,
params object[]  args 
)
inlinestatic

Outputs a trace message.

Parameters
moduleIdThe module id.
levelThe trace level.
messageThe message.
argsThe args.
static void UnifiedAutomation.UaBase.TraceBase.Output ( int  moduleId,
TraceLevel  level,
uint  status,
string  message,
params object[]  args 
)
inlinestatic

Outputs a trace message with a status code.

Parameters
moduleIdThe module id.
levelThe trace level.
statusThe status.
messageThe message.
argsAdditional arguments used to format the message.
static void UnifiedAutomation.UaBase.TraceBase.Output ( int  moduleId,
TraceLevel  level,
StatusCode  status 
)
inlinestatic

Outputs a trace message with an exception.

Parameters
moduleIdThe module id.
levelThe trace level.
statusThe status.
static void UnifiedAutomation.UaBase.TraceBase.Output ( int  moduleId,
TraceLevel  level,
Exception  e,
string  message,
params object[]  args 
)
inlinestatic

Outputs a trace message with an exception.

Parameters
moduleIdThe module id.
levelThe trace level.
eThe exception.
messageThe message.
argsAdditional arguments used to format the message.
static void UnifiedAutomation.UaBase.TraceBase.RemoveListener ( ITraceListener  listener)
inlinestatic

Removes a trace listener.

Parameters
listenerThe listener to remove.
static void UnifiedAutomation.UaBase.TraceBase.SetModuleTraceLevel ( string  moduleName,
TraceLevel  level 
)
inlinestatic

Called to set the trace level for the specified module name.

Parameters
moduleNameName of the module.
levelThe level.

Property Documentation

TraceLevel UnifiedAutomation.UaBase.TraceBase.DefaultLevel
staticgetset

The default trace level.


The documentation for this class was generated from the following file: