Package svs_simulation :: Package terrain :: Module special_areas :: Class SimDataArea
[show private | hide private]
[frames | no frames]

Class SimDataArea

        Entity --+            
                 |            
BasicSpatialEntity --+        
                     |        
         SpatialEntity --+    
                         |    
               GenericArea --+
                             |
                            SimDataArea


Area that contains simulation data.
Method Summary
  __init__(self)
  collect(self, request, agent)
Responds to agent collecting data from area.
  decode(self, data)
Decodes data and applies it to self.
  deposit(self, data, agent)
Responds to agent placing data in area.
dict encode(self)
Returns encoded representation of self.
  inspect(self, request, agent)
Responds to agent requesting data from area.
  setup(self, idtag, name, simdata)
    Inherited from GenericArea
  __str__(self)
Returns string representation of structure.
  containsPoint(self, x, y)
Tests if coordinates are contaiend within structure bounds.
  enter(self, agent)
Responds to agent entering area.
  enterPartition(self, partition)
Called when structure is added to a partition.
  exit(self, agent)
Responds to agent leaving area.
  exitPartition(self, partition)
Called when structure is removed from a partition.
  getName(self)
Returns name for structure.
  setFloorplane(self, floorplane)
Sets floorplane and adjust bounds to contain it.
    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
  exitWorld(self, simTime)
Called when structure is removed world.
  handleSimEvent(self, event)
Handles event form simulation.
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.
  startWorld(self, simTime)
Called when the simulation world starts running, or if an entity has been added to a world after it has started.
  stopWorld(self, simTime)
Called when the simulation world stops running, or if an entity has been removed from a world after it has started.
  updateWorld(self, simTime)
Called when the simulation world updates.

Method Details

collect(self, request=None, agent=None)

Responds to agent collecting data from area.

decode(self, data)

Decodes data and applies it to self.
Overrides:
svs_simulation.terrain.special_areas.GenericArea.decode

deposit(self, data, agent=None)

Responds to agent placing data in area.

encode(self)

Returns encoded representation of self.
Returns:
dict
Overrides:
svs_simulation.terrain.special_areas.GenericArea.encode

inspect(self, request=None, agent=None)

Responds to agent requesting data from area.

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