C# Class TimeSeriesLibrary.TSParameters

This class houses the meta-parameters that TimeSeriesLibrary is responsible for writing to the database along with the BLOB (this class contains the meta parameters but not the BLOB itself).

显示文件 Open project: hydrologics/TimeSeriesLibrary Class Usage Examples

Public Properties

Property	Type	Description
BlobStartDate	System.DateTime
CompressionCode	int
TimeStepQuantity	short
TimeStepUnit	TSDateCalculator.TimeStepUnitCode

Public Methods

Method	Description
SetParametersIrregular ( int timeStepCount, System.DateTime blobStartDate, System.DateTime blobEndDate, int compressionCode ) : void	TimeSeriesLibrary is responsible for ensuring that a certain set of meta-parameters (which are saved as database fields) are coordinated with the BLOB of timeseries data. This method records all of the meta-parameters of an irregular timeseries into the fields of this TSParameters object, using the input parameters given to the method.
SetParametersRegular ( TSDateCalculator timeStepUnit, short timeStepQuantity, int timeStepCount, System.DateTime blobStartDate, int compressionCode ) : void	TimeSeriesLibrary is responsible for ensuring that a certain set of meta-parameters (which are saved as database fields) are coordinated with the BLOB of timeseries data. This method records all of the meta-parameters of a regular timeseries into the fields of this TSParameters object, using the input parameters given to the method.

Method Details

SetParametersIrregular() public method

TimeSeriesLibrary is responsible for ensuring that a certain set of meta-parameters (which are saved as database fields) are coordinated with the BLOB of timeseries data. This method records all of the meta-parameters of an irregular timeseries into the fields of this TSParameters object, using the input parameters given to the method.

public SetParametersIrregular ( int timeStepCount, System.DateTime blobStartDate, System.DateTime blobEndDate, int compressionCode ) : void
timeStepCount	int
blobStartDate	System.DateTime
blobEndDate	System.DateTime
compressionCode	int
return	void

SetParametersRegular() public method

TimeSeriesLibrary is responsible for ensuring that a certain set of meta-parameters (which are saved as database fields) are coordinated with the BLOB of timeseries data. This method records all of the meta-parameters of a regular timeseries into the fields of this TSParameters object, using the input parameters given to the method.

public SetParametersRegular ( TSDateCalculator timeStepUnit, short timeStepQuantity, int timeStepCount, System.DateTime blobStartDate, int compressionCode ) : void
timeStepUnit	TSDateCalculator
timeStepQuantity	short
timeStepCount	int
blobStartDate	System.DateTime
compressionCode	int
return	void

Property Details

BlobStartDate public_oe property

Date of the first time step stored in the database

public DateTime,System BlobStartDate
return	System.DateTime

CompressionCode public_oe property

The compression code that indicates what compression algorithm is used to compress the BLOB

public int CompressionCode
return	int

TimeStepQuantity public_oe property

number of units per time step (e.g. Quantity=6 for 6-hour time steps)

public short TimeStepQuantity
return	short

TimeStepUnit public_oe property

code for the units that measure the regular time step (e.g. hour, day, month)

public TSDateCalculator.TimeStepUnitCode TimeStepUnit
return	TSDateCalculator.TimeStepUnitCode