SensorMetadata (UnetStack 3.4.0 API)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.arl.unet.c3.SensorMetadata

Sensor metadata base class.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`SensorMetadata.Metadata`	Sensor metadata by quantity name.
`static class`	`SensorMetadata.QuantityMetadata`	Quantity metadata for each quantity that a sensor can measure.

Properties Summary

Properties
Type	Name and description
`String`	`info` User-defined sensor class information.
`SensorMetadata.Metadata`	`metadata` Metadata for various quantities that the sensor can measure.
`String`	`sensorClass` Sensor class name.

Constructor Summary

Constructors
Constructor and description
`protected SensorMetadata (Performative perf)`
`protected SensorMetadata (Message msg, Performative perf)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`SensorMetadata`	`add(String qty, SensorMetadata.QuantityMetadata md)` Add sensor metadata by quantity name.
	`SensorMetadata`	`add(String qty, Map md)` Convenience method to enable syntax to add metadata easily.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Property Detail
  - String info
    
    User-defined sensor class information.
  - SensorMetadata.Metadata metadata
    
    Metadata for various quantities that the sensor can measure.
  - String sensorClass
    
    Sensor class name. The class name is hierarchical, with "/" separators between parts. Examples:
    - temperature/TS201: temperature sensor model number TS201
    - temperature/TS201/industrial: temperature sensor model number TS201, industrial variant
- Constructor Detail
  - protected SensorMetadata(Performative perf)
  - protected SensorMetadata(Message msg, Performative perf)
- Method Detail
  - SensorMetadata add(String qty, SensorMetadata.QuantityMetadata md)
    
    Add sensor metadata by quantity name.
    Parameters:
    qty - quantity name
    md - sensor metadata
  - SensorMetadata add(String qty, Map md)
    
    Convenience method to enable syntax to add metadata easily. Example:
    req = new RegisterSensorClassReq(sensorClass: 'CTD/X761').add('salinity', [units: 'ppt', scalar: true, minimum: 0, maximum: 50])
    Parameters:
    qty - quantity name
    md - sensor metadata as key-value pairs
  - @Override String toString()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Copyright 2013-21, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd