IpBusImpl Class Reference

#include <ipbrw.h>

Public Member Functions
void	close ()
	Close the IpBusImpl connection.
uint32_t	getSize (const std::string &nodeId) const
	Computes the node size.
	IpBusImpl (const std::string &connectionFilePath, const std::string &connectionId)
	Constructor of IpBusImpl.
bool	read (const std::string &nodeId, uint32_t &res)
	Reads a register using the uHAL library.
bool	readBlock (const std::string &nodeId, std::vector< uint32_t > &results, const uint32_t &aSize)
	Reads a block of data from a block of registers or a block-read port.
bool	write (const std::string &nodeId, const uint32_t values)
	Writes a register using the uHAL library.
bool	writeBlock (const std::string &nodeId, const std::vector< uint32_t > values)
	Writes a block of data to a block of registers or a block-write port.
	~IpBusImpl ()
	Destructor of IpBusImpl.

Static Public Member Functions
static IpBusImpl *	pipbus_createSocket (const std::string &connectionFilePath, const std::string &connectionId)
	Creates an IpBusImpl instance.
static void	setLogLevelTo (const std::string level)
	Sets the uHAL log level to the given level.

Private Attributes
uhal::HwInterface *	hardwareInterface

Detailed Description

Definition at line 8 of file ipbrw.h.

Constructor & Destructor Documentation

IpBusImpl()

IpBusImpl::IpBusImpl	(	const std::string &	connectionFilePath,
		const std::string &	connectionId )

Constructor of IpBusImpl.

Parameters

connectionFilePath	Path to the connection file.
connectionId	Identifier for the connection.

Definition at line 12 of file ipbrw.cpp.

                                                    {
  uhal::ConnectionManager connectionMgr(connectionFilePath);
  hardwareInterface =
      new uhal::HwInterface(connectionMgr.getDevice(connectionId));
}

References hardwareInterface.

Referenced by pipbus_createSocket().

Here is the caller graph for this function:

~IpBusImpl()

IpBusImpl::~IpBusImpl

(

)

Destructor of IpBusImpl.

Definition at line 22 of file ipbrw.cpp.

                      {
  delete hardwareInterface;
  hardwareInterface = nullptr;
}

References hardwareInterface.

Member Function Documentation

close()

void IpBusImpl::close

(

)

Close the IpBusImpl connection.

Definition at line 151 of file ipbrw.cpp.

                      {
        if (hardwareInterface != nullptr) {
        try {
                // uHAL does not provide a close method,
                // But we can delete the HwInterface to close the connection.
                delete hardwareInterface;
                hardwareInterface = nullptr;
        } catch (const std::exception& e) {
                std::cerr << "Error closing connection: " << e.what() << std::endl;
        }
        }
}

References hardwareInterface.

getSize()

uint32_t IpBusImpl::getSize

(

const std::string &

nodeId

)

const

Computes the node size.

Parameters

nodeId

Identifier of the node.

Returns

Size of the node.

Definition at line 33 of file ipbrw.cpp.

                                                         {
  return this->hardwareInterface->getNode(nodeId).getSize();
}

References hardwareInterface.

pipbus_createSocket()

IpBusImpl * IpBusImpl::pipbus_createSocket ( const std::string & connectionFilePath, const std::string & connectionId )

static

Creates an IpBusImpl instance.

Parameters

connectionFilePath	Path to the connection file.
connectionId	Identifier for the connection.

Returns

Pointer to the IpBusImpl instance.

Definition at line 117 of file ipbrw.cpp.

                                                                         {
  static IpBusImpl _self(connectionFilePath, connectionId);
  return &_self;
}

References IpBusImpl().

Referenced by PIpBusSocket::createClientSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

bool IpBusImpl::read	(	const std::string &	nodeId,
		uint32_t &	result )

Reads a register using the uHAL library.

Parameters

nodeId	Identifier of the node.
result	Reference to store the read value.

Returns

true if the read was successful, false otherwise.

