include_TEMPLATE_MSGS.h File Reference

Go to the source code of this file.

Functions
bool	getTopicMessage (int topicSpecifier, TEMPLATE_MSGS &msg)
bool	getUpdateTopicMessage (int topicSpecifier, TEMPLATE_MSGS &msg)
bool	writeTopic (int topicSpecifier, const TEMPLATE_MSGS &msg)
void	getTopicMessages (int topicSpecifier, deque< TEMPLATE_MSGS > &msg)
void	getUpdateTopicMessages (int topicSpecifier, deque< TEMPLATE_MSGS > &msg)

---

Function Documentation

bool getTopicMessage	(	int	topicSpecifier,
		TEMPLATE_MSGS &	msg
	)

\brief Get the message from a topic \param[in].topicSpecifier This is the topic specifier number, and is given when the topic is opened. \param[out].msg String where store the info \details This method reads the topic specified by "topicSpecifier" and updates the internal variable. The method returns \b true if ros::ok(), \b false otherwise. If the specified topic was opened as write-only the method throws an exception and terminate the execution of the process.

void getTopicMessages	(	int	topicSpecifier,
		deque< TEMPLATE_MSGS > &	msg
	)

\brief Get the actual list of the stored topic \param[in].topicSpecifier This is the topic specifier number, and is given when the topic is opened. \param[in].msg List where the messages will be stored.

bool getUpdateTopicMessage	(	int	topicSpecifier,
		TEMPLATE_MSGS &	msg
	)

\brief Update the topic and get the message \param[in].topicSpecifier This is the topic specifier number, and is given when the topic is opened. \param[out].msg String where store the info \details This method reads the topic specified by "topicSpecifier" and updates the internal variable. The method returns \b true if ros::ok(), \b false otherwise. If the specified topic was opened as write-only the method throws an exception and terminate the execution of the process.

void getUpdateTopicMessages	(	int	topicSpecifier,
		deque< TEMPLATE_MSGS > &	msg
	)

\brief Get and update the actual list of the stored topic \param[in].topicSpecifier This is the topic specifier number, and is given when the topic is opened. \param[in].msg List where the messages will be stored.

bool writeTopic	(	int	topicSpecifier,
		const TEMPLATE_MSGS &	msg
	)

\brief Write a topic. \param[in].topicSpecifier This is the topic specifier number, and is given when the topic is opened. \param[in].&message If a message is found on the topic, it is stored in this string. \details This method writes "message" on the topic specified by "topicSpecifier". The method returns \b true if ros::ok(), \b false otherwise. If the specified topic was opened as read-only the method throws an exception and terminate the execution of the process.