Simulation.Settings Class Reference

Public Member Functions
	Settings ()
void	Randomize ()
	Randomly select simulation parameters. More...

Public Attributes
string	title = "Simulation"
	The title of this simulation. More...
int	numberOfTests = 1
	The number of repeat tests with these parameters. More...
string	environmentName = "<none>"
	The filename of the environment to load. More...
string	navigationAssemblyName = "<none>"
	The filename of the navigation assembly to load. More...
string	robotName = "<none>"
	The filename of the robot to load. More...
bool	randomizeOrigin = false
	If true, robot starts each test at a random location in simulation bounds. More...
bool	randomizeDestination = false
	If true, destination starts each test at a random location in simulation bounds. More...
int	maximumTestTime = 60
	The maximum test time in seconds. More...
bool	continueOnNavObjectiveComplete = false
	If true, test ends when robot reaches the destination. More...
bool	continueOnRobotIsStuck = false
	If true, test ends when robot average position over time doesn't change enough. More...

Properties
bool	isValid [get]
	Gets a value indicating whether this Simulation.Settings is valid for simulating with. More...
bool	active [get, set]
	Gets or sets a value indicating whether this Simulation.Settings is active and determines which properties are editable in UI. More...
string	name [get]
string	fileName [get]
System.DateTime	datetime [get, private set]
string	date [get]
string	time [get]

Detailed Description

Definition at line 68 of file Simulation.cs.

Constructor & Destructor Documentation

Simulation.Settings.Settings

(

)

Definition at line 168 of file Simulation.cs.

                          {
            datetime = System.DateTime.Now;
        }

Member Function Documentation

void Simulation.Settings.Randomize

(

)

Randomly select simulation parameters.

Definition at line 175 of file Simulation.cs.

                                {
            title = "Random Settings";
            numberOfTests = 3;
            environmentName = EnvLoader.RandomEnvironmentName();
            robotName = BotLoader.RandomRobotName();
            navigationAssemblyName = NavLoader.RandomPluginName();
            randomizeDestination = true;
            continueOnNavObjectiveComplete = true;
            continueOnRobotIsStuck = true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool Simulation.Settings.continueOnNavObjectiveComplete = false

If true, test ends when robot reaches the destination.

Definition at line 116 of file Simulation.cs.

bool Simulation.Settings.continueOnRobotIsStuck = false

If true, test ends when robot average position over time doesn't change enough.

Definition at line 120 of file Simulation.cs.

string Simulation.Settings.environmentName = "<none>"

The filename of the environment to load.

Definition at line 85 of file Simulation.cs.

int Simulation.Settings.maximumTestTime = 60

The maximum test time in seconds.

Definition at line 112 of file Simulation.cs.

string Simulation.Settings.navigationAssemblyName = "<none>"

The filename of the navigation assembly to load.

Definition at line 89 of file Simulation.cs.

int Simulation.Settings.numberOfTests = 1

The number of repeat tests with these parameters.

Definition at line 78 of file Simulation.cs.

bool Simulation.Settings.randomizeDestination = false

If true, destination starts each test at a random location in simulation bounds.

Definition at line 105 of file Simulation.cs.

bool Simulation.Settings.randomizeOrigin = false

If true, robot starts each test at a random location in simulation bounds.

Definition at line 101 of file Simulation.cs.

string Simulation.Settings.robotName = "<none>"

The filename of the robot to load.

Definition at line 93 of file Simulation.cs.

string Simulation.Settings.title = "Simulation"

The title of this simulation.

Definition at line 73 of file Simulation.cs.

Property Documentation

bool Simulation.Settings.active

getset

Gets or sets a value indicating whether this Simulation.Settings is active and determines which properties are editable in UI.

true if active; otherwise, false.

Definition at line 143 of file Simulation.cs.

string Simulation.Settings.date

get

Definition at line 157 of file Simulation.cs.

System.DateTime Simulation.Settings.datetime

getprivate set

Definition at line 156 of file Simulation.cs.

string Simulation.Settings.fileName

get

Definition at line 150 of file Simulation.cs.

bool Simulation.Settings.isValid

get

Gets a value indicating whether this Simulation.Settings is valid for simulating with.

true if is valid; otherwise, false.

Definition at line 127 of file Simulation.cs.

string Simulation.Settings.name

get

Definition at line 145 of file Simulation.cs.

string Simulation.Settings.time

get

Definition at line 162 of file Simulation.cs.

---

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

• Assets/botnavsim/Scripts/Simulation.cs