Service for managing and controlling force variables by the Arp GDS.
More...
#include <IForceService.hpp>
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Returns a reference to service proxy factory to create a proxy instance of the service More...
|
|
Service for managing and controlling force variables by the Arp GDS.
Use Arp.Plc.Gds.Services.IForceService in order to force and to unforce variables.
◆ IForceService()
Arp::Plc::Gds::Services::IForceService::IForceService |
( |
void |
| ) |
|
|
default |
◆ AddVariable()
Adds a new variable and value for forcing. Enables force mode.
The enabled force mode is signalized by notification and by the activated 'PlcState.Forcing'
- Parameters
-
item | Force item Arp.Plc.Gds.Services.ForceItem, which contains the the name of the variable with the full instance path and the force value. The data type of the force value must be equal with the data type of the target variable. |
- Returns
- Returns Arp.Plc.Gds.Services.DataAccessError.None on success.
◆ GetVariables()
virtual std::vector<ForceItem> Arp::Plc::Gds::Services::IForceService::GetVariables |
( |
| ) |
|
|
pure virtual |
◆ IsActive()
virtual boolean Arp::Plc::Gds::Services::IForceService::IsActive |
( |
| ) |
|
|
pure virtual |
Tests whether force mode is active.
- Returns
- trueif the force mode is active.
◆ IsForcable()
virtual boolean Arp::Plc::Gds::Services::IForceService::IsForcable |
( |
const RscString< 512 > & |
variableName | ) |
|
|
pure virtual |
Tests whether variable is forcable.
The variable has to meet the following requirements to be forcable:
- The kind of variable should be an In- or an Out-port of a program (IEC, C ++, Simulink ...) or a variable that is connected to I/O data.
- The data type of the variable has to be supported.
- Returns
- trueif the variable is forcable.
◆ RemoveVariable()
virtual void Arp::Plc::Gds::Services::IForceService::RemoveVariable |
( |
const RscString< 512 > & |
variableName | ) |
|
|
pure virtual |
Resets forced variable. Disables force mode after force list is empty.
- Parameters
-
variableName | Instance path of the variable. |
◆ Reset()
virtual void Arp::Plc::Gds::Services::IForceService::Reset |
( |
| ) |
|
|
pure virtual |
Resets the force list. Disables force mode.
The disabled force mode is signalized by notification and by the deactivated PlcState.
The documentation for this class was generated from the following file: