#include <HWBlockImplementation.hh>

Inheritance diagram for HDB::HWBlockImplementation:

Collaboration diagram for HDB::HWBlockImplementation:

Public Member Functions
	HWBlockImplementation (const std::string &moduleName, const std::string &clkPort, const std::string &rstPort, const std::string &glockPort)

	HWBlockImplementation (const HWBlockImplementation &b)

virtual	~HWBlockImplementation ()

bool	hasID () const

void	setID (RowID id)

RowID	id () const

void	setModuleName (const std::string &name)

std::string	moduleName () const

void	setClkPort (const std::string &name)

std::string	clkPort () const

void	setRstPort (const std::string &name)

std::string	rstPort () const

void	setGlockPort (const std::string &name)

std::string	glockPort () const

void	addImplementationFile (BlockImplementationFile *file)

void	removeImplementationFile (const BlockImplementationFile &file)

int	implementationFileCount () const

BlockImplementationFile &	file (int index) const

Private Types
typedef std::vector< BlockImplementationFile * >	FileTable
	Vector type for BlockImplementationFile. More...

Private Attributes
std::string	moduleName_
	Name of the module. More...

std::string	clkPort_
	Name of the clock port. More...

std::string	rstPort_
	Name of the reset port. More...

std::string	glockPort_
	Name of the global lock port. More...

FileTable	files_
	Contains the block implementation files. More...

bool	hasID_
	Tells whether the implementation has an ID. More...

RowID	id_
	ID of the implementation. More...

Detailed Description

Base class for FUImplementation and RFImplementation.

Definition at line 49 of file HWBlockImplementation.hh.

Member Typedef Documentation

◆ FileTable

typedef std::vector<BlockImplementationFile*> HDB::HWBlockImplementation::FileTable

private

Vector type for BlockImplementationFile.

Definition at line 82 of file HWBlockImplementation.hh.

Constructor & Destructor Documentation

◆ HWBlockImplementation() [1/2]

HDB::HWBlockImplementation::HWBlockImplementation	(	const std::string &	moduleName,
		const std::string &	clkPort,
		const std::string &	rstPort,
		const std::string &	glockPort
	)

The constructor.

Parameters

moduleName	Name of the module.
clkPort	Name of the clock port.
rstPort	Name of the reset port.
glockPort	Name of the global lock port.

Definition at line 52 of file HWBlockImplementation.cc.

                                 :
     moduleName_(moduleName), clkPort_(clkPort), rstPort_(rstPort), 
     glockPort_(glockPort) {
 }

◆ HWBlockImplementation() [2/2]

HDB::HWBlockImplementation::HWBlockImplementation ( const HWBlockImplementation & original )

Copy constructor.

Parameters

original HWBlock to copy.

Definition at line 66 of file HWBlockImplementation.cc.

                                            {
  
     moduleName_ = original.moduleName();
     clkPort_ = original.clkPort();
     rstPort_ = original.rstPort();
     glockPort_ = original.glockPort();
     hasID_ = original.hasID();
  
     if (original.hasID()) {
         id_ = original.id();
     } else {
         id_ = -1;
     }
  
     // Deep copy implementation file list.
     for (int i = 0; i < original.implementationFileCount(); i++) {
         BlockImplementationFile* newFile =
             new BlockImplementationFile(original.file(i));
  
         addImplementationFile(newFile);
     }
 }

References addImplementationFile(), clkPort(), clkPort_, file(), glockPort(), glockPort_, hasID(), hasID_, id(), id_, implementationFileCount(), moduleName(), moduleName_, rstPort(), and rstPort_.

Here is the call graph for this function:

◆ ~HWBlockImplementation()

HDB::HWBlockImplementation::~HWBlockImplementation ( )

virtual

The destructor.

Definition at line 94 of file HWBlockImplementation.cc.

                                               {
     SequenceTools::deleteAllItems(files_);
 }

References SequenceTools::deleteAllItems(), and files_.

Here is the call graph for this function:

Member Function Documentation

◆ addImplementationFile()

void HDB::HWBlockImplementation::addImplementationFile ( BlockImplementationFile * file )

Adds a new implementation file for the block implementation.

Parameters

file	The file to add.

Definition at line 230 of file HWBlockImplementation.cc.

                                                                           {
     files_.push_back(file);
 }

References file(), and files_.

Referenced by HWBlockImplementation().

Here is the call graph for this function:

◆ clkPort()

std::string HDB::HWBlockImplementation::clkPort ( ) const

Returns the name of the clock signal port.

Returns: The name of the port.

Definition at line 175 of file HWBlockImplementation.cc.

                                      {
     return clkPort_;
 }

References clkPort_.

