us.gov.dod.standard.ssrf._3_1.channelplan

Class ChannelFreq

java.lang.Object

us.gov.dod.standard.ssrf._3_1.metadata.AMetadata<ChannelFreq>

us.gov.dod.standard.ssrf._3_1.channelplan.ChannelFreq

All Implemented Interfaces:

Comparable<ChannelFreq>

public class ChannelFreq
extends AMetadata<ChannelFreq>
implements Comparable<ChannelFreq>

ChannelFreq contains one frequency in the channel plan.

Element of Channel

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Field Summary

Fields

Modifier and Type	Field and Description
protected BigDecimal	value The value property; one frequency in the channel plan.

Fields inherited from class us.gov.dod.standard.ssrf._3_1.metadata.AMetadata

availability, cls, extReferences, idref, legacyReleasability, quality, recommendedValue, remarkRef

Constructor Summary

Constructors

Constructor and Description
ChannelFreq() Construct a new, empty ChannelFreq instance.
ChannelFreq(BigDecimal value) Construct a new ChannelFreq instance with the given initial value.
ChannelFreq(Double value) Construct a new ChannelFreq instance with the given initial value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ChannelFreq obj) Comparison and sorting.
boolean	equals(Object obj) Equality is based upon the value.
BigDecimal	getValue() Get the value of the value property.
int	hashCode() Hash code is based upon the value.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetValue() Determine if the value property is configured.
void	setValue(BigDecimal value) Set the value of the value property.
String	toString() Get a string representation of this data wrapper value.
ChannelFreq	withValue(BigDecimal value) Set the frequency in the channel plan.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.metadata.AMetadata

getAvailability, getCls, getExtReferences, getIdref, getLegacyReleasability, getQuality, getRecommendedValue, getRemarkRef, isSetAvailability, isSetCls, isSetExtReferences, isSetIdref, isSetLegacyReleasability, isSetQuality, isSetRecommendedValue, isSetRemarkRef, setAvailability, setCls, setIdref, setLegacyReleasability, setQuality, setRecommendedValue, unsetExtReferences, unsetRemarkRef, withAvailability, withCls, withExtReferences, withExtReferences, withIdref, withLegacyReleasability, withQuality, withRecommendedValue, withRemarkRef, withRemarkRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected BigDecimal value

The value property; one frequency in the channel plan.

Format is UN(16,9) [0..1.0E9](MHz)

Constructor Detail

ChannelFreq

public ChannelFreq()

Construct a new, empty ChannelFreq instance.

ChannelFreq

public ChannelFreq(BigDecimal value)

Construct a new ChannelFreq instance with the given initial value.

Parameters:

value - The initial value.

ChannelFreq

public ChannelFreq(Double value)

Construct a new ChannelFreq instance with the given initial value.

Parameters:

value - The initial value.

Method Detail

getValue

public BigDecimal getValue()

Get the value of the value property.

Returns:

the value of the value property

setValue

public void setValue(BigDecimal value)

Set the value of the value property.

Parameters:

the - value

isSetValue

public boolean isSetValue()

Determine if the value property is configured.

Returns:

TRUE if the value is set, FALSE if the value is null

withValue

public ChannelFreq withValue(BigDecimal value)

Set the frequency in the channel plan. (MHz)

Format is FREQ / UN(16,9) [0..1.0E9](MHz)

Parameters:

value - An instances of type BigDecimal

Returns:

The current ChannelFreq object instance

toString

public String toString()

Get a string representation of this data wrapper value.

Overrides:

toString in class AMetadata<ChannelFreq>

Returns:

The current data value.

isSet

public boolean isSet()

Determine if the required fields in this SSRF data type instance are set.

ChannelFreq requires cls and value.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Overrides:

isSet in class AMetadata<ChannelFreq>

Returns:

TRUE if required fields are set, otherwise FALSE

hashCode

public int hashCode()

Hash code is based upon the value.

Overrides:

hashCode in class Object

Returns:

a unique hash code from the value.

equals

public boolean equals(Object obj)

Equality is based upon the value.

Overrides:

equals in class Object

Parameters:

obj - the other object to compare.

Returns:

TRUE if the values match exactly.

compareTo

public int compareTo(ChannelFreq obj)

Comparison and sorting.

Specified by:

compareTo in interface Comparable<ChannelFreq>

Parameters:

obj - the other object to compare

Returns:

the sorting order.