us.gov.dod.standard.ssrf._3_1.transmitter

Class ObservedMOPSweep

java.lang.Object

us.gov.dod.standard.ssrf._3_1.transmitter.ObservedMOPSweep

public class ObservedMOPSweep
extends Object

ObservedMOPSweep (US) contains data describing the parametric information for the period of the Modulation on the Pulse sweep.

Element of ObservedMOPAnalysis

Sub-Element is ObservedMOPSequence

Example: See ObservedMOPAnalysis.

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
ObservedMOPSweep()

Method Summary

Modifier and Type	Method and Description
Percent	getMOPDutyCycle() Get In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period..
microsecs	getMOPFlyBackInterval() Get In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep.
UN6	getMOPNumElements() Get In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time).
microsecs	getMOPRepetionInterval() Get the overall interval which may include multiple Sweep Repetition Intervals (SRI).
Unsigned_DB_5_2	getMOPStepAM() Get In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse.
US_MOPFm	getMOPStepCW() Get In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse.
US_MOPFm	getMOPStepFM() Get In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse.
US_PhaseAngle	getMOPStepPM() Get In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse.
microsecs	getMOPSweepPeriod() Get In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation)..
Set<ObservedMOPSequence>	getObservedMOPSequence() Get the US:ObservedMOPSequence
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetMOPDutyCycle() Determine if the MOPDutyCycle is configured.
boolean	isSetMOPFlyBackInterval() Determine if the MOPFlyBackInterval is configured.
boolean	isSetMOPNumElements() Determine if the MOPNumElements is configured.
boolean	isSetMOPRepetionInterval() Determine if the MOPRepetionInterval is configured.
boolean	isSetMOPStepAM() Determine if the MOPStepAM is configured.
boolean	isSetMOPStepCW() Determine if the MOPStepCW is configured.
boolean	isSetMOPStepFM() Determine if the MOPStepFM is configured.
boolean	isSetMOPStepPM() Determine if the MOPStepPM is configured.
boolean	isSetMOPSweepPeriod() Determine if the MOPSweepPeriod is configured.
boolean	isSetObservedMOPSequence() Determine if the ObservedMOPSequence is configured.
void	setMOPDutyCycle(Percent value) Set In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period..
void	setMOPFlyBackInterval(microsecs value) Set In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep.
void	setMOPNumElements(UN6 value) Set In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time).
void	setMOPRepetionInterval(microsecs value) Set the overall interval which may include multiple Sweep Repetition Intervals (SRI).
void	setMOPStepAM(Unsigned_DB_5_2 value) Set In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse.
void	setMOPStepCW(US_MOPFm value) Set In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse.
void	setMOPStepFM(US_MOPFm value) Set In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse.
void	setMOPStepPM(US_PhaseAngle value) Set In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse.
void	setMOPSweepPeriod(microsecs value) Set In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation)..
String	toString() Get a string representation of this ObservedMOPSweep instance configuration.
void	unsetObservedMOPSequence() Clear the ObservedMOPSequence field.
ObservedMOPSweep	withMOPDutyCycle(Double value) Set In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period.
ObservedMOPSweep	withMOPFlyBackInterval(Double value) Set In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep.
ObservedMOPSweep	withMOPNumElements(Integer value) Set In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time)
ObservedMOPSweep	withMOPRepetionInterval(Double value) Set the overall interval which may include multiple Sweep Repetition Intervals (SRI).
ObservedMOPSweep	withMOPStepAM(Double value) Set In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse.
ObservedMOPSweep	withMOPStepCW(Double value) Set In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse.
ObservedMOPSweep	withMOPStepFM(Double value) Set In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse.
ObservedMOPSweep	withMOPStepPM(Double value) Set In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse.
ObservedMOPSweep	withMOPSweepPeriod(Double value) Set In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation).
ObservedMOPSweep	withObservedMOPSequence(Collection<ObservedMOPSequence> values) Set the US:ObservedMOPSequence
ObservedMOPSweep	withObservedMOPSequence(ObservedMOPSequence... values) Set the US:ObservedMOPSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservedMOPSweep

public ObservedMOPSweep()

Method Detail

getMOPDutyCycle

public Percent getMOPDutyCycle()

Get In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period..

Returns:

a Percent instance

Since:

3.1.0

setMOPDutyCycle

public void setMOPDutyCycle(Percent value)

Set In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period..

Parameters:

value - a Percent instance

Since:

3.1.0

isSetMOPDutyCycle

public boolean isSetMOPDutyCycle()

Determine if the MOPDutyCycle is configured.

Returns:

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

getMOPNumElements

public UN6 getMOPNumElements()

Get In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time).

Returns:

a UN6 instance

Since:

3.1.0

setMOPNumElements

public void setMOPNumElements(UN6 value)

Set In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time).

Parameters:

value - a UN6 instance

Since:

3.1.0

isSetMOPNumElements

public boolean isSetMOPNumElements()

Determine if the MOPNumElements is configured.

Returns:

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

getMOPStepAM

public Unsigned_DB_5_2 getMOPStepAM()

Get In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Returns:

a Unsigned_DB_5_2 instance

Since:

3.1.0

setMOPStepAM

public void setMOPStepAM(Unsigned_DB_5_2 value)

Set In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Parameters:

value - a Unsigned_DB_5_2 instance

Since:

3.1.0

isSetMOPStepAM

public boolean isSetMOPStepAM()

Determine if the MOPStepAM is configured.

Returns:

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

getMOPStepCW

public US_MOPFm getMOPStepCW()

Get In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Returns:

a US_MOPFm instance

Since:

3.1.0

setMOPStepCW

public void setMOPStepCW(US_MOPFm value)

Set In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Parameters:

value - a US_MOPFm instance

Since:

3.1.0

isSetMOPStepCW

public boolean isSetMOPStepCW()

Determine if the MOPStepCW is configured.

Returns:

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

getMOPStepFM

public US_MOPFm getMOPStepFM()

Get In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Returns:

a US_MOPFm instance

Since:

3.1.0

setMOPStepFM

public void setMOPStepFM(US_MOPFm value)

Set In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Parameters:

value - a US_MOPFm instance

Since:

3.1.0

isSetMOPStepFM

public boolean isSetMOPStepFM()

Determine if the MOPStepFM is configured.

Returns:

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

getMOPStepPM

public US_PhaseAngle getMOPStepPM()

Get In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Returns:

a US_PhaseAngle instance

Since:

3.1.0

setMOPStepPM

public void setMOPStepPM(US_PhaseAngle value)

Set In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType..

Parameters:

value - a US_PhaseAngle instance

Since:

3.1.0

isSetMOPStepPM

public boolean isSetMOPStepPM()

Determine if the MOPStepPM is configured.

Returns:

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

getMOPFlyBackInterval

public microsecs getMOPFlyBackInterval()

Get In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep. Flyback time is included in the Sweep Repetition Interval (SWI) but also may be reported separately..

Returns:

a microsecs instance

Since:

3.1.0

setMOPFlyBackInterval

public void setMOPFlyBackInterval(microsecs value)

Set In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep. Flyback time is included in the Sweep Repetition Interval (SWI) but also may be reported separately..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetMOPFlyBackInterval

public boolean isSetMOPFlyBackInterval()

Determine if the MOPFlyBackInterval is configured.

Returns:

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

getMOPSweepPeriod

public microsecs getMOPSweepPeriod()

Get In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation)..

Returns:

a microsecs instance

Since:

3.1.0

setMOPSweepPeriod

public void setMOPSweepPeriod(microsecs value)

Set In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation)..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetMOPSweepPeriod

public boolean isSetMOPSweepPeriod()

Determine if the MOPSweepPeriod is configured.

Returns:

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

getMOPRepetionInterval

public microsecs getMOPRepetionInterval()

Get the overall interval which may include multiple Sweep Repetition Intervals (SRI). Fly-back times, and dead times..

Returns:

a microsecs instance

Since:

3.1.0

setMOPRepetionInterval

