javawrapper.DetailedGridSettings Class Reference

Captures the output settings for a single grid. More...

Inheritance diagram for javawrapper.DetailedGridSettings:

javawrapper.DetailedOutputSettings

List of all members.

Public Member Functions

 DetailedGridSettings (String sName)
 Constructor.
String GetName ()
 Get the name of this grid.
void SetXCellLength (float fValue)
 Sets the X cell length.
void SetYCellLength (float fValue)
 Sets the Y cell length.
float GetXCellLength ()
 Gets the X cell length.
float GetYCellLength ()
 Gets the Y cell length.
void AddPackageFloat (String sCodeName, String sDisplayName)
 Add a new package float data label.
void AddPackageInt (String sCodeName, String sDisplayName)
 Add a new package int data member.
void AddPackageBool (String sCodeName, String sDisplayName)
 Add a new package bool data member.
void AddPackageChar (String sCodeName, String sDisplayName)
 Add a new package char data member.
int GetNumberOfPackageFloats ()
 Get the number of package float data members.
int GetNumberOfPackageInts ()
 Get the number of package int data members.
int GetNumberOfPackageChars ()
 Get the number of package char data members.
int GetNumberOfPackageBools ()
 Get the number of package bool data members.
void RemovePackageInt (int i)
 Removes a package integer data member.
void RemovePackageFloat (int i)
 Removes a package float data member.
void RemovePackageBool (int i)
 Removes a package boolean data member.
void RemovePackageChar (int i)
 Removes a package char data member.
DataMember GetPackageFloat (int iIndex)
 Gets a package float data member.
DataMember GetPackageInt (int iIndex)
 Get the label of an package int data member.
DataMember GetPackageChar (int iIndex)
 Get the label of a package char data member.
DataMember GetPackageBool (int iIndex)
 Gets a package bool data member.
Object clone ()
 Creates a deep clone of this object.

Protected Attributes

Vector< DataMembermp_oPackageFloats = new Vector<DataMember>(0)
 Vector of DataMembers representing package floats.
Vector< DataMembermp_oPackageInts = new Vector<DataMember>(0)
 Vector of DataMembers representing package ints.
Vector< DataMembermp_oPackageChars = new Vector<DataMember>(0)
 Vector of DataMembers representing package chars.
Vector< DataMembermp_oPackageBools = new Vector<DataMember>(0)
 Vector of DataMembers representing package bools.

Private Attributes

String m_sName
 Grid name.
float m_fXCellLength
 Length of grid cells in X direction, in m.
float m_fYCellLength
 Length of grid cells in Y direction, in m.


Detailed Description

Captures the output settings for a single grid.

This is used in two ways: when a user is setting up detailed output options, and when the data visualizer is working with grids.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.DetailedGridSettings.DetailedGridSettings ( String  sName  ) 

Constructor.

Parameters:
sName Grid name.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

String javawrapper.DetailedGridSettings.GetName (  ) 

Get the name of this grid.

Returns:
Grid name.

void javawrapper.DetailedGridSettings.SetXCellLength ( float  fValue  ) 

Sets the X cell length.

Parameters:
fValue X cell length, in m.

void javawrapper.DetailedGridSettings.SetYCellLength ( float  fValue  ) 

Sets the Y cell length.

Parameters:
fValue Y cell length, in m.

float javawrapper.DetailedGridSettings.GetXCellLength (  ) 

Gets the X cell length.

Returns:
X cell length, in m.

float javawrapper.DetailedGridSettings.GetYCellLength (  ) 

Gets the Y cell length.

Returns:
Y cell length, in m.

void javawrapper.DetailedGridSettings.AddPackageFloat ( String  sCodeName,
String  sDisplayName 
)

Add a new package float data label.

Parameters:
sLabel Package float data label. Add a new package float data member. If it already exists it won't be added again.
sCodeName Code name.
sDisplayName Display name.

void javawrapper.DetailedGridSettings.AddPackageInt ( String  sCodeName,
String  sDisplayName 
)

Add a new package int data member.

If it already exists it won't be added again.

Parameters:
sCodeName Code name.
sDisplayName Display name.

void javawrapper.DetailedGridSettings.AddPackageBool ( String  sCodeName,
String  sDisplayName 
)

Add a new package bool data member.

If it already exists it won't be added again.

Parameters:
sCodeName Code name.
sDisplayName Display name.

void javawrapper.DetailedGridSettings.AddPackageChar ( String  sCodeName,
String  sDisplayName 
)

Add a new package char data member.

If it already exists it won't be added again.

Parameters:
sCodeName Code name.
sDisplayName Display name.

int javawrapper.DetailedGridSettings.GetNumberOfPackageFloats (  ) 

Get the number of package float data members.

Returns:
Number of data members.

int javawrapper.DetailedGridSettings.GetNumberOfPackageInts (  ) 

Get the number of package int data members.

Returns:
Number of data members.

int javawrapper.DetailedGridSettings.GetNumberOfPackageChars (  ) 

Get the number of package char data members.

Returns:
Number of data members.

int javawrapper.DetailedGridSettings.GetNumberOfPackageBools (  ) 

Get the number of package bool data members.

Returns:
Number of data members.

void javawrapper.DetailedGridSettings.RemovePackageInt ( int  i  ) 

Removes a package integer data member.

Parameters:
i int Index of data member to remove.

void javawrapper.DetailedGridSettings.RemovePackageFloat ( int  i  ) 

Removes a package float data member.

Parameters:
i int Index of data member to remove.

void javawrapper.DetailedGridSettings.RemovePackageBool ( int  i  ) 

Removes a package boolean data member.

Parameters:
i int Index of data member to remove.

void javawrapper.DetailedGridSettings.RemovePackageChar ( int  i  ) 

Removes a package char data member.

Parameters:
i int Index of data member to remove.

DataMember javawrapper.DetailedGridSettings.GetPackageFloat ( int  iIndex  ) 

Gets a package float data member.

Parameters:
iIndex of the package float data member
Returns:
The data member

DataMember javawrapper.DetailedGridSettings.GetPackageInt ( int  iIndex  ) 

Get the label of an package int data member.

Parameters:
iIndex of the package int data member
Returns:
The data member

DataMember javawrapper.DetailedGridSettings.GetPackageChar ( int  iIndex  ) 

Get the label of a package char data member.

Parameters:
iIndex of the package char data member
Returns:
The data member

DataMember javawrapper.DetailedGridSettings.GetPackageBool ( int  iIndex  ) 

Gets a package bool data member.

Parameters:
iIndex of the package bool data member
Returns:
The data member

Object javawrapper.DetailedGridSettings.clone (  ) 

Creates a deep clone of this object.

Returns:
Clone.


Member Data Documentation

Vector of DataMembers representing package floats.

Vector of DataMembers representing package ints.

Vector of DataMembers representing package chars.

Vector of DataMembers representing package bools.

Grid name.

Length of grid cells in X direction, in m.

Length of grid cells in Y direction, in m.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:37 2011 for SORTIE Java Interface by  doxygen 1.5.6