Server Class Reference

#include <Server.hh>

Public Member Functions

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

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]_filenameName of the world file to load.
[in]_physicsPhysics 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]_sdfStringSDF string from which to load a World.
Returns
True on success.

◆ ParseArgs()

bool ParseArgs ( int _argc,
char ** _argv )

Parse command line arguments.

Parameters
[in]_argcNumber of arguments.
[in]_argvArray 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]_paramsMap of string parameters

◆ Stop()

void Stop ( )

Stop the Server.


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