Server Class Reference

#include <Server.hh>

Public Member Functions
	Server ()
	Constructor. More...
virtual	~Server ()
	Destructor. More...
void	Fini ()
	Finalize the Server. More...
bool	GetInitialized () const
	Get whether the Server has been initialized. More...
bool	LoadFile (const std::string &_filename="worlds/empty.world", const std::string &_physics="")
	Load a world file and optionally override physics engine type. More...
bool	LoadString (const std::string &_sdfString)
	Load the Server from an SDF string. More...
bool	ParseArgs (int _argc, char **_argv)
	Parse command line arguments. More...
bool	PreLoad ()
	Preload the server. More...
void	PrintUsage ()
	Output help about gzserver. More...
void	Run ()
	Run the Server. More...
void	SetParams (const common::StrStr_M &_params)
	Set the parameters. More...
void	Stop ()
	Stop the Server. More...

Constructor & Destructor Documentation

Server()

Server

(

)

Constructor.

~Server()

virtual ~Server ( )

virtual

Destructor.

Member Function Documentation

Fini()

void Fini

(

)

Finalize the Server.

GetInitialized()

bool GetInitialized

(

)

const

Get whether the Server has been initialized.

Returns

True if initialized.

LoadFile()

bool LoadFile	(	const std::string &	_filename = "worlds/empty.world",
		const std::string &	_physics = ""
	)

Load a world file and optionally override physics engine type.

Parameters

[in]	_filename	Name of the world file to load.
[in]	_physics	Physics engine type (ode|bullet|dart|simbody).

Returns

True on success.

LoadString()

bool LoadString

(

const std::string &

_sdfString

)

Load the Server from an SDF string.

Parameters

[in]

_sdfString

SDF string from which to load a World.

Returns

True on success.

ParseArgs()

bool ParseArgs	(	int	_argc,
		char **	_argv
	)

Parse command line arguments.

Parameters

[in]	_argc	Number of arguments.
[in]	_argv	Array of argument values.

Returns

True on success.

PreLoad()

bool PreLoad

(

)

Preload the server.

Returns

True if load was successful.

PrintUsage()

void PrintUsage

(

)

Output help about gzserver.

Run()

void Run

(

)

Run the Server.

SetParams()

void SetParams

(

const common::StrStr_M &

_params

)

Set the parameters.

Parameters

[in]

_params

Map of string parameters

Stop()

void Stop

(

)

Stop the Server.

---

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

• Server.hh