BotNavSim  v0.4.3
Mobile Robot Simulation
Public Types | Properties | Static Private Member Functions | Static Private Attributes | List of all members
BotNavSim Class Reference

BotNavSim high-level manager class. Holds BotNavSim.State and controls state transition behaviour. More...

Public Types

enum  State {
  State.Idle, State.Simulating, State.ViewingData, State.EditingRobot,
  State.EditingEnvironment
}
 

Properties

static State state [get, set]
 Gets or sets the state. More...
 
static bool isIdle [get]
 Gets a value indicating whether BotNavSim is idle. More...
 
static bool isSimulating [get]
 Gets a value indicating whether BotNavSim is simulating. More...
 
static bool isViewingData [get]
 Gets a value indicating whether BotNavSim is viewing data. More...
 
static bool isEditingRobot [get]
 Gets a value indicating whether this BotNavSim is editing robot. More...
 
static bool isEditingEnvironment [get]
 Gets a value indicating whether this BotNavSim is editing environment. More...
 

Static Private Member Functions

static BotNavSim ()
 
static void ChangeState (State newState)
 

Static Private Attributes

static State _state
 

Detailed Description

BotNavSim high-level manager class. Holds BotNavSim.State and controls state transition behaviour.

Definition at line 7 of file BotNavSim.cs.

Member Enumeration Documentation

enum BotNavSim.State
Enumerator
Idle 

Idle state - no particular functionality in operation.

Simulating 

Program is running a simulation. Functionality managed by Simulation class.

ViewingData 

Program is displaying BotPath data loaded from CSV. Functionality is managed by DataPlayback class.

EditingRobot 

Program is editing a robot. Functionality is managed by RobotCreator class.

EditingEnvironment 

Program is editing an environment. Functionality is managed by EnvironmentEditor class.

Definition at line 13 of file BotNavSim.cs.

13  {
17  Idle,
18 
22  Simulating,
23 
27  ViewingData,
28 
32  EditingRobot,
33 
37  EditingEnvironment
38  }
BotNavSim.Simulating
Program is running a simulation. Functionality managed by Simulation class.
BotNavSim.ViewingData
Program is displaying BotPath data loaded from CSV. Functionality is managed by DataPlayback class...
BotNavSim.Idle
Idle state - no particular functionality in operation.
BotNavSim.EditingEnvironment
Program is editing an environment. Functionality is managed by EnvironmentEditor class.
BotNavSim.EditingRobot
Program is editing a robot. Functionality is managed by RobotCreator class.

Constructor & Destructor Documentation

static BotNavSim.BotNavSim ( )
staticprivate

Definition at line 9 of file BotNavSim.cs.

9  {
10  _state = State.Idle;
11  }
BotNavSim._state
static State _state
Definition: BotNavSim.cs:104

Member Function Documentation

static void BotNavSim.ChangeState ( State  newState)
staticprivate

Definition at line 106 of file BotNavSim.cs.

106  {
107  // exit old state behaviour
108  switch (_state) {
109  case State.Idle:
110  break;
111  case State.Simulating:
112  Simulation.Exit();
113  break;
114  case State.ViewingData:
115  LogLoader.Exit();
116  break;
117  case State.EditingRobot:
118  break;
119  case State.EditingEnvironment:
120  break;
121  }
122 
123  _state = newState;
124  // enter new state behaviour
125  switch (newState) {
126  case State.Idle:
127  break;
128  case State.Simulating:
129  Simulation.Enter();
130  break;
131  case State.ViewingData:
132  LogLoader.Enter();
133  break;
134  case State.EditingRobot:
135  break;
136  case State.EditingEnvironment:
137  break;
138  }
139 
140  Debug.Log("BotNavSim: " + state.ToString());
141  }
BotNavSim._state
static State _state
Definition: BotNavSim.cs:104
LogLoader.Enter
static void Enter()
Enter this BotNavSim state: setup camera views
Definition: LogLoader.cs:64
Simulation.Exit
static void Exit()
Exit simulation.
Definition: Simulation.cs:536
LogLoader
Log loader high level BotNavSim state manager
Definition: LogLoader.cs:10
Simulation.Enter
static void Enter()
Enter this instance.
Definition: Simulation.cs:401
Simulation
This is a manager class used to overlook the running of a simulation.
Definition: Simulation.cs:8
BotNavSim.state
static State state
Gets or sets the state.
Definition: BotNavSim.cs:45
LogLoader.Exit
static void Exit()
Exit BotNavSim.state behaviour: remove environment, clear paths
Definition: LogLoader.cs:73

Here is the call graph for this function:

Member Data Documentation

State BotNavSim._state
staticprivate

Definition at line 104 of file BotNavSim.cs.

Property Documentation

bool BotNavSim.isEditingEnvironment
staticget

Gets a value indicating whether this BotNavSim is editing environment.

true if is editing environment; otherwise, false.

Definition at line 98 of file BotNavSim.cs.

bool BotNavSim.isEditingRobot
staticget

Gets a value indicating whether this BotNavSim is editing robot.

true if is editing robot; otherwise, false.

Definition at line 88 of file BotNavSim.cs.

bool BotNavSim.isIdle
staticget

Gets a value indicating whether BotNavSim is idle.

true if is idle; otherwise, false.

Definition at line 58 of file BotNavSim.cs.

bool BotNavSim.isSimulating
staticget

Gets a value indicating whether BotNavSim is simulating.

true if is simulating; otherwise, false.

Definition at line 68 of file BotNavSim.cs.

bool BotNavSim.isViewingData
staticget

Gets a value indicating whether BotNavSim is viewing data.

true if is viewing data; otherwise, false.

Definition at line 78 of file BotNavSim.cs.

State BotNavSim.state
staticgetset

Gets or sets the state.

Definition at line 45 of file BotNavSim.cs.

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