Class GaugeMeasure

api/gauges/:id/measures/:id

Hierarchy (view full)

Measure
- GaugeMeasure

Index

Constructors

Properties

TYPE gauge date values validity id version

Accessors

Methods

toJSON setConfiguration getConfiguration getLinks getLink getLinkIds getLinksCount addLinks getVersion

Constructors

constructor

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

Properties

`Static` TYPE

TYPE: string = 'gauge-measure'

gauge

gauge: string

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

Accessors

links

get links(): Link[]
Gets all links associated with the node.

Returns Link[]
Array of HATEOAS links
Inherited from Measure.links
- Defined in organization/RaainNode.ts:58
set links(links): void
Sets the links for the node.
Parameters
- links: Link[] | RaainNode[]
  Array of links to set
Returns void
Inherited from Measure.links
- Defined in organization/RaainNode.ts:67

Methods

toJSON

toJSON(options?): {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
}
Converts the node to a JSON object.
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;
}
A JSON object containing the node's data
- date: Date
- validity: number
- configurationAsJSON: string
- values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[]
- id: string
- links: Link[]
- Optional version?: string
Overrides Measure.toJSON
- Defined in gauge/GaugeMeasure.ts:28

setConfiguration

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

getConfiguration

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

getLinks

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

getLink

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

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:163

getLinksCount

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

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:188

getVersion

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

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