rdm_command.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************
 * This file is a part of RDMnet. For more information, go to:
 * https://github.com/ETCLabs/RDMnet
 *****************************************************************************/
 
 
#ifndef RDMNET_CPP_MESSAGE_TYPES_RDM_COMMAND_H_
#define RDMNET_CPP_MESSAGE_TYPES_RDM_COMMAND_H_
 
#include <cstdint>
#include "etcpal/common.h"
#include "rdm/cpp/message.h"
#include "rdm/cpp/uid.h"
#include "rdmnet/defs.h"
#include "rdmnet/message.h"
 
namespace rdmnet
{
class SavedRdmCommand;
 
class RdmCommand
{
public:
  RdmCommand() = delete;
  RdmCommand(const RdmCommand& other) = delete;
  RdmCommand& operator=(const RdmCommand& other) = delete;
 
  constexpr RdmCommand(const RdmnetRdmCommand& c_cmd) noexcept;
 
  constexpr rdm::Uid rdmnet_source_uid() const noexcept;
  constexpr uint16_t dest_endpoint() const noexcept;
  constexpr uint32_t seq_num() const noexcept;
 
  constexpr rdm::Uid            rdm_source_uid() const noexcept;
  constexpr rdm::Uid            rdm_dest_uid() const noexcept;
  constexpr uint16_t            subdevice() const noexcept;
  constexpr rdm_command_class_t command_class() const noexcept;
  constexpr uint16_t            param_id() const noexcept;
 
  constexpr rdm::CommandHeader rdm_header() const noexcept;
 
  constexpr const uint8_t* data() const noexcept;
  constexpr uint8_t        data_len() const noexcept;
 
  constexpr bool HasData() const noexcept;
  constexpr bool IsToDefaultResponder() const noexcept;
 
  constexpr bool IsGet() const noexcept;
  constexpr bool IsSet() const noexcept;
 
  constexpr const RdmnetRdmCommand& get() const noexcept;
 
  rdm::Command    ToRdm() const;
  SavedRdmCommand Save() const;
 
private:
  const RdmnetRdmCommand& cmd_;
};
 
class SavedRdmCommand
{
public:
  SavedRdmCommand() = default;
  constexpr SavedRdmCommand(const RdmnetSavedRdmCommand& c_cmd) noexcept;
  SavedRdmCommand& operator=(const RdmnetSavedRdmCommand& c_cmd) noexcept;
  SavedRdmCommand(const RdmCommand& command) noexcept;
  SavedRdmCommand& operator=(const RdmCommand& command) noexcept;
 
  constexpr rdm::Uid rdmnet_source_uid() const noexcept;
  constexpr uint16_t dest_endpoint() const noexcept;
  constexpr uint32_t seq_num() const noexcept;
 
  constexpr rdm::Uid            rdm_source_uid() const noexcept;
  constexpr rdm::Uid            rdm_dest_uid() const noexcept;
  constexpr uint16_t            subdevice() const noexcept;
  constexpr rdm_command_class_t command_class() const noexcept;
  constexpr uint16_t            param_id() const noexcept;
 
  constexpr rdm::CommandHeader rdm_header() const noexcept;
 
  constexpr const uint8_t* data() const noexcept;
  constexpr uint8_t        data_len() const noexcept;
 
  bool           IsValid() const noexcept;
  constexpr bool HasData() const noexcept;
  constexpr bool IsToDefaultResponder() const noexcept;
 
  constexpr bool IsGet() const noexcept;
  constexpr bool IsSet() const noexcept;
 
  ETCPAL_CONSTEXPR_14 RdmnetSavedRdmCommand& get() noexcept;
  constexpr const RdmnetSavedRdmCommand&     get() const noexcept;
 
