com.buglabs.bug.module.gps
Class GPSModlet

java.lang.Object
  com.buglabs.bug.module.gps.GPSModlet

All Implemented Interfaces:

INMEASentenceProvider, IPositionProvider, IModlet, IModuleControl, PublicWSProvider

public class GPSModlet
extends java.lang.Object
implements IModlet, IPositionProvider, IModuleControl, PublicWSProvider, INMEASentenceProvider

Field Summary

static java.lang.String	MODULE_ID
protected static java.lang.String	PROPERTY_MODULE_NAME

Fields inherited from interface com.buglabs.services.ws.PublicWSProvider

DELETE, GET, PACKAGE_ID, POST, PUT

Constructor Summary

GPSModlet(org.osgi.framework.BundleContext context, int slotId, java.lang.String moduleId, java.lang.String moduleName)

Method Summary

PublicWSDefinition	discover(int operation)
IWSResponse	execute(int operation, java.lang.String input) Execute a service.
java.lang.String	getDescription()
LatLon	getLatitudeLongitude()
java.lang.String	getModuleId() Return the MODULE ID.
java.lang.String	getModuleName() Get the human-readable name of this module.
java.util.List	getModuleProperties() Return a list of IModuleProperty elements.
org.osgi.util.position.Position	getPosition()
java.lang.String	getPublicName()
RMC	getRMC() Provides the latest RMC sentence read from the GPS Device.
int	getSlotId()
boolean	setModuleProperty(IModuleProperty property) Set a property.
void	setup() Connect to any devices or do any initialization.
void	start() Begin modlet.
void	stop() Unregister services and release any resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_MODULE_NAME

protected static final java.lang.String PROPERTY_MODULE_NAME

See Also:

Constant Field Values

MODULE_ID

public static final java.lang.String MODULE_ID

See Also:

Constant Field Values

Constructor Detail

GPSModlet

public GPSModlet(org.osgi.framework.BundleContext context,
                 int slotId,
                 java.lang.String moduleId,
                 java.lang.String moduleName)

Method Detail

start

public void start()
           throws java.lang.Exception

Description copied from interface: IModlet

Begin modlet. Any services that the modlet supports should be registered here.

Specified by:

start in interface IModlet

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from interface: IModlet

Unregister services and release any resources.

Specified by:

stop in interface IModlet

Throws:

java.lang.Exception

getPosition

public org.osgi.util.position.Position getPosition()

Specified by:

getPosition in interface IPositionProvider

Returns:

current position as Position object.

getModuleProperties

public java.util.List getModuleProperties()

Description copied from interface: IModuleControl

Return a list of IModuleProperty elements.

Specified by:

getModuleProperties in interface IModuleControl

Returns:

setModuleProperty

public boolean setModuleProperty(IModuleProperty property)

Description copied from interface: IModuleControl

Set a property. This is from a client request.

Specified by:

setModuleProperty in interface IModuleControl

Returns:

getModuleName

public java.lang.String getModuleName()

Description copied from interface: IModuleControl

Get the human-readable name of this module.

Specified by:

getModuleName in interface IModuleControl

Returns:

getModuleId

public java.lang.String getModuleId()

Description copied from interface: IModlet

Return the MODULE ID. This comes from the hardware.

Specified by:

getModuleId in interface IModlet

Returns:

getSlotId

public int getSlotId()

Specified by:

getSlotId in interface IModlet

Specified by:

getSlotId in interface IModuleControl

Returns:

Slot that the Module is currently connected to.

discover

public PublicWSDefinition discover(int operation)

Specified by:

discover in interface PublicWSProvider

Parameters:

operation - HTTP operation. See IPublicServiceProvider.GET, etc.

Returns:

The description of what the service requires and provides.

execute

public IWSResponse execute(int operation,
                           java.lang.String input)

Description copied from interface: PublicWSProvider

Execute a service. This is a proxy to a native OSGi style service.

Specified by:

execute in interface PublicWSProvider

Parameters:

operation - PublicWSProvider.GET, .PUT, .POST, .DELETE

Returns:

getPublicName

public java.lang.String getPublicName()

Specified by:

getPublicName in interface PublicWSProvider

Returns:

Name that this service uses.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface PublicWSProvider

Returns:

A brief description of the service.

setup

public void setup()
           throws java.lang.Exception

Description copied from interface: IModlet

Connect to any devices or do any initialization. This is a good place to throw an exception if the expected hardware environment is not valid.

Specified by:

setup in interface IModlet

Throws:

java.lang.Exception

getLatitudeLongitude

public LatLon getLatitudeLongitude()

Specified by:

getLatitudeLongitude in interface IPositionProvider

Returns:

current position as LatLon object.

getRMC

public RMC getRMC()

Description copied from interface: INMEASentenceProvider

Provides the latest RMC sentence read from the GPS Device.

Specified by:

getRMC in interface INMEASentenceProvider

Returns:

RMC sentence object