Class Measure

Base class for all RAAIN nodes in the system. Implements versioning and link management functionality.

Remarks

This is the foundation class for all API entities in the RAAIN system. It provides common functionality for:

Version management
HATEOAS link handling
JSON serialization

Example

const node = new RaainNode({
  id: 'node1',
  version: '1.0.0',
  links: [
    new Link('self', '/api/nodes/node1')
  ]
});

Hierarchy (view full)

RaainNode
- Measure

Index

Constructors

constructor

new Measure(json): Measure
Parameters
- json: {
      id: string;
      values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
      date?: string | Date;
      validity?: number;
      configurationAsJSON?: string;
      version?: string;
  }
  - id: string
  - values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[]
  - Optional date?: string | Date
  - Optional validity?: number
  - Optional configurationAsJSON?: string
  - Optional version?: string
Returns Measure
Overrides RaainNode.constructor
- Defined in organization/Measure.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

Accessors

Methods

setConfiguration

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

toJSON

toJSON(options?): {
    date: Date;
    validity: number;
    configurationAsJSON: string;
    values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
    id: string;
    links: Link[];
    version?: string;
}
Parameters
- 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[]
- Optional version?: string
Overrides RaainNode.toJSON
- Defined in organization/Measure.ts:43

getConfiguration

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

getMinMaxValues

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

getLinks

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

getLink

getLink(linkType, index?): Link
Parameters
- linkType: RaainNodeType
- Optional index: number
Returns Link
Inherited from RaainNode.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 RaainNode.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 RaainNode.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 RaainNode.addLinks
- Defined in organization/RaainNode.ts:198

getVersion

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

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

Class Measure

Remarks

Example

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 version?: string

Returns Measure

Properties

date

values

validity

id

version

Accessors

links

Returns Link[]

Parameters

Returns void

Methods

setConfiguration

Parameters

Returns void

toJSON

Parameters

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[]

Optional version?: string

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

Settings

Member Visibility

Theme

On This Page

`Optional` date?: string | Date

`Optional` validity?: number

`Optional` configurationAsJSON?: string

`Optional` version?: string

`Optional` removeValues?: boolean

Returns {
date: Date;
validity: number;
configurationAsJSON: string;
values: number[] | IPolarMeasureValue[] | ICartesianMeasureValue[];
id: string;
links: Link[];
version?: string;
}

`Optional` version?: string

Returns {
min: number;
max: number;
}