RDMnet  0.3.0
Implementation of ANSI E1.33 (RDMnet)
View other versions:
rdmnet::llrp::SavedRdmCommand Class Reference

Overview

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

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

Public Member Functions

 SavedRdmCommand ()=default
 Create an empty, invalid SavedRdmCommand by default.
 
constexpr SavedRdmCommand (const LlrpSavedRdmCommand &c_cmd) noexcept
 Construct a SavedRdmCommand copied from an instance of the C LlrpSavedRdmCommand type.
 
SavedRdmCommandoperator= (const LlrpSavedRdmCommand &c_cmd) noexcept
 Assign an instance of the C LlrpSavedRdmCommand type to an instance of this class.
 
 SavedRdmCommand (const RdmCommand &command) noexcept
 Construct a SavedRdmCommand from an RdmCommand.
 
SavedRdmCommandoperator= (const RdmCommand &command) noexcept
 Assign an RdmCommand to an instance of this class.
 
constexpr etcpal::Uuid source_cid () const noexcept
 Get the CID of the LLRP manager that sent this command.
 
constexpr uint32_t seq_num () const noexcept
 Get the LLRP sequence number of this command.
 
constexpr RdmnetMcastNetintId netint_id () const noexcept
 Get the network interface ID on which this command was received. More...
 
constexpr etcpal_iptype_t netint_ip_type () const noexcept
 Get the IP protocol type of the network interface on which this command was received.
 
constexpr unsigned int netint_index () const noexcept
 Get the index of the network interface on which this command was received.
 
constexpr rdm::Uid source_uid () const noexcept
 Get the UID of the LLRP manager that sent this command.
 
constexpr rdm::Uid dest_uid () const noexcept
 Get the UID of the LLRP target 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 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 LlrpSavedRdmCommandget () noexcept
 Get a mutable reference to the underlying C type.
 
constexpr const LlrpSavedRdmCommandget () 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

◆ IsValid()

bool rdmnet::llrp::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.

◆ netint_id()

constexpr RdmnetMcastNetintId rdmnet::llrp::SavedRdmCommand::netint_id ( ) const
constexprnoexcept

Get the network interface ID on which this command was received.

This helps the LLRP library send the response on the same interface.


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