Class TcoLogger

Default implementation of Logger.

tip

This type is partially extended by IVF to retrieve messages from the logger in IVF application.

Inheritance
System.Object
TcoObject
TcoLogger
Implements
Vortex.Connector.Identity.IVortexIdentity
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: TcoCore
Assembly: TcoCoreConnector.dll
Syntax
[TypeMetaDescriptor("{attribute addProperty Name \"\" }", "TcoLogger", "TcoCore", TypeComplexityEnum.Complex)]
public class TcoLogger : TcoObject, IVortexIdentity, IsTcoObject, IVortexObject, ITwinObject, IVortexElement, ITcoLogger, ITcoObject, IShadowTcoLogger, IShadowTcoObject, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoLogger()

Declaration
public TcoLogger()
| Improve this Doc View Source

TcoLogger(IVortexObject, String, String)

Declaration
public TcoLogger(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail

Fields

| Improve this Doc View Source

__constMAX_MESSAGE_BUFFER_INDEX

Declaration
public const short __constMAX_MESSAGE_BUFFER_INDEX = 1000
Field Value
Type Description
System.Int16
| Improve this Doc View Source

__minLoggingLevel

Declaration
OnlinerInt __minLoggingLevel
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

__plcCarret

Declaration
OnlinerInt __plcCarret
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

_inxtonLogger

Declaration
ILogger _inxtonLogger
Field Value
Type Description
ILogger
| Improve this Doc View Source

_MAX_MESSAGE_BUFFER_INDEX

Declaration
OnlinerInt _MAX_MESSAGE_BUFFER_INDEX
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt

Properties

| Improve this Doc View Source

_buffer

Circural buffer for this logger.

Declaration
public TcoLogItem[] _buffer { get; set; }
Property Value
Type Description
TcoLogItem[]
| Improve this Doc View Source

_minLoggingLevel

Minimal log level. Only messages with higher serverity than this will be logged.

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
public OnlinerInt _minLoggingLevel { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

_plcCarret

Circular carret of of the message buffer.

Declaration
public OnlinerInt _plcCarret { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

expectDequeingTags

Declaration
IList<IValueTag> expectDequeingTags { }
Property Value
Type Description
System.Collections.Generic.IList<Vortex.Connector.IValueTag>
| Improve this Doc View Source

InxtonLogger

Declaration
public ILogger InxtonLogger { get; }
Property Value
Type Description
ILogger
| Improve this Doc View Source

MAX_MESSAGE_BUFFER_INDEX

Max number of buffered log entries.

Declaration
public OnlinerInt MAX_MESSAGE_BUFFER_INDEX { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

MinLogLevelCategory

Gets or set the minimal level category for PLC event logging.

Declaration
public eMessageCategory MinLogLevelCategory { get; set; }
Property Value
Type Description
eMessageCategory

Methods

| Improve this Doc View Source

CopyPlainToShadow(PlainTcoLogger)

Declaration
public void CopyPlainToShadow(PlainTcoLogger source)
Parameters
Type Name Description
PlainTcoLogger source
| Improve this Doc View Source

CreatePlainerType()

Declaration
public PlainTcoLogger CreatePlainerType()
Returns
Type Description
PlainTcoLogger
| Improve this Doc View Source

CreatePlainerType(PlainTcoLogger)

Declaration
protected PlainTcoLogger CreatePlainerType(PlainTcoLogger cloned)
Parameters
Type Name Description
PlainTcoLogger cloned
Returns
Type Description
PlainTcoLogger
| Improve this Doc View Source

FlushOnlineToPlain(PlainTcoLogger)

Declaration
public void FlushOnlineToPlain(PlainTcoLogger source)
Parameters
Type Name Description
PlainTcoLogger source
| Improve this Doc View Source

FlushOnlineToShadow()

Declaration
public void FlushOnlineToShadow()
| Improve this Doc View Source

FlushPlainToOnline(PlainTcoLogger)

Declaration
public void FlushPlainToOnline(PlainTcoLogger source)
Parameters
Type Name Description
PlainTcoLogger source
| Improve this Doc View Source

FlushShadowToOnline()

Declaration
public void FlushShadowToOnline()
| Improve this Doc View Source

LazyOnlineToShadow()

Declaration
public void LazyOnlineToShadow()
| Improve this Doc View Source

LazyShadowToOnline()

Declaration
public void LazyShadowToOnline()
| Improve this Doc View Source

LogMessage(PlainTcoLogItem, Object)

Declaration
void LogMessage(PlainTcoLogItem message, object payload)
Parameters
Type Name Description
PlainTcoLogItem message
System.Object payload
| Improve this Doc View Source

LogMessages(IEnumerable<PlainTcoLogItem>)

Logs messages into ILogger of this application.

Declaration
public void LogMessages(IEnumerable<PlainTcoLogItem> messages)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<PlainTcoLogItem> messages

Messages to push to the application logger.
| Improve this Doc View Source

Peek()

Peeks messaging from this logger without effecting dequeuing.

Declaration
public IEnumerable<PlainTcoLogItem> Peek()
Returns
Type Description
System.Collections.Generic.IEnumerable<PlainTcoLogItem>

Messages from this logger.
| Improve this Doc View Source

PexConstructor(IVortexObject, String, String)

Declaration
void PexConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexConstructorParameterless()

Declaration
void PexConstructorParameterless()
| Improve this Doc View Source

PexPreConstructor(IVortexObject, String, String)

Declaration
void PexPreConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexPreConstructorParameterless()

Declaration
void PexPreConstructorParameterless()
| Improve this Doc View Source

Pop()

Pops messages from this logger.

Declaration
public IEnumerable<PlainTcoLogItem> Pop()
Returns
Type Description
System.Collections.Generic.IEnumerable<PlainTcoLogItem>

Messages from the logger
| Improve this Doc View Source

StartLoggingMessages(eMessageCategory, Int32, ILogger)

Starts the event retrieval loop.

important

The log retrieval operations for given logger can be started on one system only. Make sure you do not run the log retrieval from the same logger in multiple instances.

Declaration
public void StartLoggingMessages(eMessageCategory minLevelCategory, int interLoopDelay = 25, ILogger logTarget = null)
Parameters
Type Name Description
eMessageCategory minLevelCategory

Sets the minimal logging level.
System.Int32 interLoopDelay

Sets the delay between retrievals of logs.
ILogger logTarget

Set custom log target. If default|null default application logger is used.

Explicit Interface Implementations

| Improve this Doc View Source

IShadowTcoLogger._buffer

Declaration
IShadowTcoLogItem[] IShadowTcoLogger._buffer { get; }
Returns
Type Description
IShadowTcoLogItem[]
| Improve this Doc View Source

IShadowTcoLogger._minLoggingLevel

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
IShadowInt IShadowTcoLogger._minLoggingLevel { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt
| Improve this Doc View Source

IShadowTcoLogger._plcCarret

Declaration
IShadowInt IShadowTcoLogger._plcCarret { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt
| Improve this Doc View Source

ITcoLogger._buffer

Declaration
ITcoLogItem[] ITcoLogger._buffer { get; set; }
Returns
Type Description
ITcoLogItem[]
| Improve this Doc View Source

ITcoLogger._minLoggingLevel

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
IOnlineInt ITcoLogger._minLoggingLevel { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineInt
| Improve this Doc View Source

ITcoLogger._plcCarret

Declaration
IOnlineInt ITcoLogger._plcCarret { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineInt

Implements

Vortex.Connector.Identity.IVortexIdentity
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject

See Also