DP44/DataPRO/SensorDB/TSF/ReadTSFError.cs

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

namespace DTS.SensorDB.TSF
{
    /// <summary>
    /// helper class to help returning errors while reading Test Setup Files (TSF)
    /// this is to make it easier to handle translations.
    /// </summary>
    public class ReadTSFError
    {
        /// <summary>
        /// these are all the possible errors returned by ReadTSF
        /// </summary>
        public enum TSF_ERRORS
        {
            TSF_FILE_NOT_FOUND,
            TSF_FILE_IO_ERROR,
            TSFFILE_INCOMPLETE,
            TSF_INVALID_VERSION,
            TSF_OLD_FILE_VERSION,
            TSF_UNEXPECTED_EOF,
            TSF_INCOMPLETE_SAMPLING_SECTION,
            TSF_INVALID_SAMPLERATE,
            TSF_INVALID_PRETRIGGER_TIME,
            TSF_INAVLID_POSTTRIGGER_TIME,
            TSF_INVALID_AAF,
            TSF_SKIPPED_RACK_ENTRY_INCOMPLETE,
            TSF_RACK_ENTRY_INVALID_RACK_VALUE,
            TSF_RACK_ENTRY_INVALID_ISO_POSITION,
            RACK_ENTRY_IWALLTEST_ITROLLEY_FUNCTIONALITY,
            RACK_ENTRY_ITROLLEYTEST_IWALL_FUNCTIONALITY,
            RACK_ENTRY_INVALID_RACK_INDEX,
            RACK_ENTRY_INVALID_EMPTYRACK,
            TSF_SKIPPING_MODULE_TOO_FEW_TOKENS,
            TSF_MODULE_INVALID_RACK_FIELD,
            TSF_MODULE_INVALID_MODULE_FIELD,
            TSF_MODULE_INVALID_TRIGGERMODE_FIELD,
            TSF_MODULE_INVALID_TRIGGERCHAN_FIELD,
            TSF_MODULE_INVALID_TRIGGERDIR_FIELD,
            TSF_MODULE_INVALID_TRIGGERLEVEL_FIELD,
            TSF_MODULE_INVALID_MODULETYPE_FIELD,
            TSF_MODULE_SKIPPED_RACKNOTFOUND,
            TSF_SENSORCHANNEL_INVALID_C0,
            TSF_SENSORCHANNEL_INVALID_C1,
            TSF_SENSORCHANNEL_INVALID_C2,
            TSF_SENSORCHANNEL_INVALID_C3,
            TSF_SENSORCHANNEL_INVALID_C4,
            TSF_SENSORCHANNEL_INVALID_C5,
            TSF_SENSORCHANNEL_INVALID_CALDATE,
            TSF_SENSORCHANNEL_INVALID_CALSTEP,
            TSF_SENSORCHANNEL_INVALID_CHAN,
            TSF_SENSOR_CHANNEL_INVALID_DATACHAN,
            TSF_SENSOR_CHANNEL_INVALID_DESIREDMAXRANGE,
            TSF_SENSOR_CHANNEL_INVALID_DESIREDMAXRANGESCALING,
            TSF_SENSOR_CHANNEL_INVALID_DUPLICATESERIALNUMBER,
            TSF_SENSOR_CHANNEL_INVALID_EXTVOLT,
            TSF_SENSOR_CHANNEL_INVALID_GAIN,
            TSF_SENSOR_CHANNEL_INVALID_INITIALEU,
            TSF_SENSOR_CHANNEL_INVALID_IRTRACCEXPONENT,
            TSF_SENSOR_CHANNEL_INVALID_MODULE,
            TSF_SENSOR_CHANNEL_INVALID_OFFSETHIGH,
            TSF_SENSOR_CHANNEL_INVALID_OFFSETLOW,
            TSF_SENSOR_CHANNEL_INVALID_RACK,
            TSF_SENSOR_CHANNEL_INVALID_SENSITIVITY,
            TSF_SENSOR_CHANNEL_INVALID_SENSORCATEGORY,
            TSF_SENSOR_CHANNEL_INVALID_SHUNTVALUE,
            TSF_SENSOR_CHANNEL_INVALID_ZEROREF,
            TSF_SENSOR_CHANNEL_INVALIDFIELD,
            TSF_READPROTOCOL_AND_NO_SIF,
            TSF_ERROR_IN_TSF,
            TSF_ERROR_INVALID_BRIDGERESISTANCE,
            TSF_CALCULATED_CHANNEL_INVALID_CHAN_FIELD,
            TSF_CALCULATED_CHANNEL_INVALID_EXPMAXRANGE,
            TSF_CALCULATED_CHANNEL_INVALID_FIRSTCHAN,
            TSF_CALCULATED_CHANNEL_INVALID_PROCESSTYPE,
            TSF_CALCULATED_CHANNEL_INVALID_PROGRESS2,
            TSF_CALCULATED_CHANNEL_INVALID_PROGRESS3,
            TSF_CALCULATED_CHANNEL_INVALID_SECONDCHAN,
            TSF_CALCULATED_CHANNEL_INVALID_THIRDCHAN,
            TSF_CALCULATED_CHANNEL_INVALID_VALUE,
            TSF_DIGITALCHANNEL_INVALID_CHAN,
            TSF_DIGITALCHANNEL_INVALID_DELAY,
            TSF_DIGITALCHANNEL_INVALID_DURATION,
            TSF_DIGITALCHANNEL_INVALID_DURATIONON,
            TSF_DIGITALCHANNEL_INVALID_MODULE,
            TSF_DIGITALCHANNEL_INVALID_RACK,
            TSF_DIGITALCHANNEL_INVALID_TYPE,
            TSF_SQUIBFIREENTRY_INVALID_CHAN,
            TSF_SQUIBFIREENTRY_INVALID_CURRENT,
            TSF_SQUIBFIREENTRY_INVALID_DELAY,
            TSF_SQUIBFIREENTRY_INVALID_DURATION,
            TSF_SQUIBFIREENTRY_INVALID_DURATIONON,
            TSF_SQUIBFIREENTRY_INVALID_MODULE,
            TSF_SQUIBFIREENTRY_INVALID_OHMHIGH,
            TSF_SQUIBFIREENTRY_INVALID_OHMLOW,
            TSF_SQUIBFIREENTRY_RACK,
            TSF_SQUIBFIREENTRY_TYPE,
            TSF_DIM_INVALID_CABLETEST,
            TSF_DIM_INVALID_CHAN,
            TSF_DIM_INVALID_DATACHAN,
            TSF_DIM_INVALID_FILTERMODE,
            TSF_DIM_INVALID_FILTERTHRESHOLD,
            TSF_DIM_INVALID_INVERTED,
            TSF_DIM_INVALID_MODULE,
            TSF_DIM_INVALID_RACK,
            TSF_DIM_INVALID_SCALE,
            TSF_G5DIGITALCHANNEL_INVALID_CHAN,
            TSF_G5DIGITALCHANNEL_INVALID_DATACHAN,
            TSF_G5DIGITALCHANNEL_INVALID_INVERT,
            TSF_G5DIGITALCHANNEL_INVALID_MODULE,
            TSF_G5DIGITALCHANNEL_INVALID_RACK,
            TSF_G5DIGITALCHANNEL_INVALID_SCALE,
            RACKINFORMATIONSECTION_INVALIDHEADER,
            RACKINFORMATIONSECTION_INVALIDCOLUMNHEADER,
            MODULEINFORMATIONSECTION_BADHEADER,
            MODULEINFORMATIONSECTION_BADCOLUMHEADER,
            SENSORCHANNELSECTION_INVALIDHEADER,
            SENSORCHANNELSECTION_INVALIDCOLUMNHEADER,
            CALCULATEDCHANNELSSECTION_INVALIDSECTIONHEADER,
            CALCULATEDCHANNELSECTION_INVALIDCOLUMNHEADER,
            G5DIGITALINPUTSECTION_START_INVALID_HEADER,
            G5DIGITALINPUTSECTION_COLUMN_INVALID_HEADER,
            TSF_DIM_INVALID_SECTIONSTARTHEADER,
            TSF_DIM_INVALID_COLUMNSECTIONHEADER,
            TCF_INVALID_STARTSECTIONHEADER,
            TSF_TCF_INVALID_SECTIONENDHEADER,
            TSF_TOMCHANNEL_INVALID_SECTIONSTART,
            TSF_TOMCHANNEL_INVALID_SQUIBFIREHEADER,
            TSF_SQUIBFIRECHANNELS_INVALID_COLUMNSHEADER,
            TSF_TOMCHANNEL_INVALID_DIGITALCOLUMNSHEADER,
            TSF_SENSOR_CHANNEL_INVALID_FILTER,
            TSF_SENSOR_CHANNEL_INVALID_OFFSET
        }

        private TSF_ERRORS _error;
        /// <summary>
        /// error in question
        /// </summary>
        public TSF_ERRORS Error { get { return _error; } }

        private int _line = 0;
        /// <summary>
        /// the line number where error occurred
        /// </summary>
        public int LineNumber { get { return _line; } }

        /// <summary>
        /// any additional information for the error
        /// </summary>
        private string _extraInfo = "";
        public string ExtraInfo { get { return _extraInfo; } }

        public ReadTSFError(TSF_ERRORS error) { _error = error; }
        public ReadTSFError(TSF_ERRORS error, int line) { _error = error; _line = line; }
        public ReadTSFError(TSF_ERRORS error, int line, string extraInfo) { _error = error; _line = line; _extraInfo = extraInfo; }
    }
}