Package org.esa.snap.core.datamodel
Class FlagCoding
- java.lang.Object
-
- com.bc.ceres.core.ExtensibleObject
-
- org.esa.snap.core.datamodel.ProductNode
-
- org.esa.snap.core.datamodel.MetadataElement
-
- org.esa.snap.core.datamodel.SampleCoding
-
- org.esa.snap.core.datamodel.FlagCoding
-
- All Implemented Interfaces:
Extensible
public class FlagCoding extends SampleCoding
Provides the information required to decode integer sample values that are combined of single flags (bit indexes).
-
-
Field Summary
-
Fields inherited from class org.esa.snap.core.datamodel.ProductNode
PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_NAME
-
-
Constructor Summary
Constructors Constructor Description FlagCoding(String name)
Constructs a new flag coding object with the given name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
acceptVisitor(ProductVisitor visitor)
Accepts the given visitor.MetadataAttribute
addFlag(String name, int flagMask, int flagValue, String description)
Adds a new flag definition to this flags coding.MetadataAttribute
addFlag(String name, int flagMask, String description)
Adds a new flag definition to this flags coding.MetadataAttribute
getFlag(String name)
Returns a metadata attribute wich is the representation of the flag with the given name.int
getFlagMask(String name)
Returns the flag mask value for the specified flag name.String[]
getFlagNames()
Returns a string array which contains the names of all flags contained in thisFlagCoding
object.-
Methods inherited from class org.esa.snap.core.datamodel.SampleCoding
addAttribute, addElement, addSample, addSamples, getSampleCount, getSampleName, getSampleValue
-
Methods inherited from class org.esa.snap.core.datamodel.MetadataElement
addElementAt, containsAttribute, containsElement, createDeepClone, dispose, getAttribute, getAttributeAt, getAttributeDouble, getAttributeDouble, getAttributeIndex, getAttributeInt, getAttributeInt, getAttributeNames, getAttributes, getAttributeString, getAttributeString, getAttributeUTC, getAttributeUTC, getElement, getElementAt, getElementGroup, getElementIndex, getElementNames, getElements, getNumAttributes, getNumElements, getParentElement, getRawStorageSize, removeAttribute, removeElement, setAttributeDouble, setAttributeInt, setAttributeString, setAttributeUTC, setModified
-
Methods inherited from class org.esa.snap.core.datamodel.ProductNode
fireProductNodeChanged, fireProductNodeChanged, getDescription, getDisplayName, getName, getOwner, getProduct, getProductReader, getProductReaderSafe, getProductRefString, getProductSafe, getProductWriter, getProductWriterSafe, getRawStorageSize, isModified, isPartOfSubset, isValidNodeName, removeFromFile, setDescription, setName, setNodeName, setOwner, toString, updateExpression
-
Methods inherited from class com.bc.ceres.core.ExtensibleObject
getExtension
-
-
-
-
Constructor Detail
-
FlagCoding
public FlagCoding(String name)
Constructs a new flag coding object with the given name.- Parameters:
name
- the name
-
-
Method Detail
-
getFlag
public MetadataAttribute getFlag(String name)
Returns a metadata attribute wich is the representation of the flag with the given name. This method delegates to getPropertyValue(String).- Parameters:
name
- the flag name- Returns:
- a metadata attribute wich is the representation of the flag with the given name
-
getFlagNames
public String[] getFlagNames()
Returns a string array which contains the names of all flags contained in thisFlagCoding
object.- Returns:
- a string array which contains all names of this
FlagCoding
.
If thisFlagCoding
does not contain any flag,null
is returned
-
addFlag
public MetadataAttribute addFlag(String name, int flagMask, String description)
Adds a new flag definition to this flags coding.- Parameters:
name
- the flag nameflagMask
- the flag's bit maskdescription
- the description text- Returns:
- A new attribute representing the flag.
- Throws:
IllegalArgumentException
- ifname
is null
-
addFlag
public MetadataAttribute addFlag(String name, int flagMask, int flagValue, String description)
Adds a new flag definition to this flags coding.- Parameters:
name
- the flag nameflagMask
- the flag's bit maskdescription
- the description text- Returns:
- A new attribute representing the flag.
- Throws:
IllegalArgumentException
- ifname
is null- Since:
- SNAP 0.5
-
getFlagMask
public int getFlagMask(String name)
Returns the flag mask value for the specified flag name.- Parameters:
name
- the flag name- Returns:
- flagMask the flag's bit mask as a 32 bit integer
- Throws:
IllegalArgumentException
- ifname
is null, or a flag with the name does not exist
-
acceptVisitor
public void acceptVisitor(ProductVisitor visitor)
Accepts the given visitor. This method implements the well known 'Visitor' design pattern of the gang-of-four. The visitor pattern allows to define new operations on the product data model without the need to add more code to it. The new operation is implemented by the visitor.The method simply calls
visitor.visit(this)
.- Overrides:
acceptVisitor
in classMetadataElement
- Parameters:
visitor
- the visitor, must not benull
-
-