mb_port Class Reference

Abstract port characteristics. More...

#include <port.h>

Inheritance diagram for mb_port:

[legend]

List of all members.

Public Types
enum	port_type_t { EXTERNAL, RELAY, INTERNAL }
	port classification More...
Public Member Functions
std::string	port_name () const
pmt_t	port_symbol () const
pmt_t	protocol_class () const
bool	conjugated () const
port_type_t	port_type () const
pmt_t	incoming_message_set () const
pmt_t	outgoing_message_set () const
virtual	~mb_port ()
virtual void	send (pmt_t signal, pmt_t data=PMT_F, pmt_t metadata=PMT_F, mb_pri_t priority=MB_PRI_DEFAULT)=0
	send a message
virtual void	invalidate_cache ()=0
Protected Member Functions
	mb_port (mb_mblock *mblock, const std::string &port_name, const std::string &protocol_class_name, bool conjugated, mb_port::port_type_t port_type)
mb_mblock *	mblock () const
Protected Attributes
mb_mblock *	d_mblock

---

Detailed Description

Abstract port characteristics.

---

Member Enumeration Documentation

enum mb_port::port_type_t

port classification

Enumerator:

EXTERNAL
RELAY
INTERNAL

---

Constructor & Destructor Documentation

mb_port::mb_port	(	mb_mblock *	mblock,
		const std::string &	port_name,
		const std::string &	protocol_class_name,
		bool	conjugated,
		mb_port::port_type_t	port_type
	)			[protected]

virtual mb_port::~mb_port

(

)

[virtual]

---

Member Function Documentation

bool mb_port::conjugated

(

)

const [inline]

pmt_t mb_port::incoming_message_set

(

)

const

virtual void mb_port::invalidate_cache

(

)

[pure virtual]

Implemented in mb_port_simple.

mb_mblock* mb_port::mblock

(

)

const [inline, protected]

References d_mblock.

pmt_t mb_port::outgoing_message_set

(

)

const

std::string mb_port::port_name

(

)

const [inline]

pmt_t mb_port::port_symbol

(

)

const [inline]

port_type_t mb_port::port_type

(

)

const [inline]

pmt_t mb_port::protocol_class

(

)

const [inline]

virtual void mb_port::send	(	pmt_t	signal,
		pmt_t	data = PMT_F,
		pmt_t	metadata = PMT_F,
		mb_pri_t	priority = MB_PRI_DEFAULT
	)			[pure virtual]

send a message

Parameters:

	signal	the event name
	data	optional data
	metadata	optional metadata
	priority	the urgency at which the message is sent

Implemented in mb_port_simple.

---

Member Data Documentation

mb_mblock* mb_port::d_mblock [protected]

Referenced by mblock().

---

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

• port.h