net.sf.marineapi.provider.event

Class HeadingEvent

java.lang.Object

java.util.EventObject

net.sf.marineapi.provider.event.ProviderEvent

net.sf.marineapi.provider.event.HeadingEvent

All Implemented Interfaces:

Serializable

public class HeadingEvent
extends ProviderEvent

HeadingProvider event, reports the current magnetic/true heading of vessel in degrees.

Author:

Kimmo Tuukkanen

See Also:

HeadingProvider, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
HeadingEvent(Object source, HeadingSentence s)

Method Summary

Modifier and Type	Method and Description
double	getHeading() Returns the current heading.
boolean	isTrue() Tells if the heading is relative to true or magnetic north.
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadingEvent

public HeadingEvent(Object source,
                    HeadingSentence s)

Parameters:

source -

Method Detail

getHeading

public double getHeading()

Returns the current heading.

Returns:

Heading in degrees.

isTrue

public boolean isTrue()

Tells if the heading is relative to true or magnetic north.

Returns:

true if true heading, otherwise false (magnetic).

toString

public String toString()

Overrides:

toString in class EventObject