Scenario Class Reference

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>

Inheritance diagram for Scenario:

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)

Detailed Description

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 58 of file Scenario.h.

Constructor & Destructor Documentation

Scenario()

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.

Parameters

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 37 of file Scenario.cpp.

Here is the call graph for this function:

Member Function Documentation

addApplication()

void addApplication

(

const ApplicationInstancePtr &

application

)

Adds an Application to this scenario.

Parameters

application

Application to be added to this scenario

Definition at line 223 of file Scenario.cpp.

allApplicationsFound()

bool allApplicationsFound

(

)

Definition at line 352 of file Scenario.cpp.

getAllDeploymendNodeNames()

std::vector< std::string > getAllDeploymendNodeNames

(

)

Definition at line 342 of file Scenario.cpp.

getApplicationByName()

Data_Structure::ApplicationInstancePtr getApplicationByName

(

const std::string &

name

)

Definition at line 210 of file Scenario.cpp.

getApplications()

Data_Structure::ApplicationInstanceVectorPtr getApplications

(

)

Returns

all applications this scenario contains

Definition at line 205 of file Scenario.cpp.

getCreationTime()

std::string getCreationTime

(

)

SCENARIO_H.

Returns

time this scenario was created.

Definition at line 66 of file Scenario.cpp.

getFolder()

std::string getFolder

(

)

Returns

path to the root of this scenario

Definition at line 102 of file Scenario.cpp.

getGlobalConfig()

armarx::PropertyDefinitionsPtr getGlobalConfig

(

)

Definition at line 287 of file Scenario.cpp.

getGlobalConfigName()

std::string getGlobalConfigName

(

)

Definition at line 76 of file Scenario.cpp.

getGlobalConfigPath()

std::string getGlobalConfigPath

(

)

Definition at line 292 of file Scenario.cpp.

getLastChangedTime()

std::string getLastChangedTime

(

)

Returns

time this scenario was last changed

Definition at line 71 of file Scenario.cpp.

getName()

std::string getName

(

)

Definition at line 56 of file Scenario.cpp.

getNodeName()

std::string getNodeName

(

)

const

Definition at line 366 of file Scenario.cpp.

getPackage()

Data_Structure::PackagePtr getPackage

(

)

Definition at line 127 of file Scenario.cpp.

getPath()

std::string getPath

(

)

Returns

the path to the scx file

Definition at line 86 of file Scenario.cpp.

getStatus()

std::string getStatus

(

)

Returns

status of this scenario

Definition at line 132 of file Scenario.cpp.

getStatusWriteBlock()

bool getStatusWriteBlock

(

)

Definition at line 322 of file Scenario.cpp.

getSubfolder()

std::string getSubfolder

(

)

Returns

subfolder

Definition at line 81 of file Scenario.cpp.

isGlobalConfigFileexistent()

bool isGlobalConfigFileexistent

(

)

Definition at line 317 of file Scenario.cpp.

isGlobalConfigWritable()

bool isGlobalConfigWritable

(

)

Definition at line 308 of file Scenario.cpp.

isReadOnly()

bool isReadOnly

(

)

Definition at line 266 of file Scenario.cpp.

isScenarioFileWriteable()

bool isScenarioFileWriteable

(

)

Definition at line 111 of file Scenario.cpp.

Here is the call graph for this function:

makeLocalGlobalConfig()

void makeLocalGlobalConfig

(

)

Definition at line 247 of file Scenario.cpp.

Here is the call graph for this function:

reloadAppInstances()

void reloadAppInstances

(

)

Definition at line 271 of file Scenario.cpp.

reloadGlobalConf()

void reloadGlobalConf

(

)

Definition at line 279 of file Scenario.cpp.

removeApplication()

void removeApplication

(

const ApplicationInstancePtr &

application

)

Removes an Application from this scenario.

Parameters

application

application to be removed

Definition at line 228 of file Scenario.cpp.

save()

void save

(

bool

saveApplications = true

)

Definition at line 241 of file Scenario.cpp.

setGlobalConfigName()

void setGlobalConfigName

(

std::string

name

)

Definition at line 200 of file Scenario.cpp.

setLastChangedTime()

void setLastChangedTime

(

std::string

time

)

Sets the last-changed-time to now.

Definition at line 195 of file Scenario.cpp.

setName()

void setName

(

std::string

name

)

Definition at line 61 of file Scenario.cpp.

setNodeName()

void setNodeName

(

const std::string &

value

)

Definition at line 371 of file Scenario.cpp.

Here is the call graph for this function:

setStatusWriteBlock()

void setStatusWriteBlock

(

bool

state

)

Definition at line 334 of file Scenario.cpp.

---

The documentation for this class was generated from the following files:

• ArmarXCore/util/ScenarioManagerCommon/data_structure/Scenario.h
• ArmarXCore/util/ScenarioManagerCommon/data_structure/Scenario.cpp