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

Inheritance diagram for sortie.data.simpletypes.DetailedGridSettings:

Public Member Functions
	DetailedGridSettings (String sName)
	Constructor. More...

String	getName ()
	Get the name of this grid. More...

void	setXCellLength (float fValue)
	Sets the X cell length. More...

void	setYCellLength (float fValue)
	Sets the Y cell length. More...

float	getXCellLength ()
	Gets the X cell length. More...

float	getYCellLength ()
	Gets the Y cell length. More...

void	addPackageFloat (String sCodeName, String sDisplayName)
	Add a new package float data member. More...

void	addPackageInt (String sCodeName, String sDisplayName)
	Add a new package int data member. More...

void	addPackageBool (String sCodeName, String sDisplayName)
	Add a new package bool data member. More...

void	addPackageChar (String sCodeName, String sDisplayName)
	Add a new package char data member. More...

int	getNumberOfPackageFloats ()
	Get the number of package float data members. More...

int	getNumberOfPackageInts ()
	Get the number of package int data members. More...

int	getNumberOfPackageChars ()
	Get the number of package char data members. More...

int	getNumberOfPackageBools ()
	Get the number of package bool data members. More...

void	removePackageInt (int i)
	Removes a package integer data member. More...

void	removePackageFloat (int i)
	Removes a package float data member. More...

void	removePackageBool (int i)
	Removes a package boolean data member. More...

void	removePackageChar (int i)
	Removes a package char data member. More...

DataMember	getPackageFloat (int iIndex)
	Gets a package float data member. More...

DataMember	getPackageInt (int iIndex)
	Get the label of an package int data member. More...

DataMember	getPackageChar (int iIndex)
	Get the label of a package char data member. More...

DataMember	getPackageBool (int iIndex)
	Gets a package bool data member. More...

Object	clone ()
	Creates a deep clone of this object. More...

Public Member Functions inherited from sortie.data.simpletypes.DetailedOutputSettings
int	getSaveFrequency ()
	Gets the save frequency. More...

void	setSaveFrequency (int i)
	Sets the save frequency. More...

void	addFloat (String sCodeName, String sDisplayName)
	Add a new float data member. More...

void	addInt (String sCodeName, String sDisplayName)
	Add a new int data member. More...

void	addBool (String sCodeName, String sDisplayName)
	Add a new bool data member. More...

void	addChar (String sCodeName, String sDisplayName)
	Add a new char data member. More...

int	getNumberOfFloats ()
	Get the number of float data members. More...

int	getNumberOfInts ()
	Get the number of int data members. More...

int	getNumberOfChars ()
	Get the number of char data members. More...

int	getNumberOfBools ()
	Get the number of bool data members. More...

void	removeInt (int i)
	Removes an integer data member. More...

void	removeFloat (int i)
	Removes a float data member. More...

void	removeBool (int i)
	Removes a boolean data member. More...

void	removeChar (int i)
	Removes a char data member. More...

DataMember	getFloat (int iIndex)
	Gets a float data member. More...

DataMember	getInt (int iIndex)
	Get the label of an int data member. More...

DataMember	getChar (int iIndex)
	Get the label of a char data member. More...

DataMember	getBool (int iIndex)
	Gets a bool data member. More...

Protected Attributes
ArrayList< DataMember >	mp_oPackageFloats = new ArrayList<DataMember>(0)
	Vector of DataMembers representing package floats. More...

Protected Attributes inherited from sortie.data.simpletypes.DetailedOutputSettings
ArrayList< DataMember >	mp_oFloats = new ArrayList<DataMember>(0)
	Vector of DataMembers representing floats. More...

int	m_iSaveFreq = 0
	Save frequency, in timesteps. More...

Private Attributes
String	m_sName
	Grid name. More...

float	m_fXCellLength
	Length of grid cells in X direction, in m. More...

Additional Inherited Members
Static Public Member Functions inherited from sortie.data.simpletypes.DetailedOutputSettings
static void	copyData (DetailedOutputSettings oCopyTarget, DetailedOutputSettings oCopySource)
	Copies data members from one DetailedOutputSettings object to another. More...

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: Cary 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

◆ DetailedGridSettings()

sortie.data.simpletypes.DetailedGridSettings.DetailedGridSettings ( String sName )

Constructor.

Parameters

sName Grid name.

Member Function Documentation

◆ addPackageBool()

void sortie.data.simpletypes.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.

◆ addPackageChar()

void sortie.data.simpletypes.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.

◆ addPackageFloat()

