#include <InformationServer.h>
|
static constexpr size_t | npos = std::numeric_limits<size_type>::max() |
| Unsigned size value indicating not found or no index.
|
|
◆ EClass
Variable/parameter class enumerator.
Enumerator |
---|
clA | Parameters of this class will always be writable.
|
clB | Parameters of this class should be read-only during measurement.
|
clC | Parameters of this class effect the result-geometry, and should be read-only during measurement and recording.
|
clMaxClass | Number of classes.
|
◆ EState
Enumerate for state of the info server.
Enumerator |
---|
issOff | Not generating results.
|
issRun | Generating results, and flushing.
|
issRecord | Generating results, no flushing.
|
issPause | Not generating results, saving parameters.
|
issStop | Not generating results, saving results.
|
issMaxState | Max states count.
|
◆ InformationServer()
sf::InformationServer::InformationServer |
( |
| ) |
|
◆ ~InformationServer()
virtual sf::InformationServer::~InformationServer |
( |
| ) |
|
|
virtual |
◆ attachResult()
void sf::InformationServer::attachResult |
( |
ResultData * |
res | ) |
|
◆ attachVariable()
void sf::InformationServer::attachVariable |
( |
Variable * |
var, |
|
|
EClass |
cls |
|
) |
| |
Adds a variable to the variables vector.
◆ clearValidations()
virtual void sf::InformationServer::clearValidations |
( |
| ) |
|
|
virtual |
◆ detachResult()
void sf::InformationServer::detachResult |
( |
ResultData * |
res | ) |
|
◆ detachVariable()
void sf::InformationServer::detachVariable |
( |
Variable * |
var | ) |
|
◆ flush()
void sf::InformationServer::flush |
( |
| ) |
|
Clears the instance. Also called from setup.
◆ getState()
EState sf::InformationServer::getState |
( |
| ) |
const |
◆ getStateName()
const char * sf::InformationServer::getStateName |
( |
int |
state | ) |
const |
Gets the name of the passed state.
◆ isGeneratingResults()
bool sf::InformationServer::isGeneratingResults |
( |
| ) |
|
◆ isServerId()
bool sf::InformationServer::isServerId |
( |
id_type |
id | ) |
const |
Determines if the passed id belongs to this info server.
◆ onStateChange()
virtual void sf::InformationServer::onStateChange |
( |
EState |
prevState, |
|
|
EState |
nextState |
|
) |
| |
|
pure virtual |
◆ setState()
void sf::InformationServer::setState |
( |
EState |
| ) |
|
◆ setup()
void sf::InformationServer::setup |
( |
const std::string & |
name, |
|
|
const std::string & |
namePrefix, |
|
|
long |
vid, |
|
|
long |
deviceMask, |
|
|
long |
serverMask |
|
) |
| |
When device mask is non-zero, variables are added automatically on creation to this info server.
- Parameters
-
name | Name of the server. |
namePrefix | Prefix of the name. |
vid | Variable id of state parameter. |
deviceMask | Device vid mask of this server. |
serverMask | Server vid mask of this server. |
The documentation for this class was generated from the following file: