Class TcoObjectMessageHandler

Provides access to messages of the object and all child objects.

Inheritance
System.Object
TcoObjectMessageHandler
Implements
System.ComponentModel.INotifyPropertyChanged
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
public class TcoObjectMessageHandler : INotifyPropertyChanged

Constructors

| Improve this Doc View Source

TcoObjectMessageHandler()

Create new instance of TcoObjectMessageHandler.

Declaration
[Obsolete("Do not use! Required for WPF")]
public TcoObjectMessageHandler()
| Improve this Doc View Source

TcoObjectMessageHandler(IsTcoContext, IsTcoObject)

Creates new instance of TcoObjectMessageHandler

Declaration
public TcoObjectMessageHandler(IsTcoContext context, IsTcoObject obj)
Parameters
Type Name Description
IsTcoContext context

TcoObject's context
IsTcoObject obj

TcoObject

Fields

| Improve this Doc View Source

_categoryTags

Declaration
List<IValueTag> _categoryTags
Field Value
Type Description
System.Collections.Generic.List<Vortex.Connector.IValueTag>
| Improve this Doc View Source

_context

Declaration
readonly IsTcoContext _context
Field Value
Type Description
IsTcoContext
| Improve this Doc View Source

_cycleTags

Declaration
List<IValueTag> _cycleTags
Field Value
Type Description
System.Collections.Generic.List<Vortex.Connector.IValueTag>
| Improve this Doc View Source

_descendingMessages

Declaration
IEnumerable<TcoMessage> _descendingMessages
Field Value
Type Description
System.Collections.Generic.IEnumerable<TcoMessage>
| Improve this Doc View Source

_obj

Declaration
readonly IsTcoObject _obj
Field Value
Type Description
IsTcoObject
| Improve this Doc View Source

diagnosticsDepth

Declaration
int diagnosticsDepth
Field Value
Type Description
System.Int32
| Improve this Doc View Source

highestSeverityMessage

Declaration
string highestSeverityMessage
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

ActiveMessages

Declaration
IEnumerable<TcoMessage> ActiveMessages { }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TcoMessage>
| Improve this Doc View Source

ActiveMessagesCount

Gets the number of active messages of this object and its descendants The property is updated on UpdateHealthInfo() method call.

Declaration
public int ActiveMessagesCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

CategoryTags

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

CycleTags

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

DescendingMessages

Declaration
IEnumerable<TcoMessage> DescendingMessages { }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TcoMessage>
| Improve this Doc View Source

DiagnosticsDepth

Gets or sets the diagnostics depth for this object. The object's tree will be searched for messaging objects up to diagnostics depth set in this property.

Declaration
public int DiagnosticsDepth { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

HighestSeverity

Gets the highest category from messages of this object and its descendants. The property is updated on UpdateHealthInfo() method call.

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

HighestSeverityMessage

Declaration
public string HighestSeverityMessage { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

refreshTags

Declaration
List<IValueTag> refreshTags { }
Property Value
Type Description
System.Collections.Generic.List<Vortex.Connector.IValueTag>

Methods

| Improve this Doc View Source

GetActiveMessages(eMessageCategory)

Performs refresh of the messages of this TcoObject and all its child object.

Declaration
public IEnumerable<PlainTcoMessage> GetActiveMessages(eMessageCategory category = eMessageCategory.All)
Parameters
Type Name Description
eMessageCategory category
Returns
Type Description
System.Collections.Generic.IEnumerable<PlainTcoMessage>

Enumerable of messages as POCO object.
| Improve this Doc View Source

GetObjectMessages()

Declaration
IEnumerable<TcoMessage> GetObjectMessages()
Returns
Type Description
System.Collections.Generic.IEnumerable<TcoMessage>
| Improve this Doc View Source

ReadCategories()

Declaration
void ReadCategories()
| Improve this Doc View Source

ReadCycles()

Declaration
void ReadCycles()
| Improve this Doc View Source

UpdateHealthInfo()

Executes quick update of the messages of this TcoObject and all its child object. Updates ActiveMessagesCount and HighestSeverity properties.

Declaration
public void UpdateHealthInfo()

Events

| Improve this Doc View Source

PropertyChanged

Property change notification implementation.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged