eq::fabric::ConfigParams Class Reference

Parameters for running a configuration. More...

#include <configParams.h>

Collaboration diagram for eq::fabric::ConfigParams:

Public Types
enum	Flags {   FLAG_NONE = LB_BIT_NONE, FLAG_MULTIPROCESS = LB_BIT1, FLAG_MULTIPROCESS_DB = LB_BIT2, FLAG_NETWORK_ETHERNET = LB_BIT3,   FLAG_NETWORK_INFINIBAND = LB_BIT4, FLAG_LOAD_EQ_HORIZONTAL = LB_BIT5, FLAG_LOAD_EQ_VERTICAL = LB_BIT6, FLAG_LOAD_EQ_2D = LB_BIT7,   FLAG_LOAD_EQ_ALL, FLAG_NETWORK_ALL = FLAG_NETWORK_ETHERNET | FLAG_NETWORK_INFINIBAND }

Public Member Functions
EQFABRIC_API	ConfigParams ()
	Construct new configuration parameters. More...
EQFABRIC_API	~ConfigParams ()
	Destruct this configuration parameters. More...
EQFABRIC_API	ConfigParams (const ConfigParams &rhs)
EQFABRIC_API ConfigParams &	operator= (const ConfigParams &rhs)
EQFABRIC_API void	serialize (co::DataOStream &os) const
EQFABRIC_API void	deserialize (co::DataIStream &is)
Data Access.
EQFABRIC_API void	setName (const std::string &name)
	Set the name of the configuration. More...
EQFABRIC_API const std::string &	getName () const
EQFABRIC_API void	setRenderClient (const std::string &renderClient)
	Set the name of the render client executable. More...
EQFABRIC_API const std::string &	getRenderClient () const
EQFABRIC_API void	setRenderClientArgs (const Strings &args)
	Set the command line arguments for the render client executable. More...
EQFABRIC_API const Strings &	getRenderClientArgs () const
EQFABRIC_API void	setRenderClientEnvPrefixes (const Strings &prefixes)
	Set the prefixes of the environmental variables to pass on clients. More...
EQFABRIC_API const Strings &	getRenderClientEnvPrefixes () const
EQFABRIC_API void	setWorkDir (const std::string &workDir)
	Set the directory from which to launch the render client. More...
EQFABRIC_API const std::string &	getWorkDir () const
EQFABRIC_API void	setFlags (const uint32_t flags)
EQFABRIC_API uint32_t	getFlags () const
EQFABRIC_API const Equalizer &	getEqualizer () const
EQFABRIC_API Equalizer &	getEqualizer ()
EQFABRIC_API void	setPrefixes (const Strings &prefixes)
	Set a list of network prefixes in CIDR notation for autoconfig network interface filtering. More...
EQFABRIC_API const Strings &	getPrefixes () const
EQFABRIC_API void	setGPUFilter (const std::string &regex)
	Set a regex filter matching to 'nodename:display.port'.
EQFABRIC_API const std::string &	getGPUFilter () const

Detailed Description

Parameters for running a configuration.

See also

Server::chooseConfig()

Definition at line 36 of file configParams.h.

Member Enumeration Documentation

enum eq::fabric::ConfigParams::Flags

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
FLAG_NETWORK_ETHERNET	Auto-config: use ethernet only.
FLAG_NETWORK_INFINIBAND	Auto-config: use IB only.
FLAG_LOAD_EQ_HORIZONTAL	Auto-config: horizontal partition for load equalizer.
FLAG_LOAD_EQ_VERTICAL	Auto-config: vertical partition for load equalizer.
FLAG_LOAD_EQ_2D	Auto-config: 2D partition for load equalizer.

Definition at line 44 of file configParams.h.

Constructor & Destructor Documentation

EQFABRIC_API eq::fabric::ConfigParams::ConfigParams

(

)

Construct new configuration parameters.

Version

1.0

EQFABRIC_API eq::fabric::ConfigParams::~ConfigParams

(

)

Destruct this configuration parameters.

Version

1.0

Member Function Documentation

EQFABRIC_API const Equalizer& eq::fabric::ConfigParams::getEqualizer

(

)

const

Returns

read-access to Equalizer properties.

Version

1.5.1

EQFABRIC_API Equalizer& eq::fabric::ConfigParams::getEqualizer

(

)

Returns

write-access to Equalizer properties.

Version

1.5.1

EQFABRIC_API uint32_t eq::fabric::ConfigParams::getFlags

(

)

const

Warning

Experimental - may not be supported in the future.

Returns

the configuration flags.

Version

1.3

EQFABRIC_API const std::string& eq::fabric::ConfigParams::getGPUFilter

(

)

const

Returns

the GPU regex filter.

EQFABRIC_API const std::string& eq::fabric::ConfigParams::getName

(

)

const

Returns

the name of the configuration.

Version

1.10

EQFABRIC_API const Strings& eq::fabric::ConfigParams::getPrefixes

(

)

const

Returns

network prefixes in CIDR notation.

Version

1.5.1

EQFABRIC_API const std::string& eq::fabric::ConfigParams::getRenderClient

(

)

const

Returns

the name of the render client executable.

Version

1.0

EQFABRIC_API const Strings& eq::fabric::ConfigParams::getRenderClientArgs

(

)

const

Returns

the render client command line arguments

EQFABRIC_API const Strings& eq::fabric::ConfigParams::getRenderClientEnvPrefixes

(

)

const

Returns

prefixes of the environmental variables to pass on clients.

EQFABRIC_API const std::string& eq::fabric::ConfigParams::getWorkDir

(

)

const

Returns

the directory from which to launch the render client.

Version

1.0

EQFABRIC_API void eq::fabric::ConfigParams::setFlags

(

const uint32_t

flags

)

Warning

Experimental - may not be supported in the future. Set configuration flags.

Version

1.3

EQFABRIC_API void eq::fabric::ConfigParams::setName

(

const std::string &

name

)

Set the name of the configuration.

Version

1.10

EQFABRIC_API void eq::fabric::ConfigParams::setPrefixes

(

const Strings &

prefixes

)

Set a list of network prefixes in CIDR notation for autoconfig network interface filtering.

Version

1.5.1

EQFABRIC_API void eq::fabric::ConfigParams::setRenderClient

(

const std::string &

renderClient

)

Set the name of the render client executable.

If no render client is provided, eq::Server::chooseConfig() uses the program name retrieved from eq::Global::getProgramName(), i.e., the filename part of argv[0].

Version

1.0

EQFABRIC_API void eq::fabric::ConfigParams::setRenderClientArgs

(

const Strings &

args

)

Set the command line arguments for the render client executable.

If no arguments are provided, eq::Server::chooseConfig() uses co::LocalNode::getCommandLine().

EQFABRIC_API void eq::fabric::ConfigParams::setRenderClientEnvPrefixes

(

const Strings &

prefixes

)

Set the prefixes of the environmental variables to pass on clients.

EQFABRIC_API void eq::fabric::ConfigParams::setWorkDir

(

const std::string &

workDir

)

Set the directory from which to launch the render client.

If no working directory is provided, eq::Server::chooseConfig() uses eq::Global::getWorkDir(), i.e., the current working directory.

Version

1.0

---

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

• configParams.h