Cafu Engine
PlantDescrManT Class Reference

The plant description manager holds and manages all plant descriptions so they can be shared with multiple different plants. More...

#include "PlantDescrMan.hpp"

Public Member Functions

 PlantDescrManT (const std::string &BaseDir="")
 Constructor. More...
 
 ~PlantDescrManT ()
 Destrcutor. More...
 
PlantDescriptionTGetPlantDescription (const std::string &DescrFileName)
 Gets a plant description identified by its filename. More...
 
void SetModDir (const std::string &BaseDir)
 Changes the base directory for the plant descriptions. More...
 

Detailed Description

The plant description manager holds and manages all plant descriptions so they can be shared with multiple different plants.

Constructor & Destructor Documentation

PlantDescrManT::PlantDescrManT ( const std::string &  BaseDir = "")

Constructor.

Parameters
BaseDirThe base directory in which all plant descriptions are contained.
PlantDescrManT::~PlantDescrManT ( )

Destrcutor.

Member Function Documentation

PlantDescriptionT * PlantDescrManT::GetPlantDescription ( const std::string &  DescrFileName)

Gets a plant description identified by its filename.

Parameters
DescrFileNameThe file name of the plant description (relative to the plant description base dir).
Returns
Pointer to the plant description or a dummy plant description on error.
void PlantDescrManT::SetModDir ( const std::string &  BaseDir)
inline

Changes the base directory for the plant descriptions.

Parameters
BaseDirThe new base directory.

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