Scenario Class Reference

Class containing data about a scenario and its applications. 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.
bool	allApplicationsFound ()
std::vector< std::string >	getAllDeploymendNodeNames ()
ApplicationInstancePtr	getApplicationByName (const std::string &name)
ApplicationInstanceVectorPtr	getApplications ()
std::string	getCreationTime ()
	SCENARIO_H.
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 ()
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.
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.
void	setGlobalConfigName (std::string name)
void	setLastChangedTime (std::string time)
	Sets the last-changed-time to now.
void	setName (std::string name)
void	setNodeName (const std::string &value)

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.

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

Member Function Documentation

addApplication()

void addApplication

(

const ApplicationInstancePtr &

application

)

Adds an Application to this scenario.

Parameters

application

Application to be added to this scenario

allApplicationsFound()

bool allApplicationsFound

(

)

getAllDeploymendNodeNames()

std::vector< std::string > getAllDeploymendNodeNames

(

)

getApplicationByName()

Data_Structure::ApplicationInstancePtr getApplicationByName

(

const std::string &

name

)

getApplications()

Data_Structure::ApplicationInstanceVectorPtr getApplications

(

)

Returns

all applications this scenario contains

getCreationTime()

std::string getCreationTime

(

)

SCENARIO_H.

Returns

time this scenario was created.

getFolder()

std::string getFolder

(

)

Returns

path to the root of this scenario

getGlobalConfig()

armarx::PropertyDefinitionsPtr getGlobalConfig

(

)

getGlobalConfigName()

std::string getGlobalConfigName

(

)

getGlobalConfigPath()

std::string getGlobalConfigPath

(

)

getLastChangedTime()

std::string getLastChangedTime

(

)

Returns

time this scenario was last changed

getName()

std::string getName

(

)

getNodeName()

std::string getNodeName

(

)

const

getPackage()

Data_Structure::PackagePtr getPackage

(

)

getPath()

std::string getPath

(

)

Returns

the path to the scx file

getStatus()

std::string getStatus

(

)

Returns

status of this scenario

getSubfolder()

std::string getSubfolder

(

)

Returns

subfolder

isGlobalConfigFileexistent()

bool isGlobalConfigFileexistent

(

)

isGlobalConfigWritable()

bool isGlobalConfigWritable

(

)

isReadOnly()

bool isReadOnly

(

)

isScenarioFileWriteable()

bool isScenarioFileWriteable

(

)

makeLocalGlobalConfig()

void makeLocalGlobalConfig

(

)

reloadAppInstances()

void reloadAppInstances

(

)

reloadGlobalConf()

void reloadGlobalConf

(

)

removeApplication()

void removeApplication

(

const ApplicationInstancePtr &

application

)

Removes an Application from this scenario.

Parameters

application

application to be removed

save()

void save

(

bool

saveApplications = true

)

setGlobalConfigName()

void setGlobalConfigName

(

std::string

name

)

setLastChangedTime()

void setLastChangedTime

(

std::string

time

)

Sets the last-changed-time to now.

setName()

void setName

(

std::string

name

)

setNodeName()

void setNodeName

(

const std::string &

value

)

---

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