aoexternalcomponent.cs

ASAMODS BaseModel C#

using System;
using System.Collections.Generic;
using System.Collections;
using System.Text;

namespace ASAMODS.BaseModel
{
    public abstract class AoExternalComponent : AoBase
    {
        #region Base Attributes
        private DT_LONG ordinal_number;
        private DT_LONG component_length;
        private DT_STRING filename_url;
        private typespec_enum value_type;
        private DT_LONG start_offset;
        private DT_LONG block_size;
        private DT_LONG valuesperblock;
        private DT_LONG value_offset;
        private DT_STRING flags_filename_url;
        private DT_LONG flags_start_offset;


        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// Ordinal Number; specifies the segment number of this external
        /// component. It must be unique within the context of its father. The
        /// first segment will have a value of 1. No gaps may exist in the
        /// ordinal number of the external components of one local column.
        /// If this base attribute is not contained in an application model, each
        /// local column that saves its values in external components may only
        /// use one external component per local column.
        /// If an external component instance does not specify a value for
        /// ordinal_number the default value of 1 shall be assumed
        /// </summary>
        public DT_LONG Ordinal_number
        {
            get { return ordinal_number; }
            set { ordinal_number = value; }
        }


        /// <summary>
        /// DT_LONG
        /// MANDATORY ATTRIBUTE (required in application model)
        /// Length of this component; for all numeric data types it is given as
        /// number of values , for the other data types (DT_STRING,
        /// DT_BYTESTR, DT_BLOB) it is given as number of bytes.
        /// </summary>
        public DT_LONG Component_length
        {
            get { return component_length; }
            set { component_length = value; }
        }


        /// <summary>
        /// DT_STRING
        /// MANDATORY ATTRIBUTE (required in application model)
        /// URL of the File Name
        /// </summary>
        public DT_STRING Filename_url
        {
            get { return filename_url; }
            set { filename_url = value; }
        }


        /// <summary>
        /// typespec_enum
        /// MANDATORY ATTRIBUTE (required in application model)
        /// See description below for details on this enumeration.
        /// </summary>
        public typespec_enum Value_type
        {
            get { return value_type; }
            set { value_type = value; }
        }


        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// MANDATORY ATTRIBUTE (required in application model)
        /// Start Offset; is unspecified in case value_type='DT_BLOB'; must
        /// be specified in all other cases
        /// </summary>
        public DT_LONG Start_offset
        {
            get { return start_offset; }
            set { start_offset = value; }
        }

        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// MANDATORY ATTRIBUTE (required in application model)
        /// Block Size; is unspecified in case value_type='DT_BLOB'; must be
        /// specified in all other cases
        /// </summary>
        public DT_LONG Block_size
        {
            get { return block_size; }
            set { block_size = value; }
        }


        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// MANDATORY ATTRIBUTE (required in application model)
        /// Values per Block; is unspecified in case value_type='DT_BLOB';
        /// must be specified in all other cases
        /// </summary>
        public DT_LONG Valuesperblock
        {
            get { return valuesperblock; }
            set { valuesperblock = value; }
        }


        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// MANDATORY ATTRIBUTE (required in application model)
        /// Value Offset; is unspecified in case value_type='DT_BLOB'; must
        /// be specified in all other cases
        /// </summary>
        public DT_LONG Value_offset
        {
            get { return value_offset; }
            set { value_offset = value; }
        }


        /// <summary>
        /// DT_STRING
        /// OPTIONAL
        /// URL of the File Name with Flags
        /// </summary>
        public DT_STRING Flags_filename_url
        {
            get { return flags_filename_url; }
            set { flags_filename_url = value; }
        }


        /// <summary>
        /// DT_LONG
        /// OPTIONAL
        /// Offset where the Flags begin
        /// </summary>
        public DT_LONG Flags_start_offset
        {
            get { return flags_start_offset; }
            set { flags_start_offset = value; }
        }
        #endregion

        #region Relations
        private AoLocalColumn local_column;

        /// <summary>
        /// FATHER
        /// AoLocalColumn
        /// INVERSE FOR external_component
        /// MANDATORY ATTRIBUTE (required in application model)
        /// </summary>
        public AoLocalColumn Local_column
        {
            get { return local_column; }
            set { local_column = value; }
        }
        #endregion
    }
}