Module org.opengis.geoapi

Package org.opengis.metadata.content

Class PolarizationOrientation

Object

CodeList<PolarizationOrientation>

PolarizationOrientation

All Implemented Interfaces:

Serializable, Comparable<PolarizationOrientation>, ControlledVocabulary

@UML(identifier="MI_PolarisationOrientationCode",
     specification=ISO_19115_2)
public final class PolarizationOrientation
extends CodeList<PolarizationOrientation>

Polarization of the antenna relative to the waveform.

Upcoming API change
This class will be renamed PolarisationOrientation in GeoAPI 4.0 for compliance with ISO 19115-2:2019.

Since:

3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final PolarizationOrientation	HORIZONTAL	Polarization of the sensor oriented in the horizontal plane in relation to swath direction.
static final PolarizationOrientation	LEFT_CIRCULAR	Polarization of the sensor oriented in the left circular plane in relation to swath direction.
static final PolarizationOrientation	PHI	Polarization of the sensor oriented in the +90 ° and 0 ° perpendicular to swath direction.
static final PolarizationOrientation	RIGHT_CIRCULAR	Polarization of the sensor oriented in the right circular plane in relation to swath direction.
static final PolarizationOrientation	THETA	Polarization of the sensor oriented in the angle between +90 ° and 0 ° parallel to swath direction.
static final PolarizationOrientation	VERTICAL	Polarization of the sensor oriented in the vertical plane in relation to swath direction.

Method Summary

Modifier and Type	Method	Description
PolarizationOrientation[]	family()	Returns the list of codes of the same kind as this code list element.
static PolarizationOrientation	valueOf(String code)	Returns the transfer function type that matches the given string, or returns a new one if none match it.
static PolarizationOrientation[]	values()	Returns the list of PolarisationOrientations.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

HORIZONTAL

@UML(identifier="horizontal",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation HORIZONTAL

Polarization of the sensor oriented in the horizontal plane in relation to swath direction.

VERTICAL

@UML(identifier="vertical",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation VERTICAL

Polarization of the sensor oriented in the vertical plane in relation to swath direction.

LEFT_CIRCULAR

@UML(identifier="leftCircular",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation LEFT_CIRCULAR

Polarization of the sensor oriented in the left circular plane in relation to swath direction.

RIGHT_CIRCULAR

@UML(identifier="rightCircular",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation RIGHT_CIRCULAR

Polarization of the sensor oriented in the right circular plane in relation to swath direction.

THETA

@UML(identifier="theta",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation THETA

Polarization of the sensor oriented in the angle between +90 ° and 0 ° parallel to swath direction.

PHI

@UML(identifier="phi",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final PolarizationOrientation PHI

Polarization of the sensor oriented in the +90 ° and 0 ° perpendicular to swath direction.

Method Details

values

public static PolarizationOrientation[] values()

Returns the list of PolarisationOrientations.

Returns:

the list of codes declared in the current JVM.

family

public PolarizationOrientation[] family()

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<PolarizationOrientation>

Returns:

all code values for this code list.

valueOf

public static PolarizationOrientation valueOf(String code)

Returns the transfer function type that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.