ApparatusFramework::CanMsg Class Reference
[Communication Services]

#include <CommunicationServices/current/include/CanOpen/CanConnection.h>

Inheritance diagram for ApparatusFramework::CanMsg:
ApparatusFramework::ConnectionMsg ApparatusFramework::Msg ApparatusFramework::CanNMTMsg ApparatusFramework::CanPDOMsg ApparatusFramework::CanReceiveMsg ApparatusFramework::CanSDOMsg ApparatusFramework::CanSYNCMsg

List of all members.

Public Member Functions

 CanMsg ()
bool toMsg (uint8 *pFrame)
void toFrame (uint8 *pFrame)
uint32 getFrameSize ()
Msgclone ()
virtual int toString (char *pBuffer, const int32 bufferLen) const

Public Attributes

CAN_MSG_TYPE m_canMsgType

Detailed Description

Special Message used for CanOpen. It is inherited of ConnectionMsg

Definition at line 115 of file CanConnection.h.


Constructor & Destructor Documentation

ApparatusFramework::CanMsg::CanMsg (  )  [inline]

constructors, destructors Default constructor of a CanMsg.

Definition at line 122 of file CanConnection.h.


Member Function Documentation

Msg* ApparatusFramework::CanMsg::clone (  )  [inline, virtual]

Copies an instance of Msg given as parameter and delievers it back.

Returns:
Msg* a can message.

Implements ApparatusFramework::Msg.

Reimplemented in ApparatusFramework::CanSDOMsg, ApparatusFramework::CanPDOMsg, ApparatusFramework::CanNMTMsg, ApparatusFramework::CanSYNCMsg, and ApparatusFramework::CanReceiveMsg.

Definition at line 147 of file CanConnection.h.

uint32 ApparatusFramework::CanMsg::getFrameSize (  )  [inline, virtual]

Gets the size of the internal data as byte stream.

Returns:
uint32 size of the internal data as byte stream.

Implements ApparatusFramework::ConnectionMsg.

Reimplemented in ApparatusFramework::CanSDOMsg, ApparatusFramework::CanPDOMsg, ApparatusFramework::CanNMTMsg, ApparatusFramework::CanSYNCMsg, and ApparatusFramework::CanReceiveMsg.

Definition at line 142 of file CanConnection.h.

void ApparatusFramework::CanMsg::toFrame ( uint8 pFrame  )  [inline, virtual]

Converts the internal representation of the data into a byte stream.

Parameters:
pFrame a byte stream representing the internal data ready for transmission.

Implements ApparatusFramework::ConnectionMsg.

Reimplemented in ApparatusFramework::CanSDOMsg, ApparatusFramework::CanPDOMsg, ApparatusFramework::CanNMTMsg, ApparatusFramework::CanSYNCMsg, and ApparatusFramework::CanReceiveMsg.

Definition at line 137 of file CanConnection.h.

bool ApparatusFramework::CanMsg::toMsg ( uint8 pFrame  )  [inline, virtual]

conversion methods Converts a frame into the internal data representation.

Parameters:
pFrame a byte stream containing the frame to be filled into the message structure.
Returns:
bool true if the buffer has been successfully converted to a message.

Implements ApparatusFramework::ConnectionMsg.

Reimplemented in ApparatusFramework::CanSDOMsg, ApparatusFramework::CanPDOMsg, ApparatusFramework::CanNMTMsg, ApparatusFramework::CanSYNCMsg, and ApparatusFramework::CanReceiveMsg.

Definition at line 132 of file CanConnection.h.

virtual int ApparatusFramework::CanMsg::toString ( char *  pBuffer,
const int32  bufferLen 
) const [inline, virtual]

Dumps the content of this message into a string for debug reasons.

Parameters:
pBuffer Buffer for the string representation.
bufferLen Size of the buffer.
Returns:
Number of characters that (would) have been printed to pBuffer or -1 on failure.

Reimplemented from ApparatusFramework::Msg.

Reimplemented in ApparatusFramework::CanSDOMsg, ApparatusFramework::CanPDOMsg, ApparatusFramework::CanNMTMsg, ApparatusFramework::CanSYNCMsg, and ApparatusFramework::CanReceiveMsg.

Definition at line 155 of file CanConnection.h.


Member Data Documentation

fields Type of the message

Definition at line 165 of file CanConnection.h.

© 2004-2010 bbv Software Services AG / Apparatus Services