Package Class Reference

Class containing data about a package, its scenarios and its applications. More...

#include <ArmarXCore/util/ScenarioManagerCommon/data_structure/Package.h>

Public Member Functions
void	addApplication (ApplicationPtr application)
	Adds an Application to this package.
void	addScenario (ScenarioPtr scenario)
	Adds a Scenario to this package.
ApplicationPtr	getApplicationByName (std::string name)
	Returns an Application contained in this package that has the given name.
ApplicationVectorPtr	getApplications ()
std::string	getName ()
std::string	getPath ()
ScenarioPtr	getScenarioByName (std::string name)
	Returns a Scenario contained in this package that has the given name.
std::string	getScenarioPath ()
ScenarioVectorPtr	getScenarios ()
bool	isScenarioPathWritable ()
	Package (const Package &other)
	Constructor that creates a light copy of the given Package, only name and path get copied.
	Package (std::string name, std::string path, std::string scenarioPath)
	Constructor that sets the name and the path of the package.
void	removeScenario (ScenarioPtr scenario)

Detailed Description

Class containing data about a package, its scenarios and its applications.

Provides methods to get and set the data contained in the package. It is only representative and doesn't actually manage the package.

Constructor & Destructor Documentation

Package() [1/2]

Package	(	std::string	name,
		std::string	path,
		std::string	scenarioPath )

Constructor that sets the name and the path of the package.

Parameters

name	name of the package
path	path to the root of the package

Package() [2/2]

Package

(

const Package &

other

)

Constructor that creates a light copy of the given Package, only name and path get copied.

Parameters

other

Package to copy

Member Function Documentation

addApplication()

void addApplication

(

Data_Structure::ApplicationPtr

application

)

Adds an Application to this package.

Parameters

application

Application to be added

addScenario()

void addScenario

(

Data_Structure::ScenarioPtr

scenario

)

Adds a Scenario to this package.

Parameters

scenario

Scenario to be added

getApplicationByName()

Data_Structure::ApplicationPtr getApplicationByName

(

std::string

name

)

Returns an Application contained in this package that has the given name.

Parameters

name	name of the application

Returns

an Application with the given name. Returns a null pointer, if no Application with that name exists.

getApplications()

Data_Structure::ApplicationVectorPtr getApplications

(

)

Returns

applications of this package

getName()

std::string getName

(

)

Returns

name of this package

getPath()

std::string getPath

(

)

Returns

path of this package (.../PackageName/build/config)

getScenarioByName()

Data_Structure::ScenarioPtr getScenarioByName

(

std::string

name

)

Returns a Scenario contained in this package that has the given name.

Parameters

name	name of the scenario

Returns

a Scenario with the given name. Returns a null pointer if no scenario with that name exists.

getScenarioPath()

std::string getScenarioPath

(

)

getScenarios()

Data_Structure::ScenarioVectorPtr getScenarios

(

)

Returns

scenarios of this package

isScenarioPathWritable()

bool isScenarioPathWritable

(

)

removeScenario()

void removeScenario

(

Data_Structure::ScenarioPtr

scenario

)

---

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

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