Skip to contents

Function init_api() (and its synonim init_srs()) create a Wrapper object for calling Omnidriver functions. This Java object of class com.oceanoptics.omnidriver.api.wrapper.Wrapper is later used by all other functions in the rOmniDriver to communicate with the spectrometers through the OmniDriver API from Ocen Insight.

Only one wrapper object can be active at a time. You should call this function only once and save the returned object as it is used to access the methods implementing communication with the spectrometer. Clean up by use of close_srs() before exiting or before initializing another wrapper to the same driver.

Function is_api_enableb() tests if the argument passed to jwrapper has been initialized and if it is connected to an active instance of the Java wrapper class.

Function init_api_extensions() enables API extensions and returns a wrapper that makes it possible to call additional functions.

Function is_extended_api_enabled() tests if the argument passed to jwrapperext has been initialized and if it is connected to an active instance of the Java wrapper class.

Function init_api_extensions() enables API extensions and returns a wrapper that makes it possible to call additional functions.

Function is_highres_time_api_enabled() tests if wrapper has been initialized and saved to a private environment of the package.

Usage

init_api()

init_srs()

is_api_enabled(jwrapper)

init_extended_api()

is_extended_api_enabled(jwrapperext)

init_highres_time_api()

is_highres_time_api_enabled()

Arguments

jwrapper

jobjRef A Java Wrapper object from OmniDriver.

jwrapperext

jobjRef An "extension" Java Wrapper object from OmniDriver API.

Value

a wrapper to an instance of a Java object of class "wrapper"

logical

logical