us.gov.dod.standard.ssrf._3_1.receiver

Class Baseband

java.lang.Object

us.gov.dod.standard.ssrf._3_1.receiver.Baseband

public class Baseband
extends Object

Baseband defines the parameters of the modulating or received signal.

Element of RxMode, TxMode

Example:

 <Baseband>
   <ModFreqMin cls="U">0.0003</ModFreqMin>
   <ModFreqMax cls="U">0.0034</ModFreqMax>
   <SignalType cls="U">FM Clear Voice</SignalType>
 </Baseband>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Baseband()

Method Summary

Modifier and Type	Method and Description
microsecs	getBitDuration() Get the period of elapsed time, per bit instance, before change of states..
FreqM	getModFreqMax() Get the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver.
FreqM	getModFreqMin() Get the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation..
S100	getOOKPattern() Get a text description of the on-off keying (OOK) pattern.
microsecs	getSignalDurationMax() Get the maximum time value for how long the tone persists in the baseband.
microsecs	getSignalDurationMin() Get the minimum time value for how long the tone persists in the baseband..
S100	getSignalSequenceDesc() Get the pattern of occurrence of sub-signals.
TString	getSignalShape() Get the basic shape of the signal..
TString	getSignalType() Get the type of modulation..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetBitDuration() Determine if the BitDuration is configured.
boolean	isSetModFreqMax() Determine if the ModFreqMax is configured.
boolean	isSetModFreqMin() Determine if the ModFreqMin is configured.
boolean	isSetOOKPattern() Determine if the OOKPattern is configured.
boolean	isSetSignalDurationMax() Determine if the SignalDurationMax is configured.
boolean	isSetSignalDurationMin() Determine if the SignalDurationMin is configured.
boolean	isSetSignalSequenceDesc() Determine if the SignalSequenceDesc is configured.
boolean	isSetSignalShape() Determine if the SignalShape is configured.
boolean	isSetSignalType() Determine if the SignalType is configured.
void	setBitDuration(microsecs value) Set the period of elapsed time, per bit instance, before change of states..
void	setModFreqMax(FreqM value) Set the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver.
void	setModFreqMin(FreqM value) Set the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation..
void	setOOKPattern(S100 value) Set a text description of the on-off keying (OOK) pattern.
void	setSignalDurationMax(microsecs value) Set the maximum time value for how long the tone persists in the baseband.
void	setSignalDurationMin(microsecs value) Set the minimum time value for how long the tone persists in the baseband..
void	setSignalSequenceDesc(S100 value) Set the pattern of occurrence of sub-signals.
void	setSignalShape(TString value) Set the basic shape of the signal..
void	setSignalType(TString value) Set the type of modulation..
String	toString() Get a string representation of this Baseband instance configuration.
Baseband	withBitDuration(Double value) Set the period of elapsed time, per bit instance, before change of states.
Baseband	withModFreqMax(Double value) Set the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver.
Baseband	withModFreqMin(Double value) Set the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation.
Baseband	withOOKPattern(String value) Set a text description of the on-off keying (OOK) pattern.
Baseband	withSignalDurationMax(Double value) Set the maximum time value for how long the tone persists in the baseband.
Baseband	withSignalDurationMin(Double value) Set the minimum time value for how long the tone persists in the baseband.
Baseband	withSignalSequenceDesc(String value) Set the pattern of occurrence of sub-signals.
Baseband	withSignalShape(ListUSS value) Set the basic shape of the signal.
Baseband	withSignalType(ListCMO value) Set the type of modulation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Baseband

public Baseband()

Method Detail

getModFreqMin

public FreqM getModFreqMin()

Get the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation..

Returns:

a FreqM instance

Since:

3.1.0

setModFreqMin

public void setModFreqMin(FreqM value)

Set the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetModFreqMin

public boolean isSetModFreqMin()

Determine if the ModFreqMin is configured.

Returns:

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

getModFreqMax

public FreqM getModFreqMax()

Get the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver. Typically, this frequency should have 3-dB attenuation relative to the least attenuated demodulated or multiplexed signal.

[XSL ERR MINMAX] If ModFreqMax is used, it MUST be greater than ModFreqMin..

Returns:

a FreqM instance

Since:

3.1.0

setModFreqMax

public void setModFreqMax(FreqM value)

Set the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver. Typically, this frequency should have 3-dB attenuation relative to the least attenuated demodulated or multiplexed signal.

[XSL ERR MINMAX] If ModFreqMax is used, it MUST be greater than ModFreqMin..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetModFreqMax

public boolean isSetModFreqMax()

Determine if the ModFreqMax is configured.

Returns:

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

getSignalType

public TString getSignalType()

Get the type of modulation..

Returns:

the SignalType value in a TString data type

Since:

3.1.0

setSignalType

public void setSignalType(TString value)

Set the type of modulation..

Parameters:

value - the SignalType value in a TString data type

Since:

3.1.0

isSetSignalType

public boolean isSetSignalType()

Determine if the SignalType is configured.

If configured this method also inspects the TString wrapped value.

Returns:

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

getBitDuration

public microsecs getBitDuration()

Get the period of elapsed time, per bit instance, before change of states..

Returns:

a microsecs instance

Since:

3.1.0

setBitDuration

public void setBitDuration(microsecs value)

Set the period of elapsed time, per bit instance, before change of states..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetBitDuration

public boolean isSetBitDuration()

Determine if the BitDuration is configured.

Returns:

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

getOOKPattern

public S100 getOOKPattern()

Get a text description of the on-off keying (OOK) pattern. Example: (3 on, 3 off, 3 on, 4 off,...).

Returns:

a S100 instance

Since:

3.1.0

