com.edustructures.sifworks.trans
Class TelemetryList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Telemetry>
                  com.edustructures.sifworks.trans.TelemetryList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Telemetry>, java.util.Collection<Telemetry>

public class TelemetryList
extends SIFKeyedList<Telemetry>

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

TelemetryList()
Constructor

TelemetryList(Telemetry telemetry)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTelemetry(java.lang.String value) Adds a new <Telemetry> repeatable element.
Telemetry	getTelemetry(java.lang.String value) Gets a Telemetry object instance.
Telemetry[]	getTelemetrys() Gets all Telemetry object instances.
void	removeTelemetry(java.lang.String value) Removes a Telemetry object instance.
void	setTelemetrys(Telemetry[] telemetrys) Sets an array of Telemetry objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

TelemetryList

public TelemetryList()

Constructor

TelemetryList

public TelemetryList(Telemetry telemetry)

Constructor that accepts values for all mandatory fields

Parameters:

telemetry - 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.

Method Detail

addTelemetry

public void addTelemetry(java.lang.String value)

Adds a new <Telemetry> repeatable element. This form of setTelemetry is provided as a convenience method that is functionally equivalent to the version of setTelemetry that accepts a single Telemetry object.

Parameters:

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

Since:

1.5r1

removeTelemetry

public void removeTelemetry(java.lang.String value)

Removes a Telemetry object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the Telemetry object to remove by its Value value

Since:

1.5r1

getTelemetry

public Telemetry getTelemetry(java.lang.String value)

Gets a Telemetry object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the Telemetry object to return by its "Value" attribute value

Returns:

A Telemetry object

Since:

1.5r1

getTelemetrys

public Telemetry[] getTelemetrys()

Gets all Telemetry object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Telemetry objects

Since:

1.5r1

setTelemetrys

public void setTelemetrys(Telemetry[] telemetrys)

Sets an array of Telemetry objects. All existing Telemetry instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Telemetrys.

Since:

1.5r1