orcasim::modeling::SignalSet< T > Class Template Reference

The SignalSet class models a generic set of busses of type T. More...

#include <SignalSet.hpp>

Inheritance diagram for orcasim::modeling::SignalSet< T >:

Public Member Functions
	SignalSet (std::string name, uint32_t nsig)
	Constructor. More...
	~SignalSet ()
	Destructor. More...
Signal< T > *	GetSignal (uint32_t index)
	Get the a signal from the set. More...
void	MapTo (MemoryType *mptr, MemoryAddr addr)
	Maps the signal set to a given memory address. More...
a name that identifies the model, advisably not empty.
Default ctor.
std::string	GetName ()
	Getter method for the <_name> field. More...
void	SetName (std::string s)
	Setter method for the <_name> field. More...

Private Attributes
uint32_t	_num_signals
	number of signals in the set. More...
MemoryAddr	_mem_addr
	memory position of the first signal. More...
MemoryType *	_mem_ptr
Signal< T > **	_signals
	a pointer to the first signal. More...
std::string	_t_name
	an optional name to identify this model during runtime More...

Detailed Description

template<typename T>
class orcasim::modeling::SignalSet< T >

The SignalSet class models a generic set of busses of type T.

Definition at line 47 of file SignalSet.hpp.

Constructor & Destructor Documentation

SignalSet()

template<typename T >

SignalSet::SignalSet	(	std::string	name,
		uint32_t	nsig
	)

Constructor.

Creates a new SignalSet.

Parameters

name	An arbitrary name for the instance.
nsig	Number of signals to be created

Definition at line 46 of file SignalSet.cpp.

                                                    : UntimedModel(name) {
    // set internal variables
    _num_signals = nsig;
    _signals = new Signal<T>*[_num_signals];

    // create a new vector of signals. Signals are no mapped yep, use MapTo.
    for (uint32_t i = 0; i < _num_signals; i++)
        _signals[i] = new Signal<T>(this->GetName() + "." + std::to_string(i));
}

~SignalSet()

template<typename T >

SignalSet::~SignalSet

(

)

Destructor.

Note

DO NOT free _t_ptr by any means as this pointer must be freed by the class which allocated the space.

Definition at line 58 of file SignalSet.cpp.

                         {
    delete[] _signals;
}

Member Function Documentation

GetName()

std::string Model::GetName ( )

inherited

Getter method for the <_name> field.

Definition at line 34 of file Model.cpp.

                         {
    return _name;
}

GetSignal()

template<typename T >

Signal< T > * SignalSet::GetSignal

(

uint32_t

index

)

Get the a signal from the set.

Parameters

index

The identifier of the signal to be returned.

Returns

A pointer to the requested signal.

Definition at line 83 of file SignalSet.cpp.

                                                 {
    if (index > _num_signals - 1 || index < 0) {
        std::cout << "warn: requested signals is out of the bounds of the set"
            << std::endl;
        return nullptr;
    }

    return _signals[index];
}

MapTo()

template<typename T >

void SignalSet::MapTo	(	MemoryType *	mptr,
		MemoryAddr	addr
	)

Maps the signal set to a given memory address.

Signals' addresses are generated by incrementing the address of the first signal.

Parameters

mptr	Pointer to the memory location to be mapped
addr	Address to the set to the first signals

Definition at line 64 of file SignalSet.cpp.

                                                            {
    MemoryAddr address = addr;
    MemoryType* memtype = memptr;

    // set the proper address to each signal and map
    for (uint32_t i = 0; i < _num_signals; i++) {
        _signals[i]->SetAddress(address);
        _signals[i]->MapTo(memtype, address, false);

        address += sizeof(T);

        // caution, pointer arithmetic here
        for (uint32_t j = 0; j < sizeof(T) / sizeof(MemoryType); j++)
            memtype++;
    }
}

SetName()

void Model::SetName ( std::string  s )

inherited

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

_mem_addr

template<typename T >

MemoryAddr orcasim::modeling::SignalSet< T >::_mem_addr

private

memory position of the first signal.

Other signals' positions are generated by incrementing this index by sizeof(T)

Definition at line 54 of file SignalSet.hpp.

_mem_ptr

template<typename T >

MemoryType* orcasim::modeling::SignalSet< T >::_mem_ptr

private

Definition at line 55 of file SignalSet.hpp.

_num_signals

template<typename T >

uint32_t orcasim::modeling::SignalSet< T >::_num_signals

private

number of signals in the set.

Cannot be changed runtime.

Definition at line 50 of file SignalSet.hpp.

_signals

template<typename T >

Signal<T>** orcasim::modeling::SignalSet< T >::_signals

private

a pointer to the first signal.

An array will be instantiated to store signals in that pointer.

Definition at line 59 of file SignalSet.hpp.

_t_name

template<typename T >

std::string orcasim::modeling::SignalSet< T >::_t_name

private

an optional name to identify this model during runtime

Definition at line 62 of file SignalSet.hpp.

---

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

• orcasim-modeling/include/SignalSet.hpp
• orcasim-modeling/src/SignalSet.cpp