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

Class AntPatternPoint

java.lang.Object

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

public class AntPatternPoint
extends Object

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

Element of AntPattern

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
AntPatternPoint()

Method Summary

Modifier and Type	Method and Description
Az	getDir() Get the direction in degrees in reference to the pointing angle of the antenna set to zero..
Signed_DB_5_2	getGain() Get the amount of gain for the direction relative to the main beam gain..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetDir() Determine if the Dir is configured.
boolean	isSetGain() Determine if the Gain is configured.
void	setDir(Az value) Set the direction in degrees in reference to the pointing angle of the antenna set to zero..
void	setGain(Signed_DB_5_2 value) Set the amount of gain for the direction relative to the main beam gain..
String	toString() Get a string representation of this AntPatternPoint instance configuration.
AntPatternPoint	withDir(Double value) Set the direction in degrees in reference to the pointing angle of the antenna set to zero.
AntPatternPoint	withGain(Double value) Set the amount of gain for the direction relative to the main beam gain.

Methods inherited from class java.lang.Object

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

Constructor Detail

AntPatternPoint

public AntPatternPoint()

Method Detail

getDir

public Az getDir()

Get the direction in degrees in reference to the pointing angle of the antenna set to zero..

Returns:

a Az instance

Since:

3.1.0

setDir

public void setDir(Az value)

Set the direction in degrees in reference to the pointing angle of the antenna set to zero..

Parameters:

value - a Az instance

Since:

3.1.0

isSetDir

public boolean isSetDir()

Determine if the Dir is configured.

Returns:

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

getGain

public Signed_DB_5_2 getGain()

Get the amount of gain for the direction relative to the main beam gain..

Returns:

a Signed_DB_5_2 instance

Since:

3.1.0

setGain

public void setGain(Signed_DB_5_2 value)

Set the amount of gain for the direction relative to the main beam gain..

Parameters:

value - a Signed_DB_5_2 instance

Since:

3.1.0

isSetGain

public boolean isSetGain()

Determine if the Gain is configured.

Returns:

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

withDir

public AntPatternPoint withDir(Double value)

Set the direction in degrees in reference to the pointing angle of the antenna set to zero.

Parameters:

value - An instances of type Double.

Returns:

The current AntPatternPoint object instance.

Since:

3.1.0

withGain

public AntPatternPoint withGain(Double value)

Set the amount of gain for the direction relative to the main beam gain.

Parameters:

value - An instances of type Double.

Returns:

The current AntPatternPoint object instance.

Since:

3.1.0

toString

public String toString()

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

AntPatternPoint requires Dir, Gain.

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