Base class for detailed output settings. More...

Inheritance diagram for sortie.data.simpletypes.DetailedOutputSettings:

Public Member Functions
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...

Static Public Member Functions
static void	copyData (DetailedOutputSettings oCopyTarget, DetailedOutputSettings oCopySource)
	Copies data members from one DetailedOutputSettings object to another. More...

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

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

Detailed Description

Base class for detailed output settings.

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)

Member Function Documentation

◆ addBool()

void sortie.data.simpletypes.DetailedOutputSettings.addBool	(	String	sCodeName,
		String	sDisplayName
	)

Add a new bool data member.

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

Parameters

sCodeName	Code name.
sDisplayName	Display name.

◆ addChar()

void sortie.data.simpletypes.DetailedOutputSettings.addChar	(	String	sCodeName,
		String	sDisplayName
	)

Add a new char data member.

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

Parameters

sCodeName	Code name.
sDisplayName	Display name.

◆ addFloat()

void sortie.data.simpletypes.DetailedOutputSettings.addFloat	(	String	sCodeName,
		String	sDisplayName
	)

Add a new float data member.

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

Parameters

sCodeName	Code name.
sDisplayName	Display name.

◆ addInt()

void sortie.data.simpletypes.DetailedOutputSettings.addInt	(	String	sCodeName,
		String	sDisplayName
	)

Add a new int data member.

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

Parameters

sCodeName	Code name.
sDisplayName	Display name.

◆ copyData()

static void sortie.data.simpletypes.DetailedOutputSettings.copyData	(	DetailedOutputSettings	oCopyTarget,
		DetailedOutputSettings	oCopySource
	)

static

Copies data members from one DetailedOutputSettings object to another.

This can be used to create deep clones.

Parameters

oCopyTarget	Object to which to copy settings
oCopySource	Object from which to copy settings.

◆ getBool()

DataMember sortie.data.simpletypes.DetailedOutputSettings.getBool ( int iIndex )

Gets a bool data member.

Parameters

iIndex of the bool data member

Returns: The data member

◆ getChar()

DataMember sortie.data.simpletypes.DetailedOutputSettings.getChar ( int iIndex )

Get the label of a char data member.

Parameters

iIndex of the char data member

Returns: The data member

◆ getFloat()

DataMember sortie.data.simpletypes.DetailedOutputSettings.getFloat ( int iIndex )

Gets a float data member.

Parameters

iIndex of the float data member

Returns: The data member

◆ getInt()

DataMember sortie.data.simpletypes.DetailedOutputSettings.getInt ( int iIndex )

Get the label of an int data member.

Parameters

iIndex of the int data member

Returns: The data member

◆ getNumberOfBools()

int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfBools ( )

Get the number of bool data members.

Returns: Number of data members.

◆ getNumberOfChars()

int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfChars ( )

Get the number of char data members.

Returns: Number of data members.

◆ getNumberOfFloats()

int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfFloats ( )

Get the number of float data members.

Returns: Number of data members.

◆ getNumberOfInts()

int sortie.data.simpletypes.DetailedOutputSettings.getNumberOfInts ( )

Get the number of int data members.

Returns: Number of data members.

◆ getSaveFrequency()

int sortie.data.simpletypes.DetailedOutputSettings.getSaveFrequency ( )

Gets the save frequency.

Returns: Save frequency, in timesteps.

◆ removeBool()

void sortie.data.simpletypes.DetailedOutputSettings.removeBool ( int i )

Removes a boolean data member.

Parameters

i	int Index of data member to remove.

◆ removeChar()

void sortie.data.simpletypes.DetailedOutputSettings.removeChar ( int i )

Removes a char data member.

Parameters

i	int Index of data member to remove.

◆ removeFloat()

void sortie.data.simpletypes.DetailedOutputSettings.removeFloat ( int i )

Removes a float data member.

Parameters

i	int Index of data member to remove.

◆ removeInt()

void sortie.data.simpletypes.DetailedOutputSettings.removeInt ( int i )

Removes an integer data member.

Parameters

i	int Index of data member to remove.

◆ setSaveFrequency()

void sortie.data.simpletypes.DetailedOutputSettings.setSaveFrequency ( int i )

Sets the save frequency.

Parameters

i	Save frequency, in timesteps.

Member Data Documentation

◆ m_iSaveFreq

int sortie.data.simpletypes.DetailedOutputSettings.m_iSaveFreq = 0

protected

Save frequency, in timesteps.

◆ mp_oFloats

ArrayList<DataMember> sortie.data.simpletypes.DetailedOutputSettings.mp_oFloats = new ArrayList<DataMember>(0)

protected

Vector of DataMembers representing floats.

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

DetailedOutputSettings.java

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addBool()

◆ addChar()

◆ addFloat()

◆ addInt()

◆ copyData()

◆ getBool()

◆ getChar()

◆ getFloat()

◆ getInt()

◆ getNumberOfBools()

◆ getNumberOfChars()

◆ getNumberOfFloats()

◆ getNumberOfInts()

◆ getSaveFrequency()

◆ removeBool()

◆ removeChar()

◆ removeFloat()

◆ removeInt()

◆ setSaveFrequency()

Member Data Documentation

◆ m_iSaveFreq

◆ mp_oFloats