com.edustructures.sifworks.trans
Class BusPositionInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.trans.BusPositionInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BusPositionInfo
extends SIFDataObject

This object exposes telematics information to the zone. SIF_Events are reported.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

BusPositionInfo()
Constructor

BusPositionInfo(java.lang.String busInfoRefId, java.util.Calendar date, java.util.Calendar time, GridLocation gridLocation)
Constructor that accepts values for all mandatory fields

Method Summary

BusDriver	getBusDriver() Gets the value of the <BusDriver> element.
java.lang.String	getBusInfoRefId() Gets the value of the BusInfoRefId attribute.
BusStaffList	getBusStaffList() Gets the value of the <BusStaffList> element.
java.util.Calendar	getDate() Gets the value of the <Date> element.
GridLocation	getGridLocation() Gets the value of the <GridLocation> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
Odometer	getOdometer() Gets the value of the <Odometer> element.
java.lang.String	getOtherStatus() Gets the value of the <OtherStatus> element.
RouteStatus	getRouteStatus() Gets the value of the <RouteStatus> element.
Speedometer	getSpeedometer() Gets the value of the <Speedometer> element.
TransStudents	getStudents() Gets the value of the <Students> element.
java.lang.String	getTelematicsId() Gets the value of the <TelematicsId> element.
TelemetryList	getTelemetryList() Gets the value of the <TelemetryList> element.
java.util.Calendar	getTime() Gets the value of the <Time> element.
void	removeBusDriver() Removes the BusDriver child element previously created by calling setBusDriver
void	removeBusStaffList() Removes the BusStaffList child element previously created by calling setBusStaffList
void	removeGridLocation() Removes the GridLocation child element previously created by calling setGridLocation
void	removeOdometer() Removes the Odometer child element previously created by calling setOdometer
void	removeRouteStatus() Removes the RouteStatus child element previously created by calling setRouteStatus
void	removeSpeedometer() Removes the Speedometer child element previously created by calling setSpeedometer
void	removeStudents() Removes the Students child element previously created by calling setStudents
void	removeTelemetryList() Removes the TelemetryList child element previously created by calling setTelemetryList
void	setBusDriver(BusDriver value) Sets the value of the <BusDriver> element.
void	setBusDriver(StaffBoardingStatus status) Sets the value of the <BusDriver> child element.
void	setBusInfoRefId(java.lang.String value) Sets the value of the BusInfoRefId attribute.
void	setBusStaffList(BusStaffList value) Sets the value of the <BusStaffList> element.
void	setDate(java.util.Calendar value) Sets the value of the <Date> element.
void	setGridLocation(java.math.BigDecimal latitude, java.math.BigDecimal longitude) Sets the value of the <GridLocation> child element.
void	setGridLocation(GridLocation value) Sets the value of the <GridLocation> element.
void	setOdometer(DistanceUnit unit, java.lang.String value) Sets the value of the <Odometer> child element.
void	setOdometer(Odometer value) Sets the value of the <Odometer> element.
void	setOtherStatus(java.lang.String value) Sets the value of the <OtherStatus> element.
void	setRouteStatus(RouteStatus value) Sets the value of the <RouteStatus> element.
void	setRouteStatus(RouteStatusStatus status, java.lang.String busRouteInfoRefId, java.lang.String value) Sets the value of the <RouteStatus> child element.
void	setSpeedometer(DistanceUnit unit, java.lang.String value) Sets the value of the <Speedometer> child element.
void	setSpeedometer(Speedometer value) Sets the value of the <Speedometer> element.
void	setStudents(TransStudents value) Sets the value of the <Students> element.
void	setTelematicsId(java.lang.String value) Sets the value of the <TelematicsId> element.
void	setTelemetryList(TelemetryList value) Sets the value of the <TelemetryList> element.
void	setTime(java.util.Calendar value) Sets the value of the <Time> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BusPositionInfo

public BusPositionInfo()

Constructor

BusPositionInfo

public BusPositionInfo(java.lang.String busInfoRefId,
                       java.util.Calendar date,
                       java.util.Calendar time,
                       GridLocation gridLocation)

Constructor that accepts values for all mandatory fields

Parameters:

busInfoRefId - The GUID that identifies the bus. This object only has meaning as current data for this particular bus.

date - The date of the report from the bus.

time - The time of the report from the bus.

gridLocation - The location of the bus.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getBusInfoRefId

public java.lang.String getBusInfoRefId()

Gets the value of the BusInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID that identifies the bus. This object only has meaning as current data for this particular bus."

Returns:

The BusInfoRefId attribute of this object.

Since:

1.5r1

setBusInfoRefId

public void setBusInfoRefId(java.lang.String value)

Sets the value of the BusInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID that identifies the bus. This object only has meaning as current data for this particular bus."

Parameters:

value - A String object

Since:

1.5r1

getDate

public java.util.Calendar getDate()

Gets the value of the <Date> element.

The SIF specification defines the meaning of this element as: "The date of the report from the bus."

