coral::master::SlaveConfig Struct Reference

Specifies variable values and connection changes for a single slave. 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

Specifies variable values and connection changes for a single slave.

This class is used in calls to Execution::Reconfigure() to specify the changes which are to be effected for one particular slave, and to obtain information about any failures the slave might have reported regarding these changes.

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