OpenASIP  2.0
Public Member Functions | Protected Attributes | List of all members
CostEstimator::CostEstimationPlugin Class Reference

#include <CostEstimationPlugin.hh>

Inheritance diagram for CostEstimator::CostEstimationPlugin:
Inheritance graph
Collaboration diagram for CostEstimator::CostEstimationPlugin:
Collaboration graph

Public Member Functions

 CostEstimationPlugin (const std::string &name)
 
virtual ~CostEstimationPlugin ()
 
virtual std::string name () const
 
virtual std::string description () const
 

Protected Attributes

std::string name_
 the name of the plugin class in the HDB; used to identify cost data More...
 

Detailed Description

A base interface for all classes that implement pluggable cost estimation algorithms.

Definition at line 45 of file CostEstimationPlugin.hh.

Constructor & Destructor Documentation

◆ CostEstimationPlugin()

CostEstimator::CostEstimationPlugin::CostEstimationPlugin ( const std::string &  name)

Constructor.

Parameters
nameThe name of the cost estimation plugin in the HDB.
dataSourceThe HDB that stores the cost estimation data of the plugin. This reference can also be used to add new data, in case required by the algorithm.

Definition at line 46 of file CostEstimationPlugin.cc.

47  :
48  name_(name) {
49 }

◆ ~CostEstimationPlugin()

CostEstimator::CostEstimationPlugin::~CostEstimationPlugin ( )
virtual

Destructor.

Definition at line 54 of file CostEstimationPlugin.cc.

54  {
55 }

Member Function Documentation

◆ description()

std::string CostEstimator::CostEstimationPlugin::description ( ) const
virtual

Returns the description of this cost estimation plugin.

Returns
The default description is empty.

Definition at line 73 of file CostEstimationPlugin.cc.

73  {
74  return "";
75 }

◆ name()

std::string CostEstimator::CostEstimationPlugin::name ( ) const
virtual

Returns the name of this cost estimation plugin.

Returns
The name of the plugin.

Definition at line 63 of file CostEstimationPlugin.cc.

63  {
64  return name_;
65 }

References name_.

Member Data Documentation

◆ name_

std::string CostEstimator::CostEstimationPlugin::name_
protected

the name of the plugin class in the HDB; used to identify cost data

Definition at line 55 of file CostEstimationPlugin.hh.

Referenced by name().


The documentation for this class was generated from the following files:
CostEstimator::CostEstimationPlugin::name
virtual std::string name() const
Definition: CostEstimationPlugin.cc:63
CostEstimator::CostEstimationPlugin::name_
std::string name_
the name of the plugin class in the HDB; used to identify cost data
Definition: CostEstimationPlugin.hh:55