Returns:

The Date element of this object.

Since:

1.5r1

setDate

public void setDate(java.util.Calendar value)

Sets the value of the <Date> element.

The SIF specification defines the meaning of this element as: "The date of the report from the bus."

Parameters:

value - A Calendar object

Since:

1.5r1

getTime

public java.util.Calendar getTime()

Gets the value of the <Time> element.

The SIF specification defines the meaning of this element as: "The time of the report from the bus."

Returns:

The Time element of this object.

Since:

1.5r1

setTime

public void setTime(java.util.Calendar value)

Sets the value of the <Time> element.

The SIF specification defines the meaning of this element as: "The time of the report from the bus."

Parameters:

value - A Calendar object

Since:

1.5r1

setGridLocation

public void setGridLocation(GridLocation value)

Sets the value of the <GridLocation> element.

The SIF specification defines the meaning of this element as: "The location of the bus."

Parameters:

value - A GridLocation object

Since:

1.5r1

setGridLocation

public void setGridLocation(java.math.BigDecimal latitude,
                            java.math.BigDecimal longitude)

Sets the value of the <GridLocation> child element. This form of setGridLocation is provided as a convenience method that is functionally equivalent to the version of setGridLocation that accepts a single GridLocation object.

Parameters:

latitude - The latitude coordinate of this location expressed in decimal format (e.g. "41.7699657")

longitude - The longitude coordinate of this location expressed in decimal format (e.g. "79.548445")

Since:

1.5r1

getGridLocation

public GridLocation getGridLocation()

Gets the value of the <GridLocation> element.

The SIF specification defines the meaning of this element as: "The location of the bus."

Returns:

A GridLocation object

Since:

1.5r1

removeGridLocation

public void removeGridLocation()

Removes the GridLocation child element previously created by calling setGridLocation

Since:

1.5r1

getTelematicsId

public java.lang.String getTelematicsId()

Gets the value of the <TelematicsId> element.

The SIF specification defines the meaning of this element as: "ID of the hardware unit on the bus that tracks & reports location and status. The interpretation of the content is deployment specific, but the format must be compact."

Returns:

The TelematicsId element of this object.

Since:

1.5r1

setTelematicsId

public void setTelematicsId(java.lang.String value)

Sets the value of the <TelematicsId> element.

The SIF specification defines the meaning of this element as: "ID of the hardware unit on the bus that tracks & reports location and status. The interpretation of the content is deployment specific, but the format must be compact."

Parameters:

value - A String object

Since:

1.5r1

setTelemetryList

public void setTelemetryList(TelemetryList value)

Sets the value of the <TelemetryList> element.

The SIF specification defines the meaning of this element as: "Indicators and values provided by the hardware along with this position snapshot. For events, it is safe to assume that one of these items triggered the hardware to issue an update."

Parameters:

value - A TelemetryList object

Since:

1.5r1

getTelemetryList

public TelemetryList getTelemetryList()

Gets the value of the <TelemetryList> element.

The SIF specification defines the meaning of this element as: "Indicators and values provided by the hardware along with this position snapshot. For events, it is safe to assume that one of these items triggered the hardware to issue an update."

Returns:

A TelemetryList object

Since:

1.5r1

removeTelemetryList

public void removeTelemetryList()

Removes the TelemetryList child element previously created by calling setTelemetryList

Since:

1.5r1

setBusDriver

public void setBusDriver(BusDriver value)

Sets the value of the <BusDriver> element.

The SIF specification defines the meaning of this element as: "Information identifying the driver."

Parameters:

value - A BusDriver object

Since:

1.5r1

setBusDriver

public void setBusDriver(StaffBoardingStatus status)

Sets the value of the <BusDriver> child element. This form of setBusDriver is provided as a convenience method that is functionally equivalent to the version of setBusDriver that accepts a single BusDriver object.

Parameters:

status - Boarding status of the driver.

Since:

1.5r1

getBusDriver

public BusDriver getBusDriver()

Gets the value of the <BusDriver> element.

The SIF specification defines the meaning of this element as: "Information identifying the driver."

Returns:

A BusDriver object

Since:

1.5r1

removeBusDriver

public void removeBusDriver()

Removes the BusDriver child element previously created by calling setBusDriver

Since:

1.5r1

setBusStaffList

public void setBusStaffList(BusStaffList value)

Sets the value of the <BusStaffList> element.

The SIF specification defines the meaning of this element as: "List identifying other staff. This may include aides, nurses, proctors, etc."

Parameters:

value - A BusStaffList object

Since:

1.5r1

getBusStaffList

public BusStaffList getBusStaffList()

Gets the value of the <BusStaffList> element.

The SIF specification defines the meaning of this element as: "List identifying other staff. This may include aides, nurses, proctors, etc."

Returns:

A BusStaffList object

Since:

1.5r1

removeBusStaffList

public void removeBusStaffList()

Removes the BusStaffList child element previously created by calling setBusStaffList

Since:

1.5r1

setRouteStatus