  rdm::Command ToRdm() const;
 
private:
  RdmnetSavedRdmCommand cmd_{};
};
 
// RdmCommand function definitions
 
constexpr RdmCommand::RdmCommand(const RdmnetRdmCommand& c_cmd) noexcept : cmd_(c_cmd)
{
}
 
constexpr rdm::Uid RdmCommand::rdmnet_source_uid() const noexcept
{
  return cmd_.rdmnet_source_uid;
}
 
constexpr uint16_t RdmCommand::dest_endpoint() const noexcept
{
  return cmd_.dest_endpoint;
}
 
constexpr uint32_t RdmCommand::seq_num() const noexcept
{
  return cmd_.seq_num;
}
 
constexpr rdm::Uid RdmCommand::rdm_source_uid() const noexcept
{
  return cmd_.rdm_header.source_uid;
}
 
constexpr rdm::Uid RdmCommand::rdm_dest_uid() const noexcept
{
  return cmd_.rdm_header.dest_uid;
}
 
constexpr uint16_t RdmCommand::subdevice() const noexcept
{
  return cmd_.rdm_header.subdevice;
}
 
constexpr rdm_command_class_t RdmCommand::command_class() const noexcept
{
  return cmd_.rdm_header.command_class;
}
 
constexpr uint16_t RdmCommand::param_id() const noexcept
{
  return cmd_.rdm_header.param_id;
}
 
constexpr rdm::CommandHeader RdmCommand::rdm_header() const noexcept
{
  return cmd_.rdm_header;
}
 
constexpr const uint8_t* RdmCommand::data() const noexcept
{
  return cmd_.data;
}
 
constexpr uint8_t RdmCommand::data_len() const noexcept
{
  return cmd_.data_len;
}
 
constexpr bool RdmCommand::HasData() const noexcept
{
  return (data_len() != 0);
}
 
constexpr bool RdmCommand::IsGet() const noexcept
{
  return (cmd_.rdm_header.command_class == kRdmCCGetCommand);
}
 
constexpr bool RdmCommand::IsSet() const noexcept
{
  return (cmd_.rdm_header.command_class == kRdmCCSetCommand);
}
 
constexpr bool RdmCommand::IsToDefaultResponder() const noexcept
{
  return (cmd_.dest_endpoint == E133_NULL_ENDPOINT);
}
 
constexpr const RdmnetRdmCommand& RdmCommand::get() const noexcept
{
  return cmd_;
}
 
inline rdm::Command RdmCommand::ToRdm() const
{
  return rdm::Command(cmd_.rdm_header, cmd_.data, cmd_.data_len);
}
 
inline SavedRdmCommand RdmCommand::Save() const
{
  return SavedRdmCommand(*this);
}
 
// SavedRdmCommand function definitions
 
constexpr SavedRdmCommand::SavedRdmCommand(const RdmnetSavedRdmCommand& c_cmd) noexcept : cmd_(c_cmd)
{
}
 
inline SavedRdmCommand& SavedRdmCommand::operator=(const RdmnetSavedRdmCommand& c_cmd) noexcept
{
  cmd_ = c_cmd;
  return *this;
}
 
inline SavedRdmCommand::SavedRdmCommand(const RdmCommand& command) noexcept
{
  rdmnet_save_rdm_command(&command.get(), &cmd_);
}
 
inline SavedRdmCommand& SavedRdmCommand::operator=(const RdmCommand& command) noexcept
{
  rdmnet_save_rdm_command(&command.get(), &cmd_);
  return *this;
}
 
constexpr rdm::Uid SavedRdmCommand::rdmnet_source_uid() const noexcept
{
  return cmd_.rdmnet_source_uid;
}
 
constexpr uint16_t SavedRdmCommand::dest_endpoint() const noexcept
{
  return cmd_.dest_endpoint;
}
 
constexpr uint32_t SavedRdmCommand::seq_num() const noexcept
{
  return cmd_.seq_num;
}
 
constexpr rdm::Uid SavedRdmCommand::rdm_source_uid() const noexcept
{
  return cmd_.rdm_header.source_uid;
}
 
constexpr rdm::Uid SavedRdmCommand::rdm_dest_uid() const noexcept
{
  return cmd_.rdm_header.dest_uid;
}
 
constexpr uint16_t SavedRdmCommand::subdevice() const noexcept
{
  return cmd_.rdm_header.subdevice;
}
 
constexpr rdm_command_class_t SavedRdmCommand::command_class() const noexcept
{
  return cmd_.rdm_header.command_class;
}
 
constexpr uint16_t SavedRdmCommand::param_id() const noexcept
{
  return cmd_.rdm_header.param_id;
}
 
constexpr rdm::CommandHeader SavedRdmCommand::rdm_header() const noexcept
{
  return cmd_.rdm_header;
}
 
constexpr const uint8_t* SavedRdmCommand::data() const noexcept
{
  return cmd_.data;
}
 
constexpr uint8_t SavedRdmCommand::data_len() const noexcept
{
  return cmd_.data_len;
}
 
inline bool SavedRdmCommand::IsValid() const noexcept
{
  return rdm_command_header_is_valid(&cmd_.rdm_header);
}
 
constexpr bool SavedRdmCommand::HasData() const noexcept
{
  return (data_len() != 0);
}
 
constexpr bool SavedRdmCommand::IsToDefaultResponder() const noexcept
{
  return (cmd_.dest_endpoint == E133_NULL_ENDPOINT);
}
 
constexpr bool SavedRdmCommand::IsGet() const noexcept
{
  return (cmd_.rdm_header.command_class == kRdmCCGetCommand);
}
 
constexpr bool SavedRdmCommand::IsSet() const noexcept
{
  return (cmd_.rdm_header.command_class == kRdmCCSetCommand);
}
 
ETCPAL_CONSTEXPR_14_OR_INLINE RdmnetSavedRdmCommand& SavedRdmCommand::get() noexcept
{
  return cmd_;
}
 
constexpr const RdmnetSavedRdmCommand& SavedRdmCommand::get() const noexcept
{
  return cmd_;
}
 
inline rdm::Command SavedRdmCommand::ToRdm() const
{
  return rdm::Command(cmd_.rdm_header, cmd_.data, cmd_.data_len);
}
};  // namespace rdmnet
 
#endif  // RDMNET_CPP_MESSAGE_TYPES_RDM_COMMAND_H_