cad.simcad.objectserver.spec.sim
Interface SimObject

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

SimAmbulance

All Known Implementing Classes:

Ambulance, SimulatedObject

public interface SimObject

extends java.io.Serializable

This is the base interface for any object wishing to be simulated

Version:

1.0

Author:

Charles-Philip Bentley

Method Summary

double	getBoundingCircleRadius() This allows to ask the radius of the object bounding circle.
java.lang.String	getClassName() This method returns the object internal name.
PathPlace	getCurrentPathPlace() Return the PathPlace for this object Could be null
int	getHeight() Returns the Height the SimObject
int	getId() Returns the Identifying number of the SimObject
java.lang.String	getName() This method returns the object name.
java.lang.String	getObjectType() Return the Type of the SimObject
long	getSerialNumber() Every Object has a unique serial number
int	getStateId() Returns the state id of the SimObject Method that will be used by the simulation to recognize auxilliary state
int	getWidth() Returns the Width of the SimObject
void	setStateId(int i)
void	stopObject() Stop the object activity
void	takeTurn() This method returns the object name.

Method Detail

takeTurn

public void takeTurn()

This method returns the object name. Name used to be shown

Pre:

-

Returns:

a String object

Post:

-

getName

public java.lang.String getName()

This method returns the object name. Name used to be shown

Pre:

-

Returns:

a String object

Post:

-

getClassName

public java.lang.String getClassName()

This method returns the object internal name. Name never shown to users

Pre:

-

Returns:

a String object

Post:

-

getId

public int getId()

Returns the Identifying number of the SimObject

Pre:

ids are all positive

Returns:

a positive integer value

Post:

getSerialNumber

public long getSerialNumber()

Every Object has a unique serial number

getBoundingCircleRadius

public double getBoundingCircleRadius()

This allows to ask the radius of the object bounding circle.

Pre:

-

Returns:

a double value, the radius of the Bounding circle for this object

Post:

-

getHeight

public int getHeight()

Returns the Height the SimObject

Pre:

-

Returns:

a positive integer value

Post:

-

getWidth

public int getWidth()

Returns the Width of the SimObject

Pre:

-

Returns:

a positive integer value

Post:

-

getStateId

public int getStateId()

Returns the state id of the SimObject Method that will be used by the simulation to recognize auxilliary state

Pre:

-

Returns:

a positive integer value

Post:

- the id. describing the state. The user must be able to correctly interpret the integer value

setStateId

public void setStateId(int i)

getObjectType

public java.lang.String getObjectType()

Return the Type of the SimObject

Pre:

-

Returns:

A String describing the type of the SimObject (unit, structure)

Post:

-

getCurrentPathPlace

public PathPlace getCurrentPathPlace()

Return the PathPlace for this object Could be null

stopObject

public void stopObject()

Stop the object activity