Skip to content

Communicators

meganlim edited this page Aug 3, 2018 · 16 revisions

Description

Communicators are used to communicate data with the outside world. These function as interfaces with various data sources and sinks by receiving data which will be used by prognosers or communicating the results with operators.

Some examples could be a playback agent that reads from a file, a GUI for displaying prognostic results, an automated report generator, or a client that connects into a network messaging system.

The GSAP Communicator Library is shipped with a few standard communicators that are listed below. Click on the communicator name for more information.

  • Recorder Communicator: This communicator is used to record information to a comma-separated file.
  • Playback Communicator: This communicator is used to playback data from a delimited file.
  • Random Communicator: This communicator is used for testing. It sets the value of every sensor to a random number in a range specified by the user.

Communicator Configuration Files

Individual communicators can have their own configuration parameters, which are documented with the specific communicator.

General configuration parameters that would be accepted by any communicator:

Parameter Description Example
type [Required] The type of prognoser recorder

Adding New Communicators

To connect GSAP to your system you may need to create a new communicator. A new communicator can be created by the following steps:

  1. Copy EmptyCommunicator.cpp and EmptyCommunicator.h from the templates directory and rename to the name of your communicator
  2. Follow the instructions inside EmptyCommunicator.cpp to create your communicator