Class cowboys::GPAgentRegisters

ClassList > cowboys > GPAgentRegisters

Class to hold the registers of the agent.

• #include <GPAgentsRegisters.hpp>

Classes

Type	Name
class	iterator Iterator class for GPAgentRegisters TODO: Just pass in the vector Iterator.

Public Functions

Type	Name
	GPAgentRegisters (int numRegisters=16) Number of registers Default is 16.
iterator	begin ()
iterator	end ()
size_t	getNumRegisters () Get the number of registers.
std::optional< size_t >	getRegister (size_t index) Get the Register object.
bool	setRegister (size_t index, size_t value) Set the Register object.
size_t	size ()
	~GPAgentRegisters () = default

Public Functions Documentation

function GPAgentRegisters

Number of registers Default is 16.

inline cowboys::GPAgentRegisters::GPAgentRegisters (
    int numRegisters=16
) 

Constructor for GPAgentRegisters

Parameters:

• numRegisters

function begin

inline iterator cowboys::GPAgentRegisters::begin () 

function end

inline iterator cowboys::GPAgentRegisters::end () 

function getNumRegisters

Get the number of registers.

inline size_t cowboys::GPAgentRegisters::getNumRegisters () 

Returns:

size of the registers

function getRegister

Get the Register object.

inline std::optional< size_t > cowboys::GPAgentRegisters::getRegister (
    size_t index
) 

Parameters:

• index Index of the register

Returns:

std::optional<size_t> Returns the value of the register if it exists

function setRegister

Set the Register object.

inline bool cowboys::GPAgentRegisters::setRegister (
    size_t index,
    size_t value
) 

Parameters:

• index
• value

Returns:

function size

inline size_t cowboys::GPAgentRegisters::size () 

function ~GPAgentRegisters

cowboys::GPAgentRegisters::~GPAgentRegisters () = default

Destructor for GPAgentRegisters

---

The documentation for this class was generated from the following file source/Agents/GP/GPAgentsRegisters.hpp