Click or drag to resize

ResultData Methods

The ResultData type exposes the following members.

Methods
  NameDescription
Public methodContainsAtLeastOneDataItem
Returns true if there is at least one data item
Public methodDispose
Dispose of ressources
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFinish
Closes persistant storage and frees related data structures.
Public methodFlush
Saves the contents of the class using the defined connection.
Public methodGenerateDerivedProperties
Generate derived properties
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNumberOfDataItems
Total number of data items. This will iterate over all types of data sets and sum up the data items.
Public methodGetNumberOfElements
Total number of elements in all data items. This will iterate over all types of data sets and sum up the number of elements.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGridPointsWithStructure
List of gridpoints that contain a specific structure. Note: This is a derived property
Public methodLoad Obsolete.
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
Public methodLoad(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
Public methodLoadData
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.
Public methodLoadHeader(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.
Public methodLoadHeader(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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
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.
Public methodPrepareLoad
Prepare load call. This will setup bridge and reader, and make access to the bridge and the reader avaialable 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.

Public methodReconnectNetwork
If network is changed (node/reach moved or reconnected), this will regenerate the network attributes in the ResultData object.
Public methodSave
Saves the contents of the resultdata using the specified connection properties.
Public methodTimeOfNextUpdate
Time of next update
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTriggerTimeStepEvent
Trigger the time step event, e.g. in case a time step has been added, updated or before writing to file.
Public methodUpdate(DateTime)
The method pulls data into the result data access module using the result items and passes the data to the dataItems.
Public methodUpdate(DateTime, Int32)
The method pulls data into the result data access module using the result items and passes the data to the dataItems.
Public methodUpdateAndFlushIfNeeded
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.
Top
Extension Methods
  NameDescription
Public Extension MethodFilterLoadsAllTimes
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.)
Public Extension MethodInitializeTimeData
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.)
Public Extension MethodQuantities
Extract all quantities of a result data object.
(Defined by ResultDataExtensions.)
Public Extension MethodQuantityDataItems
Extract all quantities and dataitems of a result data object, grouped by their quantity
(Defined by ResultDataExtensions.)
Public Extension MethodRemoveTimestep
Extract all quantities of a result data object.
(Defined by ResultDataExtensions.)
Public Extension MethodRemoveUnusedDataItems
Remove unused data items from resultData object
(Defined by Res1DExtensions.)
Top
See Also