coral::master::SlaveConfig Struct Reference

Used in Execution::Reconfigure() to specify variable value and connection changes. More...

#include "coral/master/execution.hpp"

Public Member Functions
	SlaveConfig () CORAL_NOEXCEPT
	Default constructor.
	SlaveConfig (coral::model::SlaveID slaveID_, std::vector< coral::model::VariableSetting > variableSettings_)
	Constructor which sets the slaveID and variableSettings fields.

Public Attributes
coral::model::SlaveID	slaveID = coral::model::INVALID_SLAVE_ID
	[Input] The ID number of the slave whose variables are to be configured
std::vector< coral::model::VariableSetting >	variableSettings
	[Input] The variable value/connection changes
std::error_code	error
	[Output] The error reported by the slave, if any

Detailed Description

Used in Execution::Reconfigure() to specify variable value and connection changes.

This class is used to supply information about the changes which are to be effected for one particular slave, and to obtain information about any failures the slave might have reported.

Before an object of this type is passed to Reconfigure(), the slaveID and variableSettings fields must be set. If Reconfigure() throws, the error field may be queried to figure out whether this particular slave contributed to the failure, and if so, why.

---

The documentation for this struct was generated from the following file:

• coral/master/execution.hpp