Module org.opengis.geoapi

Package org.opengis.metadata.content

Class TransferFunctionType

Object

CodeList<TransferFunctionType>

TransferFunctionType

All Implemented Interfaces:

Serializable, Comparable<TransferFunctionType>, ControlledVocabulary

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

Transform function to be used when scaling a physical value for a given element.

Since:

2.3

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 TransferFunctionType	EXPONENTIAL	Function used for transformation is exponential.
static final TransferFunctionType	LINEAR	Function used for transformation is first order polynomial.
static final TransferFunctionType	LOGARITHMIC	Function used for transformation is logarithmic

Method Summary

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

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

LINEAR

@UML(identifier="linear",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final TransferFunctionType LINEAR

Function used for transformation is first order polynomial.

LOGARITHMIC

@UML(identifier="logarithmic",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final TransferFunctionType LOGARITHMIC

Function used for transformation is logarithmic

EXPONENTIAL

@UML(identifier="exponential",
     obligation=CONDITIONAL,
     specification=ISO_19115_2)
public static final TransferFunctionType EXPONENTIAL

Function used for transformation is exponential.

Method Details

values

public static TransferFunctionType[] values()

Returns the list of TransferFunctionTypes.

Returns:

the list of codes declared in the current JVM.

family

public TransferFunctionType[] 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<TransferFunctionType>

Returns:

all code values for this code list.

valueOf

public static TransferFunctionType 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.