JSDoc: Class: System

new System(properties, networkPropertiesopt)

Parameters:

Name Type Attributes Default Description

properties Object the properties of the object

networkProperties

Object

{}

Properties

Name Type Attributes Default Description

endpointUrl String defines the Http(s) endpoint URL

tls Boolean defines is use Http or Https secure protocol for fetching data

streamProtocol String <optional> 'ws' the Stream protocol to use: 'ws' pr 'mqtt'

mqttOpts

Object

{}

the Mqtt options if stream protocol is 'mqtt'

Properties

Name	Type	Description
`prefix`	String	the Mqtt prefix value
`endpointUrl`	String	the Mqtt specific endpointUrl

Source:

core/sweapi/system/System.js, line 43

Methods

(async) getControlById(datastreamId, controlFilteropt) → {Control}

Get a specific control interface description by ID route: /systems/{sysid}/controls/{dsid}

Parameters:

Name	Type	Attributes	Default	Description
`datastreamId`	String			The ID of the datastream or command stream
`controlFilter`	ControlFilter	<optional>	new ControlFilter()	the control filter

Source:

core/sweapi/system/System.js, line 131

Returns:

- The corresponding Control

Type: Control

(async) getDetails(systemFilteropt) → {Promise.<JSON>}

Get the latest specsheet of a system route: /systems/{sysid}/details

Parameters:

Name	Type	Attributes	Default	Description
`systemFilter`	SystemFilter	<optional>	new SystemFilter()	the system filter

Source:

core/sweapi/system/System.js, line 59

Returns:

- SensorlML Description

Type: Promise.<JSON>

(async) searchControls(controlFilteropt, pageSizeopt) → {Promise.<Collection.<Control>>}

Get a list of control interfaces of a system route: /systems/{sysid}/controls

Parameters:

Name	Type	Attributes	Default	Description
`controlFilter`	ControlFilter	<optional>	new ControlFilter()	the control filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 115

Returns:

- A collection of Control

Type: Promise.<Collection.<Control>>

(async) searchDataStreams(dataStreamFilteropt, pageSizeopt) → {Promise.<Collection.<DataStream>>}

List or search output datastreams of the selected system. Individual datastreams can be retrieved by ID directly on the root "datastreams" collection. route: /systems/{sysid}/datastreams

Parameters:

Name	Type	Attributes	Default	Description
`dataStreamFilter`	DataStreamFilter	<optional>	new DataStreamFilter()	default DataStream filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 83

Returns:

- A collection of DataStream

Type: Promise.<Collection.<DataStream>>

(async) searchEvents(eventFilteropt, pageSizeopt) → {Promise.<Collection.<Event>>}

List or search events related to a system (e.g. maintenance events, contact change, etc.) route: /systems/{sysid}/events

Parameters:

Name	Type	Attributes	Default	Description
`eventFilter`	EventFilter	<optional>	new EventFilter()	the event filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 145

Returns:

- A collection of Event

Type: Promise.<Collection.<Event>>

(async) searchFeaturesOfInterest(featureOfInterestFilteropt, pageSizeopt) → {Promise.<Collection.<FeatureOfInterest>>}

List or search features of interest of a system. Individual features can be retrieved by ID directly on the root "featuresOfInterest" collection route: /systems/{sysid}/featuresOfInterest

Parameters:

Name	Type	Attributes	Default	Description
`featureOfInterestFilter`	FeatureOfInterestFilter	<optional>	new FeatureOfInterestFilter()	FOI filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 99

Returns:

- A collection of FeatureOfInterest

Type: Promise.<Collection.<FeatureOfInterest>>

(async) searchHistory(systemHistoryFilteropt, pageSizeopt) → {Promise.<Collection.<System>>}

List or search for historical descriptions of a specific system (ordered by time of validity) route: /systems/{sysid}/history

Parameters:

Name	Type	Attributes	Default	Description
`systemHistoryFilter`	SystemHistoryFilter	<optional>	new SystemHistoryFilter()	the history filer
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 161

Returns:

- A collection of System

Type: Promise.<Collection.<System>>

(async) searchMembers(systemFilteropt, pageSizeopt) → {Promise.<Collection.<System>>}

List or search members of a system group. Individual members can be retrieved by ID directly on the root "systems" collection route: /systems/{sysid}/members

Parameters:

Name	Type	Attributes	Default	Description
`systemFilter`	SystemFilter	<optional>	new SystemFilter()	the system filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 177

Returns:

- A collection of System

Type: Promise.<Collection.<System>>

(async) searchSubSystems(systemFilteropt, pageSizeopt) → {Promise.<Collection.<System>>}

Search for subsystems route: /systems

Parameters:

Name	Type	Attributes	Default	Description
`systemFilter`	SystemFilter	<optional>	new SystemFilter()	the system filter
`pageSize`	Number	<optional>	10	default page size

Source:

core/sweapi/system/System.js, line 72

Returns:

- A collection of System

Type: Promise.<Collection.<System>>