Referenced by HDB::HDBManager::addFUImplementation(), ProGe::NetlistGenerator::addFUToNetlist(), RFTestbenchGenerator::createTbInstantiation(), FUTestbenchGenerator::createTbInstantiation(), HDBToHtml::fuImplToHtml(), HWBlockImplementation(), HDBToHtml::rfImplToHtml(), and TestbenchGenerator::writeTestbench().

◆ file()

BlockImplementationFile & HDB::HWBlockImplementation::file ( int index ) const

Returns a block implementation file by the given index.

Parameters

index The index.

Exceptions

OutOfRange If the index is negative or not smaller than the number of files.

Definition at line 267 of file HWBlockImplementation.cc.

                                            {
     if (index < 0 || index >= implementationFileCount()) {
         const string procName = "HWBlockImplementation::file";
         throw OutOfRange(__FILE__, __LINE__, procName);
     }
  
     return *files_[index];
 }

References files_, and implementationFileCount().

Referenced by HDB::HDBManager::addFUImplementation(), addImplementationFile(), ImplementationTester::createListOfSimulationFiles(), HDBToHtml::fuImplToHtml(), ProGeScriptGenerator::getBlockOrder(), HWBlockImplementation(), removeImplementationFile(), and HDBToHtml::rfImplToHtml().

Here is the call graph for this function:

◆ glockPort()

std::string HDB::HWBlockImplementation::glockPort ( ) const

Returns the name of the global lock port.

Returns: The name of the port.

Definition at line 219 of file HWBlockImplementation.cc.

                                        {
     return glockPort_;
 }

References glockPort_.

Referenced by HDB::HDBManager::addFUImplementation(), ProGe::NetlistGenerator::addFUToNetlist(), RFTestbenchGenerator::createTbInstantiation(), FUTestbenchGenerator::createTbInstantiation(), HDBToHtml::fuImplToHtml(), HWBlockImplementation(), HDBToHtml::rfImplToHtml(), and TestbenchGenerator::writeTestbench().

◆ hasID()

bool HDB::HWBlockImplementation::hasID ( ) const

Tells whether the implementation has an ID.

Returns: True if the entry has an ID, otherwise false.

Definition at line 105 of file HWBlockImplementation.cc.

                                    {
     return hasID_;
 }

References hasID_.

Referenced by HDBEditorModifyCmd::Do(), HWBlockImplementation(), and id().

◆ id()

RowID HDB::HWBlockImplementation::id ( ) const

Returns the ID of the implementation.

Returns: ID of the implementation.

Definition at line 128 of file HWBlockImplementation.cc.

                                 {
     if (!hasID()) {
         throw NotAvailable(__FILE__, __LINE__, __func__);
     } else {
         return id_;
     }
 }

References __func__, hasID(), and id_.

Referenced by HDBEditorModifyCmd::Do(), HDBToHtml::fuEntryToHtml(), HWBlockImplementation(), HDBToHtml::rfEntryToHtml(), setID(), and HDBBrowserWindow::update().

Here is the call graph for this function:

◆ implementationFileCount()

int HDB::HWBlockImplementation::implementationFileCount ( ) const

Returns the number of files which constitutes the implementation of the block.

Returns: The number of files.

Definition at line 254 of file HWBlockImplementation.cc.

                                                      {
     return files_.size();
 }

References files_.

Referenced by HDB::HDBManager::addFUImplementation(), ImplementationTester::createListOfSimulationFiles(), file(), HDBToHtml::fuImplToHtml(), ProGeScriptGenerator::getBlockOrder(), HWBlockImplementation(), and HDBToHtml::rfImplToHtml().

◆ moduleName()

std::string HDB::HWBlockImplementation::moduleName ( ) const

Returns the name of the module.

Returns: The name of the module.

Definition at line 153 of file HWBlockImplementation.cc.

                                         {
     return moduleName_;
 }

References moduleName_.

Referenced by HDB::HDBManager::addFUImplementation(), ProGe::NetlistGenerator::addFUToNetlist(), RFTestbenchGenerator::createTbInstantiation(), FUTestbenchGenerator::createTbInstantiation(), HDBToHtml::fuEntryToHtml(), HDBToHtml::fuImplToHtml(), HWBlockImplementation(), BlockImplementationDialog::onHDBSelection(), HDBToHtml::rfEntryToHtml(), HDBToHtml::rfImplToHtml(), and HDBBrowserWindow::update().

◆ removeImplementationFile()

void HDB::HWBlockImplementation::removeImplementationFile ( const BlockImplementationFile & file )

Removes the given block implementation file from the implementation.

Parameters

file	The file to remove.

Definition at line 241 of file HWBlockImplementation.cc.

                                          {
     ContainerTools::removeValueIfExists(files_, &file);
 }

