|
Class containing data about the instance of an application. Provides methods to get and set the data. It is only representative and doesn't actually synchronize with the configuration files. More...
#include <ArmarXCore/util/ScenarioManagerCommon/data_structure/ApplicationInstance.h>
Public Member Functions | |
void | addProperty (std::string name, std::string value) |
Adds a new property with the specified name and value to this ApplicationInstance. More... | |
ApplicationInstance (Application application, std::string instanceName, std::string configPath, ScenarioPtr scenarioName, std::string node, bool enabled, bool iceAutoRestart) | |
Constructor that sets the base data of this ApplicationInstance. More... | |
ApplicationInstance (std::string executableName, std::string executablePath, std::string instanceName, std::string configPath, std::string packageName, ScenarioPtr scenarioName, std::string node, bool enabled, bool iceAutoRestart) | |
Constructor that sets the base data of this ApplicationInstance. More... | |
void | copyFrom (ApplicationInstance &other) |
copyFrom Copy the other instance configuration to this one. More... | |
void | deleteConfig () |
std::string | getConfigDomain () const |
std::string | getConfigPath () |
std::string | getEffectiveNodeName () const |
bool | getEnabled () |
bool | getIceAutoRestart () |
std::string | getInstanceName () |
std::string | getNodeName () const |
int | getPid () |
ScenarioPtr | getScenario () |
std::string | getStatus () |
Returns the status. More... | |
bool | getStatusWriteBlock () |
bool | isConfigWritable () |
bool | isReadOnly () const |
void | linkFrom (ApplicationInstance &other) |
linkFrom Link this instance configuration from the other instance. More... | |
void | load (bool firstLoad=false) |
Loades the IceProperties from the configPath Firstload determins if properties that equal their default value get uncommented. More... | |
void | makeLocal () |
Make a local copy of this instance if it is linked and nothing otherwise. More... | |
void | modifyProperty (std::string name, std::string value) |
Changes the value of the specified property. More... | |
void | resetConfigPath () |
resetConfigPath. More... | |
void | save () |
Saves the IceProperties to the configPath. More... | |
void | setConfigDomain (const std::string &value) |
void | setConfigPath (std::string configPath) |
Sets the config path of this ApplicationInstance. More... | |
void | setEnabled (bool enabled) |
void | setIceAutoRestart (bool enabled) |
void | setInstanceName (std::string newName) |
Sets the name of this ApplicationInstance. More... | |
void | setNodeName (std::string nodeName) |
void | setPid (int pid) |
Sets the pid of this ApplicationInstance. More... | |
bool | setStatus (const std::string &status) |
Sets the status of this ApplicationInstance. More... | |
void | setStatusWriteBlock (bool blocked) |
Public Member Functions inherited from Application | |
Application (Application &app) | |
Copy constructor. More... | |
Application (std::string name, std::string executablePath, std::string packageName) | |
Constructor that sets the name and the path to the executable of the application. More... | |
std::string | getExecutableAbsPath () |
std::string | getExecutableName () |
bool | getFound () |
std::string | getName () |
std::string | getPackageName () |
std::string | getPathToExecutable () |
armarx::PropertyDefinitionsPtr | getProperties () |
bool | isDefaultProperty (std::string name) |
bool | isDefaultPropertyEnabled (std::string name) |
void | setDefaultPropertyEnabled (std::string name, bool enabled) |
void | setIsDefaultProperty (std::string name, bool defaultValue) |
void | setProperties (armarx::PropertyDefinitionsPtr properties) |
Sets the properties of this application. More... | |
void | updateFound () |
Additional Inherited Members | |
Protected Attributes inherited from Application | |
PropertyEnabledMap | defaultMap |
PropertyEnabledMap | enabledMap |
armarx::PropertyDefinitionsPtr | properties |
Class containing data about the instance of an application. Provides methods to get and set the data. It is only representative and doesn't actually synchronize with the configuration files.
Definition at line 63 of file ApplicationInstance.h.
ApplicationInstance | ( | std::string | executableName, |
std::string | executablePath, | ||
std::string | instanceName, | ||
std::string | configPath, | ||
std::string | packageName, | ||
ScenarioPtr | scenarioName, | ||
std::string | node, | ||
bool | enabled, | ||
bool | iceAutoRestart | ||
) |
Constructor that sets the base data of this ApplicationInstance.
executableName | The name of the Application |
executablePath | The path of the Executable |
instanceName | a name that distinguishes this instance from other instances |
configPath | path to the config file of this instance |
ApplicationInstance | ( | Application | application, |
std::string | instanceName, | ||
std::string | configPath, | ||
ScenarioPtr | scenarioName, | ||
std::string | node, | ||
bool | enabled, | ||
bool | iceAutoRestart | ||
) |
Constructor that sets the base data of this ApplicationInstance.
application | The application this class instantiates. |
instanceName | a name that distinguishes this instance from other instances |
configPath | path to the config file of this instance |
void addProperty | ( | std::string | name, |
std::string | value | ||
) |
Adds a new property with the specified name and value to this ApplicationInstance.
name | name of the new property |
value | value of the new property |
Definition at line 171 of file ApplicationInstance.cpp.
void copyFrom | ( | ApplicationInstance & | other | ) |
copyFrom Copy the other instance configuration to this one.
other | the instance to copy |
Definition at line 214 of file ApplicationInstance.cpp.
void deleteConfig | ( | ) |
Definition at line 223 of file ApplicationInstance.cpp.
std::string getConfigDomain | ( | ) | const |
Definition at line 50 of file ApplicationInstance.cpp.
std::string getConfigPath | ( | ) |
Definition at line 103 of file ApplicationInstance.cpp.
std::string getEffectiveNodeName | ( | ) | const |
Definition at line 272 of file ApplicationInstance.cpp.
bool getEnabled | ( | ) |
Definition at line 282 of file ApplicationInstance.cpp.
bool getIceAutoRestart | ( | ) |
Definition at line 292 of file ApplicationInstance.cpp.
std::string getInstanceName | ( | ) |
Definition at line 93 of file ApplicationInstance.cpp.
std::string getNodeName | ( | ) | const |
Definition at line 267 of file ApplicationInstance.cpp.
int getPid | ( | ) |
Definition at line 152 of file ApplicationInstance.cpp.
Data_Structure::ScenarioPtr getScenario | ( | ) |
Definition at line 88 of file ApplicationInstance.cpp.
std::string getStatus | ( | ) |
Returns the status.
Doesn't update automatically, is not necessarily synchronized with the actual status of the process. Use the Executor to get the actual status of this application.
Definition at line 137 of file ApplicationInstance.cpp.
bool getStatusWriteBlock | ( | ) |
Definition at line 257 of file ApplicationInstance.cpp.
bool isConfigWritable | ( | ) |
Definition at line 247 of file ApplicationInstance.cpp.
bool isReadOnly | ( | ) | const |
Definition at line 61 of file ApplicationInstance.cpp.
void linkFrom | ( | ApplicationInstance & | other | ) |
linkFrom Link this instance configuration from the other instance.
other | the source instance |
Definition at line 205 of file ApplicationInstance.cpp.
void load | ( | bool | firstLoad = false | ) |
Loades the IceProperties from the configPath Firstload determins if properties that equal their default value get uncommented.
Definition at line 231 of file ApplicationInstance.cpp.
void makeLocal | ( | ) |
Make a local copy of this instance if it is linked and nothing otherwise.
Definition at line 186 of file ApplicationInstance.cpp.
void modifyProperty | ( | std::string | name, |
std::string | value | ||
) |
Changes the value of the specified property.
name | name of the property whose value is to be changed |
value | new value of the property |
Definition at line 162 of file ApplicationInstance.cpp.
void resetConfigPath | ( | ) |
resetConfigPath.
should be called when the instanceName is changed/ deletes the old cfg file and resets the local config Path to where the file should be you should call save after this
Definition at line 113 of file ApplicationInstance.cpp.
void save | ( | ) |
Saves the IceProperties to the configPath.
Definition at line 180 of file ApplicationInstance.cpp.
void setConfigDomain | ( | const std::string & | value | ) |
void setConfigPath | ( | std::string | configPath | ) |
Sets the config path of this ApplicationInstance.
new | config path |
Definition at line 108 of file ApplicationInstance.cpp.
void setEnabled | ( | bool | enabled | ) |
Definition at line 287 of file ApplicationInstance.cpp.
void setIceAutoRestart | ( | bool | enabled | ) |
Definition at line 297 of file ApplicationInstance.cpp.
void setInstanceName | ( | std::string | newName | ) |
Sets the name of this ApplicationInstance.
new | name |
Definition at line 98 of file ApplicationInstance.cpp.
void setNodeName | ( | std::string | nodeName | ) |
Definition at line 277 of file ApplicationInstance.cpp.
void setPid | ( | int | pid | ) |
Sets the pid of this ApplicationInstance.
This pid gets used by the Executor to stop this application, therefore it is not suggested to set this to random values. Set this to -1, if no pid is known.
pid | new pid |
Definition at line 157 of file ApplicationInstance.cpp.
bool setStatus | ( | const std::string & | status | ) |
Sets the status of this ApplicationInstance.
new | status. Should be either "running" or "stopped" for Scenario statuses to work properly. |
Definition at line 142 of file ApplicationInstance.cpp.
void setStatusWriteBlock | ( | bool | blocked | ) |
Definition at line 262 of file ApplicationInstance.cpp.