API / geotoolkit / welllog / data / LogDataSample / LogDataSample
data.LogDataSample.LogDataSample
Represent a processed data sample
↳
LogDataSample
Constructors
| [new LogDataSample(depth, value, level, valid, srcIndex)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.data-4.logdatasample.logdatasample.md#new logdatasample(depth, value, level, valid, srcindex)) | [new LogDataSample(params)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.data-4.logdatasample.logdatasample.md#new logdatasample(params)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
depth | number | Depth |
index | number | Source index |
level | number | Level |
position | number | Position |
valid | boolean | Valid or not |
value | number | Value |
Constructors
• new LogDataSample(depth?, value?, level?, valid?, srcIndex?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional depth | number | depth |
Optional value | number | value |
Optional level | number | level |
Optional valid | boolean | valid |
Optional srcIndex | number | srcIndex |
DataSample.constructor
• new LogDataSample(params?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional params | Options | properties object |
DataSample.constructor
Methods
▸ clone(): LogDataSample
Create clone
clone
▸ getClassName(): string
string
▸ getDepth(): number
Return depth
number
▸ getLevel(): number
Return level of the wrap
number
▸ getOriginalIndex(): number
Get original index in the data set
number
▸ getOriginalValue(): number
Returns original value of the sample
number
▸ getPosition(): number
Return position
number
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties object
▸ getValid(): boolean
Return sample status
boolean
▸ getValue(): number
Returns value of the sample
number
▸ isNull(): boolean
Check if sample is null
boolean
▸ setDepth(depth): LogDataSample
Sets depth
| Name | Type | Description |
|---|---|---|
depth | number | depth |
this
▸ setLevel(level): LogDataSample
Sets wrap level
| Name | Type | Description |
|---|---|---|
level | number | level |
this
▸ setOriginalIndex(srcIndex): LogDataSample
Sets original index
| Name | Type | Description |
|---|---|---|
srcIndex | number | src index |
this
▸ setPosition(position): LogDataSample
Sets position
| Name | Type | Description |
|---|---|---|
position | number | position |
this
▸ setProperties(properties?): LogDataSample
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setValid(valid): LogDataSample
Sets status of the sample
| Name | Type | Description |
|---|---|---|
valid | boolean | valid |
this
▸ setValue(value): LogDataSample
Sets value of the sample
| Name | Type | Description |
|---|---|---|
value | number | value |
this
▸ Static getClassName(): string
string