Public Types | Public Member Functions | List of all members
gazebo::gui::FinishBuildingDialog Class Reference

Dialog for saving the building model. More...

#include <FinishBuildingDialog.hh>

Inheritance diagram for gazebo::gui::FinishBuildingDialog:
Inheritance graph
[legend]

Public Types

enum  FinishMode { MODEL_FINISH, MODEL_SAVE }
 Unique identifiers for all dialog modes. More...
 

Public Member Functions

 FinishBuildingDialog (int _mode=0, QWidget *_parent=0)
 Constructor. More...
 
 ~FinishBuildingDialog ()
 Destructor. More...
 
std::string GetAuthorEmail () const
 Get the model's author's email. More...
 
std::string GetAuthorName () const
 Get the model's author's name. More...
 
std::string GetDescription () const
 Get the model's description. More...
 
std::string GetModelName () const
 Get the building model name. More...
 
std::string GetSaveLocation () const
 Get the save location. More...
 
std::string GetVersion () const
 Get the model's version. More...
 
void SetModelName (const std::string &_name)
 Set the building model name. More...
 
void SetSaveLocation (const std::string &_location)
 Set the save location. More...
 

Detailed Description

Dialog for saving the building model.

Member Enumeration Documentation

Unique identifiers for all dialog modes.

Enumerator
MODEL_FINISH 

Finish mode.

MODEL_SAVE 

Save mode.

Constructor & Destructor Documentation

gazebo::gui::FinishBuildingDialog::FinishBuildingDialog ( int  _mode = 0,
QWidget *  _parent = 0 
)

Constructor.

Parameters
[in]_modeMode of the dialog
[in]_parentParent QWidget.
gazebo::gui::FinishBuildingDialog::~FinishBuildingDialog ( )

Destructor.

Member Function Documentation

std::string gazebo::gui::FinishBuildingDialog::GetAuthorEmail ( ) const

Get the model's author's email.

Returns
The author's email.
std::string gazebo::gui::FinishBuildingDialog::GetAuthorName ( ) const

Get the model's author's name.

Returns
The author's name.
std::string gazebo::gui::FinishBuildingDialog::GetDescription ( ) const

Get the model's description.

Returns
The model's description.
std::string gazebo::gui::FinishBuildingDialog::GetModelName ( ) const

Get the building model name.

Returns
The model name.
std::string gazebo::gui::FinishBuildingDialog::GetSaveLocation ( ) const

Get the save location.

Returns
Path of the save location.
std::string gazebo::gui::FinishBuildingDialog::GetVersion ( ) const

Get the model's version.

Returns
The model's version.
void gazebo::gui::FinishBuildingDialog::SetModelName ( const std::string &  _name)

Set the building model name.

Parameters
[in]_nameName to set the model to.
void gazebo::gui::FinishBuildingDialog::SetSaveLocation ( const std::string &  _location)

Set the save location.

Parameters
[in]_locationLocation to save to.

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