ResultData Methods

Methods

ContainsAtLeastOneDataItem Returns true if there is at least one data item
Dispose Dispose of ressources
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Finish Closes persistant storage and frees related data structures.
Flush Saves the contents of the class using the defined connection.
GenerateDerivedProperties Generate derived properties
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNumberOfDataItems Total number of data items. This will iterate over all types of data sets and sum up the data items.
GetNumberOfElements Total number of elements in all data items. This will iterate over all types of data sets and sum up the number of elements.
GetTypeGets the Type of the current instance.
(Inherited from Object)
GridPointsWithStructure List of gridpoints that contain a specific structure. Note: This is a derived property
Load Loads results from a persistent media into memory. Load uses the connection object to decide what and how it should load the data. Load is similar to a LoadHeader followed by LoadData
Obsolete
Load(IDiagnostics) Loads results from a persistent media into memory. Load uses the connection object to decide what and how it should load the data. Load is similar to a LoadHeader followed by LoadData
LoadData Loads the header information of the results from a persistent media into memory. Load uses the connection object to decide what and how it should load the data. Using the filter argument the user may choose to load only a sub-selection of the entire data.
LoadHeader(IDiagnostics) Loads the header information of the results from a persistent media into memory. Load uses the connection object to decide what and how it should load the data. Using the filter argument the user may choose to load only a sub-selection of the entire data.
LoadHeader(Boolean, IDiagnostics) Loads the header information of the results from a persistent media into memory. Load uses the connection object to decide what and how it should load the data. Using the filter argument the user may choose to load only a sub-selection of the entire data.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare the result data for new data. After this is called, the result data should be ready to handle calls to Update(DateTime) and UpdateAndFlushIfNeeded(DateTime). This will usually open the file on the disc, making it ready to write to the file.
PrepareLoad Prepare load call. This will setup bridge and reader, and make access to the bridge and the reader available before actual loading of data starts, i.e. for progress bar implementation

If not called explicitly, it will be called automatically by the load methods.

ReconnectNetwork If network is changed (node/reach moved or reconnected), this will regenerate the network attributes in the ResultData object.
Save Saves the contents of the resultdata using the specified connection properties.
TimeOfNextUpdate Time of next update
ToStringReturns a string that represents the current object.
(Inherited from Object)
TriggerProgressEvent Trigger the ProgressEvent
TriggerTimeStepEvent Trigger the time step event, e.g. in case a time step has been added, updated or before writing to file.
Update(DateTime) The method pulls data into the result data access module using the result items and passes the data to the dataItems.
Update(DateTime, Int32) The method pulls data into the result data access module using the result items and passes the data to the dataItems.
UpdateAndFlushIfNeeded The method pulls data into the result data access module using the result items and passes the data to the dataItems. After this it is tested whether the number of time steps kept in the DataItems are larger or equal to MaxBufferSize. In case it is the data is flushed to persistant storage.

Extension Methods

FilterLoadsAllTimes Check if filter will load all time steps. Header must have been loaded, such that resultData knows the extent in time of the data.
(Defined by ResultDataExtensions)
InitializeTimeData Initialize all data items with default time-data objects. This can be used when storing data for many time steps in a result data object, typically when reading.
(Defined by ResultDataExtensions)
Quantities Extract all quantities of a result data object.
(Defined by ResultDataExtensions)
QuantityDataItems Extract all quantities and dataitems of a result data object, grouped by their quantity
(Defined by ResultDataExtensions)
RemoveTimestep Extract all quantities of a result data object.
(Defined by ResultDataExtensions)
RemoveUnusedDataItems Remove unused data items from resultData object
(Defined by Res1DExtensions)

See Also