public void setRouteStatus(RouteStatus value)

Sets the value of the <RouteStatus> element.

The SIF specification defines the meaning of this element as: "If the bus is running a route, this element must be included in the object. Absence means the bus is not operating a route."

Parameters:

value - A RouteStatus object

Since:

1.5r1

setRouteStatus

public void setRouteStatus(RouteStatusStatus status,
                           java.lang.String busRouteInfoRefId,
                           java.lang.String value)

Sets the value of the <RouteStatus> child element. This form of setRouteStatus is provided as a convenience method that is functionally equivalent to the version of setRouteStatus that accepts a single RouteStatus object.

Parameters:

status - Status of the route.

busRouteInfoRefId - GUID

value - Gets or sets the content value of the <RouteStatus> element

Since:

1.5r1

getRouteStatus

public RouteStatus getRouteStatus()

Gets the value of the <RouteStatus> element.

The SIF specification defines the meaning of this element as: "If the bus is running a route, this element must be included in the object. Absence means the bus is not operating a route."

Returns:

A RouteStatus object

Since:

1.5r1

removeRouteStatus

public void removeRouteStatus()

Removes the RouteStatus child element previously created by calling setRouteStatus

Since:

1.5r1

getOtherStatus

public java.lang.String getOtherStatus()

Gets the value of the <OtherStatus> element.

The SIF specification defines the meaning of this element as: "If the bus is not running a regularly scheduled route but is transporting (or positioning to transport) passengers as approved and directed by the school district, this element describes the activity. It's also used for maintenance, repair, and other authorized movements. This element is mutually exclusive with RouteStatus. Absence of both RouteStatus and OtherStatus is acceptable, but may indicate unauthorized operation."

Returns:

The OtherStatus element of this object.

Since:

1.5r1

setOtherStatus

public void setOtherStatus(java.lang.String value)

Sets the value of the <OtherStatus> element.

The SIF specification defines the meaning of this element as: "If the bus is not running a regularly scheduled route but is transporting (or positioning to transport) passengers as approved and directed by the school district, this element describes the activity. It's also used for maintenance, repair, and other authorized movements. This element is mutually exclusive with RouteStatus. Absence of both RouteStatus and OtherStatus is acceptable, but may indicate unauthorized operation."

Parameters:

value - A String object

Since:

1.5r1

setOdometer

public void setOdometer(Odometer value)

Sets the value of the <Odometer> element.

The SIF specification defines the meaning of this element as: "Current odometer reading."

Parameters:

value - A Odometer object

Since:

1.5r1

setOdometer

public void setOdometer(DistanceUnit unit,
                        java.lang.String value)

Sets the value of the <Odometer> child element. This form of setOdometer is provided as a convenience method that is functionally equivalent to the version of setOdometer that accepts a single Odometer object.

Parameters:

unit - Units used in the odometer reading.

value - Gets or sets the content value of the <Odometer> element

Since:

1.5r1

getOdometer

public Odometer getOdometer()

Gets the value of the <Odometer> element.

The SIF specification defines the meaning of this element as: "Current odometer reading."

Returns:

An Odometer object

Since:

1.5r1

removeOdometer

public void removeOdometer()

Removes the Odometer child element previously created by calling setOdometer

Since:

1.5r1

setSpeedometer

public void setSpeedometer(Speedometer value)

Sets the value of the <Speedometer> element.

The SIF specification defines the meaning of this element as: "Current speedometer reading."

Parameters:

value - A Speedometer object

Since:

1.5r1

setSpeedometer

public void setSpeedometer(DistanceUnit unit,
                           java.lang.String value)

Sets the value of the <Speedometer> child element. This form of setSpeedometer is provided as a convenience method that is functionally equivalent to the version of setSpeedometer that accepts a single Speedometer object.

Parameters:

unit - Units used in the speedometer reading.

value - Gets or sets the content value of the <Speedometer> element

Since:

1.5r1

getSpeedometer

public Speedometer getSpeedometer()

Gets the value of the <Speedometer> element.

The SIF specification defines the meaning of this element as: "Current speedometer reading."

Returns:

A Speedometer object

Since:

1.5r1

removeSpeedometer

public void removeSpeedometer()

Removes the Speedometer child element previously created by calling setSpeedometer

Since:

1.5r1

setStudents

public void setStudents(TransStudents value)

Sets the value of the <Students> element.

The SIF specification defines the meaning of this element as: "List of students and their status. The complete list may be sent with some events (e.g. change in RouteStatus) per district policy, but it is more typical of responses."

Parameters:

value - A TransStudents object

Since:

1.5r1

getStudents

public TransStudents getStudents()

Gets the value of the <Students> element.

The SIF specification defines the meaning of this element as: "List of students and their status. The complete list may be sent with some events (e.g. change in RouteStatus) per district policy, but it is more typical of responses."

Returns:

A TransStudents object

Since:

1.5r1

removeStudents

public void removeStudents()

Removes the Students child element previously created by calling setStudents

Since:

1.5r1