Home
FAQ
Player
Utilities
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

WorldFile Class Reference

Class encapsulating the world file. More...

#include <WorldFile.hh>

List of all members.

Public Member Functions

 WorldFile ()
 Standard constructor.
 ~WorldFile ()
 Standard Destructor.
int Load (const char *filename)
 Load world from file.
int LoadString (const char *str)
 Load a world file from a string.
int Save (const char *filename)
 Save world back into file.
bool WarnUnused ()
 Print a warning message with unused nodes (if any).
WorldFileNodeGetRootNode () const
 Get the root node.

Public Attributes

char * filename
 File name.


Detailed Description

Class encapsulating the world file.


Constructor & Destructor Documentation

WorldFile::WorldFile  ) 
 

Standard constructor.

WorldFile::~WorldFile  ) 
 

Standard Destructor.


Member Function Documentation

int WorldFile::Load const char *  filename  ) 
 

Load world from file.

int WorldFile::LoadString const char *  str  ) 
 

Load a world file from a string.

int WorldFile::Save const char *  filename  ) 
 

Save world back into file.

Parameters:
filename Set to NULL to save back into the original file.

bool WorldFile::WarnUnused  ) 
 

Print a warning message with unused nodes (if any).

Returns:
Returns true if there are unused nodes.

WorldFileNode * WorldFile::GetRootNode  )  const
 

Get the root node.

For internal use only.


Member Data Documentation

char* WorldFile::filename
 

File name.


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


Last updated $Date: 2004/12/21 01:49:15 $
Generated on Sun May 22 18:39:09 2005 for Gazebo by doxygen 1.4.2