Helios++
Helios software for LiDAR simulations
HeliosDemos::SurveyDemo Class Reference

SurveyDemo class. More...

#include <SurveyDemo.h>

Inheritance diagram for HeliosDemos::SurveyDemo:
Collaboration diagram for HeliosDemos::SurveyDemo:

Public Member Functions

 SurveyDemo (string const name, string const surveyPath, string const assetsPath)
 Survey demo constructor. More...
 
bool validateSurveyPath ()
 Check whether the survey path points to an accessible file (true) or not (false) More...
 
bool validateAssetsPath ()
 Check whether the assets path points to an accessible directory (true) or not (false) More...
 
string const & getSurveyPath () const
 Get survey path. More...
 
void setSurveyPath (string const surveyPath)
 Set survey path. More...
 
string const & getAssetsPath () const
 Get assets path. More...
 
void setAssetsPath (string const assetsPath)
 Set assets path. More...
 

Protected Attributes

string surveyPath
 Path to the survey XML file.
 
string assetsPath
 Path to the assets directory.
 

Additional Inherited Members

- Private Member Functions inherited from HeliosDemos::BaseDemo
 BaseDemo (string const name)
 Base demo constructor. More...
 
string getName ()
 Obtain the demo name. More...
 
virtual void run ()=0
 Run the demo itself. More...
 
- Private Attributes inherited from HeliosDemos::BaseDemo
string const name
 The name for the demo.
 

Detailed Description

SurveyDemo class.

Author
Alberto M. Esmoris Pena
Version
1.0

Can be overridden to implement new demos which use a survey or some of its components (for instance, a scene)

NOTICE this is an abstract class which does not provides an implementation for the run method. In consequence, any class which extends SurveyDemo stills needing to provide an implementation of run method defining the demo behavior

Constructor & Destructor Documentation

◆ SurveyDemo()

HeliosDemos::SurveyDemo::SurveyDemo ( string const  name,
string const  surveyPath,
string const  assetsPath 
)
inline

Survey demo constructor.

Parameters
nameName for the demo
surveyPathPath to the survey XML file
See also
BaseDemo::BaseDemo(string const)
BaseDemo::name
SurveyDemo::surveyPath

Member Function Documentation

◆ getAssetsPath()

string const& HeliosDemos::SurveyDemo::getAssetsPath ( ) const
inline

Get assets path.

Returns
Assets path
See also
SurveyDemo::assetsPath

◆ getSurveyPath()

string const& HeliosDemos::SurveyDemo::getSurveyPath ( ) const
inline

Get survey path.

Returns
Survey path
See also
SurveyDemo::surveyPath

◆ setAssetsPath()

void HeliosDemos::SurveyDemo::setAssetsPath ( string const  assetsPath)
inline

Set assets path.

Parameters
assetsPathNew assets path
See also
SurveyDemo::assetsPath

◆ setSurveyPath()

void HeliosDemos::SurveyDemo::setSurveyPath ( string const  surveyPath)
inline

Set survey path.

Parameters
surveyPathNew survey path
See also
SurveyDemo::surveyPath

◆ validateAssetsPath()

bool SurveyDemo::validateAssetsPath ( )

Check whether the assets path points to an accessible directory (true) or not (false)

Returns
True if assets path points to an accessible directory, false otherwise

◆ validateSurveyPath()

bool SurveyDemo::validateSurveyPath ( )

Check whether the survey path points to an accessible file (true) or not (false)

Returns
True if the survey path points to an accessible file, false otherwise

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