• Avalanche
  • Avalanche.Core
  • Lexical

    Show / Hide Table of Contents
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
        • AspNetCore
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR41
        • Unicode.CLDR40
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Logging
      • Validation
      • Localization
    • 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
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Service
      • Introduction
      • Service
        • IService
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Cast
        • Scope
        • Dispose
      • Handler
        • Introduction
        • IHandler
        • Cancel
        • Recursion
        • Cyclicity
        • Delegates
        • Casting
        • Invokable
        • Handlers
      • Request
        • Introduction
        • IRequest
        • [Request]
        • [ContextParameter]
        • Print Tree
      • Dependency Injection
        • Introduction
        • ServiceRequest<T>
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
      • Examples
        • Expression Example
        • Mapper Example
      • ServiceMessages
    • Avalanche.Writer
      • Introduction
      • Writer
      • Referer
      • TypeCast
      • DefaultConstructor
      • DelegateWriter
      • WriterPipe
      • ConstantWriter
      • PassthroughWriter
      • Context
      • WriterMessages
    • Avalanche.Accessor
      • Introduction
      • AccessorServices
      • List
        • ListAccessor
        • ListConstructor
        • ListDeconstructor
        • ListDefaultConstructor
        • ListGet
        • ListSet
        • ListAdd
        • ListInsert
        • ListClear
        • ListCount
        • ListIndexOf
        • ListRemoveAt
        • ListReferer
      • Map
        • MapAccessor
        • MapConstructor
        • MapDeconstructor
        • MapDefaultConstructor
        • MapSet
        • MapGet
        • MapRemove
        • MapClear
        • MapCount
        • MapReferer
      • Record
        • RecordAccessor
        • RecordConstructor
        • RecordDeconstructor
        • RecordDefaultConstructor
      • Field
        • FieldAccessor
        • FieldReader
        • FieldWriter
        • FieldReferer
      • Dependency Injection
        • Introduction
      • AccessorMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
    • Avalanche.DataType
      • Introduction
      • IDataTypeBase
      • IDataType
      • IRecordType
      • IFieldType
      • IUnionType
      • IListType
      • IMapType
      • IValueType
      • IEnumerationType
      • IIntegerType
      • IRealType
      • IStringType
      • IAnyType
      • DataTypeRequest
      • PrintTree
      • DataTypeMessages
    • 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.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
        • EnumerableCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Concatenation
        • Cache
        • ResultCapture
        • AsReadOnly
        • AsService
      • 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.Core
      • License
      • Order

    DataType

    IDataType is datatype interface for basic types. It mandates following properties: Nullable, Referable and Description.

    /// <summary>Root interface for datatype interfaces</summary>
    public interface IDataType : IDataTypeBase, INominable, IAnnotable, IDefaultValued<object?>
    {
        /// <summary>The container for this datatype has capability for holding non-assigned state distinction.</summary>
        bool Nullable { get; set; }
        /// <summary>Is instance of the type referable by identity.</summary>
        bool Referable { get; set; }
        /// <summary>Datatype description</summary>
        [IgnoreCompare] string? Description { get; set; }
    }
    

    INominable exposes Name property.

    /// <summary>Contains Name property.</summary>
    public interface INominable
    {
        /// <summary>Object name</summary>
        IIdentity? Name { get; set; }
    }
    

    IAnnotable exposes Annotations property.

    /// <summary>Annotable type</summary>
    public interface IAnnotable
    {
        /// <summary>Annotations, typically <see cref="Attribute"/>s or strings, but always easily serializable.</summary>
        object[] Annotations { get; set; }
    }
    

    IDefaultValued exposes the DefaultValue property.

    /// <summary>Contains default value property.</summary>
    public interface IDefaultValued<T>
    {
        /// <summary>Possible default value of <typeparamref name="T"/>.</summary>
        T DefaultValue { get; set; }
    }
    

    IDataType is base interface for third party datatypes with name, description and nullability and referability capabilities.

    public interface IMessageType : IDataType
    {
        IDataTypeBase Request { get; set; }
        IDataTypeBase Response { get; set; }
    }
    

    DataType is the base class for third party classes.

    public class MessageType : DataType, IMessageType
    {
        /// <summary>Interface Type</summary>
        [IgnoreDataMember] public override Type IntfType { get => typeof(IMessageType); set => CoreMessages.Instance.BadReadOnly.Throw(); }
    
        [IgnoreDataMember] protected IDataTypeBase request = null!;
        [IgnoreDataMember] protected IDataTypeBase response = null!;
    
        public IDataTypeBase Request { get => request; set => this.AssertWritable().request = value; }
        public IDataTypeBase Response { get => response; set => this.AssertWritable().response = value; }
    
        /// <summary>Check validation.</summary>
        protected override void InternalValidate(ref StructList1<IMessage> errorCodes)
        {
            // Call base implementation
            base.InternalValidate(ref errorCodes);
            // Test properties
            if (Request == null) errorCodes.Add(DataTypeMessages.Instance.BadFieldNotFound.New(nameof(Request)));
            if (Response == null) errorCodes.Add(DataTypeMessages.Instance.BadFieldNotFound.New(nameof(Response)));
        }
    
    }
    

    Values are assignable with initializer.

    // Create message description
    IMessageType messageType = new MessageType
    {
        Name = Identities.CreateName("LookupMessage"),
        Description = "Table lookup message",
        Annotations = new object[0],
        DefaultValue = null,
        Nullable = false,
        Referable = true,
        Request = DataTypes.String,
        Response = DataTypes.String
    }
    .SetReadOnly();
    

    And values are assignable with extension method setters.

    // Create message description
    IMessageType messageType = new MessageType
    {
        Request = DataTypes.String,
        Response = DataTypes.String
    }
    .SetName(Identities.CreateName("LookupMessage"))
    .SetDescription("Table lookup message")
    .SetAnnotations(new object[0])
    .SetDefaultValue<MessageType, object?>(null)
    .SetNullable(false)
    .SetReferable(true)
    .SetReadOnly();
    

    Full Example

    Full example
    using System;
    using System.Runtime.Serialization;
    using Avalanche.DataType;
    using Avalanche.Identity;
    using Avalanche.Utilities;
    using Avalanche.Message;
    
    public class datatype
    {
        public static void Run()
        {
            {
                // <01>
                // Create message description
                IMessageType messageType = new MessageType
                {
                    Name = Identities.CreateName("LookupMessage"),
                    Description = "Table lookup message",
                    Annotations = new object[0],
                    DefaultValue = null,
                    Nullable = false,
                    Referable = true,
                    Request = DataTypes.String,
                    Response = DataTypes.String
                }
                .SetReadOnly();
                // </01>
            }
            {
                // <02>
                // Create message description
                IMessageType messageType = new MessageType
                {
                    Request = DataTypes.String,
                    Response = DataTypes.String
                }
                .SetName(Identities.CreateName("LookupMessage"))
                .SetDescription("Table lookup message")
                .SetAnnotations(new object[0])
                .SetDefaultValue<MessageType, object?>(null)
                .SetNullable(false)
                .SetReferable(true)
                .SetReadOnly();
                // </02>
            }
        }
    
        // <100>
        public interface IMessageType : IDataType
        {
            IDataTypeBase Request { get; set; }
            IDataTypeBase Response { get; set; }
        }
        // </100>
    
        // <101>
        public class MessageType : DataType, IMessageType
        {
            /// <summary>Interface Type</summary>
            [IgnoreDataMember] public override Type IntfType { get => typeof(IMessageType); set => CoreMessages.Instance.BadReadOnly.Throw(); }
    
            [IgnoreDataMember] protected IDataTypeBase request = null!;
            [IgnoreDataMember] protected IDataTypeBase response = null!;
    
            public IDataTypeBase Request { get => request; set => this.AssertWritable().request = value; }
            public IDataTypeBase Response { get => response; set => this.AssertWritable().response = value; }
    
            /// <summary>Check validation.</summary>
            protected override void InternalValidate(ref StructList1<IMessage> errorCodes)
            {
                // Call base implementation
                base.InternalValidate(ref errorCodes);
                // Test properties
                if (Request == null) errorCodes.Add(DataTypeMessages.Instance.BadFieldNotFound.New(nameof(Request)));
                if (Response == null) errorCodes.Add(DataTypeMessages.Instance.BadFieldNotFound.New(nameof(Response)));
            }
    
        }
        // </101>
    }
    
    Back to top Copyright © 2022 Toni Kalajainen, contact@avalanche.fi