C# Class TimeSeriesLibrary.TSImport

This class data for one time series record that was imported. This meta-data can be used by functions outside of TimeSeriesLibrary to finish processing the time series that were imported from an XML file by the TSXml class. In this way, the outside functions can handle features of the time series that TimeSeriesLibrary was not designed to handle.

Mostrar archivo Open project: hydrologics/TimeSeriesLibrary Class Usage Examples

Public Properties

Property	Type	Description
APart	String
BPart	String
BlobStartDate	System.DateTime
CPart	String
Checksum	byte[]
CompressionCode	int
EPart	String
Id	int
IsDetailed	System.Boolean
IsPattern	System.Boolean
MultiplicationFactor	Double
Name	String
TimeSeriesType	String
TimeStepQuantity	short
TimeStepUnit	TSDateCalculator.TimeStepUnitCode
TraceList	List
Units	String
UnprocessedElements	String

Public Methods

Method	Description
AddUnprocessedElement ( String s ) : void	This method adds a string to the UnprocessedElements string. The UnprocessedElements string stores XML elements that TimeSeriesLibrary does not recognize, so that the calling process can parse and process these elements.
GetTraceNumber ( XmlReader xmlReader ) : int
RecordFromTS ( TS ts ) : void	This method copies into this TSImport object: the parameters of the time series the checksum for the entire time series the ID of the database record for the time series.
RecordFromTSParameters ( TSParameters tsp ) : void	This method copies the parameters of a time series from a TSParameters object into this TSImport object.
SetAPart ( XmlReader xmlReader ) : void
SetBPart ( XmlReader xmlReader ) : void
SetCPart ( XmlReader xmlReader ) : void
SetEPart ( XmlReader xmlReader ) : void
SetMultiplicationFactor ( XmlReader xmlReader ) : void
SetTimeSeriesType ( XmlReader xmlReader ) : void
SetUnits ( XmlReader xmlReader ) : void
TSImport ( System.Boolean isDetailed ) : System	Class constructor for TSImport class.

Private Methods

Method	Description
SetDetailFieldDouble ( Double &x, XmlReader xmlReader, Double defaultVal ) : void
SetDetailFieldInt ( int &i, XmlReader xmlReader, int defaultVal ) : void
SetDetailFieldString ( String &s, XmlReader xmlReader ) : void

Method Details

AddUnprocessedElement() public method

This method adds a string to the UnprocessedElements string. The UnprocessedElements string stores XML elements that TimeSeriesLibrary does not recognize, so that the calling process can parse and process these elements.

public AddUnprocessedElement ( String s ) : void
s	String	The string that is to be added to the UnprocessedElements string. /// The given string should include the enclosing XML tags.
return	void

GetTraceNumber() public method

public GetTraceNumber ( XmlReader xmlReader ) : int
xmlReader	System.Xml.XmlReader
return	int

RecordFromTS() public method

This method copies into this TSImport object: the parameters of the time series the checksum for the entire time series the ID of the database record for the time series.

public RecordFromTS ( TS ts ) : void
ts	TS
return	void

RecordFromTSParameters() public method

This method copies the parameters of a time series from a TSParameters object into this TSImport object.

public RecordFromTSParameters ( TSParameters tsp ) : void
tsp	TSParameters	The TSParameters object that values will be copied from
return	void

SetAPart() public method

public SetAPart ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetBPart() public method

public SetBPart ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetCPart() public method

public SetCPart ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetEPart() public method

public SetEPart ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetMultiplicationFactor() public method

public SetMultiplicationFactor ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetTimeSeriesType() public method

public SetTimeSeriesType ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

SetUnits() public method

public SetUnits ( XmlReader xmlReader ) : void
xmlReader	System.Xml.XmlReader
return	void

TSImport() public method

Class constructor for TSImport class.

public TSImport ( System.Boolean isDetailed ) : System
isDetailed	System.Boolean	/// This value indicates whether the TSImport object records certain elements /// from an XML file to dedicated fields within the TSImport object, or to the /// UnprocessedElements string field of the TSImport object. It also determines /// whether the TSImport object records the BLOB of timeseries data. /// /// If true, then XML elements such as "Apart" are recorded to their own fields, /// and the BLOB is recorded in the BlobData field. /// /// If false, then XML elements such as "Apart" are recorded to the /// UnprocessedElements field, and the BLOB is not recorded in this object. ///
return	System

Property Details

APart public_oe property

public String APart
return	String

BPart public_oe property

public String BPart
return	String

BlobStartDate public_oe property

public DateTime,System BlobStartDate
return	System.DateTime

CPart public_oe property

public String CPart
return	String

Checksum public_oe property

public byte[] Checksum
return	byte[]

CompressionCode public_oe property

public int CompressionCode
return	int

EPart public_oe property

public String EPart
return	String

Id public_oe property

The ID that identifies the record that was created for this timeseries in the the database. If the database was not written to, then this field is meaningless.

public int Id
return	int

IsDetailed public_oe property

This value indicates whether the TSImport object records certain elements from an XML file to dedicated fields within the TSImport object, or to the UnprocessedElements string field of the TSImport object. It also determines whether the TSImport object records the BLOB of timeseries data. If true, then XML elements such as "Apart" are recorded to their own fields, and the BLOB is recorded in the BlobData field. If false, then XML elements such as "Apart" are recorded to the UnprocessedElements field, and the BLOB is not recorded in this object.

public Boolean,System IsDetailed
return	System.Boolean

IsPattern public_oe property

If true, then this TSImport represents a cyclic Time Pattern

public Boolean,System IsPattern
return	System.Boolean

MultiplicationFactor public_oe property

public Double MultiplicationFactor
return	Double

Name public_oe property

Content of the Name tag in the XML file, presumably the name of a HECDSS record

public String Name
return	String

TimeSeriesType public_oe property

public String TimeSeriesType
return	String

TimeStepQuantity public_oe property

public short TimeStepQuantity
return	short

TimeStepUnit public_oe property

public TSDateCalculator.TimeStepUnitCode TimeStepUnit
return	TSDateCalculator.TimeStepUnitCode

TraceList public_oe property

public List TraceList
return	List

Units public_oe property

public String Units
return	String

UnprocessedElements public_oe property

A string of XML elements, including the surrounding tags, that were not directly processed by the TimeSeriesLibrary. The design calls for the caller to process these elements according to its own logic.

public String UnprocessedElements
return	String