com.newisys.ova
Interface OVAInterface

All Known Implementing Classes:

OVA

public interface OVAInterface

Interface to the OVA API.

Method Summary

boolean	addAssertListener(long clientID, int eventID, long assertID) Adds a callback for a specified assert and event type.
boolean	addEngineListener(long clientID, int eventID) Adds a callback for the specified engine event type.
boolean	assertDoAction(long clientID, int actionID, long assertID, long attemptID, int userData) Performs the specified action on the specified OVAAssert.
boolean	disableAssertCount(long clientID, long assertID, int eventID) Disables counting the specified event type for the specified assert.
boolean	doAction(long clientID, int actionID, int userData) Performs the specified action on the OVA Engine.
boolean	enableAssertCount(long clientID, long assertID, int eventID) Enables counting the specified event type for the specified assert.
long	firstAssert(long clientID) Returns the first assert from the engine, or null if no asserts are present in the design.
String	getApiVersion() Returns a string representing the OVA API version.
int	getAssertCategory(long clientID, long assertID) Returns the current category for the specified assert.
long	getAssertCount(long clientID, long assertID, int eventID) Returns the number of times the specified event type has occurred for the specified assert since counting was enabled.
OVAAssertInfo	getAssertInfo(long clientID, long assertID) Returns the information for the specified assert.
int	getAssertSeverity(long clientID, long assertID) Returns the current severity level for the specified assert.
String	getAssertUserMessage(long clientID, long assertID) Returns the current user message for the specified assert.
boolean	hasAssertInfo(long clientID) Returns whether information about OVA asserts is available from OVA.
long	nextAssert(long clientID) Returns the next assert from the engine, or null if no more asserts are available.
long	registerClient() Registers a client with OVA.
boolean	removeAssertListener(int eventID, long assertID) Removes a callback for a specified assert and event type.
boolean	removeEngineListener(int eventID) Removes a callback for the specified engine event type.
boolean	setAssertCategory(long clientID, long assertID, int category) Sets the category of the specified assert.
boolean	setAssertSeverity(long clientID, long assertID, int severity) Sets the severity level of the specified assert.
boolean	setAssertUserMessage(long clientID, long assertID, String msg) Sets the user message of the specified assert.
boolean	setConfigSwitch(long clientID, int confSwitch, boolean enable) Sets the specified OVA option.

Method Detail

getApiVersion

String getApiVersion()

Returns a string representing the OVA API version.

Returns:

the API version string

registerClient

long registerClient()

Registers a client with OVA. A client identifier is returned. This identifier can be zero in the following cases:

• There is no OVA support in the simulator
• There are no OVA assertions present in the design being simulated

Returns:

the client identifier to be used in future calls into the API, or zero as described above

setConfigSwitch

boolean setConfigSwitch(long clientID,
                        int confSwitch,
                        boolean enable)

Sets the specified OVA option.

Parameters:

clientID - the client identifier

confSwitch - the configuration switch to be set

enable - true if confSwitch should be enabled, false otherwise

Returns:

true if the operation is successful, false otherwise

See Also:

OVAConfigSwitch

doAction

boolean doAction(long clientID,
                 int actionID,
                 int userData)

Performs the specified action on the OVA Engine.

Parameters:

clientID - the client identifier

actionID - the type of action to be performed on the OVA engine

userData - user defined data

Returns:

true if the operation is successful, false otherwise

See Also:

OVAEngineAction

firstAssert

long firstAssert(long clientID)

Returns the first assert from the engine, or null if no asserts are present in the design.

Parameters:

clientID - the client identifier

Returns:

the assert identifier of the first assert or null if no asserts are present in the design

See Also:

OVAAssert

nextAssert

long nextAssert(long clientID)

Returns the next assert from the engine, or null if no more asserts are available. It is expected that firstAssert(long) has been called before calling this method.

Parameters:

clientID - the client identifier

Returns:

the assert identifier of the next assert or null if no more asserts are available

See Also:

OVAAssert

assertDoAction

boolean assertDoAction(long clientID,
                       int actionID,
                       long assertID,
                       long attemptID,
                       int userData)

Performs the specified action on the specified OVAAssert. Some actions require an attempt identifier. For those that do not, attemptID should be zero.

Parameters:

clientID - the client identifier

actionID - the type of action to be performed on the assert

assertID - the assert identifier

attemptID - the attempt identifier

userData - user defined data

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert, OVAAssertAction

hasAssertInfo

boolean hasAssertInfo(long clientID)

Returns whether information about OVA asserts is available from OVA.

Parameters:

clientID - the client identifier

Returns:

true if assert information is available, false otherwise

getAssertInfo

OVAAssertInfo getAssertInfo(long clientID,
                            long assertID)

Returns the information for the specified assert. It is expected that hasAssertInfo(long) will be called and return true before calling this method.

Parameters:

clientID - the client identifier

assertID - the assert identifier

Returns:

the OVAAssertInfo corresponding to the assert referenced by assertID

See Also:

OVAAssert

addEngineListener

boolean addEngineListener(long clientID,
                          int eventID)

Adds a callback for the specified engine event type.

Parameters:

clientID - the client identifier

eventID - the event type

Returns:

true if the operation is successful, false otherwise

See Also:

OVAEngineEventType

addAssertListener

boolean addAssertListener(long clientID,
                          int eventID,
                          long assertID)

Adds a callback for a specified assert and event type.

Parameters:

clientID - the client identifier

eventID - the event type

assertID - the assert identifier

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert, OVAAssertEventType

removeAssertListener

boolean removeAssertListener(int eventID,
                             long assertID)

Removes a callback for a specified assert and event type.

Parameters:

eventID - the event type

assertID - the assert identifier

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert, OVAEngineEventType

removeEngineListener

boolean removeEngineListener(int eventID)

Removes a callback for the specified engine event type.

Parameters:

eventID - the event type

Returns:

true if the operation is successful, false otherwise

See Also:

OVAEngineEventType

setAssertSeverity

boolean setAssertSeverity(long clientID,
                          long assertID,
                          int severity)

Sets the severity level of the specified assert. The severity should be a value from 0 to 0xFF.

Parameters:

clientID - the client identifier

assertID - the assert identifier

severity - the severity level

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert

getAssertSeverity

int getAssertSeverity(long clientID,
                      long assertID)

Returns the current severity level for the specified assert. The severity is a value from 0 to 0xFF.

Parameters:

clientID - the client identifier

assertID - the assert identifier

Returns:

the severity level for the assert referenced by assertID

See Also:

OVAAssert

setAssertCategory

boolean setAssertCategory(long clientID,
                          long assertID,
                          int category)

Sets the category of the specified assert. The category should be a value from 0 to 0xFFFFFF.

Parameters:

clientID - the client identifier

assertID - the assert identifier

category - the category

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert

getAssertCategory

int getAssertCategory(long clientID,
                      long assertID)

Returns the current category for the specified assert. The category is a value from 0 to 0xFFFFFF.

Parameters:

clientID - the client identifier

assertID - the assert identifier

Returns:

the category for the assert referenced by assertID

See Also:

OVAAssert

setAssertUserMessage

boolean setAssertUserMessage(long clientID,
                             long assertID,
                             String msg)

Sets the user message of the specified assert. The user message should be any non-null string.

Parameters:

clientID - the client identifier

assertID - the assert identifier

msg - the user message

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert

getAssertUserMessage

String getAssertUserMessage(long clientID,
                            long assertID)

Returns the current user message for the specified assert. The user message is a non-null string.

Parameters:

clientID - the client identifier

assertID - the assert identifier

Returns:

theuser message for the assert referenced by assertID

See Also:

OVAAssert

enableAssertCount

boolean enableAssertCount(long clientID,
                          long assertID,
                          int eventID)

Enables counting the specified event type for the specified assert. This method is separate from the generic addAssertListener(long, int, long) method in order to improve performance. This method resets the count to zero before enabling counting.

Parameters:

clientID - the client identifier

assertID - the assert identifier

eventID - the event type being counted

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert, OVAAssertEventType

disableAssertCount

boolean disableAssertCount(long clientID,
                           long assertID,
                           int eventID)

Disables counting the specified event type for the specified assert. This method is a counterpart to enableAssertCount(long, long, int). The event count obtained via getAssertCount(long, long, int) will continue to be valid after this method is called (unless there is a subsequent call to enableAssertCount).

Parameters:

clientID - the client identifier

assertID - the assert identifier

eventID - the event type being counted

Returns:

true if the operation is successful, false otherwise

See Also:

OVAAssert, OVAAssertEventType

getAssertCount

long getAssertCount(long clientID,
                    long assertID,
                    int eventID)

Returns the number of times the specified event type has occurred for the specified assert since counting was enabled. If counting is not enabled, an OVAException is thrown.

Parameters:

clientID - the client identifier

assertID - the assert identifier

eventID - the event type being counted

Returns:

the number of times an event of type eventID occurred for the assert referenced by assertID

Throws:

OVAException - if counting has not been enabled

See Also:

OVAAssert, OVAAssertEventType