javawrapper::ModelData Class Reference

This is a base class for packaging data values with additional information. More...

Inheritance diagram for javawrapper::ModelData:

javawrapper::ModelEnum javawrapper::ModelFloat javawrapper::ModelInt javawrapper::ModelString javawrapper::ModelVector List of all members.

Public Member Functions

 ModelData (String sDescriptor, String sXMLTag)
 Constructor.
String GetDescriptor ()
 Returns the descriptor string.
String GetXMLTag ()
 Returns the XML tag associated with this piece of data.
abstract String toString ()
 String representation of the value.

Protected Attributes

String m_sDescriptor
 Descriptive string.
String m_sXMLTag
 XML tag.

Detailed Description

This is a base class for packaging data values with additional information.

The additional information allows for automation of lots of data operations.

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::ModelData::ModelData ( String  sDescriptor,
String  sXMLTag 
) [inline]

Constructor.

Parameters:
sDescriptor Descriptor string.
sXMLTag The XML tag associated with this piece of data.

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


Member Function Documentation

String javawrapper::ModelData::GetDescriptor (  )  [inline]

Returns the descriptor string.

Returns:
The Descriptor string.

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

String javawrapper::ModelData::GetXMLTag (  )  [inline]

Returns the XML tag associated with this piece of data.

Returns:
The XML tag.

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

abstract String javawrapper::ModelData::toString (  )  [pure virtual]

String representation of the value.

Required to be overridden.

Returns:
String representation of the value.

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

Implemented in javawrapper::ModelEnum, javawrapper::ModelFloat, javawrapper::ModelInt, javawrapper::ModelString, and javawrapper::ModelVector.


Member Data Documentation

String javawrapper::ModelData::m_sDescriptor [protected]

Descriptive string.

This should be meaningful to the user because it will be used in error messages and entry windows.


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