OpenASIP  2.0
Public Types | Public Member Functions | Private Attributes | List of all members
HDB::CostFunctionPlugin Class Reference

#include <CostFunctionPlugin.hh>

Collaboration diagram for HDB::CostFunctionPlugin:
Collaboration graph

Public Types

enum  CostFunctionPluginType { COST_FU, COST_RF, COST_DECOMP, COST_ICDEC }
 all supported cost function plugin types More...
 

Public Member Functions

 CostFunctionPlugin (int id, const std::string &description, const std::string &name, const std::string &pluginFilePath, CostFunctionPluginType type)
 
virtual ~CostFunctionPlugin ()
 
int id () const
 
std::string description () const
 
std::string name () const
 
std::string pluginFilePath () const
 
CostFunctionPluginType type () const
 

Private Attributes

int id_
 id of the plugin in HDB More...
 
std::string description_
 description of the plugin HDB More...
 
std::string name_
 (the class) name of the plugin More...
 
std::string pluginFilePath_
 the path in the file system of the plugin More...
 
CostFunctionPluginType type_
 the type of the plugin More...
 

Detailed Description

Class that contains data stored in HDB of a cost function plugin.

Definition at line 43 of file CostFunctionPlugin.hh.

Member Enumeration Documentation

◆ CostFunctionPluginType

all supported cost function plugin types

Enumerator
COST_FU 

function unit cost estimator

COST_RF 

register file cost estimator

COST_DECOMP 

decompressor cost estimator

COST_ICDEC 

interconnection network & decoder cost estimator

Definition at line 46 of file CostFunctionPlugin.hh.

46  {
47  COST_FU, ///< function unit cost estimator
48  COST_RF, ///< register file cost estimator
49  COST_DECOMP, ///< decompressor cost estimator
50  COST_ICDEC ///< interconnection network & decoder cost estimator
51  };

Constructor & Destructor Documentation

◆ CostFunctionPlugin()

HDB::CostFunctionPlugin::CostFunctionPlugin ( int  id,
const std::string &  description,
const std::string &  name,
const std::string &  pluginFilePath,
CostFunctionPluginType  type 
)

Constructor.

Parameters
pluginFilePathPath of the plugin.

Definition at line 42 of file CostFunctionPlugin.cc.

◆ ~CostFunctionPlugin()

HDB::CostFunctionPlugin::~CostFunctionPlugin ( )
virtual

Destructor.

Definition at line 55 of file CostFunctionPlugin.cc.

55  {
56 }

Member Function Documentation

◆ description()

std::string HDB::CostFunctionPlugin::description ( ) const

Returns the description of the plugin.

Returns
Description of the plugin.

Definition at line 74 of file CostFunctionPlugin.cc.

74  {
75  return description_;
76 }

References description_.

Referenced by HDB::HDBManager::addCostFunctionPlugin(), CostFunctionPluginDialog::CostFunctionPluginDialog(), HDBToHtml::costFunctionPluginToHtml(), and HDB::HDBManager::modifyCostFunctionPlugin().

◆ id()

int HDB::CostFunctionPlugin::id ( ) const

Returns the id of the plugin.

Returns
Id of the plugin.

Definition at line 64 of file CostFunctionPlugin.cc.

64  {
65  return id_;
66 }

References id_.

Referenced by CostDatabase::buildFunctionUnits(), CostDatabase::buildRegisterFiles(), HDBToHtml::fuEntryToHtml(), and HDBToHtml::rfEntryToHtml().

◆ name()

std::string HDB::CostFunctionPlugin::name ( ) const

◆ pluginFilePath()

std::string HDB::CostFunctionPlugin::pluginFilePath ( ) const

◆ type()

CostFunctionPlugin::CostFunctionPluginType HDB::CostFunctionPlugin::type ( ) const

Returns the type of the plugin.

Returns
Description of the plugin.

Definition at line 104 of file CostFunctionPlugin.cc.

104  {
105  return type_;
106 }

References type_.

Referenced by HDB::HDBManager::addCostFunctionPlugin(), CostFunctionPluginDialog::CostFunctionPluginDialog(), HDBToHtml::costFunctionPluginToHtml(), and HDB::HDBManager::modifyCostFunctionPlugin().

Member Data Documentation

◆ description_

std::string HDB::CostFunctionPlugin::description_
private

description of the plugin HDB

Definition at line 71 of file CostFunctionPlugin.hh.

Referenced by description().

◆ id_

int HDB::CostFunctionPlugin::id_
private

id of the plugin in HDB

Definition at line 69 of file CostFunctionPlugin.hh.

Referenced by id().

◆ name_

std::string HDB::CostFunctionPlugin::name_
private

(the class) name of the plugin

Definition at line 73 of file CostFunctionPlugin.hh.

Referenced by name().

◆ pluginFilePath_

std::string HDB::CostFunctionPlugin::pluginFilePath_
private

the path in the file system of the plugin

Definition at line 75 of file CostFunctionPlugin.hh.

Referenced by pluginFilePath().

◆ type_

CostFunctionPluginType HDB::CostFunctionPlugin::type_
private

the type of the plugin

Definition at line 77 of file CostFunctionPlugin.hh.

Referenced by type().


The documentation for this class was generated from the following files:
HDB::CostFunctionPlugin::description
std::string description() const
Definition: CostFunctionPlugin.cc:74
HDB::CostFunctionPlugin::pluginFilePath_
std::string pluginFilePath_
the path in the file system of the plugin
Definition: CostFunctionPlugin.hh:75
HDB::CostFunctionPlugin::COST_DECOMP
@ COST_DECOMP
decompressor cost estimator
Definition: CostFunctionPlugin.hh:49
HDB::CostFunctionPlugin::COST_FU
@ COST_FU
function unit cost estimator
Definition: CostFunctionPlugin.hh:47
HDB::CostFunctionPlugin::COST_ICDEC
@ COST_ICDEC
interconnection network & decoder cost estimator
Definition: CostFunctionPlugin.hh:50
HDB::CostFunctionPlugin::description_
std::string description_
description of the plugin HDB
Definition: CostFunctionPlugin.hh:71
HDB::CostFunctionPlugin::name_
std::string name_
(the class) name of the plugin
Definition: CostFunctionPlugin.hh:73
HDB::CostFunctionPlugin::COST_RF
@ COST_RF
register file cost estimator
Definition: CostFunctionPlugin.hh:48
HDB::CostFunctionPlugin::type_
CostFunctionPluginType type_
the type of the plugin
Definition: CostFunctionPlugin.hh:77
HDB::CostFunctionPlugin::pluginFilePath
std::string pluginFilePath() const
Definition: CostFunctionPlugin.cc:94
HDB::CostFunctionPlugin::type
CostFunctionPluginType type() const
Definition: CostFunctionPlugin.cc:104
HDB::CostFunctionPlugin::name
std::string name() const
Definition: CostFunctionPlugin.cc:84
HDB::CostFunctionPlugin::id_
int id_
id of the plugin in HDB
Definition: CostFunctionPlugin.hh:69