Last updated

API / geotoolkit / seismic / data / MemoryCube / MemoryCube

Class: MemoryCube

data.MemoryCube.MemoryCube

Defines a memory volume cube

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new MemoryCube(options)

new MemoryCube(options)

Creates memory cube

Parameters

Name Type Description
optionsOptionscube options

Overrides

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getLevelOfDetails

getLevelOfDetails(): number

Returns memory storage level of details

Returns

number


getReader

getReader(location, preload?): Promise<SliceReaderOptions>

Return seismic reader for specified location

Parameters

Name Type Description
locationLocationslice location
Optional preloadbooleanpreload next position

Returns

Promise<SliceReaderOptions>

seismic reader for specified location


getSampleType

getSampleType(): SampleType

Returns memory storage sample type

Returns

SampleType


getStatistics

getStatistics(): StatisticsOptionsOut

Returns

StatisticsOptionsOut


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

EventDispatcher.hasEventListener


hasSliceData

hasSliceData(location): boolean

Returns slice state, true if it is already loaded to the memory

Parameters

Name Type Description
locationLocationslice location

Returns

boolean

slice state


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

EventDispatcher.isSilent


notify

notify(type, source, args?): MemoryCube

Notify listeners

Parameters

Name Type Description
typestringevent types
sourceanyof the event
Optional argsanyarguments of the event

Returns

MemoryCube

this

Inherited from

EventDispatcher.notify


off

off<E>(type?, callback?): MemoryCube

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: MemoryCube, args: EventMap[E]) => voidfunction to be called

Returns

MemoryCube

this

Overrides

EventDispatcher.off


on

on<E>(type, callback): MemoryCube

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: MemoryCube, args: EventMap[E]) => voidto be called

Returns

MemoryCube

this

Overrides

EventDispatcher.on


setSilent

setSilent(bool): MemoryCube

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

MemoryCube

this

Inherited from

EventDispatcher.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName