Last updated

API / geotoolkit3d / data / well / MultiLateralWellData / MultiLateralWellData

Class: MultiLateralWellData

well.MultiLateralWellData.MultiLateralWellData

Multilateral well data combines an array of wells into one object.

Table of contents

Constructors
Methods

Contents

Constructors

new MultiLateralWellData(options)

new MultiLateralWellData(options)

Parameters

Name Type
optionsOptions
Methods

addWell

addWell(well): MultiLateralWellData

Add a well into existing well object

Parameters

Name Type Description
wellDataThe new well object

Returns

MultiLateralWellData

this


getClassName

getClassName(): string

Returns

string


getOptions

getOptions(): OptionsOut

Returns the well data's options

Returns

OptionsOut

options The array of well objects


getWell

getWell(index): Data

Get n-th well

Parameters

Name Type Description
indexnumberThe index of well

Returns

Data

The index-th well


getWellArray

getWellArray(): Data[]

Returns the well data as an array

Returns

Data[]


removeWell

removeWell(index): MultiLateralWellData

Remove n-th well from current wells

Parameters

Name Type Description
indexnumberThe index of well

Returns

MultiLateralWellData

this


getClassName

Static getClassName(): string

Returns

string