bmps::BMPPointSrcFactory Class Reference

Base class of point source BMPs. More...

#include <BMPPointSourceFactory.h>

Inheritance diagram for bmps::BMPPointSrcFactory:
bmps::BMPFactory ccgl::Interface

Public Member Functions

 BMPPointSrcFactory (int scenarioId, int bmpId, int subScenario, int bmpType, int bmpPriority, vector< string > &distribution, const string &collection, const string &location)
 Constructor.
 
 ~BMPPointSrcFactory ()
 Destructor.
 
void loadBMP (MongoClient *conn, const string &bmpDBName) OVERRIDE
 Load BMP parameters from MongoDB.
 
void Dump (std::ostream *fs) OVERRIDE
 Output.
 
void ReadPointSourceManagements (MongoClient *conn, const string &bmpDBName)
 Load point BMP location related parameters from MongoDB. More...
 
void ReadPointSourceLocations (MongoClient *conn, const string &bmpDBName)
 Load point BMP location related parameters from MongoDB. More...
 
- Public Member Functions inherited from bmps::BMPFactory
 BMPFactory (int scenario_id, int bmp_id, int sub_scenario, int bmp_type, int bmp_priority, vector< string > &distribution, const string &collection, const string &location, bool effectivenessChangeable=false, time_t changeFrequency=-1, int variableTimes=-1)
 Constructor.
 
 ~BMPFactory ()
 Destructor.
 
virtual void setRasterData (map< string, IntRaster * > &sceneRsMap)
 Set raster data if needed This function is not required for each BMP, so DO NOT define as pure virtual function. More...
 
virtual int * GetRasterData ()
 Get raster data if needed This function is not required for each BMP, so DO NOT define as pure virtual function.
 
int bmpType ()
 Get BMP type 1 - reach BMPs which are attached to specific reaches and will change the character of the reach. More...
 
int bmpPriority ()
 Get BMP priority.
 
int GetSubScenarioId ()
 Get subScenario ID.
 

Additional Inherited Members

- Protected Attributes inherited from bmps::BMPFactory
const int m_scenarioId
 Scenario ID.
 
const int m_bmpId
 BMP ID.
 
const int m_subScenarioId
 SubScenario ID within one BMP iD.
 
const int m_bmpType
 BMP Type.
 
const int m_bmpPriority
 BMP Priority.
 
vector< string > m_distribution
 Distribution vector of BMP Origin format is [distribution data type]|[distribution parameter name]|Collection name|...
 
const string m_bmpCollection
 Collection name.
 
const string m_location
 Define where the BMP will be applied.
 

Detailed Description

Base class of point source BMPs.

Actually, include point pollution sources, such as sewage outlet of animal farm.

Member Function Documentation

◆ ReadPointSourceLocations()

void bmps::BMPPointSrcFactory::ReadPointSourceLocations ( MongoClient conn,
const string &  bmpDBName 
)

Load point BMP location related parameters from MongoDB.

Parameters
[in]connMongoClient instance
[in]bmpDBNameBMP Scenario database

◆ ReadPointSourceManagements()

void bmps::BMPPointSrcFactory::ReadPointSourceManagements ( MongoClient conn,
const string &  bmpDBName 
)

Load point BMP location related parameters from MongoDB.

Parameters
[in]connMongoClient instance
[in]bmpDBNameBMP Scenario database

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