|
Class containing data about a scenario and its applications. Provides methods to get and set the data contained in the scenario. It is only representative and doesn't actually manage the scenario. More...
#include <ArmarXCore/util/ScenarioManagerCommon/data_structure/Scenario.h>
Public Member Functions | |
void | addApplication (const ApplicationInstancePtr &application) |
Adds an Application to this scenario. More... | |
bool | allApplicationsFound () |
std::vector< std::string > | getAllDeploymendNodeNames () |
ApplicationInstancePtr | getApplicationByName (const std::string &name) |
ApplicationInstanceVectorPtr | getApplications () |
std::string | getCreationTime () |
SCENARIO_H. More... | |
std::string | getFolder () |
armarx::PropertyDefinitionsPtr | getGlobalConfig () |
std::string | getGlobalConfigName () |
std::string | getGlobalConfigPath () |
std::string | getLastChangedTime () |
std::string | getName () |
std::string | getNodeName () const |
PackagePtr | getPackage () |
std::string | getPath () |
std::string | getStatus () |
bool | getStatusWriteBlock () |
std::string | getSubfolder () |
bool | isGlobalConfigFileexistent () |
bool | isGlobalConfigWritable () |
bool | isReadOnly () |
bool | isScenarioFileWriteable () |
void | makeLocalGlobalConfig () |
void | reloadAppInstances () |
void | reloadGlobalConf () |
void | removeApplication (const ApplicationInstancePtr &application) |
Removes an Application from this scenario. More... | |
void | save (bool saveApplications=true) |
Scenario (const std::string &name, const std::string &creationTime, const std::string &lastChangedTime, const PackagePtr &package, const std::string &globalConfigName="./config/global.cfg", const std::string &subfolder="") | |
Constructor that sets some base information about the scenario. More... | |
void | setGlobalConfigName (std::string name) |
void | setLastChangedTime (std::string time) |
Sets the last-changed-time to now. More... | |
void | setName (std::string name) |
void | setNodeName (const std::string &value) |
void | setStatusWriteBlock (bool state) |
Class containing data about a scenario and its applications. Provides methods to get and set the data contained in the scenario. It is only representative and doesn't actually manage the scenario.
Definition at line 56 of file Scenario.h.
Scenario | ( | const std::string & | name, |
const std::string & | creationTime, | ||
const std::string & | lastChangedTime, | ||
const PackagePtr & | package, | ||
const std::string & | globalConfigName = "./config/global.cfg" , |
||
const std::string & | subfolder = "" |
||
) |
Constructor that sets some base information about the scenario.
name | name of the scenario |
creationTime | when this scenario was first created |
lastChangedTime | when this scenario was last changed. Should usually be the same as the time of creation, except when creating an exact copy of another Scenario. |
path | path to the root of this scenario |
Definition at line 40 of file Scenario.cpp.
void addApplication | ( | const ApplicationInstancePtr & | application | ) |
Adds an Application to this scenario.
application | Application to be added to this scenario |
Definition at line 265 of file Scenario.cpp.
bool allApplicationsFound | ( | ) |
Definition at line 417 of file Scenario.cpp.
std::vector< std::string > getAllDeploymendNodeNames | ( | ) |
Definition at line 406 of file Scenario.cpp.
Data_Structure::ApplicationInstancePtr getApplicationByName | ( | const std::string & | name | ) |
Definition at line 251 of file Scenario.cpp.
Data_Structure::ApplicationInstanceVectorPtr getApplications | ( | ) |
Definition at line 245 of file Scenario.cpp.
std::string getCreationTime | ( | ) |
std::string getFolder | ( | ) |
Definition at line 125 of file Scenario.cpp.
armarx::PropertyDefinitionsPtr getGlobalConfig | ( | ) |
Definition at line 337 of file Scenario.cpp.
std::string getGlobalConfigName | ( | ) |
Definition at line 90 of file Scenario.cpp.
std::string getGlobalConfigPath | ( | ) |
Definition at line 343 of file Scenario.cpp.
std::string getLastChangedTime | ( | ) |
Definition at line 84 of file Scenario.cpp.
std::string getName | ( | ) |
Definition at line 66 of file Scenario.cpp.
std::string getNodeName | ( | ) | const |
Definition at line 431 of file Scenario.cpp.
Data_Structure::PackagePtr getPackage | ( | ) |
Definition at line 152 of file Scenario.cpp.
std::string getPath | ( | ) |
Definition at line 102 of file Scenario.cpp.
std::string getStatus | ( | ) |
Definition at line 158 of file Scenario.cpp.
bool getStatusWriteBlock | ( | ) |
Definition at line 384 of file Scenario.cpp.
std::string getSubfolder | ( | ) |
Definition at line 96 of file Scenario.cpp.
bool isGlobalConfigFileexistent | ( | ) |
Definition at line 378 of file Scenario.cpp.
bool isGlobalConfigWritable | ( | ) |
Definition at line 368 of file Scenario.cpp.
bool isReadOnly | ( | ) |
Definition at line 313 of file Scenario.cpp.
bool isScenarioFileWriteable | ( | ) |
void makeLocalGlobalConfig | ( | ) |
void reloadAppInstances | ( | ) |
Definition at line 319 of file Scenario.cpp.
void reloadGlobalConf | ( | ) |
Definition at line 328 of file Scenario.cpp.
void removeApplication | ( | const ApplicationInstancePtr & | application | ) |
Removes an Application from this scenario.
application | application to be removed |
Definition at line 271 of file Scenario.cpp.
void save | ( | bool | saveApplications = true | ) |
Definition at line 286 of file Scenario.cpp.
void setGlobalConfigName | ( | std::string | name | ) |
Definition at line 239 of file Scenario.cpp.
void setLastChangedTime | ( | std::string | time | ) |
Sets the last-changed-time to now.
Definition at line 233 of file Scenario.cpp.
void setName | ( | std::string | name | ) |
Definition at line 72 of file Scenario.cpp.
void setNodeName | ( | const std::string & | value | ) |
void setStatusWriteBlock | ( | bool | state | ) |
Definition at line 397 of file Scenario.cpp.