void sortie.data.simpletypes.DetailedGridSettings.addPackageFloat	(	String	sCodeName,
		String	sDisplayName
	)

Add a new package float data member.

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

Parameters

sCodeName	Code name.
sDisplayName	Display name.

◆ addPackageInt()

void sortie.data.simpletypes.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.

◆ clone()

Object sortie.data.simpletypes.DetailedGridSettings.clone ( )

Creates a deep clone of this object.

Returns: Clone.

◆ getName()

String sortie.data.simpletypes.DetailedGridSettings.getName ( )

Get the name of this grid.

Returns: Grid name.

◆ getNumberOfPackageBools()

int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageBools ( )

Get the number of package bool data members.

Returns: Number of data members.

◆ getNumberOfPackageChars()

int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageChars ( )

Get the number of package char data members.

Returns: Number of data members.

◆ getNumberOfPackageFloats()

int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageFloats ( )

Get the number of package float data members.

Returns: Number of data members.

◆ getNumberOfPackageInts()

int sortie.data.simpletypes.DetailedGridSettings.getNumberOfPackageInts ( )

Get the number of package int data members.

Returns: Number of data members.

◆ getPackageBool()

DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageBool ( int iIndex )

Gets a package bool data member.

Parameters

iIndex of the package bool data member

Returns: The data member

◆ getPackageChar()

DataMember sortie.data.simpletypes.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

◆ getPackageFloat()

DataMember sortie.data.simpletypes.DetailedGridSettings.getPackageFloat ( int iIndex )

Gets a package float data member.

Parameters

iIndex of the package float data member

Returns: The data member

◆ getPackageInt()

DataMember sortie.data.simpletypes.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

◆ getXCellLength()

float sortie.data.simpletypes.DetailedGridSettings.getXCellLength ( )

Gets the X cell length.

Returns: X cell length, in m.

◆ getYCellLength()

float sortie.data.simpletypes.DetailedGridSettings.getYCellLength ( )

Gets the Y cell length.

Returns: Y cell length, in m.

◆ removePackageBool()

void sortie.data.simpletypes.DetailedGridSettings.removePackageBool ( int i )

Removes a package boolean data member.

Parameters

i	int Index of data member to remove.

◆ removePackageChar()

void sortie.data.simpletypes.DetailedGridSettings.removePackageChar ( int i )

Removes a package char data member.

Parameters

i	int Index of data member to remove.

◆ removePackageFloat()

void sortie.data.simpletypes.DetailedGridSettings.removePackageFloat ( int i )

Removes a package float data member.

Parameters

i	int Index of data member to remove.

◆ removePackageInt()

void sortie.data.simpletypes.DetailedGridSettings.removePackageInt ( int i )

Removes a package integer data member.

Parameters

i	int Index of data member to remove.

◆ setXCellLength()

void sortie.data.simpletypes.DetailedGridSettings.setXCellLength ( float fValue )

Sets the X cell length.

Parameters

fValue X cell length, in m.

◆ setYCellLength()

void sortie.data.simpletypes.DetailedGridSettings.setYCellLength ( float fValue )

Sets the Y cell length.

Parameters

fValue Y cell length, in m.

Member Data Documentation

◆ m_fXCellLength

float sortie.data.simpletypes.DetailedGridSettings.m_fXCellLength

private

Length of grid cells in X direction, in m.

◆ m_sName

String sortie.data.simpletypes.DetailedGridSettings.m_sName

private

Grid name.

◆ mp_oPackageFloats

ArrayList<DataMember> sortie.data.simpletypes.DetailedGridSettings.mp_oPackageFloats = new ArrayList<DataMember>(0)

protected

Vector of DataMembers representing package floats.

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

DetailedGridSettings.java

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DetailedGridSettings()

Member Function Documentation

◆ addPackageBool()

◆ addPackageChar()

◆ addPackageFloat()

◆ addPackageInt()

◆ clone()

◆ getName()

◆ getNumberOfPackageBools()

◆ getNumberOfPackageChars()

◆ getNumberOfPackageFloats()

◆ getNumberOfPackageInts()

◆ getPackageBool()

◆ getPackageChar()

◆ getPackageFloat()

◆ getPackageInt()

◆ getXCellLength()

◆ getYCellLength()

◆ removePackageBool()

◆ removePackageChar()

◆ removePackageFloat()

◆ removePackageInt()

◆ setXCellLength()

◆ setYCellLength()

Member Data Documentation

◆ m_fXCellLength

◆ m_sName

◆ mp_oPackageFloats