Package svs_simulation :: Package agents :: Module basic_agents :: Class SimAgentBaseClass
[show private | hide private]
[frames | no frames]

Class SimAgentBaseClass

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

Known Subclasses:
SimAgent, SimAgentProxy

Base class with common properties an dmethids used by SimAgent and SimAgentProxy.
Method Summary
  __init__(self)
  __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.
  handleSimEvent(self, event)
Handles event from simulation.
  setup(self, name)
  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 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 BasicSpatialEntity
  encode(self)
Returns encoded representation of self.
    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.

Method Details

__str__(self)
(Informal representation operator)

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.
Overrides:
svs_simulation.entities.base_entities.BasicSpatialEntity.decode

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. If the structure has no name returns its idtag.
Overrides:
svs_simulation.entities.base_entities.Entity.getName

getWorldbounds(self)

Returns the bounds of the structure as mapped to the world coordinates.

handleSimEvent(self, event)

Handles event from simulation.
Overrides:
svs_simulation.entities.base_entities.Entity.handleSimEvent

startWorld(self, simTime)

Forwards start call from world.
Overrides:
svs_simulation.entities.base_entities.Entity.startWorld

stopWorld(self, simTime)

Forwards stop call from world.
Overrides:
svs_simulation.entities.base_entities.Entity.stopWorld

updateWorld(self, simTime)

Forwards update call from world.
Overrides:
svs_simulation.entities.base_entities.Entity.updateWorld

Generated by Epydoc 2.1 on Thu Oct 20 15:30:26 2005 http://epydoc.sf.net