Class RadarMeasure

External

API: /radars/:radarId/measures
API: /radars/:radarId/measures/:radarMeasureId

Hierarchy (view full)

Measure
- RadarMeasure

Index

Constructors

constructor

new RadarMeasure(json): RadarMeasure
Parameters
- json: {
      id: string;
      values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
      date?: string | Date;
      validity?: number;
      configurationAsJSON?: string;
      radar?: string;
  }
  - id: string
  - values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[]
  - Optional date?: string | Date
  - Optional validity?: number
  - Optional configurationAsJSON?: string
  - Optional radar?: string
Returns RadarMeasure
Overrides Measure.constructor
- Defined in radar/RadarMeasure.ts:15

Properties

date

date: Date

values

values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[]

validity

validity: number

id

id: string

Unique identifier for the node

version

version: string

Version string of the node

`Static` TYPE

TYPE: RaainNodeType = RaainNodeType.RadarMeasure

Accessors

Methods

setConfiguration

setConfiguration(configuration): void
Parameters
- configuration: any
Returns void
Inherited from Measure.setConfiguration
- Defined in organization/Measure.ts:30

getConfiguration

getConfiguration(): any
Returns any
Inherited from Measure.getConfiguration
- Defined in organization/Measure.ts:63

getMinMaxValues

getMinMaxValues(): {
min: number;
max: number;
}
Returns {
min: number;
max: number;
}
- min: number
- max: number
Inherited from Measure.getMinMaxValues
- Defined in organization/Measure.ts:67

getLinks

getLinks(linkType?): Link[]
Parameters
- Optional linkType: RaainNodeType
Returns Link[]
Inherited from Measure.getLinks
- Defined in organization/RaainNode.ts:149

getLink

getLink(linkType, index?): Link
Parameters
- linkType: RaainNodeType
- Optional index: number
Returns Link
Inherited from Measure.getLink
- Defined in organization/RaainNode.ts:159

getLinkIds

getLinkIds(): string[]
Gets all link IDs associated with the node.

Returns string[]
Array of link IDs
Inherited from Measure.getLinkIds
- Defined in organization/RaainNode.ts:173

getLinksCount

getLinksCount(linkType?): number
Gets the count of links, optionally filtered by type.
Parameters
- Optional linkType: RaainNodeType
  Optional type of links to count
Returns number
The number of links
Inherited from Measure.getLinksCount
- Defined in organization/RaainNode.ts:183

addLinks

addLinks(links): void
Adds new links to the node.
Parameters
- links: Link[] | RaainNode[]
  Array of links to add
Returns void
Inherited from Measure.addLinks
- Defined in organization/RaainNode.ts:198

getVersion

getVersion(): string
Gets the version string of the node.

Returns string
The version string
Inherited from Measure.getVersion
- Defined in organization/RaainNode.ts:211

toJSON

toJSON(options?): {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
} | {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
    radar: string;
}
Parameters
- Optional options: {
  removeValues?: boolean;
  }
  - Optional removeValues?: boolean
Returns {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
} | {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
    radar: string;
}
Overrides Measure.toJSON
- Defined in radar/RadarMeasure.ts:29

Class RadarMeasure

External

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[]

Optional date?: string | Date

Optional validity?: number

Optional configurationAsJSON?: string

Optional radar?: string

Returns RadarMeasure

Properties

date

values

validity

id

version

Static TYPE

Accessors

links

Returns Link[]

Parameters

Returns void

Methods

setConfiguration

Parameters

Returns void

getConfiguration

Returns any

getMinMaxValues

Returns { min: number; max: number; }

min: number

max: number

getLinks

Parameters

Returns Link[]

getLink

Parameters

Returns Link

getLinkIds

Returns string[]

getLinksCount

Parameters

Returns number

addLinks

Parameters

Returns void

getVersion

Returns string

toJSON

Parameters

Optional removeValues?: boolean

Settings

Member Visibility

Theme

On This Page

`Optional` date?: string | Date

`Optional` validity?: number

`Optional` configurationAsJSON?: string

`Optional` radar?: string

`Static` TYPE

Returns {
min: number;
max: number;
}

`Optional` removeValues?: boolean