mm_messages::Publisher< Multiplexer > Class Template Reference

Template parent class for specific publishers. More...

#include <publisher.hpp>

List of all members.

Public Types
typedef mm_messages::ByteArray	ByteArray
typedef mm_messages::MessageRegistry	MessageRegistry
Public Member Functions
template<typename T >
void	publish (const unsigned int &id, const T &msg)
	Shunt a message off to be published.
	Publisher (const std::string &name)
virtual	~Publisher ()
Private Attributes
std::string	name

---

Detailed Description

template<typename Multiplexer>
class mm_messages::Publisher< Multiplexer >

Template parent class for specific publishers.

This gets typedef'd for specific publisher types in each package (e.g. MessageDemux, RadioMuxDemux)

Definition at line 41 of file publisher.hpp.

---

Member Typedef Documentation

template<typename Multiplexer >

typedef mm_messages::ByteArray mm_messages::Publisher< Multiplexer >::ByteArray

Definition at line 44 of file publisher.hpp.

template<typename Multiplexer >

typedef mm_messages::MessageRegistry mm_messages::Publisher< Multiplexer >::MessageRegistry

Definition at line 43 of file publisher.hpp.

---

Constructor & Destructor Documentation

template<typename Multiplexer >

mm_messages::Publisher< Multiplexer >::Publisher

(

const std::string &

name

)

[inline]

Definition at line 46 of file publisher.hpp.

template<typename Multiplexer >

virtual mm_messages::Publisher< Multiplexer >::~Publisher

(

)

[inline, virtual]

Definition at line 52 of file publisher.hpp.

---

Member Function Documentation

template<typename Multiplexer >

template<typename T >

void mm_messages::Publisher< Multiplexer >::publish	(	const unsigned int &	id,
		const T &	msg
	)		[inline]

Shunt a message off to be published.

Parameters:

id
msg

Template Parameters:

T	the data type for the message.

Exceptions:

UnregisteredID	: if this packet id hasn't been registered by the mux.
InvalidIDTypeCombination	: if this packet id doesn't correspond to the template msg type.

Definition at line 63 of file publisher.hpp.

---

Member Data Documentation

template<typename Multiplexer >

std::string mm_messages::Publisher< Multiplexer >::name [private]

Definition at line 89 of file publisher.hpp.

---

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

• publisher.hpp