ClMsgS2CTxMode Class Reference

#include <ms2c_ClMessage.h>

Inheritance diagram for ClMsgS2CTxMode:

Collaboration diagram for ClMsgS2CTxMode:

Public Types
enum	tx_mode { S2C_TX_MODE_IM = 0 , S2C_TX_MODE_BURST , SBC_TX_MODE_PBM }
typedef enum ClMsgS2CTxMode::tx_mode	tx_mode_t
Public Types inherited from ClMsgUwPhy
enum	ReqType {   NOT_VALID = -1 , SET_REQ , GET_REQ , SET_REPLY ,   GET_REPLY }

Public Member Functions
	ClMsgS2CTxMode ()
	ClMsgS2CTxMode (int stack_id, int dest_module_id)
	ClMsgS2CTxMode (const ClMsgS2CTxMode &msg)
virtual	~ClMsgS2CTxMode ()
void	set_tx_mode (tx_mode_t mode)
tx_mode_t	get_tx_mode () const
Public Member Functions inherited from ClMsgUwPhy
	ClMsgUwPhy (ClMessage_t type)
	ClMsgUwPhy (int stack_id, int dest_module_id, ClMessage_t type)
	ClMsgUwPhy (const ClMsgUwPhy &msg)
virtual	~ClMsgUwPhy ()
virtual ClMsgUwPhy *	copy ()
void	setReqType (ReqType type)
ReqType	getReqType ()

Private Attributes
tx_mode_t	tx_mode

Additional Inherited Members
Protected Attributes inherited from ClMsgUwPhy
int	stack_id
ReqType	req_type

Detailed Description

Cl Message type for setting the Tx Mode: Instant Message, Burst or Piggyback.

Definition at line 100 of file ms2c_ClMessage.h.

Member Typedef Documentation

tx_mode_t

typedef enum ClMsgS2CTxMode::tx_mode ClMsgS2CTxMode::tx_mode_t

Member Enumeration Documentation

tx_mode

enum ClMsgS2CTxMode::tx_mode

Enumerator
S2C_TX_MODE_IM
S2C_TX_MODE_BURST
SBC_TX_MODE_PBM

Definition at line 104 of file ms2c_ClMessage.h.

Constructor & Destructor Documentation

ClMsgS2CTxMode() [1/3]

ClMsgS2CTxMode::ClMsgS2CTxMode

(

)

Class constructor: no parameters.

Definition at line 69 of file ms2c_ClMessage.cc.

ClMsgS2CTxMode() [2/3]

ClMsgS2CTxMode::ClMsgS2CTxMode	(	int	stack_id,
		int	dest_module_id
	)

Class constructor with parameters.

Parameters

int	stack_id: id of the stack
dest_mod_id	id of the destination module

Definition at line 74 of file ms2c_ClMessage.cc.

ClMsgS2CTxMode() [3/3]

ClMsgS2CTxMode::ClMsgS2CTxMode

(

const ClMsgS2CTxMode &

msg

)

Class copy constructor.

Definition at line 79 of file ms2c_ClMessage.cc.

~ClMsgS2CTxMode()

ClMsgS2CTxMode::~ClMsgS2CTxMode ( )

virtual

Class destructor.

Definition at line 84 of file ms2c_ClMessage.cc.

Member Function Documentation

get_tx_mode()

tx_mode_t ClMsgS2CTxMode::get_tx_mode ( ) const

inline

Method used to retrieve the TX mode value in the message.

Returns

Tx mode value in the message

Definition at line 142 of file ms2c_ClMessage.h.

set_tx_mode()

void ClMsgS2CTxMode::set_tx_mode

(

ClMsgS2CTxMode::tx_mode_t

mode

)

Method that sets the TX mode in the message to the specified value.

Parameters

mode	TX mode to set in the message

Definition at line 88 of file ms2c_ClMessage.cc.

Member Data Documentation

tx_mode

tx_mode_t ClMsgS2CTxMode::tx_mode

private

Tx mode set in the message: IM, Burst or PBM.

Definition at line 148 of file ms2c_ClMessage.h.

---

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

• ms2c_ClMessage.h
• ms2c_ClMessage.cc