References file(), files_, and ContainerTools::removeValueIfExists().

Here is the call graph for this function:

◆ rstPort()

std::string HDB::HWBlockImplementation::rstPort ( ) const

Returns the name of the reset port.

Returns: The name of the port.

Definition at line 197 of file HWBlockImplementation.cc.

                                      {
     return rstPort_;
 }

References rstPort_.

Referenced by HDB::HDBManager::addFUImplementation(), ProGe::NetlistGenerator::addFUToNetlist(), RFTestbenchGenerator::createTbInstantiation(), FUTestbenchGenerator::createTbInstantiation(), HDBToHtml::fuImplToHtml(), HWBlockImplementation(), HDBToHtml::rfImplToHtml(), and TestbenchGenerator::writeTestbench().

◆ setClkPort()

void HDB::HWBlockImplementation::setClkPort ( const std::string & name )

Sets the name of the clock port.

Parameters

name	Name of the port.

Definition at line 164 of file HWBlockImplementation.cc.

                                                        {
     clkPort_ = name;
 }

References clkPort_.

◆ setGlockPort()

void HDB::HWBlockImplementation::setGlockPort ( const std::string & name )

Sets the name of the global lock port.

Parameters

name	Name of the port.

Definition at line 208 of file HWBlockImplementation.cc.

                                                          {
     glockPort_ = name;
 }

References glockPort_.

◆ setID()

void HDB::HWBlockImplementation::setID ( RowID id )

Sets the ID for the implementation.

Parameters

id	The ID to set.

Definition at line 116 of file HWBlockImplementation.cc.

                                      {
     hasID_ = true;
     id_ = id;
 }

References hasID_, id(), and id_.

Here is the call graph for this function:

◆ setModuleName()

void HDB::HWBlockImplementation::setModuleName ( const std::string & name )

Sets the module name.

Parameters

name	Name of the module.

Definition at line 142 of file HWBlockImplementation.cc.

                                                           {
     moduleName_ = name;
 }

References moduleName_.

◆ setRstPort()

void HDB::HWBlockImplementation::setRstPort ( const std::string & name )

Sets the name of the reset port.

Parameters

name	Name of the port.

Definition at line 186 of file HWBlockImplementation.cc.

                                                        {
     rstPort_ = name;
 }

References rstPort_.

Member Data Documentation

◆ clkPort_

std::string HDB::HWBlockImplementation::clkPort_

private

Name of the clock port.

Definition at line 87 of file HWBlockImplementation.hh.

Referenced by clkPort(), HWBlockImplementation(), and setClkPort().

◆ files_

FileTable HDB::HWBlockImplementation::files_

private

Contains the block implementation files.

Definition at line 93 of file HWBlockImplementation.hh.

Referenced by addImplementationFile(), file(), implementationFileCount(), removeImplementationFile(), and ~HWBlockImplementation().

◆ glockPort_

std::string HDB::HWBlockImplementation::glockPort_

private

Name of the global lock port.

Definition at line 91 of file HWBlockImplementation.hh.

Referenced by glockPort(), HWBlockImplementation(), and setGlockPort().

◆ hasID_

bool HDB::HWBlockImplementation::hasID_

private

Tells whether the implementation has an ID.

Definition at line 95 of file HWBlockImplementation.hh.

Referenced by hasID(), HWBlockImplementation(), and setID().

◆ id_

RowID HDB::HWBlockImplementation::id_

private

ID of the implementation.

Definition at line 98 of file HWBlockImplementation.hh.

Referenced by HWBlockImplementation(), id(), and setID().

◆ moduleName_

std::string HDB::HWBlockImplementation::moduleName_

private

Name of the module.

Definition at line 85 of file HWBlockImplementation.hh.

Referenced by HWBlockImplementation(), moduleName(), and setModuleName().

◆ rstPort_

std::string HDB::HWBlockImplementation::rstPort_

private

Name of the reset port.

Definition at line 89 of file HWBlockImplementation.hh.

Referenced by HWBlockImplementation(), rstPort(), and setRstPort().

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

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FileTable

Constructor & Destructor Documentation

◆ HWBlockImplementation() [1/2]

◆ HWBlockImplementation() [2/2]

◆ ~HWBlockImplementation()

Member Function Documentation

◆ addImplementationFile()

◆ clkPort()

◆ file()

◆ glockPort()

◆ hasID()

◆ id()

◆ implementationFileCount()

◆ moduleName()

◆ removeImplementationFile()

◆ rstPort()

◆ setClkPort()

◆ setGlockPort()

◆ setID()

◆ setModuleName()

◆ setRstPort()

Member Data Documentation

◆ clkPort_

◆ files_

◆ glockPort_

◆ hasID_

◆ id_

◆ moduleName_

◆ rstPort_