Umasoft
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Protected Attributes | List of all members
vtSpeciesList Class Reference

#include <Plants.h>

Inheritance diagram for vtSpeciesList:
vtSpeciesList3d

Public Member Functions

bool ReadXML (const char *fname, vtString *msg=NULL)
 
bool WriteXML (const char *fname) const
 
bool WriteHTML (const char *fname) const
 
uint NumSpecies () const
 
vtPlantSpecies * GetSpecies (uint i) const
 
short GetSpeciesIdByName (const char *name) const
 
short GetSpeciesIdByCommonName (const char *name) const
 
void Append (vtPlantSpecies *pSpecies)
 
short FindSpeciesId (vtPlantSpecies *ps)
 
void Clear ()
 

Protected Attributes

vtArray< vtPlantSpecies * > m_Species
 

Detailed Description

A species list is a list of species.

Member Function Documentation

short vtSpeciesList::GetSpeciesIdByCommonName ( const char *  name) const

Find the index of a species by common name. Example:

short index = pSpeciesList->GetSpeciesIdByName("Coconut Palm");
Returns
The 0-based index, or -1 if not found.
short vtSpeciesList::GetSpeciesIdByName ( const char *  name) const

Find the index of a species by scientific name. Example:

short index = pSpeciesList->GetSpeciesIdByName("Cocos nucifera");
Returns
The 0-based index, or -1 if not found.
The documentation for this class was generated from the following files:
Generated on Fri Jun 7 2013 16:08:25 for Umasoft by   doxygen 1.8.4