public class ResultData : AbstractDataAccess, IResultData,
INetworkGeneric| ResultData | Initializes a new instance of the ResultData class |
| Bridge | Get the bridge that was used for loading/saving |
| Catchments | List of catchments |
| ClearDataItemsOnFlush |
Flag indicating whether data items are cleared when flushing to file
Default is false. |
| Connection |
Holder of read/write information
(Inherited from AbstractDataAccess) |
| CustomTypes |
List of custom types stored in the data object and that must be serialized.
A custom type is e.g. a user implemented structure or catchment model. In order to store information on the custom type in the .m1dx file, the system needs to know which custom types are being used, and they must be added to this list. (Inherited from AbstractDataAccess) |
| DataItems | Get an iterator that iterates over all data items |
| DataSets | Get an iterator that iterates over all data sets |
| DeleteValue | Delete value for double variables. Any double data value with this value should be treated as a missing value. |
| EndTime | Data coverage end |
| ExtensionData |
Holds data from an extended DataContract
(Inherited from AbstractDataAccess) |
| GlobalData | Global data. Valid for entire network |
| IgnoreCase |
Flag specifying whether to ignore case in string Id's
Default is true |
| LoadStatus | |
| MaxBufferSize |
The MaxBufferSize is the limit for how many time steps that may be
held in memory during file generation.
|
| NetworkDatas |
Static data on the network.
Used for user defined markers from MIKE 11 and Critical Levels in MU. |
| NetworkDataSet |
Static data on the network.
Also used for user defined markers from MIKE 11 |
| Nodes | List of nodes |
| NumberOfTimeSteps | Number of time steps |
| Parameters | Parameters to use when loading results |
| ProjectionString | A WKT string for a spatial reference system. |
| Quantities | List of the contained quantities. Note: This is a derived property |
| Reaches | List of branches |
| Reader | Reader used for reading the result file. |
| ResultSpecs | Result specification |
| ResultType | Result type |
| SecondsBetweenFileFlush | Seconds between flush to file. Set this lower if you need to read the result file while your calculations are running. WARNING: File flush is a potentially expensive operation. Use with care. |
| StartTime | Data coverage start |
| StructureTypes | List of the contained quantities. Note: This is a derived property |
| TimeBetweenUpdates | Resultdata subscribes to the TimeStepPerformed(DateTime) event. Set this to non-zero to control how often data are stored. For non-zero values there will be AT LEAST TimeBetweenUpdates between store times in ResultData |
| TimesList | Time axis for the data. |
| TimingFlush | Timers used for flushing |
| TimingUpdate | Timers used for flushing |
| UnitSystem |
Unit system of the simulation that produced the result data object.
When creating a result data object and storing: Properties of ResultData objects (coordinates, bottom levels etc.) must always be set in SI units. When loading a result data object from storage: The UnitSystem and ConvertGeometry can be used to change units of data and properties in the Result Data object. This property will maintain the original value and will not be changed by updating the IResultDataParameters |
| ContainsAtLeastOneDataItem | Returns true if there is at least one data item |
| Dispose | Dispose of ressources |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows 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 |
| GetHashCode | Serves 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. |
| GetType | Gets 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
|
| 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. |
| MemberwiseClone | Creates 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 |
| ToString | Returns 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. |
| ProgressEvent | Event triggered while reading or writing a file |
| TimeStepEvent | Event triggered everytime a time step has been read |
| _connection |
Protected holder of read/write info
(Inherited from AbstractDataAccess) |
| DoStoreUserFunction |
Function used to override the build in functionality of when to store results
in the result data object. See ResultDataDoStoreDelegate for details.
This is currently not supported for standalone RR simulations. |
| 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) |