C# Class TimeSeriesLibrary.ComTSLibrary

Inheritance: _ComTSLibrary
Show file Open project: hydrologics/TimeSeriesLibrary Class Usage Examples

Public Properties

Property Type Description
ConnxObject TSConnection

Private Properties

Property Type Description
CloseConnection void
CountTimeSteps int
DeleteMatchingSeries bool
DeleteSeries bool
FillDateArray void
FillSeriesDateArray void
GetConnectionFromId System.Data.SqlClient.SqlConnection
IncrementDate System.DateTime
OpenConnection int
ReadDatesValues int
ReadValuesRegular int
WriteParametersIrregular int
WriteParametersRegular int
WriteTraceIrregular void
WriteTraceRegular void
XmlImport int

Public Methods

Method Description
ComTSLibrary ( ) : System

Class constructor. In accord with the COM callable wrapper, this constructor can not take any parameters, and there can be no other constructors besides this one.
GetErrorMessage ( sbyte pErrorMessage ) : void
GetHasError ( ) : bool
ResetErrorHandler ( ) : void
XmlImportWithList ( int connectionNumber, String paramTableName, String traceTableName, String xmlFileName, List tsImportList ) : int

This method reads the given XML file and stores any time series that are defined in the XML file to the database using the given database connection number and database table name. For each time series that the method adds to the database, it adds a TSImport object to the given List of TSImport objects. Each TSImport object records fields that were read from the XML file, but which TSLibrary does not process.

Private Methods

Method Description
CloseConnection ( int connectionNumber ) : void
CountTimeSteps ( System.DateTime startDate, System.DateTime endDate, short unit, short stepSize ) : int
DeleteMatchingSeries ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, sbyte pWhereClause ) : bool
DeleteSeries ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int id ) : bool
FillDateArray ( short timeStepUnit, short timeStepQuantity, int nReqValues, System.DateTime dateArray, System.DateTime reqStartDate ) : void
FillSeriesDateArray ( int connectionNumber, String paramTableName, String traceTableName, int id, int nReqValues, System.DateTime dateArray, System.DateTime reqStartDate ) : void
GetConnectionFromId ( int connectionNumber ) : SqlConnection
IncrementDate ( System.DateTime startDate, short unit, short stepSize, int numSteps ) : System.DateTime
OpenConnection ( sbyte pConnectionString ) : int
ReadDatesValues ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int id, int traceNumber, int nReqValues, TSDateValueStruct &dateValueArray, System.DateTime reqStartDate, System.DateTime reqEndDate ) : int
ReadValuesRegular ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int id, int traceNumber, int nReqValues, double valueArray, System.DateTime reqStartDate, System.DateTime reqEndDate ) : int
WriteParametersIrregular ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int nOutValues, System.DateTime outStartDate, System.DateTime outEndDate, sbyte pExtraParamNames, sbyte pExtraParamValues ) : int
WriteParametersRegular ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, short timeStepUnit, short timeStepQuantity, int nOutValues, System.DateTime outStartDate, sbyte pExtraParamNames, sbyte pExtraParamValues ) : int
WriteTraceIrregular ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int id, int traceNumber, TSDateValueStruct dateValueArray ) : void
WriteTraceRegular ( int connectionNumber, sbyte pParamTableName, sbyte pTraceTableName, int id, int traceNumber, double valueArray ) : void
XmlImport ( int connectionNumber, String paramTableName, String traceTableName, String xmlFileName ) : int

Method Details

ComTSLibrary() public method

Class constructor. In accord with the COM callable wrapper, this constructor can not take any parameters, and there can be no other constructors besides this one.
public ComTSLibrary ( ) : System
return System

GetErrorMessage() public method

public GetErrorMessage ( sbyte pErrorMessage ) : void
pErrorMessage sbyte
return void

GetHasError() public method

public GetHasError ( ) : bool
return bool

ResetErrorHandler() public method

public ResetErrorHandler ( ) : void
return void

XmlImportWithList() public method

This method reads the given XML file and stores any time series that are defined in the XML file to the database using the given database connection number and database table name. For each time series that the method adds to the database, it adds a TSImport object to the given List of TSImport objects. Each TSImport object records fields that were read from the XML file, but which TSLibrary does not process.
public XmlImportWithList ( int connectionNumber, String paramTableName, String traceTableName, String xmlFileName, List tsImportList ) : int
connectionNumber int The serial number of the connection that is used to write to the database
paramTableName String The name of the database table that time series will be written to
traceTableName String The name of the database table that stores the BLOB for a single trace
xmlFileName String The file name (with path) of an XML file that defines one or more time series to import
tsImportList List A List of TSImport objects that the method adds to--one item for each time series /// that is saved to the database. The List must already be instantiated before calling this method. /// The method does not change any items that are already in the List.
return int

Property Details

ConnxObject public property

TSConnection object maintains a list of connections that have been opened by the library
public TSConnection,TimeSeriesLibrary ConnxObject
return TSConnection