rdmnet::RdmCommand Class Reference

Overview

An RDM command received over RDMnet and delivered to an RDMnet callback function.

Not valid for use other than as a parameter to an RDMnet callback function; use RdmCommand::Save() to create a copyable version.

#include <rdmnet/cpp/message_types/rdm_command.h>

Public Member Functions
	RdmCommand ()=delete
	Not default-constructible.
	RdmCommand (const RdmCommand &other)=delete
	Not copyable - use Save() to create a copyable version.
RdmCommand &	operator= (const RdmCommand &other)=delete
	Not copyable - use Save() to create a copyable version.
constexpr	RdmCommand (const RdmnetRdmCommand &c_cmd) noexcept
	Construct an RdmCommand which references an instance of the C RdmnetRdmCommand type.
constexpr rdm::Uid	rdmnet_source_uid () const noexcept
	Get the UID of the RDMnet controller that sent this command.
constexpr uint16_t	dest_endpoint () const noexcept
	Get the endpoint to which this command is addressed.
constexpr uint32_t	seq_num () const noexcept
	Get the RDMnet sequence number of this command.
constexpr rdm::Uid	rdm_source_uid () const noexcept
	Get the UID of the RDM controller that has sent this command.
constexpr rdm::Uid	rdm_dest_uid () const noexcept
	Get the UID of the RDM responder to which this command is addressed.
constexpr uint16_t	subdevice () const noexcept
	Get the RDM subdevice to which this command is addressed (0 means the root device).
constexpr rdm_command_class_t	command_class () const noexcept
	Get the RDM command class of this command.
constexpr uint16_t	param_id () const noexcept
	Get the RDM parameter ID (PID) of this command.
constexpr rdm::CommandHeader	rdm_header () const noexcept
	Get the RDM protocol header contained within this command.
constexpr const uint8_t *	data () const noexcept
	Get a pointer to the RDM parameter data buffer contained within this command.
constexpr uint8_t	data_len () const noexcept
	Get the length of the RDM parameter data contained within this command.
constexpr bool	HasData () const noexcept
	Whether this command has any associated RDM parameter data.
constexpr bool	IsToDefaultResponder () const noexcept
	Whether this command is addressed to the RDMnet default responder. More...
constexpr bool	IsGet () const noexcept
	Whether this command is an RDM GET command.
constexpr bool	IsSet () const noexcept
	Whether this command is an RDM SET command.
constexpr const RdmnetRdmCommand &	get () const noexcept
	Get a const reference to the underlying C type.
rdm::Command	ToRdm () const
	Convert the RDM data in this command to an RDM command type.
SavedRdmCommand	Save () const
	Save the data in this command for later use with API functions from a different context. More...

Member Function Documentation

IsToDefaultResponder()

constexpr bool rdmnet::RdmCommand::IsToDefaultResponder ( ) const

constexprnoexcept

Whether this command is addressed to the RDMnet default responder.

See Devices and Gateways for more information.

Save()

SavedRdmCommand rdmnet::RdmCommand::Save ( ) const

inline

Save the data in this command for later use with API functions from a different context.

Returns

A SavedRdmCommand containing the copied data.

---

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

• include/rdmnet/cpp/message_types/rdm_command.h