Package com.uppaal.engine

Interface Protocol

All Known Implementing Classes:

DotProtocol, KeyValueProtocol

public interface Protocol

Method Summary

Modifier and Type	Method	Description
void	close()	Disconnect from the server.
ConcreteState	getConcreteInitial(UppaalSystem system)	Returns the concrete initial state for the system.
ConcreteSuccessor	getConcreteSuccessor(UppaalSystem system, ConcreteState state, SystemEdgeSelect[] edges, java.math.BigDecimal currentTime, java.math.BigDecimal delay)	Get the concrete simulation successor
GanttChart	getGanttChart(UppaalSystem system, java.math.BigDecimal globalTime)	Get the gantt chart
java.lang.String	getOptionsInfo()	Returns information about available options.
SymbolicState	getSymbolicInitial(UppaalSystem system)	Returns the symbolic initial state for the system.
java.util.ArrayList<SymbolicTransition>	getTransitions(UppaalSystem system, SymbolicState state)	Returns the list of outgoing transitions for the state.
java.lang.String	getVersion()	Returns the version string of the server.
QueryResult	query(UppaalSystem system, Query query, QueryFeedback f)	Verify a query on an instantiated UPPAAL model.
QueryResult	query(UppaalSystem system, SymbolicState state, Query query, QueryFeedback f)	Verify a query on an instantiated UPPAAL model with custom initial state.
void	setOptions(java.lang.String options)	Sets server options used for verification.
UppaalSystem	upload(Document document)	Upload the document to the server.
UppaalSystem	upload(Document document, java.util.ArrayList<Problem> problems)	Upload the document to the server.
LscProcess	uploadLsc(Document document, java.util.ArrayList<Problem> problems)

Method Detail

close

void close()
    throws java.io.IOException

Disconnect from the server.

Throws:

java.io.IOException - engine crash or problem in communication.

getVersion

java.lang.String getVersion()
                     throws java.io.IOException,
                            EngineException

Returns the version string of the server. The stub must be connected.

Returns:

The version

Throws:

java.io.IOException - engine crash or problem in communication.

EngineException - problem in the Uppaal engine.

getOptionsInfo

java.lang.String getOptionsInfo()
                         throws EngineException,
                                java.io.IOException

Returns information about available options. The information is returned as an XML document. The stub must be connected.

Returns:

The options information

Throws:

java.io.IOException - engine crash or problem in communication.

EngineException - problem in the Uppaal engine.

setOptions

void setOptions(java.lang.String options)
         throws EngineException,
                java.io.IOException

Sets server options used for verification. The stub must be connected. TODO: Document format.

Parameters:

options - - The options string

Throws:

java.io.IOException - engine crash or problem in communication.

EngineException - problem in the Uppaal engine.

getSymbolicInitial

SymbolicState getSymbolicInitial(UppaalSystem system)
                          throws EngineException,
                                 java.io.IOException,
                                 CannotEvaluateException

Returns the symbolic initial state for the system. The stub must be connected and the system must be the last one uploaded to the server.

Parameters:

system - the compiled Uppaal system representation.

Returns:

initial symbolic state.

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

CannotEvaluateException - some expression could not be evaluated.

getConcreteInitial

ConcreteState getConcreteInitial(UppaalSystem system)
                          throws EngineException,
                                 java.io.IOException,
                                 CannotEvaluateException

Returns the concrete initial state for the system. The stub must be connected and the system must be the last one uploaded to the server.

Parameters:

system - the compiled Uppaal system representation.

Returns:

initial concrete state

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

CannotEvaluateException - some expression could not be evaluated.

getConcreteSuccessor

ConcreteSuccessor getConcreteSuccessor(UppaalSystem system,
                                       ConcreteState state,
                                       SystemEdgeSelect[] edges,
                                       java.math.BigDecimal currentTime,
                                       java.math.BigDecimal delay)
                                throws EngineException,
                                       java.io.IOException,
                                       CannotEvaluateException

Get the concrete simulation successor

Parameters:

system - - The uppaal system

state - - The concrete simulator state

edges - - The vector of the selected system edges

currentTime - - the current simulation time

delay - - The delay time

Returns:

concrete successor object

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

CannotEvaluateException - some expression could not be evaluated.

getGanttChart

GanttChart getGanttChart(UppaalSystem system,
                         java.math.BigDecimal globalTime)
                  throws EngineException,
                         java.io.IOException

Get the gantt chart

Parameters:

system - - The uppaal system

globalTime - - The global time

Returns:

The gantt chart object

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

getTransitions

java.util.ArrayList<SymbolicTransition> getTransitions(UppaalSystem system,
                                                       SymbolicState state)
                                                throws EngineException,
                                                       java.io.IOException,
                                                       CannotEvaluateException

Returns the list of outgoing transitions for the state. The stub must be connected, the state must belong to the system, and the system must be the last one uploaded to the server.

Parameters:

system - - The uppaal system

state - - The symbolic state of the system

Returns:

The array list of the symbolic transition

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

CannotEvaluateException - some expression could not be evaluated.

upload

UppaalSystem upload(Document document,
                    java.util.ArrayList<Problem> problems)
             throws EngineException,
                    java.io.IOException

Upload the document to the server. If no errors occurred, the instantiated system is returned. Otherwise, null is returned and error reports are stored in the problems vector. Even if no errors occurred, warnings may have been added to the problems vector. The stub must be connected.

Parameters:

document - - The system document

problems - - The problem array list

Returns:

the compiled system representation

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

uploadLsc

LscProcess uploadLsc(Document document,
                     java.util.ArrayList<Problem> problems)
              throws EngineException,
                     java.io.IOException

Throws:

EngineException

java.io.IOException

upload

UppaalSystem upload(Document document)
             throws EngineException,
                    java.io.IOException

Upload the document to the server. If no errors occurred, the instantiated system is returned. Otherwise, null is returned. The stub must be connected.

Parameters:

document - - The system document

Returns:

The Uppaal system

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

query

QueryResult query(UppaalSystem system,
                  Query query,
                  QueryFeedback f)
           throws EngineException,
                  java.io.IOException

Verify a query on an instantiated UPPAAL model. Returns 'T' if property is satisfied, 'F' if it is not satisfied, 'M' if it is maybe satisfied, and 'E' if an error occurred. Progress feedback and traces are provided via the feedback object. The stub must be connected and the system must be the last one uploaded to the server.

Parameters:

system - - The uppaal system

query - - The query

f - - The query feed back

Returns:

The query verification results

Throws:

java.io.IOException - I/O communication error.

EngineException - error in the server protocol.

query

QueryResult query(UppaalSystem system,
                  SymbolicState state,
                  Query query,
                  QueryFeedback f)
           throws EngineException,
                  java.io.IOException,
                  CannotEvaluateException

Verify a query on an instantiated UPPAAL model with custom initial state. Returns 'T' if property is satisfied, 'F' if it is not satisfied, 'M' if it is maybe satisfied, and 'E' if an error occurred. Progress feedback and traces are provided via the feedback object. The stub must be connected and the system must be the last one uploaded to the server.

Parameters:

system - system model representation

state - initial symbolic state

query - the property to check for

f - feedback handler

Returns:

Throws:

EngineException

java.io.IOException

CannotEvaluateException