mira::can::CANOpenUtil Namespace Reference

A collection for some utility functions for the CANopen standard. More...

Functions
MLAB_CAN_EXPORT std::string	getErrorMsg (CANOpenError pError)
	Get a textual description of a CANopen error. More...
MLAB_CAN_EXPORT std::string	getTypeString (CANOpenType pType)
	Get a textual description of a CANopen type. More...
MLAB_CAN_EXPORT std::string	getAccessModeString (CANOpenAccessMode pMode)
	Get a textual description of a CANopen access mode. More...
MLAB_CAN_EXPORT std::string	getSDOKindString (CANOpenSDOKind pKind)
	Get a textual description of a CANopen SDO kind. More...
MLAB_CAN_EXPORT std::string	getNodeStatusString (CANOpenNodeStatus pStatus)
	Get a textual description of a CANopen node status. More...
template<typename T >
T	read (const CANMessage &message, std::size_t offset)
	A template based read operation of CANopen data types. More...
template<>
MLAB_CAN_EXPORT int8	read< int8 > (const CANMessage &message, std::size_t offset)
	CANopen read for int8. More...
template<>
MLAB_CAN_EXPORT int16	read< int16 > (const CANMessage &message, std::size_t offset)
	CANopen read for int16. More...
template<>
MLAB_CAN_EXPORT int32	read< int32 > (const CANMessage &message, std::size_t offset)
	CANopen read for int32. More...
template<>
MLAB_CAN_EXPORT int64	read< int64 > (const CANMessage &message, std::size_t offset)
	CANopen read for int64. More...
template<>
MLAB_CAN_EXPORT uint8	read< uint8 > (const CANMessage &message, std::size_t offset)
	CANopen read for uint8. More...
template<>
MLAB_CAN_EXPORT uint16	read< uint16 > (const CANMessage &message, std::size_t offset)
	CANopen read for uint16. More...
template<>
MLAB_CAN_EXPORT uint32	read< uint32 > (const CANMessage &message, std::size_t offset)
	CANopen read for uint32. More...
template<>
MLAB_CAN_EXPORT uint64	read< uint64 > (const CANMessage &message, std::size_t offset)
	CANopen read for uint64. More...
template<>
MLAB_CAN_EXPORT float	read< float > (const CANMessage &message, std::size_t offsete)
	CANopen read for float. More...
template<>
MLAB_CAN_EXPORT double	read< double > (const CANMessage &message, std::size_t offset)
	CANopen read for double. More...
template<typename T >
std::size_t	write (CANMessage &ioMmessage, std::size_t offset, T value)
	A template based write operation of CANopen data types. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< int8 > (CANMessage &ioMmessage, std::size_t offset, int8 value)
	CANopen write for int8. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< int16 > (CANMessage &ioMmessage, std::size_t offset, int16 value)
	CANopen write for int16. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< int32 > (CANMessage &ioMmessage, std::size_t offset, int32 value)
	CANopen write for int32. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< int64 > (CANMessage &ioMmessage, std::size_t offset, int64 value)
	CANopen write for int64. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< uint8 > (CANMessage &ioMmessage, std::size_t offset, uint8 value)
	CANopen write for uint8. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< uint16 > (CANMessage &ioMmessage, std::size_t offset, uint16 value)
	CANopen write for uint16. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< uint32 > (CANMessage &ioMmessage, std::size_t offset, uint32 value)
	CANopen write for uint32. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< uint64 > (CANMessage &ioMmessage, std::size_t offset, uint64 value)
	CANopen write for uint64. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< float > (CANMessage &ioMmessage, std::size_t offset, float value)
	CANopen write for float. More...
template<>
MLAB_CAN_EXPORT std::size_t	write< double > (CANMessage &ioMmessage, std::size_t offset, double value)
	CANopen write for double. More...

Detailed Description

A collection for some utility functions for the CANopen standard.

Function Documentation

getErrorMsg()

MLAB_CAN_EXPORT std::string mira::can::CANOpenUtil::getErrorMsg

(

CANOpenError

pError

)

Get a textual description of a CANopen error.

getTypeString()

MLAB_CAN_EXPORT std::string mira::can::CANOpenUtil::getTypeString

(

CANOpenType

pType

)

Get a textual description of a CANopen type.

getAccessModeString()

MLAB_CAN_EXPORT std::string mira::can::CANOpenUtil::getAccessModeString

(

CANOpenAccessMode

pMode

)

Get a textual description of a CANopen access mode.

getSDOKindString()

MLAB_CAN_EXPORT std::string mira::can::CANOpenUtil::getSDOKindString

(

CANOpenSDOKind

pKind

)

Get a textual description of a CANopen SDO kind.

getNodeStatusString()

MLAB_CAN_EXPORT std::string mira::can::CANOpenUtil::getNodeStatusString

(

CANOpenNodeStatus

pStatus

)

Get a textual description of a CANopen node status.

read()

T mira::can::CANOpenUtil::read	(	const CANMessage &	message,
		std::size_t	offset
	)

A template based read operation of CANopen data types.

read< int8 >()

MLAB_CAN_EXPORT int8 mira::can::CANOpenUtil::read< int8 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for int8.

read< int16 >()

MLAB_CAN_EXPORT int16 mira::can::CANOpenUtil::read< int16 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for int16.

read< int32 >()

MLAB_CAN_EXPORT int32 mira::can::CANOpenUtil::read< int32 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for int32.

read< int64 >()

MLAB_CAN_EXPORT int64 mira::can::CANOpenUtil::read< int64 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for int64.

read< uint8 >()

MLAB_CAN_EXPORT uint8 mira::can::CANOpenUtil::read< uint8 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for uint8.

read< uint16 >()

MLAB_CAN_EXPORT uint16 mira::can::CANOpenUtil::read< uint16 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for uint16.

read< uint32 >()

MLAB_CAN_EXPORT uint32 mira::can::CANOpenUtil::read< uint32 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for uint32.

read< uint64 >()

MLAB_CAN_EXPORT uint64 mira::can::CANOpenUtil::read< uint64 >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for uint64.

read< float >()

MLAB_CAN_EXPORT float mira::can::CANOpenUtil::read< float >	(	const CANMessage &	message,
		std::size_t	offsete
	)

CANopen read for float.

read< double >()

MLAB_CAN_EXPORT double mira::can::CANOpenUtil::read< double >	(	const CANMessage &	message,
		std::size_t	offset
	)

CANopen read for double.

write()

std::size_t mira::can::CANOpenUtil::write	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		T	value
	)

A template based write operation of CANopen data types.

write< int8 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< int8 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		int8	value
	)

CANopen write for int8.

write< int16 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< int16 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		int16	value
	)

CANopen write for int16.

write< int32 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< int32 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		int32	value
	)

CANopen write for int32.

write< int64 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< int64 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		int64	value
	)

CANopen write for int64.

write< uint8 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< uint8 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		uint8	value
	)

CANopen write for uint8.

write< uint16 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< uint16 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		uint16	value
	)

CANopen write for uint16.

write< uint32 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< uint32 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		uint32	value
	)

CANopen write for uint32.

write< uint64 >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< uint64 >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		uint64	value
	)

CANopen write for uint64.

write< float >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< float >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		float	value
	)

CANopen write for float.

write< double >()

MLAB_CAN_EXPORT std::size_t mira::can::CANOpenUtil::write< double >	(	CANMessage &	ioMmessage,
		std::size_t	offset,
		double	value
	)

CANopen write for double.