#include <HwInterface.h>

Public Member Functions
Node &	getNode (const std::string nodeId)
	Retrieves a node by its identifier.

	HwInterface (std::string connectionFilePath, std::string connectionId, PSocketMode::PSocketMode _mock_mode, std::string mock_directory="")
	Constructor for the HwInterface class.

virtual	~HwInterface ()
	Destructor for the HwInterface class.

Public Attributes
friend	Node

Protected Member Functions
uint32_t	read (const std::string nodeId) const
	Reads data from a specific node.

std::vector< uint32_t >	readBlock (const std::string &nodeId, const uint32_t &aSize) const
	Reads a block of data from a specific node.

bool	write (const std::string &nodeId, const uint32_t &aValue)
	Writes data to a specific node.

bool	writeBlock (const std::string &nodeId, const std::vector< uint32_t > &aValues) const
	Writes a block of data to a specific node.

Protected Attributes
std::string	connectionFilePath

std::string	connectionId

std::string	mock_directory

PSocketMode::PSocketMode	mock_mode

std::map< std::string, std::unique_ptr< Node > >	nodes

Static Protected Attributes
static SocketManager	manager = SocketManager()

Detailed Description

Definition at line 38 of file HwInterface.h.

Constructor & Destructor Documentation

◆ HwInterface()

HwInterface::HwInterface	(	std::string	connectionFilePath,
		std::string	connectionId,
		PSocketMode::PSocketMode	mock_mode,
		std::string	mock_directory = "" )

Constructor for the HwInterface class.

Initializes the hardware interface, sets the mock mode, and adds a server socket for communication.

Parameters

connectionFilePath	Path to the connection file.
connectionId	Identifier for the connection.
mock_mode	Mode for mock operation (e.g., MOCK_RECORD or MOCK_PLAYBACK).
mock_directory	Directory for mock data storage (default: "/tmp").

Definition at line 22 of file HwInterface.cpp.

    : connectionFilePath(connectionFilePath), connectionId(connectionId),
      mock_mode(mock_mode), mock_directory(mock_directory) {
  if (mock_directory.empty()) {
    mock_directory = connectionId + "_mock_dir"; // Default directory
  }
  std::filesystem::create_directory(mock_directory);
  manager.setMode(mock_mode);
 
  log(uhal::Debug(),
      "Creating HwInterface. Adding server socket for device: ", connectionId,
      " from ", connectionFilePath);
  data_stream_assert(manager.addServerSocket(connectionId, PSocketParam{"localhost", 3390}, Backend::server(connectionFilePath, connectionId), "./", Mock::server()));
}

References connectionFilePath, connectionId, manager, mock_directory, and mock_mode.

◆ ~HwInterface()

HwInterface::~HwInterface ( )

virtual

Destructor for the HwInterface class.

Cleans up resources, including deleting all dynamically allocated Node objects and clearing the nodes map.

Definition at line 46 of file HwInterface.cpp.

                          {
  nodes.clear();
  log(uhal::Debug(), "Deleting HwInterface:", connectionFilePath, ", ",
      connectionId);
}

References connectionFilePath, connectionId, and nodes.

Member Function Documentation

◆ getNode()

Node & HwInterface::getNode ( const std::string nodeId )

Retrieves a node by its identifier.

If the node does not exist, it creates a new Node object, stores it in the nodes map, and returns it.

Parameters

nodeId Identifier of the node to retrieve.

Returns: Reference to the Node object corresponding to the specified identifier.

Definition at line 62 of file HwInterface.cpp.

                                                 {
  if (nodes.count(nodeId)) {
    return *nodes[nodeId];
  }
  nodes[nodeId] = std::unique_ptr<Node>(new Node(this, nodeId));
  return *nodes[nodeId];
}

References Node, and nodes.

◆ read()

uint32_t HwInterface::read ( const std::string nodeId ) const

protected

Reads data from a specific node.

Sends a request to the node and retrieves the value stored in the node.

Parameters

