Protocol++® (Protocolpp®)  v5.6.2
InterfacePP::ringflow Class Reference

Public Member Functions

 ringflow (uintptr_t address, uint32_t size, std::string name)
 
virtual ~ringflow ()=default
 standard deconstructor
 
uintptr_t get_addr ()
 
uint32_t get_size ()
 
std::string get_name ()
 
void set_addr (uintptr_t address)
 
void set_size (uint32_t size)
 
void set_name (std::string &name)
 

Constructor & Destructor Documentation

◆ ringflow()

InterfacePP::ringflow::ringflow ( uintptr_t  address,
uint32_t  size,
std::string  name 
)
inline

Constructor for testbench flow ring object

Parameters
address- address of flow
size- size of flow
name- name of the flow

Sits in the flow ring as


| address (8-byte flow address) |

| size (4-byte value) |

| name (12-byte string) |

Member Function Documentation

◆ get_addr()

uintptr_t InterfacePP::ringflow::get_addr ( )
inline

return address

Returns
- address

◆ get_name()

std::string InterfacePP::ringflow::get_name ( )
inline

return the name of the flow

Returns
- name of the flow

◆ get_size()

uint32_t InterfacePP::ringflow::get_size ( )
inline

return size

Returns
- size

◆ set_addr()

void InterfacePP::ringflow::set_addr ( uintptr_t  address)
inline

set the address

Parameters
address- address of the input

◆ set_name()

void InterfacePP::ringflow::set_name ( std::string &  name)
inline

set the name of the flow

Parameters
name- name of the flow to add

◆ set_size()

void InterfacePP::ringflow::set_size ( uint32_t  size)
inline

set the size of the input

Parameters
size- size of the input

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