public void setMOPRepetionInterval(microsecs value)

Set the overall interval which may include multiple Sweep Repetition Intervals (SRI). Fly-back times, and dead times..

Parameters:

value - a microsecs instance

Since:

3.1.0

isSetMOPRepetionInterval

public boolean isSetMOPRepetionInterval()

Determine if the MOPRepetionInterval is configured.

Returns:

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

getObservedMOPSequence

public Set<ObservedMOPSequence> getObservedMOPSequence()

Get the US:ObservedMOPSequence

Complex element ObservedMOPSequence (US) contains descriptive information about the sequencing used for the Modulation impressed On the Pulse (MOP)..

Returns:

a ObservedMOPSequence instance

Since:

3.1.0

isSetObservedMOPSequence

public boolean isSetObservedMOPSequence()

Determine if the ObservedMOPSequence is configured.

Returns:

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

unsetObservedMOPSequence

public void unsetObservedMOPSequence()

Clear the ObservedMOPSequence field. This sets the field to null.

withMOPDutyCycle

public ObservedMOPSweep withMOPDutyCycle(Double value)

Set In Data Item US:MOPDutyCycle (US), enter as a percentage, the minimum or nominal ratio of the pulse duration to the pulse period.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPNumElements

public ObservedMOPSweep withMOPNumElements(Integer value)

Set In Data Item US:MOPNumElements (US), enter the number of discrete FREQ/PHASE/AMP values transmitted in a patterned sequence (i.e., any repeated values are counted each time)

Parameters:

value - An instances of type Integer.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPStepAM

public ObservedMOPSweep withMOPStepAM(Double value)

Set In Data Item US:MOPStepAM (US), enter the difference between adjacent amplitude discrete power values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPStepCW

public ObservedMOPSweep withMOPStepCW(Double value)

Set In Data Item US:MOPStepCW(US), enter the difference between adjacent continuous wave frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPStepFM

public ObservedMOPSweep withMOPStepFM(Double value)

Set In Data Item US:MOPStepFM (US), enter the difference between adjacent frequency discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPStepPM

public ObservedMOPSweep withMOPStepPM(Double value)

Set In Data Item US:MOPStepPM (US), enter the difference between adjacent phase discrete values, within a pulse. Use of this element should agree with the selection made in US:ObservedMOPAnalysis.MOPType.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPFlyBackInterval

public ObservedMOPSweep withMOPFlyBackInterval(Double value)

Set In Data Item US:MOPFlyBackInterval (US), enter the time duration between the end of a continuous (linear) sweep and the beginning of the next continuous (linear) sweep. Flyback time is included in the Sweep Repetition Interval (SWI) but also may be reported separately.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPSweepPeriod

public ObservedMOPSweep withMOPSweepPeriod(Double value)

Set In Data Item US:MOPSweepPeriod (US), enter the time duration from a point in the RF sequence (or continuous variation) to the like point in the next repeating RF sequence (or continuous variation).

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withMOPRepetionInterval

public ObservedMOPSweep withMOPRepetionInterval(Double value)

Set the overall interval which may include multiple Sweep Repetition Intervals (SRI). Fly-back times, and dead times.

Parameters:

value - An instances of type Double.

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withObservedMOPSequence

public ObservedMOPSweep withObservedMOPSequence(ObservedMOPSequence... values)

Set the US:ObservedMOPSequence

Complex element ObservedMOPSequence (US) contains descriptive information about the sequencing used for the Modulation impressed On the Pulse (MOP).

Parameters:

values - One or more instances of type ObservedMOPSequence....

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

withObservedMOPSequence

public ObservedMOPSweep withObservedMOPSequence(Collection<ObservedMOPSequence> values)

Set the US:ObservedMOPSequence

Complex element ObservedMOPSequence (US) contains descriptive information about the sequencing used for the Modulation impressed On the Pulse (MOP).

Parameters:

values - A collection of ObservedMOPSequence instances

Returns:

The current ObservedMOPSweep object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this ObservedMOPSweep 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.

ObservedMOPSweep has no configuration requirements.

Returns:

TRUE