• Avalanche.Core
Search Results for

    Show / Hide Table of Contents
    • Avalanche.Accessor
      • Introduction
      • IAccessor
        • IAccessor
        • IListAccessor
        • IMapAccessor
        • IRecordAccessor
        • IContentAccessor
        • IOneOfAccessor
        • IAnyAccessor
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • Articles
        • Dependency Injection
        • AccessorMessages
    • Avalanche.Binding
      • Introduction
    • Avalanche.Core
      • License
    • Avalanche.DataType
      • Introduction
      • DataType
        • IDataType
        • IListType
        • IMapType
        • IRecordType
        • IFieldType
        • IOneOfType
        • IAnyType
        • IStringType
        • IValueType
        • IIntegerType
        • IEnumerationType
        • IRealType
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • Enum
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • Articles
        • DataTypeRequest
        • PrintTree
        • DataTypeMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystem
          • IFileSystemBrowse
          • IFileSystemCreateDirectory
          • IFileSystemDelete
          • IFileSystemFileAttribute
          • IFileSystemMount
          • IFileSystemMove
          • IFileSystemObserve
          • IFileSystemOpen
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Events
      • Utilities
        • Dispose
        • File Scanner
        • Visit Tree
        • File Operation
    • Avalanche.Identity
      • Introduction
      • Identity
      • IdentityParts
      • IdentityInterner
      • IdentityComparer
      • Print Tree
      • IdentityAccessors
        • Introduction
        • TypeName
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
      • Asp.Net
        • Introduction
        • Supplying localization
        • Inject to pages
        • Culture Assigned
        • Minimalistic Api
        • Diagnostics
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR40
        • Unicode.CLDR41
        • Unicode.CLDR42
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
        • Printing templates
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Microsoft.Extensions
        • DependencyInjection
      • Articles
        • Aggregate Messages
        • Localization
        • Logging
        • Validation
    • Avalanche.Service
      • Introduction
      • Service
        • Introduction
        • IService
        • IServiceDisposable
        • IServiceDecoration
        • IServiceCast
        • IServiceObservable
        • IServiceContainer
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Scope
      • Handler
        • Introduction
        • IHandler
        • IHandlerCast
        • IHandlerDecoration
        • IHandlerWithOrder
        • CancellationToken
        • Cyclicity
        • Delegates
        • Invokable
        • ExportAttribute
        • OrderAttribute
        • PrintTree
        • Recursion
      • Query
        • Introduction
        • IQuery
        • IQueryCast
        • IQueryDecoration
      • Entry
        • Introduction
        • IEntry
        • IEntryCast
        • IEntryDecoration
        • IEntryObservable
        • IEntryVisitable
        • EntryState
      • Request
        • Introduction
        • IRequest
        • IRequestFor
        • IRequestToBeCached
        • IRequestToBeDisposed
        • RequestAttribute
        • ContextParameterAttribute
        • Print Tree
      • Dependency Injection
        • Introduction
        • Asp.Net
        • ServiceRequest<T>
        • Decorating a service
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
      • Examples
        • NodeCount
        • Expression
        • Mapper
      • Articles
        • Benchmarks
        • Error Handling
        • ServiceMessages
    • Avalanche.StatusCode
      • Introduction
      • HResult
        • Introduction
        • HResult.Facilities
        • BasicMessages
        • RpcMessages
        • DispatchMessages
        • ItfMessages
        • Win32Messages
        • ClrMessages
      • System
        • Introduction
        • AccessControlMessages
        • AggregateMessages
        • AppDomainMessages
        • ArgumentMessages
        • ArgumentNullMessages
        • ArgumentOutOfRangeMessages
        • ArithmeticMessages
        • ArrayMessages
        • AssemblyMessages
        • BadImageFormatMessages
        • CodeContractMessages
        • CodePageMessages
        • CollectionsMessages
        • CompilerServiceMessages
        • CryptographyMessages
        • CultureMessages
        • DiagnosticsMessages
        • EventSourceMessages
        • ExecutionEngineMessages
        • FormatMessages
        • HostProtectionMessages
        • IOMessages
        • IndexOutOfRangeMessages
        • InteropServiceMessages
        • InvalidCastMessages
        • InvalidOperationMessages
        • IsolatedStorageMessages
        • LazyMessages
        • MarshalerMessages
        • MemoryMessages
        • MiscellaneousMessages
        • NotImplementedMessages
        • NotSupportedMessages
        • ObjectDisposedMessages
        • OperationCanceledMessages
        • OverflowMessages
        • PlatformMessages
        • PolicyMessages
        • PrincipalMessages
        • ProgramMessages
        • ReferenceMessages
        • ReflectionMessages
        • RegionMessages
        • RemotingMessages
        • ResourcesMessages
        • SecurityMessages
        • SerializationMessages
        • StackMessages
        • TaskMessages
        • TextMessages
        • ThreadingMessages
        • TimeZoneMessages
        • TypeMessages
        • XmlMessages
      • HttpStatusCode
      • OpcUaStatusCode
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Utilities
      • Introduction
      • Collections
        • Tuples
        • StructList
        • ArrayList
        • BijectionMap
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • EnumerableExtensions
        • TupleUtilities
        • ArrayUtilities
      • Comparers
        • IGraphComparer
        • IGraphComparable
        • AlphaNumericComparer
        • EnumerableComparer
        • EnumerableGraphComparer
        • ReferenceComparer
        • KeyValuePairComparer
        • DefaultComparerProvider
        • RecordComparer
      • Cloners
        • ICloner
        • IGraphCloner
        • IGraphCloneable
        • ListCloner
        • DictionaryCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Pipe
        • Cache
        • ResultCapture
        • AsReadOnly
        • AsService
        • IProviderEvent
      • Record
        • IRecordDescription
        • IFieldDescription
        • IConstructorDescription
        • IConstructionDescription
        • IParameterDescription
        • IRecordProviders
        • RecordDelegates
          • RecordCreate
          • RecordClone
          • RecordCopy
          • IRecordDelegates
        • FieldDelegates
          • FieldRead
          • FieldWrite
          • RecreateWith
          • IFieldDelegates
      • String
        • IEscaper
        • UnicodeString
      • Miscellaneous
        • IIdGenerator
        • Permutation
        • IReadOnly
        • IUserDataContainer
        • Void
    • Avalanche.Writer
      • Introduction
      • ConstantWriter
      • Context
      • ConvertWriter
      • DefaultConstructor
      • DelegateWriter
      • PassthroughWriter
      • Referer
      • TypeCast
      • Writer
      • WriterPipe
      • WriterMessages

    IMessageDescriptions

    IMessageDescriptions is a store of message descriptions.

    /// <summary>Table of <see cref="IMessageDescriptions"/>.</summary>
    public interface IMessageDescriptions : IReadOnly
    {
        /// <summary>Message descriptions by key</summary>
        IDictionary<string, IMessageDescription> Keys { get; set; }
        /// <summary>Message descriptions by hresult</summary>
        IDictionary<int, List<IMessageDescription>> HResults { get; set; }
        /// <summary>Message descriptions by code</summary>
        IDictionary<int, IMessageDescription> Codes { get; set; }
        /// <summary>Message descriptions as list</summary>
        IList<IMessageDescription> List { get; set; }
    
        /// <summary>Add <paramref name="messageDescription"/>.</summary>
        /// <exception cref="InvalidOperationException">On key or code collision.</exception>
        void Add(IMessageDescription messageDescription);
    }
    

    MessageDescriptions is the default implementation. .Add(messageDescription) adds to .List and to lookup tables Codes and Keys.

    IMessageDescriptions store = new MessageDescriptions()
        .Add(LibraryMessagesTable.Instance.GoodResult)
        .SetReadOnly();
    
    WriteLine(store.Keys["Library.GoodResult"]); // "'MyObject' Ok result"
    

    MessageDescriptions can be sub-classed. .ReadSummaryXmls() reads triple slash /// <summary> comments from assembly.

    /// <summary></summary>
    public class LibraryMessages : MessageDescriptions
    {
        /// <summary>Base id for datatype codes.</summary>
        public const int BaseCode = 0x20A10000;
        /// <summary>Singleton</summary>
        static Lazy<LibraryMessages> instance = new Lazy<LibraryMessages>(() => new LibraryMessages().ReadSummaryXmls().SetAllReadOnly().SetReadOnly());
        /// <summary>Singleton</summary>
        public static LibraryMessages Instance => instance.Value;
    
        /// <summary>Create messages</summary>
        public LibraryMessages() : base() { this.AddRange(MessageDescriptionsExtensions.FieldReader(this)); }
    
        /// <summary>Create description</summary>
        static IMessageDescription create(string key, long id, string templateText) => new MessageDescription($"Library.{key}", id, templateText).SetHResult(id);
    
        /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
        public readonly IMessageDescription BadUnexpected = create(nameof(BadUnexpected), 0xA0A10001, "'{object}': Unexpected error");
        /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
        public readonly IMessageDescription BadArgumentNull = create(nameof(BadArgumentNull), 0xA0A10002, "'{object}': Unexpected error");
        /// <summary>Good result.</summary>
        public readonly IMessageDescription GoodResult = create(nameof(GoodResult), 0x20A10003, "'{object}': Unexpected error");
    }
    

    Note, that .ReadSummaryXmls() requires that the .csproj has following property.

        <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
            <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
        </PropertyGroup>
    

    Messages are available from singleton.

    // Print key
    WriteLine(LibraryMessagesTable.Instance.GoodResult); // "Library.GoodResult"
    
    // Create message
    IMessage message = LibraryMessagesTable.Instance.GoodResult.New("MyObject");
    // Print message
    WriteLine(message); // "'MyObject' Ok result"
    

    .List contains all message descriptions.

    foreach (IMessageDescription code in LibraryMessagesTable.Instance.List) WriteLine(code);
    
    // Prints:
    //   MessageDescription(Code = A0A10001, Key = Library.BadUnexpected, HResult = A0A10001, Severity =, Template = "'{object}': Unexpected error", "Captured unexpected <see cref="T: System.Exception" />.")
    //   MessageDescription(Code = A0A10002, Key = Library.BadArgumentNull, HResult = A0A10002, Severity =, Template = "'{object}': Bad argument 'null'", "Captured unexpected <see cref="T: System.Exception" />.")
    //   MessageDescription(Code = 20A10003, Key = Library.GoodResult, HResult = 20A10003, Severity =, Template = "'{object}': Ok result", "Good result.")
    

    .Codes contain code to message description mapping.

    IMessageDescription statusCode = LibraryMessagesTable.Instance.Codes[0x20A10003];
    

    .Keys contain key to message description mapping.

    IMessageDescription statusCode = LibraryMessagesTable.Instance.Keys["Library.GoodResult"];
    

    .HResults contain hresult to message description mapping.

    IMessageDescription statusCodes = LibraryMessagesTable.Instance.HResults[unchecked((int)0xA0A10002)].First();
    

    .ToMarkdownText() prints table as .md text.

    WriteLine(LibraryMessagesTable.Instance.ToMarkdownText());
    
    | Key                                                                             |StatusCode| Description                                                                 | Message Template                                                | Exception           |
    |:--------------------------------------------------------------------------------|:---------|:----------------------------------------------------------------------------|:----------------------------------------------------------------|:--------------------|
    | Library.BadUnexpected                                                           | A0A10001 | Captured unexpected <em>Exception</em>.                                     | '{object}': Unexpected error                                    |                     |
    | Library.BadArgumentNull                                                         | A0A10002 | Captured unexpected <em>Exception</em>.                                     | '{object}': Bad argument 'null'                                 |                     |
    | Library.GoodResult                                                              | 20A10003 | Good result.                                                                | '{object}': Ok result                                           |                     |
    

    See Avalanche.StatusCode for message description tables.

    Full Example

    Full example
    using System.Collections.Generic;
    using Avalanche.Utilities;
    using Avalanche.Message;
    using static System.Console;
    using System.Runtime.CompilerServices;
    using static messagedescriptions;
    
    
    class messagedescriptions
    {
        /// <summary>ABC</summary>
        public class Test<T>
        {
            /// <summary>DEF</summary>
            public Test<T> Do<K>() { return default!; }
        }
    
    
        public static void Run()
        {
            {
                // <01>
                // Print key
                WriteLine(LibraryMessagesTable.Instance.GoodResult); // "Library.GoodResult"
    
                // Create message
                IMessage message = LibraryMessagesTable.Instance.GoodResult.New("MyObject");
                // Print message
                WriteLine(message); // "'MyObject' Ok result"
                // </01>
            }
            {
                // <02>
                foreach (IMessageDescription code in LibraryMessagesTable.Instance.List) WriteLine(code);
    
                // Prints:
                //   MessageDescription(Code = A0A10001, Key = Library.BadUnexpected, HResult = A0A10001, Severity =, Template = "'{object}': Unexpected error", "Captured unexpected <see cref="T: System.Exception" />.")
                //   MessageDescription(Code = A0A10002, Key = Library.BadArgumentNull, HResult = A0A10002, Severity =, Template = "'{object}': Bad argument 'null'", "Captured unexpected <see cref="T: System.Exception" />.")
                //   MessageDescription(Code = 20A10003, Key = Library.GoodResult, HResult = 20A10003, Severity =, Template = "'{object}': Ok result", "Good result.")
                // </02>
            }
            {
                // <03>
                IMessageDescription statusCode = LibraryMessagesTable.Instance.Codes[0x20A10003];
                // </03>
                WriteLine(statusCode);
            }        
            {
                // <03B>
                IMessageDescription statusCode = LibraryMessages.Instance.Codes[0x20A10003];
                // </03B>
                WriteLine(statusCode);
            }
            {
                // <04>
                IMessageDescription statusCode = LibraryMessagesTable.Instance.Keys["Library.GoodResult"];
                // </04>
                WriteLine(statusCode);
            }
            {
                // <05>
                IMessageDescription statusCodes = LibraryMessagesTable.Instance.HResults[unchecked((int)0xA0A10002)].First();
                // </05>
                WriteLine(statusCodes);
            }
            {
                // <10>
                IMessageDescriptions store = new MessageDescriptions()
                    .Add(LibraryMessagesTable.Instance.GoodResult)
                    .SetReadOnly();
    
                WriteLine(store.Keys["Library.GoodResult"]); // "'MyObject' Ok result"
                // </10>
            }
            {
                // <20>
                WriteLine(LibraryMessagesTable.Instance.ToMarkdownText());
                // </20>
            }
        }
    
        // <98>
        /// <summary></summary>
        public class LibraryMessages : MessageDescriptions
        {
            /// <summary>Base id for datatype codes.</summary>
            public const int BaseCode = 0x20A10000;
            /// <summary>Singleton</summary>
            static Lazy<LibraryMessages> instance = new Lazy<LibraryMessages>(() => new LibraryMessages().ReadSummaryXmls().SetAllReadOnly().SetReadOnly());
            /// <summary>Singleton</summary>
            public static LibraryMessages Instance => instance.Value;
    
            /// <summary>Create messages</summary>
            public LibraryMessages() : base() { this.AddRange(MessageDescriptionsExtensions.FieldReader(this)); }
    
            /// <summary>Create description</summary>
            static IMessageDescription create(string key, long id, string templateText) => new MessageDescription($"Library.{key}", id, templateText).SetHResult(id);
    
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public readonly IMessageDescription BadUnexpected = create(nameof(BadUnexpected), 0xA0A10001, "'{object}': Unexpected error");
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public readonly IMessageDescription BadArgumentNull = create(nameof(BadArgumentNull), 0xA0A10002, "'{object}': Unexpected error");
            /// <summary>Good result.</summary>
            public readonly IMessageDescription GoodResult = create(nameof(GoodResult), 0x20A10003, "'{object}': Unexpected error");
        }
        // </98>
    
        // <99>
        /// <summary></summary>
        public class LibraryMessagesTable : MessageDescriptions
        {
            /// <summary>Singleton</summary>
            static readonly Lazy<LibraryMessagesTable> instance = new Lazy<LibraryMessagesTable>(() => new LibraryMessagesTable().Initialize().ReadSummaryXmls().SetAllReadOnly().SetReadOnly());
            /// <summary>Singleton</summary>
            public static LibraryMessagesTable Instance => instance.Value;
            /// <summary>Base id for datatype codes.</summary>
            public const int BaseCode = 0x20A10000;
            /// <summary>Initialize fields</summary>
            public virtual LibraryMessagesTable Initialize() => this.AddRange(MessageDescriptionsExtensions.FieldReader(this));
    
            /// <summary>Message description fields</summary>
            IMessageDescription badUnexpected = Create(0xA0A10001, nameof(badUnexpected), "'{object}': Unexpected error");
            IMessageDescription badArgumentNull = Create(0xA0A10002, nameof(badArgumentNull), "'{object}': Bad argument 'null'");
            IMessageDescription goodResult = Create(0x20A10003, nameof(goodResult), "'{object}': Ok result");
    
            /// <summary>Create description</summary>
            static IMessageDescription Create(long id, string key, string templateText)
                => new MessageDescription($"Library.{char.ToUpper(key[0])}{key.Substring(1)}", id, templateText).SetHResult(id);
    
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public IMessageDescription BadUnexpected { get => badUnexpected; set => this.AssertWritable().badUnexpected = value; }
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public IMessageDescription BadArgumentNull { get => badArgumentNull; set => this.AssertWritable().badArgumentNull = value; }
            /// <summary>Good result.</summary>
            public IMessageDescription GoodResult { get => goodResult; set => this.AssertWritable().goodResult = value; }
        }
        // </99>
    
    }
    
    In This Article
    Back to top Copyright © Toni Kalajainen