setOOKPattern

public void setOOKPattern(S100 value)

Set a text description of the on-off keying (OOK) pattern. Example: (3 on, 3 off, 3 on, 4 off,...).

Parameters:

value - a S100 instance

Since:

3.1.0

isSetOOKPattern

public boolean isSetOOKPattern()

Determine if the OOKPattern is configured.

Returns:

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

getSignalDurationMax

public microsecs getSignalDurationMax()

Get the maximum time value for how long the tone persists in the baseband.

[XSL ERR MINMAX] If US:SignalDurationMax is used, it MUST be greater than US:SignalDurationMin..

Returns:

a microsecs instance

Since:

3.1.0

setSignalDurationMax

public void setSignalDurationMax(microsecs value)

Set the maximum time value for how long the tone persists in the baseband.

[XSL ERR MINMAX] If US:SignalDurationMax is used, it MUST be greater than US:SignalDurationMin..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetSignalDurationMax

public boolean isSetSignalDurationMax()

Determine if the SignalDurationMax is configured.

Returns:

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

getSignalDurationMin

public microsecs getSignalDurationMin()

Get the minimum time value for how long the tone persists in the baseband..

Returns:

a microsecs instance

Since:

3.1.0

setSignalDurationMin

public void setSignalDurationMin(microsecs value)

Set the minimum time value for how long the tone persists in the baseband..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetSignalDurationMin

public boolean isSetSignalDurationMin()

Determine if the SignalDurationMin is configured.

Returns:

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

getSignalSequenceDesc

public S100 getSignalSequenceDesc()

Get the pattern of occurrence of sub-signals. (Example: beep, beep, pause, bip, pause...) If using SignalDuration, entries in ToneName MUST match the descriptive names used here..

Returns:

a S100 instance

Since:

3.1.0

setSignalSequenceDesc

public void setSignalSequenceDesc(S100 value)

Set the pattern of occurrence of sub-signals. (Example: beep, beep, pause, bip, pause...) If using SignalDuration, entries in ToneName MUST match the descriptive names used here..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetSignalSequenceDesc

public boolean isSetSignalSequenceDesc()

Determine if the SignalSequenceDesc is configured.

Returns:

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

getSignalShape

public TString getSignalShape()

Get the basic shape of the signal..

Returns:

the SignalShape value in a TString data type

Since:

3.1.0

setSignalShape

public void setSignalShape(TString value)

Set the basic shape of the signal..

Parameters:

value - the SignalShape value in a TString data type

Since:

3.1.0

isSetSignalShape

public boolean isSetSignalShape()

Determine if the SignalShape is configured.

If configured this method also inspects the TString wrapped value.

Returns:

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

withModFreqMin

public Baseband withModFreqMin(Double value)

Set the minimum modulating frequency measured: - for a transmitter, on the low side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, at the -3 dB point on the low frequency side of the receiver baseband, after detection but prior to de-multiplexing or demodulation.

Parameters:

value - An instances of type Double.

Returns:

The current Baseband object instance.

Since:

3.1.0

withModFreqMax

public Baseband withModFreqMax(Double value)

Set the maximum modulating frequency: - for a transmitter, measured on the high side of the spectrum signature at the -3 dB point before the baseband signal begins the up-conversion process; - for a receiver, frequency that can be recovered and demodulated by the receiver. Typically, this frequency should have 3-dB attenuation relative to the least attenuated demodulated or multiplexed signal.

[XSL ERR MINMAX] If ModFreqMax is used, it MUST be greater than ModFreqMin.

Parameters:

value - An instances of type Double.

Returns:

The current Baseband object instance.

Since:

3.1.0

withSignalType

public Baseband withSignalType(ListCMO value)

Set the type of modulation.

Parameters:

value - An instances of type ListCMO.

Returns:

The current Baseband object instance.

Since:

3.1.0

withBitDuration

public Baseband withBitDuration(Double value)

Set the period of elapsed time, per bit instance, before change of states.

Parameters:

value - An instances of type Double.

Returns:

The current Baseband object instance.

Since:

3.1.0

withOOKPattern

public Baseband withOOKPattern(String value)

Set a text description of the on-off keying (OOK) pattern. Example: (3 on, 3 off, 3 on, 4 off,...)

Parameters:

value - An instances of type String.

Returns:

The current Baseband object instance.

Since:

3.1.0

withSignalDurationMax

public Baseband withSignalDurationMax(Double value)

Set the maximum time value for how long the tone persists in the baseband.

[XSL ERR MINMAX] If US:SignalDurationMax is used, it MUST be greater than US:SignalDurationMin.

Parameters:

value - An instances of type Double.

Returns:

The current Baseband object instance.

Since:

3.1.0

withSignalDurationMin

public Baseband withSignalDurationMin(Double value)

Set the minimum time value for how long the tone persists in the baseband.

Parameters:

value - An instances of type Double.

Returns:

The current Baseband object instance.

Since:

3.1.0

withSignalSequenceDesc

public Baseband withSignalSequenceDesc(String value)

Set the pattern of occurrence of sub-signals. (Example: beep, beep, pause, bip, pause...) If using SignalDuration, entries in ToneName MUST match the descriptive names used here.

Parameters:

value - An instances of type String.

Returns:

The current Baseband object instance.

Since:

3.1.0

withSignalShape

public Baseband withSignalShape(ListUSS value)

Set the basic shape of the signal.

Parameters:

value - An instances of type ListUSS.

Returns:

The current Baseband object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Baseband instance configuration.

Overrides:

toString in class Object

Returns:

The current object instance configuration as a non-null String

isSet

public boolean isSet()

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

Baseband has no configuration requirements.

Returns:

TRUE