us.gov.dod.standard.ssrf._3_1.antenna

Class AntPattern

java.lang.Object

us.gov.dod.standard.ssrf._3_1.antenna.AntPattern

public class AntPattern
extends Object

AntPattern contains an antenna pattern diagram on a specific plane. General pattern cuts can be defined by a spherical coordinate system with the electrical boresite of the antenna oriented in the direction of the Z-axis. At different values of phi, pattern cuts can be taken with theta as the dependent variable. These will be great circle cuts through the main-beam peak.

Element of AntMode

Sub-Element is AntPatternPoint

Example:

 <AntPattern>
   <Type cls="U">Azimuth</Type>
   <Calculated cls="U">Yes</Calculated>
   <AntPatternPoint>
     <Dir cls="U">180</Dir>
     <Gain cls="U">40.1</Gain>
   </AntPatternPoint>
   <AntPatternPoint/>
   </AntPattern>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
AntPattern()

Method Summary

Modifier and Type	Method and Description
Set<AntPatternPoint>	getAntPatternPoint() Get the AntPatternPoint
TString	getCalculated() Get Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
Az180	getCutAngle() Get the angle of the pattern cut.
TString	getCutType() Get the type of the pattern cut.
TString	getType() Get the type of the pattern cut.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAntPatternPoint() Determine if the AntPatternPoint is configured.
boolean	isSetCalculated() Determine if the Calculated is configured.
boolean	isSetCutAngle() Determine if the CutAngle is configured.
boolean	isSetCutType() Determine if the CutType is configured.
boolean	isSetType() Determine if the Type is configured.
void	setCalculated(TString value) Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
void	setCutAngle(Az180 value) Set the angle of the pattern cut.
void	setCutType(TString value) Set the type of the pattern cut.
void	setType(TString value) Set the type of the pattern cut.
String	toString() Get a string representation of this AntPattern instance configuration.
void	unsetAntPatternPoint() Clear the AntPatternPoint field.
AntPattern	withAntPatternPoint(AntPatternPoint... values) Set the AntPatternPoint
AntPattern	withAntPatternPoint(Collection<AntPatternPoint> values) Set the AntPatternPoint
AntPattern	withCalculated(ListCBO value) Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
AntPattern	withCutAngle(Double value) Set the angle of the pattern cut.
AntPattern	withCutType(ListCTP value) Set the type of the pattern cut.
AntPattern	withType(ListCAP value) Set the type of the pattern cut.

Methods inherited from class java.lang.Object

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

Constructor Detail

AntPattern

public AntPattern()

Method Detail

getType

public TString getType()

Get the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight..

Parameters:

value - the Type value in a TString data type

Since:

3.1.0

isSetType

public boolean isSetType()

Determine if the Type 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

getCalculated

public TString getCalculated()

Get Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known..

Returns:

the Calculated value in a TString data type

Since:

3.1.0

setCalculated

public void setCalculated(TString value)

Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known..

Parameters:

value - the Calculated value in a TString data type

Since:

3.1.0

isSetCalculated

public boolean isSetCalculated()

Determine if the Calculated 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

getCutType

public TString getCutType()

Get the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight..

Returns:

the CutType value in a TString data type

Since:

3.1.0

setCutType

public void setCutType(TString value)

Set the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight..

Parameters:

value - the CutType value in a TString data type

Since:

3.1.0

isSetCutType

public boolean isSetCutType()

Determine if the CutType 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

getCutAngle

public Az180 getCutAngle()

Get the angle of the pattern cut. It is the value of Phi for a Theta cut and the value of Theta for a Phi cut..

Returns:

a Az180 instance

Since:

3.1.0

setCutAngle

public void setCutAngle(Az180 value)

Set the angle of the pattern cut. It is the value of Phi for a Theta cut and the value of Theta for a Phi cut..

Parameters:

value - a Az180 instance

Since:

3.1.0

isSetCutAngle

public boolean isSetCutAngle()

Determine if the CutAngle is configured.

Returns:

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

getAntPatternPoint

public Set<AntPatternPoint> getAntPatternPoint()

Get the AntPatternPoint

Complex element AntPatternPoint contains a single point of the antenna radiation pattern, defined by a direction and gain..

Returns:

a AntPatternPoint instance

Since:

3.1.0

isSetAntPatternPoint

public boolean isSetAntPatternPoint()

Determine if the AntPatternPoint is configured.

Returns:

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

unsetAntPatternPoint

public void unsetAntPatternPoint()

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

withType

public AntPattern withType(ListCAP value)

Set the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight.

Parameters:

value - An instances of type ListCAP.

Returns:

The current AntPattern object instance.

Since:

3.1.0

withCalculated

public AntPattern withCalculated(ListCBO value)

Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known.

Parameters:

value - An instances of type ListCBO.

Returns:

The current AntPattern object instance.

Since:

3.1.0

withCutType

public AntPattern withCutType(ListCTP value)

Set the type of the pattern cut. A Theta cut holds Phi constant while varying Theta. A Phi cut holds Theta constant while varying Phi, where Theta is the angle off the boresight and Phi is the rotation angle about the boresight.

Parameters:

value - An instances of type ListCTP.

Returns:

The current AntPattern object instance.

Since:

3.1.0

withCutAngle

public AntPattern withCutAngle(Double value)

Set the angle of the pattern cut. It is the value of Phi for a Theta cut and the value of Theta for a Phi cut.

Parameters:

value - An instances of type Double.

Returns:

The current AntPattern object instance.

Since:

3.1.0

withAntPatternPoint

public AntPattern withAntPatternPoint(AntPatternPoint... values)

Set the AntPatternPoint

Complex element AntPatternPoint contains a single point of the antenna radiation pattern, defined by a direction and gain.

Parameters:

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

Returns:

The current AntPattern object instance.

Since:

3.1.0

withAntPatternPoint

public AntPattern withAntPatternPoint(Collection<AntPatternPoint> values)

Set the AntPatternPoint

Complex element AntPatternPoint contains a single point of the antenna radiation pattern, defined by a direction and gain.

Parameters:

values - A collection of AntPatternPoint instances

Returns:

The current AntPattern object instance.

Since:

3.1.0

toString

public String toString()

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

AntPattern requires AntPatternPoint.

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

Returns:

TRUE if required fields are set, otherwise FALSE