SORTIE Java Interface  1
Public Member Functions | Protected Attributes | List of all members
sortie.data.simpletypes.ModelData Class Referenceabstract

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

Inheritance diagram for sortie.data.simpletypes.ModelData:
sortie.data.simpletypes.ModelEnum sortie.data.simpletypes.ModelFloat sortie.data.simpletypes.ModelInt sortie.data.simpletypes.ModelString sortie.data.simpletypes.ModelVector

Public Member Functions

 ModelData (String sDescriptor, String sXMLTag)
 Constructor. More...
 
String getDescriptor ()
 Returns the descriptor string. More...
 
void setDescriptor (String sDescriptor)
 Sets the descriptor string. More...
 
String getXMLTag ()
 Returns the XML tag associated with this piece of data. More...
 
abstract String toString ()
 String representation of the value. More...
 
void setXMLTag (String sXMLTag)
 Sets the XML tag associated with this piece of data. More...
 

Protected Attributes

String m_sDescriptor
 Descriptive string. More...
 

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: Cary Institute of Ecosystem Studies

Author
Lora E. Murphy
Version
1.0


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

Constructor & Destructor Documentation

◆ ModelData()

sortie.data.simpletypes.ModelData.ModelData ( String  sDescriptor,
String  sXMLTag 
)

Constructor.

Parameters
sDescriptorDescriptor string.
sXMLTagThe XML tag associated with this piece of data.

Member Function Documentation

◆ getDescriptor()

String sortie.data.simpletypes.ModelData.getDescriptor ( )

Returns the descriptor string.

Returns
The Descriptor string.

◆ getXMLTag()

String sortie.data.simpletypes.ModelData.getXMLTag ( )

Returns the XML tag associated with this piece of data.

Returns
The XML tag.

◆ setDescriptor()

void sortie.data.simpletypes.ModelData.setDescriptor ( String  sDescriptor)

Sets the descriptor string.

Parameters
sDescriptorThe Descriptor string.

◆ setXMLTag()

void sortie.data.simpletypes.ModelData.setXMLTag ( String  sXMLTag)

Sets the XML tag associated with this piece of data.

Parameters
sXMLTagtag.

◆ toString()

abstract String sortie.data.simpletypes.ModelData.toString ( )
abstract

String representation of the value.

Required to be overridden.

Returns
String representation of the value.

Member Data Documentation

◆ m_sDescriptor

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