aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/EventLogging/IEventLogger.cs
blob: ceb399d24a3ce8eb729c17f0a50ca40a0075d542 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.BL.Enumerations;
using Tango.PMR.Diagnostics;

namespace Tango.MachineStudio.Common.EventLogging
{
    /// <summary>
    /// Represents a database events logger.
    /// </summary>
    public interface IEventLogger
    {
        /// <summary>
        /// Occurs when a new machine event has been logged.
        /// </summary>
        event EventHandler<MachinesEvent> NewLog;

        /// <summary>
        /// Logs the specified machine event.
        /// </summary>
        /// <param name="machineEvent">The machine event.</param>
        void Log(MachinesEvent machineEvent);

        /// <summary>
        /// Logs the specified event type.
        /// </summary>
        /// <param name="eventType">Type of the event.</param>
        /// <param name="message">The message.</param>
        void Log(EventTypes eventType, String message, bool write_to_db = true);

        /// <summary>
        /// Logs the specified hardware event.
        /// </summary>
        /// <param name="hardwareEvent">The hardware event.</param>
        void Log(Event hardwareEvent);

        /// <summary>
        /// Logs the specified exception using the <see cref="EventTypes.ApplicationException"/>.
        /// </summary>
        /// <param name="exception">The exception.</param>
        void Log(Exception exception);

        /// <summary>
        /// Logs the specified exception using the <see cref="EventTypes.ApplicationException"/>.
        /// </summary>
        /// <param name="exception">The exception.</param>
        void Log(Exception exception, String description);

        /// <summary>
        /// Logs the specified message using the <see cref="EventTypes.ApplicationInformation"/>.
        /// </summary>
        /// <param name="message">The message.</param>
        void Log(String message);

