ucar.ma2

Class StructureMembers

java.lang.Object

ucar.ma2.StructureMembers

public final class StructureMembers
extends Object

A Collection of members contained in a StructureData.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StructureMembers.Member A member of a StructureData.

Constructor Summary

Constructors

Constructor and Description
StructureMembers(String name)
StructureMembers(StructureMembers from)

Method Summary

Modifier and Type	Method and Description
void	addMember(int pos, StructureMembers.Member m) Add a member at the given position.
StructureMembers.Member	addMember(String name, String desc, String units, DataType dtype, int[] shape)
void	addMember(StructureMembers.Member m) Add a member.
StructureMembers.Member	findMember(String memberName) Find the member by its name.
StructureMembers.Member	getMember(int index) Get the index-th member
List<String>	getMemberNames() Get the names of the members.
List<StructureMembers.Member>	getMembers() Get the list of Member objects.
String	getName() Get the name.
int	getStructureSize() Get the total size of the Structure in bytes.
int	hideMember(StructureMembers.Member m) Remove the given member
void	setStructureSize(int structureSize) Set the total size of the Structure in bytes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureMembers

public StructureMembers(String name)

StructureMembers

public StructureMembers(StructureMembers from)

Method Detail

getName

public String getName()

Get the name.

Returns:

the name.

addMember

public void addMember(StructureMembers.Member m)

Add a member.

Parameters:

m - member to add

addMember

public void addMember(int pos,
                      StructureMembers.Member m)

Add a member at the given position.

Parameters:

m - member to add

addMember

public StructureMembers.Member addMember(String name,
                                         String desc,
                                         String units,
                                         DataType dtype,
                                         int[] shape)

hideMember

public int hideMember(StructureMembers.Member m)

Remove the given member

Parameters:

m - member

Returns:

position that it used to occupy, or -1 if not found

getStructureSize

public int getStructureSize()

Get the total size of the Structure in bytes.

Returns:

the total size of the Structure in bytes.

setStructureSize

public void setStructureSize(int structureSize)

Set the total size of the Structure in bytes.

Parameters:

structureSize - set to this value

getMembers

public List<StructureMembers.Member> getMembers()

Get the list of Member objects.

Returns:

the list of Member objects.

getMemberNames

public List<String> getMemberNames()

Get the names of the members.

Returns:

List of type String.

getMember

public StructureMembers.Member getMember(int index)

Get the index-th member

Parameters:

index - of member

Returns:

Member

findMember

public StructureMembers.Member findMember(String memberName)

Find the member by its name.

Parameters:

memberName - find by this name

Returns:

Member matching the name, or null if not found

toString

public String toString()

Overrides:

toString in class Object