Class GaugeNode

Represents a rain gauge station in the RAAIN system. This class manages gauge data collection and configuration.

Remarks

Used in the API endpoint: api/gauges/:id

Example

const gaugeNode = new GaugeNode({
  id: 'gauge1',
  latitude: 48.8566,
  longitude: 2.3522,
  name: 'Paris Gauge',
  team: teamNode,
  description: 'Main rain gauge station'
});

External

  • API: /gauges
  • API: /gauges/:gaugeId

Hierarchy (view full)

Constructors

constructor

Properties

TYPE name description latitude longitude team id version

Accessors

links

Methods

setConfiguration getConfiguration toJSON getLinks getLink getLinkIds getLinksCount addLinks getVersion

Constructors

constructor

  • new GaugeNode(json): GaugeNode

  • Creates a new GaugeNode instance.

    Parameters

    • json: {
          id: string;
          latitude: number;
          longitude: number;
          name: string;
          team: string | TeamNode;
          description?: string;
          links?: Link[] | RaainNode[];
          version?: string;
          configurationAsJSON?: string;
      }

      Configuration object

      • id: string

        Unique identifier

      • latitude: number

        Latitude of the gauge station

      • longitude: number

        Longitude of the gauge station

      • name: string

        Name of the gauge station

      • team: string | TeamNode

        Associated team

      • Optional description?: string

        Optional description

      • Optional links?: Link[] | RaainNode[]

        Optional array of links

      • Optional version?: string

        Optional version string

      • Optional configurationAsJSON?: string

        Optional configuration object

    Returns GaugeNode

Properties

Static TYPE

TYPE: RaainNodeType = RaainNodeType.GaugeNode

Type identifier for gauge nodes

name

name: string

Name of the gauge station

description

description: string

Description of the gauge station

latitude

latitude: number

Latitude of the gauge station

longitude

longitude: number

Longitude of the gauge station

team

team: TeamNode

Associated team

id

id: string

Unique identifier for the node

version

version: string

Version string of the node

Accessors

links

Methods

setConfiguration

  • setConfiguration(configuration): void

  • Sets the configuration for the gauge node.

    Parameters

    • configuration: any

      Configuration object or JSON string

    Returns void

getConfiguration

  • getConfiguration(): any

  • Gets the configuration of the gauge node.

    Returns any

    The configuration object or null if not set

toJSON

  • toJSON(): {
        name: string;
        description: string;
        latitude: number;
        longitude: number;
        team: string | TeamNode;
        configurationAsJSON: string;
        id: string;
        links: Link[];
        version?: string;
    }

  • Converts the gauge node to a JSON object.

    Returns {
        name: string;
        description: string;
        latitude: number;
        longitude: number;
        team: string | TeamNode;
        configurationAsJSON: string;
        id: string;
        links: Link[];
        version?: string;
    }

    A JSON object containing the gauge node's data

    • name: string
    • description: string
    • latitude: number
    • longitude: number
    • team: string | TeamNode
    • configurationAsJSON: string
    • id: string
    • links: Link[]
    • Optional version?: string

getLinks

getLink

getLinkIds

getLinksCount

addLinks

getVersion

Settings

Member Visibility

Theme

On This Page

constructorTYPEnamedescriptionlatitudelongitudeteamidversionlinkssetConfigurationgetConfigurationtoJSONgetLinksgetLinkgetLinkIdsgetLinksCountaddLinksgetVersion