svs_simulation.agents.basic

Package svs_simulation :: Package agents :: Module basic_agents :: Class SimAgent

[show private | hide private]

Class SimAgent

        Entity --+            
                 |            
BasicSpatialEntity --+        
                     |        
         SpatialEntity --+    
                         |    
         SimAgentBaseClass --+
                             |
                            SimAgent

Known Subclasses:: MovingAgent

Basic class for agents with statemachine and task handling.

Method Summary
	`__init__(self)`
	`changeState(self, newState)` Changes current state in stateManager.
	`encode(self)` Returns encoded representation of self.
	`handleSimEvent(self, event)` Handles event from simulation.
	`setTask(self, taskClass)` Sets new task for agent.
	`startWorld(self, simTime)` Forwards `start` call from world.
	`stopWorld(self, simTime)` Forwards `stop` call from world.
	`updateWorld(self, simTime)` Forwards `update` call from world.
Inherited from SimAgentBaseClass
	`__str__(self)` Returns string representation of object.
	`containsPoint(self, x, y)` Tests if coordinates are contaiend within structure bounds.
	`decode(self, data)` Applies encoded data to self.
	`getBoundsMaxX(self)` Returns maximum x coordinate from bounds.
	`getBoundsMaxY(self)` Returns maximum y coordinate from bounds.
	`getBoundsMinX(self)` Returns minimum x coordinate from bounds.
	`getBoundsMinY(self)` Returns minimum y coordinate from bounds.
	`getName(self)` Returns name for structure.
	`getWorldbounds(self)` Returns the bounds of the structure as mapped to the world coordinates.
	`setup(self, name)`
Inherited from SpatialEntity
	`enterStructure(self, structure)` Called when entity enters a new structure.
	`enterWorld(self, world)` Called when entity is added to world.
	`exitStructure(self, structure)` Called when entity leaves an existing structure.
	`isOverPoint(self, x, y)` Tests if the given coordinates lie within the world bounds of the entity.
	`locateInWorld(self)`
	`setDimensions(self, dimX, dimY)`
	`setLocation(self, x, y)`
Inherited from Entity
	`enterPartition(self, partition)` Called when entity enters a partition.
	`exitPartition(self, partition)` Called when entity is leaves a structure.
	`exitWorld(self, simTime)` Called when structure is removed world.
boolean	`isTagged(self)` Returns tag state.
	`placeInWorld(self)` Sets the structure and partition that the entity is within.
	`reportChange(self, data)` Forwards data representing change in entity to process handler.