javawrapper::DetailedOutputSettings Class Reference

Base class for detailed output settings. More...

Inheritance diagram for javawrapper::DetailedOutputSettings:

javawrapper::DetailedGridSettings javawrapper::DetailedTreeSettings List of all members.

Public Member Functions

 DetailedOutputSettings ()
 Constructor.
int GetSaveFrequency ()
 Gets the save frequency.
void SetSaveFrequency (int i)
 Sets the save frequency.
void AddFloat (String sCodeName, String sDisplayName)
 Add a new float data member.
void AddInt (String sCodeName, String sDisplayName)
 Add a new int data member.
void AddBool (String sCodeName, String sDisplayName)
 Add a new bool data member.
void AddChar (String sCodeName, String sDisplayName)
 Add a new char data member.
int GetNumberOfFloats ()
 Get the number of float data members.
int GetNumberOfInts ()
 Get the number of int data members.
int GetNumberOfChars ()
 Get the number of char data members.
int GetNumberOfBools ()
 Get the number of bool data members.
void RemoveInt (int i)
 Removes an integer data member.
void RemoveFloat (int i)
 Removes a float data member.
void RemoveBool (int i)
 Removes a boolean data member.
void RemoveChar (int i)
 Removes a char data member.
DataMember GetFloat (int iIndex)
 Gets a float data member.
DataMember GetInt (int iIndex)
 Get the label of an int data member.
DataMember GetChar (int iIndex)
 Get the label of a char data member.
DataMember GetBool (int iIndex)
 Gets a bool data member.

Static Public Member Functions

static void CopyData (DetailedOutputSettings oCopyTarget, DetailedOutputSettings oCopySource)
 Copies data members from one DetailedOutputSettings object to another.

Protected Attributes

Vector mp_oFloats
 Vector of DataMembers representing floats.
Vector mp_oInts
 Vector of DataMembers representing ints.
Vector mp_oChars
 Vector of DataMembers representing chars.
Vector mp_oBools
 Vector of DataMembers representing bools.
int m_iSaveFreq
 Save frequency, in timesteps.

Detailed Description

Base class for detailed output settings.

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::DetailedOutputSettings::DetailedOutputSettings (  )  [inline]

Constructor.


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


Member Function Documentation

int javawrapper::DetailedOutputSettings::GetSaveFrequency (  )  [inline]

Gets the save frequency.

Returns:
Save frequency, in timesteps.

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

void javawrapper::DetailedOutputSettings::SetSaveFrequency ( int  i  )  [inline]

Sets the save frequency.

Parameters:
i Save frequency, in timesteps.

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

void javawrapper::DetailedOutputSettings::AddFloat ( String  sCodeName,
String  sDisplayName 
) [inline]

Add a new float data member.

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

Parameters:
sCodeName Code name.
sDisplayName Display name.

void javawrapper::DetailedOutputSettings::AddInt ( String  sCodeName,
String  sDisplayName 
) [inline]

Add a new int data member.

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

Parameters:
sCodeName Code name.
sDisplayName Display name.

void javawrapper::DetailedOutputSettings::AddBool ( String  sCodeName,
String  sDisplayName 
) [inline]

Add a new bool data member.

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

Parameters:
sCodeName Code name.
sDisplayName Display name.

void javawrapper::DetailedOutputSettings::AddChar ( String  sCodeName,
String  sDisplayName 
) [inline]

Add a new char data member.

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

Parameters:
sCodeName Code name.
sDisplayName Display name.

int javawrapper::DetailedOutputSettings::GetNumberOfFloats (  )  [inline]

Get the number of float data members.

Returns:
Number of data members.

int javawrapper::DetailedOutputSettings::GetNumberOfInts (  )  [inline]

Get the number of int data members.

Returns:
Number of data members.

int javawrapper::DetailedOutputSettings::GetNumberOfChars (  )  [inline]

Get the number of char data members.

Returns:
Number of data members.

int javawrapper::DetailedOutputSettings::GetNumberOfBools (  )  [inline]

Get the number of bool data members.

Returns:
Number of data members.

void javawrapper::DetailedOutputSettings::RemoveInt ( int  i  )  [inline]

Removes an integer data member.

Parameters:
i int Index of data member to remove.

void javawrapper::DetailedOutputSettings::RemoveFloat ( int  i  )  [inline]

Removes a float data member.

Parameters:
i int Index of data member to remove.

void javawrapper::DetailedOutputSettings::RemoveBool ( int  i  )  [inline]

Removes a boolean data member.

Parameters:
i int Index of data member to remove.

void javawrapper::DetailedOutputSettings::RemoveChar ( int  i  )  [inline]

Removes a char data member.

Parameters:
i int Index of data member to remove.

DataMember javawrapper::DetailedOutputSettings::GetFloat ( int  iIndex  )  [inline]

Gets a float data member.

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

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

DataMember javawrapper::DetailedOutputSettings::GetInt ( int  iIndex  )  [inline]

Get the label of an int data member.

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

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

DataMember javawrapper::DetailedOutputSettings::GetChar ( int  iIndex  )  [inline]

Get the label of a char data member.

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

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

DataMember javawrapper::DetailedOutputSettings::GetBool ( int  iIndex  )  [inline]

Gets a bool data member.

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

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

static void javawrapper::DetailedOutputSettings::CopyData ( DetailedOutputSettings  oCopyTarget,
DetailedOutputSettings  oCopySource 
) [inline, 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.

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


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:53 2007 for SORTIE Java Interface by  doxygen 1.5.2