Rover group header file.

Go down

Rover group header file.

Post  making on Mon Jan 26, 2009 10:59 pm

Here is our current header file, draft. If we update this later I will post the update here.


//File: Rover.h
//Purpose: Provides the interface to execute commands on the robot
//Author: Michael King, Brittney Harris, Allan Hoffman, Dustin Evans
//Last modified: 1/26/09

//public class Rover {
//Returns true if able to execute the action
public bool moveOffset(int );
public bool turnOffset(int );

public bool moveCoord(vector );
public bool turnGlobal(float );

//Returns True if bot is occupied with an action
public bool isAction();

//Used to stop and restart all actions on the rover
public void killActions();
public void unkillActions();

//Depending on interfacing with the communications group
public void recieveCommand();
//}
avatar
making

Posts : 35
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  making on Fri Jan 30, 2009 1:27 pm

Sorry for taking so long to post the finalized header file. When i got to the appartment last night i found out our cable and internet had been knocked out... It still isn't up Sad. I hope this doesn't throw us off schedule.

//File: Rover.h
//Purpose: Provides the interface to execute commands on the robot
//Author: Michael King, Brittney Harris, Allan Hoffman, Dustin Evans
//Last modified: 1/30/09

class Rover {
public:

//Moves forward at a constant speed, one tick.
//Returns true if command was executed
bool moveForward();

//Moves backwards at a constant speed, one tick.
//Returns true if command was executed
bool moveBackward();

//Turns left at a constant speed, one tick.
//Returns true if command was executed
bool turnLeft();

//Turns right at a constant speed, one tick.
//Returns true if command was executed
bool turnRight();

//Global Turn and move actions, based on 2D coordinate system
bool moveCoord(vector );
bool turnCoord(float );

//Returns True if bot is occupied with an action
bool isAction();

//Used to stop and restart all actions on the rover
void killActions();
void unkillActions();

//Queues a command, for action, recieved from the communication group
void recieveCommand();

private:
//Returns true if able to execute the action
bool moveOffset(int );
bool turnOffset(int );
}
avatar
making

Posts : 35
Join date : 2009-01-08

View user profile

Back to top Go down

An UML example

Post  Dustin on Fri Jan 30, 2009 11:46 pm

Here is a link to a website demonstrating a simple example of UML:

http://www.geocities.com/siliconvalley/network/1582/uml-example.htm
avatar
Dustin

Posts : 17
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  dsmarsh on Mon Feb 02, 2009 12:50 am

//Global Turn and move actions, based on 2D coordinate system
bool moveCoord(vector );
bool turnCoord(float );

I dont think the gui knows about all these functions. You all should get with them and let them know you want to implement these other functions.

-Comm Group
avatar
dsmarsh

Posts : 54
Join date : 2009-01-08
Age : 32

View user profile

Back to top Go down

Re: Rover group header file.

Post  rbontre on Mon Feb 02, 2009 2:59 pm

dsmarsh wrote:
//Global Turn and move actions, based on 2D coordinate system
bool moveCoord(vector );
bool turnCoord(float );

I dont think the gui knows about all these functions. You all should get with them and let them know you want to implement these other functions.

-Comm Group
a "move to coordinates" is not going to be practical. There is no way we would have to establish a coordinate system, and then to be able to move based on that.

_________________
- Ryan Bontreger
rbontre@clemson.edu
Webpage / GUI
avatar
rbontre

Posts : 59
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  making on Mon Feb 02, 2009 7:49 pm

The global move and turn functions are not for the comm group, or gui group. They are for us incase we have time to implement autoplay, and are entirely optional at this point. You guys should not worry about those functions.
avatar
making

Posts : 35
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  dsmarsh on Tue Feb 03, 2009 2:15 pm

--API for comm to rover group--
Code:
/*
ECE 453 - Spring 2009
Communication group
Rover API
Describes the application programming interface between the communication
group and rover movement applications.
*/

//This is the API the rover is using since it will be all in the same header file.
//We just call the functions

//Moves forward at a constant speed, one tick.
//Returns true if command was executed
bool moveForward();

//Moves backwards at a constant speed, one tick.
//Returns true if command was executed
bool moveBackward();

//Turns left at a constant speed, one tick.
//Returns true if command was executed
bool turnLeft();

//Turns right at a constant speed, one tick.
//Returns true if command was executed
bool turnRight();


Let me know if these are the commands that you want from the gui, if you need more let me know and we can discuss them.
avatar
dsmarsh

