Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Entity Class Reference

An entity is an object that exists in a workspace, such as a robot, or roadmap. More...

#include <Simulation/entity.h>

Inheritance diagram for Entity:

Arbitrator Path List of all members.

Public Member Functions

 Entity ()
 default constructor... doesn't do anything

Static Public Member Functions

static void SetWorkspace (Workspace *w)
 simply sets the workspace handle
static void SetIO (IO_Window *i)
 Sets the IO window this entity is tied too.

Static Protected Attributes

static Workspace * workspace = NULL
 handle for the workspace
static IO_Windowio = NULL
 handle for the io window

Detailed Description

An entity is an object that exists in a workspace, such as a robot, or roadmap.

This is used to facilitate the access to global data such as the workspace; can be extended to access other global data. Typically, the Simulation object calls Entity's member functions.

Basically, we if want to create something that needs access to global data, derive it from here.


Member Function Documentation

static void Entity::SetIO IO_Window i  )  [inline, static]
 

Sets the IO window this entity is tied too.

Parameters:
i,: The io window we want to tie this entity too.

static void Entity::SetWorkspace Workspace *  w  )  [inline, static]
 

simply sets the workspace handle

Parameters:
w,: the workspace to use


The documentation for this class was generated from the following files:
Generated on Fri Jan 12 14:15:02 2007 for Construct by  doxygen 1.4.3-20050530