nodeId Identifier of the node to read from.

Returns: The value read from the node.

Definition at line 93 of file HwInterface.cpp.

                                                       {
  UaMessage UaMessage(connectionId, nodeId);
  manager.recvMsg(connectionId, UaMessage);
  std::vector<uint32_t> *valuePtr = UaMessage.value.get();
  return valuePtr->at(0);
}

References connectionId, manager, and UaMessage::value.

◆ readBlock()

std::vector< uint32_t > HwInterface::readBlock	(	const std::string &	nodeId,
		const uint32_t &	aSize ) const

protected

Reads a block of data from a specific node.

Parameters

nodeId	Identifier of the node to read from.
aSize	Number of values to read.

Returns: Vector of values read from the node.

Definition at line 120 of file HwInterface.cpp.

                                                                          {
  UaMessage msg{connectionId, nodeId, aSize};
  manager.recvMsg(connectionId, msg);
  return *msg.value.get();
}

References connectionId, and manager.

◆ write()

bool HwInterface::write	(	const std::string &	nodeId,
		const uint32_t &	aValue )

protected

Writes data to a specific node.

Sends a message containing the node identifier and the value to be written.

Parameters

nodeId	Identifier of the node to write to.
aValue	Value to write to the node.

Returns: true if the data was sent successfully, false otherwise.

Definition at line 79 of file HwInterface.cpp.

                                                                       {
  std::vector<uint32_t> data = {aValue};
  UaMessage msgOut{connectionId, nodeId, &data};
  return manager.sendMsg(connectionId, msgOut);
}

References connectionId, and manager.

◆ writeBlock()

bool HwInterface::writeBlock	(	const std::string &	nodeId,
		const std::vector< uint32_t > &	aValues ) const

protected

Writes a block of data to a specific node.

Parameters

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

Returns: true if the data was sent successfully, false otherwise.

Definition at line 107 of file HwInterface.cpp.

                                                                       {
  UaMessage msgOut{connectionId, nodeId, &aValues};
  return manager.sendMsg(connectionId, msgOut);
}

References connectionId, and manager.

Member Data Documentation

◆ connectionFilePath

std::string PIpBusInterface::HwInterface::connectionFilePath

protected

Definition at line 50 of file HwInterface.h.

Referenced by HwInterface(), and ~HwInterface().

◆ connectionId

std::string PIpBusInterface::HwInterface::connectionId

protected

Definition at line 51 of file HwInterface.h.

Referenced by HwInterface(), read(), readBlock(), write(), writeBlock(), and ~HwInterface().

◆ manager

SocketManager HwInterface::manager = SocketManager()

staticprotected

Definition at line 54 of file HwInterface.h.

Referenced by HwInterface(), read(), readBlock(), write(), and writeBlock().

◆ mock_directory

std::string PIpBusInterface::HwInterface::mock_directory

protected

Definition at line 53 of file HwInterface.h.

Referenced by HwInterface().

◆ mock_mode

PSocketMode::PSocketMode PIpBusInterface::HwInterface::mock_mode

protected

Definition at line 52 of file HwInterface.h.

Referenced by HwInterface().

◆ Node

friend PIpBusInterface::HwInterface::Node

Definition at line 40 of file HwInterface.h.

Referenced by getNode().

◆ nodes

std::map<std::string, std::unique_ptr<Node> > PIpBusInterface::HwInterface::nodes

protected

Definition at line 55 of file HwInterface.h.

Referenced by getNode(), and ~HwInterface().

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

/builds/mockplatform/ipbusmock/src/HwInterface.h
/builds/mockplatform/ipbusmock/src/HwInterface.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HwInterface()

◆ ~HwInterface()

Member Function Documentation

◆ getNode()

◆ read()

◆ readBlock()

◆ write()

◆ writeBlock()

Member Data Documentation

◆ connectionFilePath

◆ connectionId

◆ manager

◆ mock_directory

◆ mock_mode

◆ Node

◆ nodes