ispike::YarpConnection Class Reference

#include <YarpConnection.hpp>

List of all members.

Public Member Functions
	YarpConnection (std::string ip, unsigned port)
	~YarpConnection ()
int	connect_to_port (std::string ip, unsigned port)
map< string, YarpPortDetails > &	getPortMap ()
string	getSocketString ()
void	prepare_to_read_binary ()
void	prepare_to_read_text ()
bool	read_image (Bitmap &bitmap)
std::string	read_until (string until)
int	write_text (std::string message)

---

Detailed Description

Main interface used for communication with Yarp

Definition at line 18 of file YarpConnection.hpp.

---

Constructor & Destructor Documentation

YarpConnection::YarpConnection	(	std::string	ip,
		unsigned	port
	)

Constructor

Definition at line 24 of file YarpConnection.cpp.

YarpConnection::~YarpConnection

(

)

Destructor

Definition at line 77 of file YarpConnection.cpp.

---

Member Function Documentation

int YarpConnection::connect_to_port	(	std::string	ip,
		unsigned	port
	)

Connect to a given YARP port

Parameters:

ip	The IP address of the Yarp server
port	The port number to connect to

Returns:

true if connected, false otherwise

Definition at line 137 of file YarpConnection.cpp.

map<string, YarpPortDetails>& ispike::YarpConnection::getPortMap

(

)

[inline]

Definition at line 23 of file YarpConnection.hpp.

string YarpConnection::getSocketString

(

)

Definition at line 97 of file YarpConnection.cpp.

void YarpConnection::prepare_to_read_binary

(

)

Reverses the connection to enable binary contents to be read. It will no longer be possible to write to this port

Definition at line 167 of file YarpConnection.cpp.

void YarpConnection::prepare_to_read_text

(

)

Reverses the connection to enable text to be read It will no longer be possible to write to this port

Definition at line 156 of file YarpConnection.cpp.

bool YarpConnection::read_image

(

Bitmap &

bitmap

)

Reads image data into the supplied bitmap, resizing it if necessary Returns true if data has been successfully read, false otherwise.

Definition at line 203 of file YarpConnection.cpp.

string YarpConnection::read_until

(

string

until

)

Read text until a given string is received

Parameters:

until

The string where we stop

Returns:

The text that has been read including the stop characters

Definition at line 124 of file YarpConnection.cpp.

int YarpConnection::write_text

(

std::string

message

)

Write text contents to a previously opened socket

Parameters:

message

The message to be written

Returns:

something

Definition at line 88 of file YarpConnection.cpp.

---

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

• D:/Home/Programs/iSpike/include/iSpike/YarpConnection.hpp
• D:/Home/Programs/iSpike/src/YarpConnection.cpp