Posts : 54
Join date : 2009-01-08
Age : 32

View user profile

Back to top Go down

Re: Rover group header file.

Post  making on Tue Feb 03, 2009 2:43 pm

You guys are going to want to have the kill and unkill commands incase you want to stop the robot and restart him remotly. From running into a wall or stopping movement after a dart hit.
avatar
making

Posts : 35
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  dsmarsh on Tue Feb 03, 2009 7:24 pm

making wrote:You guys are going to want to have the kill and unkill commands incase you want to stop the robot and restart him remotly. From running into a wall or stopping movement after a dart hit.

That is fine but we dont call these things, the gui group calls them and these thing are not in the gui groups API with us
Thus they will never be called.
avatar
dsmarsh

Posts : 54
Join date : 2009-01-08
Age : 32

View user profile

Back to top Go down

Re: Rover group header file.

Post  making on Wed Feb 04, 2009 6:27 pm

Here is our final header file. NOTE: the initialize and uninitialize commands may or may not need to be called by the gui/comm group to start and shutdown the robots.

Code:
//File: Rover.h
//Purpose: Provides the interface to execute commands on the robot
//Author: Michael King, Brittney Harris, Allan Hoffman, Dustin Evans
//Last modified: 1/30/09

class Rover {
   public:

   //Initializes the robot to prepare to move. Needs to be called only once.
   void initialize();

   //Unititalizes the robot to prepare to shut down. Needs to be called only once.
   void uninitialize();

   //Moves forward at a constant speed, one tick.
   //Returns true if command was executed
   bool moveForward();

   //Moves backwards at a constant speed, one tick.
   //Returns true if command was executed
   bool moveBackward();

   //Turns left at a constant speed, one tick.
   //Returns true if command was executed
   bool turnLeft();
   
   //Turns right at a constant speed, one tick.
   //Returns true if command was executed
   bool turnRight();
   
   //Global Turn and move actions, based on 2D    coordinate system
   bool moveCoord(vector );
   bool turnCoord(float );
   
   //Returns True if bot is occupied with an action
   bool isAction();
   
   //Used to stop and restart all actions on the rover
   void killActions();
   void unkillActions();
   
   //Queues a command, for action, recieved from the communication group
   void recieveCommand();

   private:
   //Returns true if able to execute the action
   bool moveOffset(int );
   bool turnOffset(int );
}
avatar
making

Posts : 35
Join date : 2009-01-08

View user profile

Back to top Go down

Re: Rover group header file.

Post  seanc on Wed Feb 04, 2009 9:11 pm

Michael after talking to the comm group I understand this is a good headfile, but we need an API, just what we are calling

mainly we need

moveforward
movebackward
moveleft
moreright
stopmove

i think that is basically what we need from you....
your header file is convoluted and confusing for us...

_________________
Sean Cavanaugh
seanc@clemson.edu
avatar
seanc

Posts : 30
Join date : 2009-01-07
Age : 32
Location : Clemson,SC

View user profile http://people.clemson.edu/~seanc

Back to top Go down

Re: Rover group header file.

Post  dsmarsh on Wed Feb 04, 2009 9:15 pm

seanc wrote:Michael after talking to the comm group I understand this is a good headfile, but we need an API, just what we are calling

mainly we need

moveforward
movebackward
moveleft
moreright
stopmove

i think that is basically what we need from you....
your header file is convoluted and confusing for us...


I agree
this is your api with the comm group:
Code:
class Rover {
  public:
  //Moves forward at a constant speed, one tick.
  //Returns true if command was executed
  bool moveForward();

  //Moves backwards at a constant speed, one tick.
  //Returns true if command was executed
  bool moveBackward();

  //Turns left at a constant speed, one tick.
  //Returns true if command was executed
  bool turnLeft();
 
  //Turns right at a constant speed, one tick.
  //Returns true if command was executed
  bool turnRight();

  //stops any current movement
  //Returns true if command was executed
  bool stopMoving();
}

_________________
David Marshall
(803) 707-3466
dsmarsh@clemson.edu
Comm Group Leader
avatar
dsmarsh

Posts : 54
Join date : 2009-01-08
Age : 32

View user profile

Back to top Go down

Re: Rover group header file.

Post  Sponsored content


Sponsored content


Back to top Go down

Back to top

- Similar topics

 
Permissions in this forum:
You cannot reply to topics in this forum