Helios++
Helios software for LiDAR simulations
Survey Class Reference

Class representing a Helios++ survey. More...

#include <Survey.h>

Inheritance diagram for Survey:
Collaboration diagram for Survey:

Public Member Functions

 Survey ()=default
 Survey default constructor.
 
 Survey (Survey &survey)
 
void addLeg (int insertIndex, std::shared_ptr< Leg > leg)
 Add a leg to the survey at given index. More...
 
void removeLeg (int legIndex)
 Remove a leg from the survey. More...
 
void calculateLength ()
 Compute survey length (distance passing through all legs) More...
 
double getLength ()
 Obtain survey length (distance passing through all legs) More...
 
- Public Member Functions inherited from Asset
std::string getLocationString ()
 Obtain asset location string. More...
 

Public Attributes

std::string name = "Unnamed Survey Playback"
 Survey name.
 
int numRuns = -1
 Number of runs for the survey.
 
std::shared_ptr< Scannerscanner = nullptr
 Scanner used by the survey. More...
 
double simSpeedFactor = 1
 Simulation speed factor for the survey.
 
std::vector< std::shared_ptr< Leg > > legs
 All legs belonging to the survey. More...
 
- Public Attributes inherited from Asset
std::string id = ""
 Asset identifier.
 
std::string name = "Unnamed Asset"
 Asset name.
 
std::string sourceFilePath = ""
 Path to asset file.
 

Private Attributes

double length = 0
 Distance passing through all legs.
 

Detailed Description

Class representing a Helios++ survey.

Member Function Documentation

◆ addLeg()

void Survey::addLeg ( int  insertIndex,
std::shared_ptr< Leg leg 
)

Add a leg to the survey at given index.

Parameters
insertIndexIndex where the leg must be inserted
legLeg to be added to the survey
See also
Leg

◆ calculateLength()

void Survey::calculateLength ( )

Compute survey length (distance passing through all legs)

See also
Survey::length

◆ getLength()

double Survey::getLength ( )

Obtain survey length (distance passing through all legs)

Returns
Survey length
See also
Survey::length

◆ removeLeg()

void Survey::removeLeg ( int  legIndex)

Remove a leg from the survey.

Parameters
legIndexIndex of the leg to be removed from the survey
See also
Leg

Member Data Documentation

◆ legs

std::vector<std::shared_ptr<Leg> > Survey::legs

All legs belonging to the survey.

See also
Leg

◆ scanner

std::shared_ptr<Scanner> Survey::scanner = nullptr

Scanner used by the survey.

See also
Scanner

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