Equalizer  1.4.1
Public Member Functions | Public Types
eq::ConfigParams Class Reference

Parameters for running a configuration. More...

#include <configParams.h>

List of all members.

Public Member Functions

 ConfigParams ()
 Construct new configuration parameters.
 ~ConfigParams ()
 Destruct this configuration parameters.
Data Access.
void setRenderClient (const std::string &renderClient)
 Set the name of the render client executable.
const std::string & getRenderClient () const
void setWorkDir (const std::string &workDir)
 Set the directory from which to launch the render client.
const std::string & getWorkDir () const
void setFlags (const uint32_t flags)
uint32_t getFlags () const

Public Types

enum  Flags { FLAG_NONE = LB_BIT_NONE, FLAG_MULTIPROCESS = LB_BIT1, FLAG_MULTIPROCESS_DB = LB_BIT2 }

Detailed Description

Parameters for running a configuration.

See also:
Server::chooseConfig()

Definition at line 30 of file configParams.h.


Member Enumeration Documentation

Warning:
Experimental - may not be supported in the future. Flags influencing the configuration to be used or created.
Version:
1.3.0
Enumerator:
FLAG_NONE 

Unset all flags.

FLAG_MULTIPROCESS 

Auto-config: one node per pipe.

FLAG_MULTIPROCESS_DB 

one node per DB decomposition

Definition at line 38 of file configParams.h.


Constructor & Destructor Documentation

Construct new configuration parameters.

Version:
1.0

Destruct this configuration parameters.

Version:
1.0

Member Function Documentation

uint32_t eq::ConfigParams::getFlags ( ) const
Warning:
Experimental - may not be supported in the future.
Returns:
the configuration flags.
Version:
1.3
const std::string& eq::ConfigParams::getRenderClient ( ) const
Returns:
the name of the render client executable.
Version:
1.0
const std::string& eq::ConfigParams::getWorkDir ( ) const
Returns:
the directory from which to launch the render client.
Version:
1.0
void eq::ConfigParams::setFlags ( const uint32_t  flags)
Warning:
Experimental - may not be supported in the future. Set configuration flags.
Version:
1.3
void eq::ConfigParams::setRenderClient ( const std::string &  renderClient)

Set the name of the render client executable.

The default value is the program name retrieved from co::Global::getProgramName(), i.e., the filename part of argv[0].

Version:
1.0
void eq::ConfigParams::setWorkDir ( const std::string &  workDir)

Set the directory from which to launch the render client.

The default value is the program directory retrieved from co::Global::getWorkDir(), i.e., the directory part of the render client executable.

Version:
1.0

The documentation for this class was generated from the following file:
Generated on Mon Nov 26 2012 14:41:50 for Equalizer 1.4.1 by  doxygen 1.7.6.1