cad.simcad.objectserver.spec.sim
Interface SimObjectServer

All Known Implementing Classes:

ObjectProducer

public interface SimObjectServer

Interface towards a server of Simulate Objects

Author:

Charles-Philip Bentley

Method Summary

SimObject	createSimObject(java.lang.String name) Creates a new SimObject .
SimObject	createSimObject(java.lang.String name, Owner o, PathPlace pp) Creates a new SimObject .
java.lang.String[]	getAllSimObjects() Return all the names of SimObject the server knows about.
java.lang.String[]	getAllSimObjects(java.lang.String type) Return all the names of SimObject of a certain type the server knows about.
java.lang.String	getClassName(java.lang.String name) Get the ClassName of a given object from its name
int	getId(java.lang.String className) Returns the Id associated with the Class name className
java.lang.String	getName(int id) Returns the name associated with the id
java.lang.String	getName(java.lang.String className) Returns the name associated with the Class name className
SimEnvironment	getSimEnvironment() Returns SimEnvironment of the ObjectServer
java.lang.String[]	getSimObjectTypes() Return the types of SimObject the server knows about.

Method Detail

createSimObject

public SimObject createSimObject(java.lang.String name)

Creates a new SimObject .

Pre:

Name name is known by the ObjectServer

Returns:

the new SimObject. null if name is not known

Post:

A new instance of the SimObject corresponding to the name given in parameters is made and returned to the caller of the method Owner will be the default one and PathPlace will be null

createSimObject

public SimObject createSimObject(java.lang.String name,
                                 Owner o,
                                 PathPlace pp)

Creates a new SimObject .

Pre:

Name name is known by the ObjectServer

Returns:

the new SimObject. null if name is not known

Post:

A new instance of the SimObject corresponding to the name given in parameters is made and returned to the caller of the method Owner will be o, one and PathPlace will be pp

getAllSimObjects

public java.lang.String[] getAllSimObjects()

Return all the names of SimObject the server knows about.

Pre:

-

Returns:

an Array of SimObject

Post:

The Name to be shown to real users is returned

getAllSimObjects

public java.lang.String[] getAllSimObjects(java.lang.String type)

Return all the names of SimObject of a certain type the server knows about.

Pre:

-

Returns:

an Array of String

Post:

The Name to be shown to real users is returned

getSimObjectTypes

public java.lang.String[] getSimObjectTypes()

Return the types of SimObject the server knows about.

Pre:

-

Returns:

an Array of String

Post:

-

getId

public int getId(java.lang.String className)

Returns the Id associated with the Class name className

Pre:

-

Returns:

an integer value

Post:

getName

public java.lang.String getName(int id)

Returns the name associated with the id

Pre:

-

Returns:

a String.

Post:

the name of the SimObject associated with id is returned

getClassName

public java.lang.String getClassName(java.lang.String name)

Get the ClassName of a given object from its name

getName

public java.lang.String getName(java.lang.String className)

Returns the name associated with the Class name className

Pre:

-

Returns:

a String.

Post:

the name of the SimObject associated with className is returned

getSimEnvironment

public SimEnvironment getSimEnvironment()

Returns SimEnvironment of the ObjectServer

Pre:

-

Returns:

a SimEnvironment.

Post:

the SimEnvironment of the ObjectServer is returned