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

Class Nomenclature

java.lang.Object

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

public class Nomenclature
extends Object

Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number.

Element of Antenna, ForceElement, RFSystem, Receiver, SSRequest, Satellite, Transmitter

Sub-Element is Manufacturer

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Nomenclature()

Method Summary

Modifier and Type	Method and Description
TString	getLevel() Get the level of nomenclature (primary, nickname, etc)..
Set<Manufacturer>	getManufacturer() Get the Manufacturer
S100	getName() Get the standard military nomenclature.
TString	getPhysicalUsage() Get In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates..
TString	getType() Get the type of nomenclature (commercial, military, etc)..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetLevel() Determine if the Level is configured.
boolean	isSetManufacturer() Determine if the Manufacturer is configured.
boolean	isSetName() Determine if the Name is configured.
boolean	isSetPhysicalUsage() Determine if the PhysicalUsage is configured.
boolean	isSetType() Determine if the Type is configured.
void	setLevel(TString value) Set the level of nomenclature (primary, nickname, etc)..
void	setName(S100 value) Set the standard military nomenclature.
void	setPhysicalUsage(TString value) Set In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates..
void	setType(TString value) Set the type of nomenclature (commercial, military, etc)..
String	toString() Get a string representation of this Nomenclature instance configuration.
void	unsetManufacturer() Clear the Manufacturer field.
Nomenclature	withLevel(ListCNU value) Set the level of nomenclature (primary, nickname, etc).
Nomenclature	withManufacturer(Collection<Manufacturer> values) Set the Manufacturer
Nomenclature	withManufacturer(Manufacturer... values) Set the Manufacturer
Nomenclature	withName(String value) Set the standard military nomenclature.
Nomenclature	withPhysicalUsage(ListUS5 value) Set In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates.
Nomenclature	withType(ListCTO value) Set the type of nomenclature (commercial, military, etc).

Methods inherited from class java.lang.Object

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

Constructor Detail

Nomenclature

public Nomenclature()

Method Detail

getType

public TString getType()

Get the type of nomenclature (commercial, military, etc)..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set the type of nomenclature (commercial, military, etc)..

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

getLevel

public TString getLevel()

Get the level of nomenclature (primary, nickname, etc)..

Returns:

the Level value in a TString data type

Since:

3.1.0

setLevel

public void setLevel(TString value)

Set the level of nomenclature (primary, nickname, etc)..

Parameters:

value - the Level value in a TString data type

Since:

3.1.0

isSetLevel

public boolean isSetLevel()

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

getName

public S100 getName()

Get the standard military nomenclature. If the unit does not have a military nomenclature, enter the manufacturer model number, or a short description..

Returns:

a S100 instance

Since:

3.1.0

setName

public void setName(S100 value)

Set the standard military nomenclature. If the unit does not have a military nomenclature, enter the manufacturer model number, or a short description..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetName

public boolean isSetName()

Determine if the Name is configured.

Returns:

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

getPhysicalUsage

public TString getPhysicalUsage()

Get In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates..

Returns:

the PhysicalUsage value in a TString data type

Since:

3.1.0

setPhysicalUsage

public void setPhysicalUsage(TString value)

Set In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates..

Parameters:

value - the PhysicalUsage value in a TString data type

Since:

3.1.0

isSetPhysicalUsage

public boolean isSetPhysicalUsage()

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

getManufacturer

public Set<Manufacturer> getManufacturer()

Get the Manufacturer

Complex element Manufacturer contains the manufacturer name of the equipment listed in the corresponding data entry in data element Nomenclature. Additionally the country in which the equipment is manufactured may be included..

Returns:

a Manufacturer instance

Since:

3.1.0

isSetManufacturer

public boolean isSetManufacturer()

Determine if the Manufacturer is configured.

Returns:

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

unsetManufacturer

public void unsetManufacturer()

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

withType

public Nomenclature withType(ListCTO value)

Set the type of nomenclature (commercial, military, etc).

Parameters:

value - An instances of type ListCTO.

Returns:

The current Nomenclature object instance.

Since:

3.1.0

withLevel

public Nomenclature withLevel(ListCNU value)

Set the level of nomenclature (primary, nickname, etc).

Parameters:

value - An instances of type ListCNU.

Returns:

The current Nomenclature object instance.

Since:

3.1.0

withName

public Nomenclature withName(String value)

Set the standard military nomenclature. If the unit does not have a military nomenclature, enter the manufacturer model number, or a short description.

Parameters:

value - An instances of type String.

Returns:

The current Nomenclature object instance.

Since:

3.1.0

withPhysicalUsage

public Nomenclature withPhysicalUsage(ListUS5 value)

Set In Data Item PhysicalUsage (US), indicate the type of vehicle or other entity that uses the equipment, or from which the subject signal emanates.

Parameters:

value - An instances of type ListUS5.

Returns:

The current Nomenclature object instance.

Since:

3.1.0

withManufacturer

public Nomenclature withManufacturer(Manufacturer... values)

Set the Manufacturer

Complex element Manufacturer contains the manufacturer name of the equipment listed in the corresponding data entry in data element Nomenclature. Additionally the country in which the equipment is manufactured may be included.

Parameters:

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

Returns:

The current Nomenclature object instance.

Since:

3.1.0

withManufacturer

public Nomenclature withManufacturer(Collection<Manufacturer> values)

Set the Manufacturer

Complex element Manufacturer contains the manufacturer name of the equipment listed in the corresponding data entry in data element Nomenclature. Additionally the country in which the equipment is manufactured may be included.

Parameters:

values - A collection of Manufacturer instances

Returns:

The current Nomenclature object instance.

Since:

3.1.0

toString

public String toString()

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

Nomenclature requires Name.

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