rdmnet::SavedRdmCommand Class Reference

Overview

An RDM command received over RDMnet by a local component and saved for a later response.

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

Public Member Functions
	SavedRdmCommand ()=default
	Construct an empty, invalid SavedRdmCommand by default.
constexpr	SavedRdmCommand (const RdmnetSavedRdmCommand &c_cmd) noexcept
	Construct a SavedRdmCommand copied from an instance of the C RdmnetSavedRdmCommand type.
SavedRdmCommand &	operator= (const RdmnetSavedRdmCommand &c_cmd) noexcept
	Assign an instance of the C RdmnetSavedRdmCommand type to an instance of this class.
	SavedRdmCommand (const RdmCommand &command) noexcept
	Construct a SavedRdmCommand from an RdmCommand.
SavedRdmCommand &	operator= (const RdmCommand &command) noexcept
	Assign an RdmCommand to an instance of this class.
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 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.
bool	IsValid () const noexcept
	Whether the values contained in this command are valid for an RDM command. More...
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.
ETCPAL_CONSTEXPR_14 RdmnetSavedRdmCommand &	get () noexcept
	Get a mutable reference to the underlying C type.
constexpr const RdmnetSavedRdmCommand &	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.

Member Function Documentation

IsToDefaultResponder()

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

constexprnoexcept

Whether this command is addressed to the RDMnet default responder.

See Devices and Gateways for more information.

IsValid()

bool rdmnet::SavedRdmCommand::IsValid ( ) const

inlinenoexcept

Whether the values contained in this command are valid for an RDM command.

In particular, a default-constructed SavedRdmCommand is not valid.

---

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

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