Definition at line 44 of file ipbrw.cpp.

                                                              {
  const uhal::Node &lNode = this->hardwareInterface->getNode(nodeId);
  uhal::ValWord<uint32_t> lReg = lNode.read();
  this->hardwareInterface->dispatch();
  if (!lReg.valid()) {
    std::cerr << "Error: Register read failed." << std::endl;
    return false;
  } else {
    result = lReg.value();
    return true;
  }
}

References hardwareInterface.

readBlock()

bool IpBusImpl::readBlock	(	const std::string &	nodeId,
		std::vector< uint32_t > &	results,
		const uint32_t &	aSize )

Reads a block of data from a block of registers or a block-read port.

Parameters

nodeId	Identifier of the node.
results	Vector to store the read values.
aSize	Number of words to read.

Returns

true if the read was successful, false otherwise.

Definition at line 79 of file ipbrw.cpp.

                                                 {
  const uhal::Node &lNode = this->hardwareInterface->getNode(nodeId);
  uhal::ValVector<uint32_t> lReg = lNode.readBlock(aSize);
  this->hardwareInterface->dispatch();
  if (!lReg.valid()) {
    std::cerr << "Error: Register read failed." << std::endl;
    return false;
  } else {
    results.clear();
    copy(lReg.begin(), lReg.end(), back_inserter(results));
    return true;
  }
}

References hardwareInterface.

setLogLevelTo()

void IpBusImpl::setLogLevelTo ( const std::string level )

static

Sets the uHAL log level to the given level.

Parameters

level

Log level (e.g., Debug, Info, Warning, etc.).

Definition at line 128 of file ipbrw.cpp.

                                                   {
  if (level == "Debug") {
    uhal::setLogLevelTo(uhal::Debug());
  } else if (level == "Info") {
    uhal::setLogLevelTo(uhal::Info());
  } else if (level == "Notice") {
    uhal::setLogLevelTo(uhal::Notice());
  } else if (level == "Warning") {
    uhal::setLogLevelTo(uhal::Warning());
  } else if (level == "Error") {
    uhal::setLogLevelTo(uhal::Error());
  } else if (level == "Fatal") {
    uhal::setLogLevelTo(uhal::Fatal());
  } else {
    std::cerr << "Invalid log level. Use Debug, Info, Notice, Warning, "
              << "Error, or Fatal." << std::endl;
    uhal::setLogLevelTo(uhal::Info());
  }
}

write()

bool IpBusImpl::write	(	const std::string &	nodeId,
		const uint32_t	value )

Writes a register using the uHAL library.

Parameters

nodeId	Identifier of the node.
value	Value to write.

Returns

true if the write was successful, false otherwise.

Definition at line 64 of file ipbrw.cpp.

                                                                   {
  const uhal::Node &lNode = this->hardwareInterface->getNode(nodeId);
  lNode.write(value);
  this->hardwareInterface->dispatch();
  return true;
}

References hardwareInterface.

writeBlock()

bool IpBusImpl::writeBlock	(	const std::string &	nodeId,
		const std::vector< uint32_t >	values )

Writes a block of data to a block of registers or a block-write port.

Parameters

nodeId	Identifier of the node.
values	Vector of values to write.

Returns

true if the write was successful, false otherwise.

Definition at line 102 of file ipbrw.cpp.

                                                             {
  const uhal::Node &lNode = this->hardwareInterface->getNode(nodeId);
  lNode.writeBlock(values);
  this->hardwareInterface->dispatch();
  return true;
}

References hardwareInterface.

Member Data Documentation

hardwareInterface

uhal::HwInterface* IpBusImpl::hardwareInterface

private

Definition at line 29 of file ipbrw.h.

Referenced by close(), getSize(), IpBusImpl(), read(), readBlock(), write(), writeBlock(), and ~IpBusImpl().

---

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

• /builds/mockplatform/ipbusmock/src/ipbrw.h
• /builds/mockplatform/ipbusmock/src/ipbrw.cpp