org.xtce.toolkit

Class XTCEValidRange

java.lang.Object

org.xtce.toolkit.XTCEValidRange

public class XTCEValidRange
extends Object

This class provides a simple accessor to the ValidRange element on an XTCEParameter or XTCEArgument while abstracting the user away from the type differences.

Author:

David Overeem

Method Summary

Modifier and Type	Method and Description
String	getHighValue() Retrieve the high valid valid in the allowable range.
String	getLowValue() Retrieve the low valid valid in the allowable range.
boolean	isHighValueCalibrated() Retrieve the flag indicating if the high value should be applied to the calibrated or the raw value.
boolean	isHighValueInclusive() Retrieve the flag indicating if the high value should be applied as inclusive or exclusive.
boolean	isLowValueCalibrated() Retrieve the flag indicating if the low value should be applied to the calibrated or the raw value.
boolean	isLowValueInclusive() Retrieve the flag indicating if the low value should be applied as inclusive or exclusive.
boolean	isValidRangeApplied() Retrieve the flag indicating if there is currently a ValidRange element applied to the type represented in this object.

Methods inherited from class java.lang.Object

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

Method Detail

isValidRangeApplied

public final boolean isValidRangeApplied()

Retrieve the flag indicating if there is currently a ValidRange element applied to the type represented in this object.

Returns:

boolean indicating if a ValidRange was processed.

getLowValue

public final String getLowValue()

Retrieve the low valid valid in the allowable range.

Returns:

String containing the value.

getHighValue

public final String getHighValue()

Retrieve the high valid valid in the allowable range.

Returns:

String containing the value.

isLowValueInclusive

public final boolean isLowValueInclusive()

Retrieve the flag indicating if the low value should be applied as inclusive or exclusive.

Returns:

boolean indicating if the low value is inclusive.

isHighValueInclusive

public final boolean isHighValueInclusive()

Retrieve the flag indicating if the high value should be applied as inclusive or exclusive.

Returns:

boolean indicating if the high value is inclusive.

isLowValueCalibrated

public final boolean isLowValueCalibrated()

Retrieve the flag indicating if the low value should be applied to the calibrated or the raw value.

Returns:

boolean indicating if the value should be applied to the calibrated form.

isHighValueCalibrated

public final boolean isHighValueCalibrated()

Retrieve the flag indicating if the high value should be applied to the calibrated or the raw value.

Returns:

boolean indicating if the value should be applied to the calibrated form.