API / geotoolkit / ivaapbackend / reservoir / RemoteReservoirDataSource / RemoteReservoirDataSource
reservoir.RemoteReservoirDataSource.RemoteReservoirDataSource
Provide utility class to load reservoir data from IVAAP backend
↳
RemoteReservoirDataSource
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
hostname | string | The host name for requests |
Constructors
• new RemoteReservoirDataSource(options?)
| Name | Type |
|---|---|
Optional options | Options |
RemoteDataSource<RemoteReservoirDataSource.MetaInfo&gt;.constructor
Methods
▸ dispose(): void
Dispose
void
▸ getClassName(): string
string
▸ Protected getHostName(): string
Gets host name
string
▸ Protected getHttpService(): AbstractHttpService
Gets a http service associated with this data source
RemoteDataSource.getHttpService
▸ getId(): string
Gets data identifier
string
▸ getLinks(): Link[]
Gets links
Link[]
▸ getMetaData(): MetaInfo
Returns meta information from IVAAP backend
meta meta data
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties
RemoteDataSource.getProperties
▸ isZFPEnabled(): boolean
Returns true if browser supports WebAssembly and ZFP is enabled
boolean
▸ loadCells(level?, idNode?, filterSpec?, onProgress?, cancel?): Promise<LegacyCell[] | ArrayCells>
Load reservoir cells
| Name | Type | Description |
|---|---|---|
Optional level | number | the level of resolution |
Optional idNode | number | the node index |
Optional filterSpec | string | the filter that should be applied |
Optional onProgress | (event: ProgressEvent<EventTarget>) => void | a function to be executed to handle progress |
Optional cancel | Cancel | a Cancel object that can be used to cancel the loading. |
Promise<LegacyCell[] | ArrayCells>
and promise with cells data, the Promise return type change based on the value set to this dataSource constructor "efficientdatalayout" option. If set to false or not specified, the return type will be the deprecated LegacyCellType[] type. If set to true, the return type will be the new TypedArrayCells type.
▸ loadMeta(url, onProgress?, cancel?): Promise<MetaInfo>
Load the reservoir MetaDatas from the given URL
| Name | Type | Description |
|---|---|---|
url | string | url of metaData information |
Optional onProgress | (event: ProgressEvent<EventTarget>) => void | a function to be executed to handle progress |
Optional cancel | Cancel | a Cancel object that can be used to cancel the loading |
Promise<MetaInfo>
The promise for the MetaData
▸ loadValues(ordinal?, filterSpec?, onProgress?, cancel?): Promise<LegacyValues | ArrayValues>
Load reservoir values
| Name | Type | Description |
|---|---|---|
Optional ordinal | string | the ordinal number of a requested property in a list of properties |
Optional filterSpec | string | the filter that should be applied |
Optional onProgress | (event: ProgressEvent<EventTarget>) => void | a function to be executed to handle progress |
Optional cancel | Cancel | a Cancel object that can be used to cancel the loading. |
Promise<LegacyValues | ArrayValues>
and promise with cells data, the Promise return type change based on the value set to this dataSource constructor "efficientdatalayout" option. If set to false or not specified, the return type will be the deprecated LegacyValuesType[] type. If set to true, the return type will be the new TypedArrayValues type.
▸ Protected setHostName(host): RemoteReservoirDataSource
Sets host name
| Name | Type | Description |
|---|---|---|
host | string | the host name |
▸ Protected setHttpService(service): RemoteReservoirDataSource
Sets a http service associated with this data source
| Name | Type | Description |
|---|---|---|
service | AbstractHttpService | the http service |
RemoteDataSource.setHttpService
▸ Protected setId(id): RemoteReservoirDataSource
Sets data identifier
| Name | Type | Description |
|---|---|---|
id | string | the identifier |
▸ Protected setLinks(links): RemoteReservoirDataSource
Sets links
| Name | Type | Description |
|---|---|---|
links | Link[] | the links |
▸ Protected setMetaData(meta): RemoteReservoirDataSource
Sets meta information
| Name | Type | Description |
|---|---|---|
meta | MetaInfo | the meta information |
▸ setOptions(options): RemoteReservoirDataSource
Set this RemoteReservoirDataSource options
| Name | Type |
|---|---|
options | OptionsBase |
▸ setProperties(properties?): RemoteReservoirDataSource
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
RemoteDataSource.setProperties
▸ Static getClassName(): string
string