DISPLACE  1.0
A spatial model of fisheries to help sustainable fishing and maritime spatial planning
Public Member Functions | List of all members
dtree::StateEvaluator Class Referenceabstract

An abstract class to allow internal/External states to be evaluated. More...

#include <stateevaluator.h>

Inheritance diagram for dtree::StateEvaluator:
displace::dtree::TimeSeriesEvaluator< Var > displace::dtree::TimeSeriesEvaluator< displace::simulation::TimeSeriesManager::Fishprice > dtree::ConstStateEvaluator< T > dtree::TwoArgumentsComparatorStateEvaluator< Operator > dtree::VariableReferenceStateEvaluator< T > dtree::vessels::AverageProfitComparationsStateEvaluator dtree::vessels::AverageRevenuesComparationStateEvaluator dtree::vessels::MetierStateEvaluator dtree::vessels::VesselCatchVolumeStateEvaluator dtree::vessels::VesselEndOfTheDayIsStateEvaluator dtree::vessels::VesselFeelingForCatchingElsewhereStateEvaluator dtree::vessels::VesselFuelTankStateEvaluator dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksHereIsStateEvaluator dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksIsStateEvaluator dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksNowIsStateEvaluator dtree::vessels::VesselHighPotentialCatchStateEvaluator dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksHereIsStateEvaluator dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksIsStateEvaluator dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksNowIsStateEvaluator dtree::vessels::VesselIsInAreaClosureEvaluator dtree::vessels::VesselKnowledgeOfThisGroundStateEvaluator dtree::vessels::VesselLowestTariffStateEvaluator dtree::vessels::VesselMonthIsStateEvaluator dtree::vessels::VesselNbOfDaysAtSeaSoFarIsStateEvaluator dtree::vessels::VesselNotThatFarStateEvaluator dtree::vessels::VesselRiskOfBycatchAllStksIsStateEvaluator dtree::vessels::VesselRiskOfBycatchAvoidedStksHereIsStateEvaluator dtree::vessels::VesselRiskOfBycatchAvoidedStksIsStateEvaluator dtree::vessels::VesselRiskOfBycatchAvoidedStksNowIsStateEvaluator dtree::vessels::VesselSeeingOtherVesselFishingElsewhereStateEvaluator dtree::vessels::VesselSizeStateEvaluator dtree::vessels::VesselSmartCatchStateEvaluator dtree::vessels::VesselsuitableBottomTypeIsStateEvaluator dtree::vessels::VesselTargetEvaluator dtree::vessels::VesselTariffThisGroundIsStateEvaluator dtree::vessels::VesselTodayIsStateEvaluator

Public Member Functions

 StateEvaluator ()
 
virtual ~StateEvaluator ()
 
virtual double evaluate (int tstep, Vessel *vessel) const =0
 evaluate the state/variable, and returns the selected output, as double. Client can decide what to do with the value, for example, it can round it and use it as an index to select the proper output in a node. It is a client responsibility, in particular, to handle special cases, for example, if the index is outside the range of expected outputs. A decorator class can eventually remap outputs. More...
 

Detailed Description

An abstract class to allow internal/External states to be evaluated.

Constructor & Destructor Documentation

◆ StateEvaluator()

dtree::StateEvaluator::StateEvaluator ( )
inline

◆ ~StateEvaluator()

virtual dtree::StateEvaluator::~StateEvaluator ( )
inlinevirtual

Member Function Documentation

◆ evaluate()

virtual double dtree::StateEvaluator::evaluate ( int  tstep,
Vessel *  vessel 
) const
pure virtual

evaluate the state/variable, and returns the selected output, as double. Client can decide what to do with the value, for example, it can round it and use it as an index to select the proper output in a node. It is a client responsibility, in particular, to handle special cases, for example, if the index is outside the range of expected outputs. A decorator class can eventually remap outputs.

  • tstep The current Time Step of the simulation.
  • vessel A pointer for the vessel being evaluated.

Implemented in dtree::vessels::VesselSeeingOtherVesselFishingElsewhereStateEvaluator, dtree::vessels::VesselFeelingForCatchingElsewhereStateEvaluator, dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksHereIsStateEvaluator, dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksHereIsStateEvaluator, dtree::vessels::VesselsuitableBottomTypeIsStateEvaluator, dtree::vessels::VesselRiskOfBycatchAvoidedStksHereIsStateEvaluator, dtree::vessels::VesselTariffThisGroundIsStateEvaluator, dtree::vessels::VesselLowestTariffStateEvaluator, dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksIsStateEvaluator, dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksIsStateEvaluator, dtree::vessels::VesselRiskOfBycatchAvoidedStksIsStateEvaluator, dtree::vessels::VesselRiskOfBycatchAllStksIsStateEvaluator, dtree::vessels::VesselKnowledgeOfThisGroundStateEvaluator, dtree::vessels::VesselNotThatFarStateEvaluator, dtree::vessels::VesselHighPotentialCatchStateEvaluator, dtree::vessels::VesselSmartCatchStateEvaluator, dtree::vessels::VesselIsInAreaClosureEvaluator, dtree::vessels::VesselEndOfTheDayIsStateEvaluator, dtree::vessels::VesselNbOfDaysAtSeaSoFarIsStateEvaluator, dtree::vessels::VesselCatchVolumeStateEvaluator, dtree::vessels::VesselFuelTankStateEvaluator, dtree::vessels::VesselRiskOfBycatchAvoidedStksNowIsStateEvaluator, dtree::vessels::VesselglobalQuotaLeftOnAvoidedStksNowIsStateEvaluator, dtree::vessels::VesselindividualQuotaLeftOnAvoidedStksNowIsStateEvaluator, dtree::vessels::VesselMonthIsStateEvaluator, dtree::TwoArgumentsComparatorStateEvaluator< Operator >, dtree::vessels::VesselTodayIsStateEvaluator, dtree::vessels::MetierStateEvaluator, dtree::vessels::VesselTargetEvaluator, dtree::ConstStateEvaluator< T >, displace::dtree::TimeSeriesEvaluator< displace::simulation::TimeSeriesManager::Fishprice >, dtree::vessels::VesselSizeStateEvaluator, dtree::vessels::AverageRevenuesComparationStateEvaluator, dtree::VariableReferenceStateEvaluator< T >, displace::dtree::TimeSeriesEvaluator< Var >, and dtree::vessels::AverageProfitComparationsStateEvaluator.

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