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

Class AntHardware

java.lang.Object

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

public class AntHardware
extends Object

AntHardware contains the physical parameters related to the antenna feed and lead.

Element of Antenna

Example:

 <Ant Hardware>
   <ConnectorType  cls="U">Neill-Concelman Threaded</ConnectorType >
   <FeedOrientation  cls="U">down-right</FeedOrientation >
   <FeedType  cls="U">Eight Feed Horn Cluster</FeedType >
   <LeadType  cls="U">Waveguide Semirigid</LeadType >
 </Ant Hardware>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
AntHardware()

Method Summary

Modifier and Type	Method and Description
TString	getConnectorType() Get the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna..
S10	getFeedOrientation() Get the orientation of the feed when looking in the direction of the boresight.
TString	getFeedType() Get the element used to "illuminate" the reflector for an antenna unit..
TString	getLeadType() Get the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide)..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetConnectorType() Determine if the ConnectorType is configured.
boolean	isSetFeedOrientation() Determine if the FeedOrientation is configured.
boolean	isSetFeedType() Determine if the FeedType is configured.
boolean	isSetLeadType() Determine if the LeadType is configured.
void	setConnectorType(TString value) Set the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna..
void	setFeedOrientation(S10 value) Set the orientation of the feed when looking in the direction of the boresight.
void	setFeedType(TString value) Set the element used to "illuminate" the reflector for an antenna unit..
void	setLeadType(TString value) Set the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide)..
String	toString() Get a string representation of this AntHardware instance configuration.
AntHardware	withConnectorType(ListCCN value) Set the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna.
AntHardware	withFeedOrientation(String value) Set the orientation of the feed when looking in the direction of the boresight.
AntHardware	withFeedType(ListCAF value) Set the element used to "illuminate" the reflector for an antenna unit.
AntHardware	withLeadType(ListCAL value) Set the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide).

Methods inherited from class java.lang.Object

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

Constructor Detail

AntHardware

public AntHardware()

Method Detail

getFeedType

public TString getFeedType()

Get the element used to "illuminate" the reflector for an antenna unit..

Returns:

the FeedType value in a TString data type

Since:

3.1.0

setFeedType

public void setFeedType(TString value)

Set the element used to "illuminate" the reflector for an antenna unit..

Parameters:

value - the FeedType value in a TString data type

Since:

3.1.0

isSetFeedType

public boolean isSetFeedType()

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

getLeadType

public TString getLeadType()

Get the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide)..

Returns:

the LeadType value in a TString data type

Since:

3.1.0

setLeadType

public void setLeadType(TString value)

Set the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide)..

Parameters:

value - the LeadType value in a TString data type

Since:

3.1.0

isSetLeadType

public boolean isSetLeadType()

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

getConnectorType

public TString getConnectorType()

Get the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna..

Returns:

the ConnectorType value in a TString data type

Since:

3.1.0

setConnectorType

public void setConnectorType(TString value)

Set the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna..

Parameters:

value - the ConnectorType value in a TString data type

Since:

3.1.0

isSetConnectorType

public boolean isSetConnectorType()

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

getFeedOrientation

public S10 getFeedOrientation()

Get the orientation of the feed when looking in the direction of the boresight. Examples of orientations are right, left, center, up, down, up-left, up-right, down-left, down-right..

Returns:

a S10 instance

Since:

3.1.0

setFeedOrientation

public void setFeedOrientation(S10 value)

Set the orientation of the feed when looking in the direction of the boresight. Examples of orientations are right, left, center, up, down, up-left, up-right, down-left, down-right..

Parameters:

value - a S10 instance

Since:

3.1.0

isSetFeedOrientation

public boolean isSetFeedOrientation()

Determine if the FeedOrientation is configured.

Returns:

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

withFeedType

public AntHardware withFeedType(ListCAF value)

Set the element used to "illuminate" the reflector for an antenna unit.

Parameters:

value - An instances of type ListCAF.

Returns:

The current AntHardware object instance.

Since:

3.1.0

withLeadType

public AntHardware withLeadType(ListCAL value)

Set the type of device used for conducting or guiding the radio-frequency energy from the transmitter or receiver to the antenna (e.g., continuous waveguide).

Parameters:

value - An instances of type ListCAL.

Returns:

The current AntHardware object instance.

Since:

3.1.0

withConnectorType

public AntHardware withConnectorType(ListCCN value)

Set the type of connector used to attach the antenna to the equipment or the antenna to the transmission media that attaches the equipment to the antenna.

Parameters:

value - An instances of type ListCCN.

Returns:

The current AntHardware object instance.

Since:

3.1.0

withFeedOrientation

public AntHardware withFeedOrientation(String value)

Set the orientation of the feed when looking in the direction of the boresight. Examples of orientations are right, left, center, up, down, up-left, up-right, down-left, down-right.

Parameters:

value - An instances of type String.

Returns:

The current AntHardware object instance.

Since:

3.1.0

toString

public String toString()

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

AntHardware has no configuration requirements.

Returns:

TRUE