        /// <summary>
        /// Immediately saves all pending events to database.
        /// </summary>
        void FlushAll();
    }
}
class="w"> get; set; } /// <returns> True in wellformed XML </returns> public bool HasStartOrEmptyTag { get; set; } /// <returns> True in wellformed XML </returns> public bool HasEndTag { get; set; } /// <inheritdoc/> internal override bool UpdateDataFrom(AXmlObject source) { if (!base.UpdateDataFrom(source)) return false; AXmlElement src = (AXmlElement)source; // Clear the cache for this - quite expensive attributesAndElements = null; if (this.IsProperlyNested != src.IsProperlyNested || this.HasStartOrEmptyTag != src.HasStartOrEmptyTag || this.HasEndTag != src.HasEndTag) { OnChanging(); this.IsProperlyNested = src.IsProperlyNested; this.HasStartOrEmptyTag = src.HasStartOrEmptyTag; this.HasEndTag = src.HasEndTag; OnChanged(); return true; } else { return false; } } /// <summary> The start or empty-element tag if there is any </summary> internal AXmlTag StartTag { get { Assert(HasStartOrEmptyTag, "Does not have a start tag"); return (AXmlTag)this.Children[0]; } } /// <summary> The end tag if there is any </summary> internal AXmlTag EndTag { get { Assert(HasEndTag, "Does not have an end tag"); return (AXmlTag)this.Children[this.Children.Count - 1]; } } internal override void DebugCheckConsistency(bool checkParentPointers) { DebugAssert(Children.Count > 0, "No children"); base.DebugCheckConsistency(checkParentPointers); } #region Helpper methods /// <summary> Gets attributes of the element </summary> /// <remarks> /// Warning: this is a cenvenience method to access the attributes of the start tag. /// However, since the start tag might be moved/replaced, this property might return /// different values over time. /// </remarks> public AXmlAttributeCollection Attributes { get { if (this.HasStartOrEmptyTag) { return this.StartTag.Attributes; } else { return AXmlAttributeCollection.Empty; } } } ObservableCollection<AXmlObject> attributesAndElements; /// <summary> Gets both attributes and elements. Expensive, avoid use. </summary> /// <remarks> Warning: the collection will regenerate after each update </remarks> public ObservableCollection<AXmlObject> AttributesAndElements { get { if (attributesAndElements == null) { if (this.HasStartOrEmptyTag) { attributesAndElements = new MergedCollection<AXmlObject, ObservableCollection<AXmlObject>> ( // New wrapper with RawObject types new FilteredCollection<AXmlObject, AXmlObjectCollection<AXmlObject>>(this.StartTag.Children, x => x is AXmlAttribute), new FilteredCollection<AXmlObject, AXmlObjectCollection<AXmlObject>>(this.Children, x => x is AXmlElement) ); } else { attributesAndElements = new FilteredCollection<AXmlObject, AXmlObjectCollection<AXmlObject>>(this.Children, x => x is AXmlElement); } } return attributesAndElements; } } /// <summary> Name with namespace prefix - exactly as in source </summary> public string Name { get { if (this.HasStartOrEmptyTag) { return this.StartTag.Name; } else { return this.EndTag.Name; } } } /// <summary> The part of name before ":" </summary> /// <returns> Empty string if not found </returns> public string Prefix { get { return GetNamespacePrefix(this.Name); } } /// <summary> The part of name after ":" </summary> /// <returns> Empty string if not found </returns> public string LocalName { get { return GetLocalName(this.Name); } } /// <summary> Resolved namespace of the name </summary> /// <returns> Empty string if prefix is not found </returns> public string Namespace { get { string prefix = this.Prefix; if (string.IsNullOrEmpty(prefix)) { return FindDefaultNamespace(); } else { return ResolvePrefix(prefix); } } } /// <summary> Find the defualt namespace for this context </summary> public string FindDefaultNamespace() { AXmlElement current = this; while(current != null) { string namesapce = current.GetAttributeValue(NoNamespace, "xmlns"); if (namesapce != null) return namesapce; current = current.Parent as AXmlElement; } return string.Empty; // No namesapce } /// <summary> /// Recursively resolve given prefix in this context. Prefix must have some value. /// </summary> /// <returns> Empty string if prefix is not found </returns> public string ResolvePrefix(string prefix) { if (string.IsNullOrEmpty(prefix)) throw new ArgumentException("No prefix given", "prefix"); // Implicit namesapces if (prefix == "xml") return XmlNamespace; if (prefix == "xmlns") return XmlnsNamespace; AXmlElement current = this; while(current != null) { string namesapce = current.GetAttributeValue(XmlnsNamespace, prefix); if (namesapce != null) return namesapce; current = current.Parent as AXmlElement; } return NoNamespace; // Can not find prefix } /// <summary> /// Get unquoted value of attribute. /// It looks in the no namespace (empty string). /// </summary> /// <returns>Null if not found</returns> public string GetAttributeValue(string localName) { return GetAttributeValue(NoNamespace, localName); } /// <summary> /// Get unquoted value of attribute /// </summary> /// <param name="namespace">Namespace. Can be no namepace (empty string), which is the default for attributes.</param> /// <param name="localName">Local name - text after ":"</param> /// <returns>Null if not found</returns> public string GetAttributeValue(string @namespace, string localName) { @namespace = @namespace ?? string.Empty; foreach(AXmlAttribute attr in this.Attributes.GetByLocalName(localName)) { DebugAssert(attr.LocalName == localName, "Bad hashtable"); if (attr.Namespace == @namespace) { return attr.Value; } } return null; } #endregion /// <inheritdoc/> public override void AcceptVisitor(IAXmlVisitor visitor) { visitor.VisitElement(this); } /// <inheritdoc/> public override string ToString() { return string.Format(CultureInfo.InvariantCulture, "[{0} '{1}' Attr:{2} Chld:{3} Nest:{4}]", base.ToString(), this.Name, this.HasStartOrEmptyTag ? this.StartTag.Children.Count : 0, this.Children.Count, this.IsProperlyNested ? "Ok" : "Bad"); } } }