ucar.ma2

Class StructureMembers.Member

java.lang.Object

ucar.ma2.StructureMembers.Member

Enclosing class:

StructureMembers

public static final class StructureMembers.Member
extends java.lang.Object

A member of a StructureData.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Array	getDataArray() Get the data array, if any.
java.lang.Object	getDataObject() Get an opaque data object, for use behind the scenes.
int	getDataParam() Get the data parameter value, for use behind the scenes.
DataType	getDataType() Get the DataType.
java.lang.String	getDescription() Get the description, if any.
java.lang.String	getFullName()
java.lang.String	getFullNameEscaped()
java.lang.String	getName() Get the StructureMembers name.
int[]	getShape() Get the array shape.
int	getSize() Get the total number of elements.
int	getSizeBytes() Get the total size in bytes.
StructureMembers	getStructureMembers()
java.lang.String	getUnitsString() Get the units string, if any.
boolean	isScalar() Is this a scalar (size == 1).
boolean	isVariableLength()
StructureMembers.MemberBuilder	toBuilder(boolean wantsData) Turn into a mutable Builder.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getDataArray

public Array getDataArray()

Get the data array, if any. Used for implementation, DO NOT USE DIRECTLY!

Returns:

data object, may be null

getDataObject

public java.lang.Object getDataObject()

Get an opaque data object, for use behind the scenes. May be null

Returns:

data object, may be null

getDataParam

public int getDataParam()

Get the data parameter value, for use behind the scenes.

Returns:

data parameter value

getDataType

public DataType getDataType()

Get the DataType.

Returns:

the DataType.

getDescription

public java.lang.String getDescription()

Get the description, if any.

Returns:

the description, or null if none.

getFullName

public java.lang.String getFullName()

getFullNameEscaped

public java.lang.String getFullNameEscaped()

getName

public java.lang.String getName()

Get the StructureMembers name.

getShape

public int[] getShape()

Get the array shape. This does not have to match the VariableSimpleIF.

Returns:

the array shape.

getSize

public int getSize()

Get the total number of elements. This does not have to match the VariableSimpleIF.

Returns:

the total number of elements.

getSizeBytes

public int getSizeBytes()

Get the total size in bytes. This does not have to match the VariableSimpleIF. Note that this will not be correct when containing a member of type Sequence, or String, since those are variable length. In that case

Returns:

total size in bytes

getStructureMembers

public StructureMembers getStructureMembers()

getUnitsString

public java.lang.String getUnitsString()

Get the units string, if any.

Returns:

the units string, or null if none.

isScalar

public boolean isScalar()

Is this a scalar (size == 1). This does not have to match the VariableSimpleIF.

Returns:

if this is a scalar

isVariableLength

public boolean isVariableLength()

toBuilder

public StructureMembers.MemberBuilder toBuilder(boolean wantsData)

Turn into a mutable Builder. Can use toBuilder().build() to copy.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object