ClMsgUwPhy Class Reference

#include <uwphy-clmsg.h>

Inheritance diagram for ClMsgUwPhy:

Collaboration diagram for ClMsgUwPhy:

Public Types
enum	ReqType {   NOT_VALID = -1 , SET_REQ , GET_REQ , SET_REPLY ,   GET_REPLY }

Public Member Functions
	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 ()

Protected Attributes
int	stack_id
ReqType	req_type

Detailed Description

ClMsgUwPhy should be extended and used to ask to set or get a parameter of a specific phy. In addition, ClMsgUwPhy can be used from the phy to reply such a request.

Member Enumeration Documentation

ReqType

enum ClMsgUwPhy::ReqType

Enumerator
NOT_VALID
SET_REQ
GET_REQ
SET_REPLY
GET_REPLY

Constructor & Destructor Documentation

ClMsgUwPhy() [1/3]

ClMsgUwPhy::ClMsgUwPhy

(

ClMessage_t

type

)

Broadcast constructor of the ClMsgUwPhy class

ClMsgUwPhy() [2/3]

ClMsgUwPhy::ClMsgUwPhy	(	int	stack_id,
		int	dest_module_id,
		ClMessage_t	type
	)

Unicast constructor of the ClMsgUwPhy class

Parameters

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

ClMsgUwPhy() [3/3]

ClMsgUwPhy::ClMsgUwPhy

(

const ClMsgUwPhy &

msg

)

Copy constructor

Parameters

const

ClMsgUwPhy& msg: ClMsgUwPhy that has to be copied

References req_type.

~ClMsgUwPhy()

ClMsgUwPhy::~ClMsgUwPhy ( )

virtual

Destructor of the ClMsgUwPhy class

Member Function Documentation

copy()

ClMsgUwPhy * ClMsgUwPhy::copy ( )

virtual

Copy method of the ClMsgUwPhy class, the specialization of the return value is intentional and it is allowed by c++ standard

Returns

pointer to a copy of the current ClMsgUwPhy object

getReqType()

ClMsgUwPhy::ReqType ClMsgUwPhy::getReqType

(

)

method to return the request type

Returns

req_type

References req_type.

Referenced by UwEvoLogicsS2CModem::recvSyncClMsg().

setReqType()

void ClMsgUwPhy::setReqType

(

ReqType

type

)

method to set the request type

Parameters

ReqType

type: request type

References req_type.

Referenced by UwEvoLogicsS2CModem::recvSyncClMsg().

Member Data Documentation

req_type

ReqType ClMsgUwPhy::req_type

protected

Referenced by ClMsgUwPhy(), getReqType(), and setReqType().

stack_id

int ClMsgUwPhy::stack_id

protected

---

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

• DESERT_Framework/DESERT/physical/uwphy_clmsgs/uwphy-clmsg.h
• DESERT_Framework/DESERT/physical/uwphy_clmsgs/uwphy-clmsg.cc