orcasim::base::Model Class Reference

Models a generic hardware model. More...

#include <Model.hpp>

Inheritance diagram for orcasim::base::Model:

Public Member Functions
a name that identifies the model, advisably not empty.
Default ctor.
	Model (std::string name)
std::string	GetName ()
	Getter method for the <_name> field. More...
void	SetName (std::string s)
	Setter method for the <_name> field. More...
virtual	~Model ()=0
	Virtual destructor, must implement by subclass. More...

Private Attributes
std::string	_name
	A name for the model. More...

Detailed Description

Models a generic hardware model.

Models usually correspond to modules, which can be include any kind of hardware. Since not all the hardware behaviour is considered for simulation, we designed models to be either timed, when they obey to some clock domain, or untimed, when their clock is irrelevant for the simulation. See <TimedModel> and <UntimedModel>.

Definition at line 40 of file Model.hpp.

Constructor & Destructor Documentation

Model()

Model::Model ( std::string  name )

explicit

Definition at line 30 of file Model.cpp.

                                 {
    _name = name;
}

~Model()

Model::~Model ( )

pure virtual

Virtual destructor, must implement by subclass.

Definition at line 42 of file Model.cpp.

              {
    // nothing to do
}

Member Function Documentation

GetName()

std::string Model::GetName

(

)

Getter method for the <_name> field.

Definition at line 34 of file Model.cpp.

                         {
    return _name;
}

SetName()

void Model::SetName

(

std::string

s

)

Setter method for the <_name> field.

Parameters

s	Value to be set

Definition at line 38 of file Model.cpp.

                                        {
    _name = name;
}

Member Data Documentation

_name

std::string orcasim::base::Model::_name

private

A name for the model.

Users may name models without any restriction, although we advise to give models meaningful names, as these names may come in hand when debugging or reporting simulation.

Definition at line 47 of file Model.hpp.

---

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

• orcasim-base/include/Model.hpp
• orcasim-base/src/Model.cpp