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

#include <Buffer.hpp>

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

Public Member Functions
	Buffer (std::string name, uint32_t capacity)
	Constructor. More...
	~Buffer ()
	Destructor. More...
T	top ()
	Peeks at the top of the buffer. More...
void	pop ()
	Removes the object at the front of the buffer. More...
uint32_t	full ()
	Returns TRUE when the buffer is full. More...
void	push (T)
	Pushes an object to the back of the buffer. More...
uint32_t	capacity ()
	Returns max size of the buffer. More...
uint32_t	size ()
	Counts elements from the buffer. 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
std::string	_name
std::queue< T > *	_queue
uint32_t	_size
uint32_t	_capacity

Detailed Description

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

Author

Anderson Domingues

Date

07/31/18

Definition at line 53 of file Buffer.hpp.

Constructor & Destructor Documentation

Buffer()

template<typename T >

Buffer::Buffer	(	std::string	name,
		uint32_t	capacity
	)

Constructor.

Instantiate a new buffer.

Parameters

name	(optional) An arbitrary name for the instance of Buffer.
name	A unique name for the buffer (optional)

Definition at line 35 of file Buffer.cpp.

                                                   : UntimedModel(name) {
    _name = name;
    _size = 0;
    _queue = new std::queue<T>();
    _capacity = capacity;
}

~Buffer()

template<typename T >

Buffer::~Buffer

(

)

Destructor.

Dtor.

Cleans dynamic allocated memory before disposing the object.

Definition at line 46 of file Buffer.cpp.

                   {
    // the underlying queue is the only object
    // with dynamic allocation
    delete(_queue);
}

Member Function Documentation

capacity()

template<typename T >

uint32_t Buffer::capacity

(

)

Returns max size of the buffer.

Return the next element to be popped from the buffer.

Returns

the element

Definition at line 91 of file Buffer.cpp.

                             {
    return _capacity;
}

full()

template<typename T >

uint32_t Buffer::full

(

)

Returns TRUE when the buffer is full.

Return the number of elements store into underlying container.

Returns

Number of elements

Definition at line 118 of file Buffer.cpp.

                         {
    return _size == _capacity;
}

GetName()

std::string Model::GetName ( )

inherited

Getter method for the <_name> field.

Definition at line 34 of file Model.cpp.

                         {
    return _name;
}

pop()

template<typename T >

void Buffer::pop

(

)

Removes the object at the front of the buffer.

Remove the element at the top of the buffer.

Definition at line 56 of file Buffer.cpp.

                    {
    // prevents underflow
    #ifdef BUFFER_UNDERFLOW_CHECKING
    if (_size == 0) {
        throw std::runtime_error(this->GetName() +
            ": unable to pop from an empty queue");
    }
    #endif

    _size--;
    _queue->pop();
}

push()

template<typename T>

void Buffer::push

(

T

e

)

Pushes an object to the back of the buffer.

Push an element to the bottom of the buffer.

Parameters

e

Definition at line 74 of file Buffer.cpp.

                        {
    #ifdef BUFFER_OVERFLOW_CHECKING
    // prevents overflow
    if (_size == _capacity)
        throw std::runtime_error(this->GetName() +
            ": unable to push to a full queue.");
    #endif

    _size++;
    _queue->push(e);
}

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;
}

size()

template<typename T >

uint32_t Buffer::size

(

)

Counts elements from the buffer.

Return the number of elements store into underlying container.

Returns

The number of elements.

Number of elements

Definition at line 109 of file Buffer.cpp.

                         {
    return _size;
}

top()

template<typename T >

T Buffer::top

(

)

Peeks at the top of the buffer.

Return the next element to be popped from the buffer.

Returns

The object at the top of the buffer.

the element

Definition at line 100 of file Buffer.cpp.

                 {
    return _queue->front();
}

Member Data Documentation

_capacity

template<typename T>

uint32_t orcasim::modeling::Buffer< T >::_capacity

private

Definition at line 58 of file Buffer.hpp.

_name

template<typename T>

std::string orcasim::modeling::Buffer< T >::_name

private

Definition at line 55 of file Buffer.hpp.

_queue

template<typename T>

std::queue<T>* orcasim::modeling::Buffer< T >::_queue

private

Definition at line 56 of file Buffer.hpp.

_size

template<typename T>

uint32_t orcasim::modeling::Buffer< T >::_size

private

Definition at line 57 of file Buffer.hpp.

---

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

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