Package ucar.array

Class StructureDataArray

java.lang.Object

ucar.array.Array<StructureData>

ucar.array.StructureDataArray

All Implemented Interfaces:

Iterable<StructureData>

@Immutable
public final class StructureDataArray
extends Array<StructureData>

Concrete implementation of Array specialized for StructureData. Not really immutable, since Storage<StructureData> may not be, but thats hidden to the consumer.

Constructor Summary

Constructors

Constructor	Description
StructureDataArray(StructureMembers members, int[] shape, Storage<StructureData> storage)	Create an Array of type StructureData and the given shape and storage.
StructureDataArray(StructureMembers members, int[] shape, StructureData[] parray)	Create an Array of type StructureData and the given shape and storage.

Method Summary

Modifier and Type	Method	Description
Array<?>	extractMemberArray(StructureMembers.Member m)	Extract data for one member, over all structures in this StructureDataArray.
Array<?>	extractNestedMemberArray(StructureMembers.Member nestedStruct, StructureMembers.Member m)	Extract data for one member, over all nested structures in this StructureDataArray.
StructureData	get(int... index)	Get the element indicated by the list of multidimensional indices.
StructureData	get(Index index)	Get the element indicated by Index.
List<String>	getStructureMemberNames()	Get a list of structure member names.
StructureMembers	getStructureMembers()	Get the StructureMembers.
int	getStructureSize()	Get the size of one StructureData in bytes.
Iterator<StructureData>	iterator()	Iterates in canonical order over all the elements of the Array.

Methods inherited from class ucar.array.Array

contains, equals, getArrayType, getIndex, getRank, getScalar, getSection, getShape, getSize, hashCode, isVlen, length, show, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StructureDataArray

public StructureDataArray(StructureMembers members,
                          int[] shape,
                          StructureData[] parray)

Create an Array of type StructureData and the given shape and storage. Ok if parray is bigger than shape.

StructureDataArray

public StructureDataArray(StructureMembers members,
                          int[] shape,
                          Storage<StructureData> storage)

Create an Array of type StructureData and the given shape and storage.

Method Detail

getStructureMembers

public StructureMembers getStructureMembers()

Get the StructureMembers.

getStructureMemberNames

public List<String> getStructureMemberNames()

Get a list of structure member names.

iterator

public Iterator<StructureData> iterator()

Description copied from class: Array

Iterates in canonical order over all the elements of the Array.

Specified by:

iterator in interface Iterable<StructureData>

Specified by:

iterator in class Array<StructureData>

get

public StructureData get(int... index)

Description copied from class: Array

Get the element indicated by the list of multidimensional indices.

Specified by:

get in class Array<StructureData>

Parameters:

index - list of indices, one for each dimension. For vlen, the last is ignored.

get

public StructureData get(Index index)

Description copied from class: Array

Get the element indicated by Index.

Specified by:

get in class Array<StructureData>

Parameters:

index - multidimensional indices.

getStructureSize

public int getStructureSize()

Get the size of one StructureData in bytes.

extractMemberArray

public Array<?> extractMemberArray(StructureMembers.Member m)

Extract data for one member, over all structures in this StructureDataArray. The resulting shape is the structure shape appended to the member's shape.

Parameters:

m - get all data for this StructureMembers.Member.

extractNestedMemberArray

public Array<?> extractNestedMemberArray(StructureMembers.Member nestedStruct,
                                         StructureMembers.Member m)

Extract data for one member, over all nested structures in this StructureDataArray. The resulting shape is the structure shape appended to the member's shape.

Parameters:

nestedStruct - the parent Stucture of m.

m - get all data for this StructureMembers.Member.