fw4spl
fwRuntime::profile::Profile Class Reference

Implements a bundle set profile. More...

#include <Profile.hpp>

+ Inheritance diagram for fwRuntime::profile::Profile:
+ Collaboration diagram for fwRuntime::profile::Profile:

Public Types

typedef std::vector< std::string > ParamsContainer
 
typedef std::function< int() > RunCallbackType
 

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWRUNTIME_API Profile ()
 Constructor : does nothing.
 
FWRUNTIME_API void add (std::shared_ptr< Activater > activater)
 Adds a new activator. More...
 
FWRUNTIME_API void add (std::shared_ptr< Starter > starter)
 Adds a new starter. More...
 
FWRUNTIME_API void add (std::shared_ptr< Stopper > stopper)
 Adds a new stopper. More...
 
FWRUNTIME_API void add (std::shared_ptr< Initializer > initializer)
 Adds a new starter. More...
 
FWRUNTIME_API void add (std::shared_ptr< Uninitializer > uninitializer)
 Adds a new starter. More...
 
FWRUNTIME_API void start ()
 Starts the profile.
 
FWRUNTIME_API void stop ()
 
FWRUNTIME_API int run ()
 Run the profile.
 
FWRUNTIME_API int defaultRun ()
 
FWRUNTIME_API void setRunCallback (RunCallbackType callback)
 
FWRUNTIME_API void setup ()
 Once started, setup the profile.
 
FWRUNTIME_API void cleanup ()
 
std::string getName () const
 Return profile name.
 
void setName (std::string _sName)
 Set profile name. More...
 
::boost::filesystem::path getFilePath () const
 Get profile m_filePath.
 
void setFilePath (const ::boost::filesystem::path &_filePath)
 Set profile m_filePath.
 
std::string getVersion () const
 Return profile version.
 
void setVersion (std::string _sVersion)
 Set profile version. More...
 
bool getCheckSingleInstance () const
 Return profile CheckSingleInstance.
 
void setCheckSingleInstance (bool _checkSingleInstance)
 Set profile CheckSingleInstance. More...
 
ParamsContainer getParams () const
 
FWRUNTIME_API void setParams (const ParamsContainer &params)
 
FWRUNTIME_API void setParams (int argc, char **argv)
 
int & getRawArgCount ()
 Returns internal arg count. The returned int shall not be modified. This is provided for external library needs (QApplication contructor for example)
 
char ** getRawParams () const
 Returns a raw pointer on internal arguments. The returned data shall not be modified. This is provided for external library needs (QApplication contructor for example)
 
- Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwCore::BaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Detailed Description

Implements a bundle set profile.

Definition at line 43 of file Profile.hpp.

Member Function Documentation

void fwRuntime::profile::Profile::add ( std::shared_ptr< Activater activater)

Adds a new activator.

Parameters
[in]activatera shared pointer to an activator

Definition at line 85 of file Profile.cpp.

void fwRuntime::profile::Profile::add ( std::shared_ptr< Starter starter)

Adds a new starter.

Parameters
[in]startera shared pointer to a starter

Definition at line 92 of file Profile.cpp.

void fwRuntime::profile::Profile::add ( std::shared_ptr< Stopper stopper)

Adds a new stopper.

Parameters
[in]stoppera shared pointer to a stopper

Definition at line 99 of file Profile.cpp.

void fwRuntime::profile::Profile::add ( std::shared_ptr< Initializer initializer)

Adds a new starter.

Parameters
[in]initializera shared pointer to an initializer

Definition at line 106 of file Profile.cpp.

void fwRuntime::profile::Profile::add ( std::shared_ptr< Uninitializer uninitializer)

Adds a new starter.

Parameters
[in]uninitializera shared pointer to an uninitializer

Definition at line 113 of file Profile.cpp.

void fwRuntime::profile::Profile::setCheckSingleInstance ( bool  _checkSingleInstance)
inline

Set profile CheckSingleInstance.

Parameters
[in]_checkSingleInstanceprofile CheckSingleInstance

Definition at line 174 of file Profile.hpp.

void fwRuntime::profile::Profile::setName ( std::string  _sName)
inline

Set profile name.

Parameters
[in]_sNameprofile name

Definition at line 126 of file Profile.hpp.

void fwRuntime::profile::Profile::setVersion ( std::string  _sVersion)
inline

Set profile version.

Parameters
[in]_sVersionprofile version

Definition at line 156 of file Profile.hpp.


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