Last updated

API / geotoolkit / seismic / data / SeismicData / SeismicData

Class: SeismicData

data.SeismicData.SeismicData

Defines an interface for seismic data source/source of traces.
It implements methods like getMetaData() which returns SeismicMetaData and
Select() function to select and load relevant seismic trace sections .

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new SeismicData()

Protected new SeismicData()

Overrides

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getMetaData

Abstract getMetaData(): SeismicMetaData

Returns seismic meta data information

Returns

SeismicMetaData


getTimeStamp

getTimeStamp(): number

Return the value to indicate if data was changed

Returns

number


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


invalidate

invalidate(rect?): void

Invalidate data and notify that data is changed

Parameters

Name Type Description
Optional rectRectoptional area of tracers and samples to invalidate. It is not supported now

Returns

void


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<E>(type, source, args?): SeismicData

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceSeismicDataof the event
Optional argsEventMap[E]arguments of the event

Returns

SeismicData

this

Overrides

EventDispatcher.notify


off

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

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: SeismicData, args: EventMap[E]) => voidfunction to be called

Returns

SeismicData

this

Overrides

EventDispatcher.off


on

on<E>(type, callback): SeismicData

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: SeismicData, args: EventMap[E]) => voidto be called

Returns

SeismicData

this

Overrides

EventDispatcher.on


select

Abstract select(query, callback, validationCallback?): void

Select seismic trace sections and call "callback" method then section is loaded.

Parameters

Name Type Description
querySelectQuerya query in JSON format. Should contain parameters relevant to the trace, such as "from", "to", "headers", and "samples"
callbackSelectCallbackcallback to be called then section is loaded. This method has QueryResult as parameter
Optional validationCallbackValidationCallbackCallback function which is executed before data requested.

Returns

void


setSilent

setSilent(bool): SeismicData

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

SeismicData

this

Inherited from

EventDispatcher.setSilent


updateTimeStamp

Protected updateTimeStamp(): void

Update time stamp

Returns

void


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName