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 sLabel)
 Add a new package float data label.
void AddPackageInt (String sLabel)
 Add a new package int data label.
void AddPackageChar (String sLabel)
 Add a new package char data label.
void AddPackageBool (String sLabel)
 Add a new package bool data label.
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.
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 mp_oPackageFloats
 Vector of GridDataMembers representing package floats.
Vector mp_oPackageInts
 Vector of GridDataMembers representing package ints.
Vector mp_oPackageChars
 Vector of GridDataMembers representing package chars.
Vector mp_oPackageBools
 Vector of GridDataMembers 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)


Constructor & Destructor Documentation

javawrapper::DetailedGridSettings::DetailedGridSettings ( String  sName  )  [inline]

Constructor.

Parameters:
sName Grid name.

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


Member Function Documentation

void javawrapper::DetailedGridSettings::AddPackageBool ( String  sLabel  )  [inline]

Add a new package bool data label.

Parameters:
sLabel Package bool data label.

void javawrapper::DetailedGridSettings::AddPackageChar ( String  sLabel  )  [inline]

Add a new package char data label.

Parameters:
sLabel Package char data label.

void javawrapper::DetailedGridSettings::AddPackageFloat ( String  sLabel  )  [inline]

Add a new package float data label.

Parameters:
sLabel Package float data label.

void javawrapper::DetailedGridSettings::AddPackageInt ( String  sLabel  )  [inline]

Add a new package int data label.

Parameters:
sLabel Package int data label.

Object javawrapper::DetailedGridSettings::clone (  )  [inline]

Creates a deep clone of this object.

Returns:
Clone.

String javawrapper::DetailedGridSettings::GetName (  )  [inline]

Get the name of this grid.

Returns:
Grid name.

int javawrapper::DetailedGridSettings::GetNumberOfPackageBools (  )  [inline]

Get the number of package bool data members.

Returns:
Number of data members.

int javawrapper::DetailedGridSettings::GetNumberOfPackageChars (  )  [inline]

Get the number of package char data members.

Returns:
Number of data members.

int javawrapper::DetailedGridSettings::GetNumberOfPackageFloats (  )  [inline]

Get the number of package float data members.

Returns:
Number of data members.

int javawrapper::DetailedGridSettings::GetNumberOfPackageInts (  )  [inline]

Get the number of package int data members.

Returns:
Number of data members.

DataMember javawrapper::DetailedGridSettings::GetPackageBool ( int  iIndex  )  [inline]

Gets a package bool data member.

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

DataMember javawrapper::DetailedGridSettings::GetPackageChar ( int  iIndex  )  [inline]

Get the label of a package char data member.

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

DataMember javawrapper::DetailedGridSettings::GetPackageFloat ( int  iIndex  )  [inline]

Gets a package float data member.

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

DataMember javawrapper::DetailedGridSettings::GetPackageInt ( int  iIndex  )  [inline]

Get the label of an package int data member.

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

float javawrapper::DetailedGridSettings::GetXCellLength (  )  [inline]

Gets the X cell length.

Returns:
X cell length, in m.

float javawrapper::DetailedGridSettings::GetYCellLength (  )  [inline]

Gets the Y cell length.

Returns:
Y cell length, in m.

void javawrapper::DetailedGridSettings::SetXCellLength ( float  fValue  )  [inline]

Sets the X cell length.

Parameters:
fValue X cell length, in m.

void javawrapper::DetailedGridSettings::SetYCellLength ( float  fValue  )  [inline]

Sets the Y cell length.

Parameters:
fValue Y cell length, in m.


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:03 2006 for SORTIE Java Interface by  doxygen 1.4.7