Skip to content
Last updated

API / geotoolkit / welllog / multiwell / AbstractDistanceStrategy / AbstractDistanceStrategy

Class: AbstractDistanceStrategy

multiwell.AbstractDistanceStrategy.AbstractDistanceStrategy

Interface for track distance strategy

Hierarchy

Table of contents

Constructors
  • [new AbstractDistanceStrategy()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.multiwell.abstractdistancestrategy.abstractdistancestrategy.md#new abstractdistancestrategy())
Methods

Contents

Constructors

new AbstractDistanceStrategy()

• new AbstractDistanceStrategy()

Inherited from

EventDispatcher.constructor

Methods

dispose

▸ dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getDistance

▸ Abstract getDistance(well1, well2): number

Returns distance in pixels, NaN if distance cannot be computed

Parameters

Name Type
well1ITrack
well2ITrack

Returns

number


getHeaderLabel

▸ Abstract getHeaderLabel(well1, well2): string

Returns header text for correlation track

Parameters

Name Type
well1ITrack
well2ITrack

Returns

string


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


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&gt;(type, source, args?): AbstractDistanceStrategy

Notify listeners

Type parameters

NameType
Eextends string

Parameters

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

Returns

AbstractDistanceStrategy

this

Overrides

EventDispatcher.notify


off

▸ off<E&gt;(type?, callback?): AbstractDistanceStrategy

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

Returns

AbstractDistanceStrategy

this

Overrides

EventDispatcher.off


on

▸ on<E&gt;(type, callback): AbstractDistanceStrategy

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

Type parameters

NameType
Eextends string

Parameters

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

Returns

AbstractDistanceStrategy

this

Overrides

EventDispatcher.on


setSilent

▸ setSilent(bool): AbstractDistanceStrategy

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

AbstractDistanceStrategy

this

Inherited from

EventDispatcher.setSilent


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName