RDMFrame.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * RDMFrame.h
 * Represents the raw contents of an RDM frame.
 * Copyright (C) 2010 Simon Newton
 */

#ifndef INCLUDE_OLA_RDM_RDMFRAME_H_
#define INCLUDE_OLA_RDM_RDMFRAME_H_

#include <stdint.h>
#include <ola/io/ByteString.h>
#include <string>
#include <vector>

namespace ola {
namespace rdm {

class RDMFrame {
 public:
 struct Options {
 public:
 Options() : prepend_start_code(false) {}

 explicit Options(bool prepend_start_code)
 : prepend_start_code(prepend_start_code) {
 }

 bool prepend_start_code;
 };

 RDMFrame(const uint8_t *data, unsigned int length,
 const Options &options = Options());

 explicit RDMFrame(const ola::io::ByteString &data,
 const Options &options = Options());

 bool operator==(const RDMFrame &other) const;

 ola::io::ByteString data;

 struct {
 uint32_t response_time;

 uint32_t break_time; 
 uint32_t mark_time; 

 uint32_t data_time;
 } timing;
};

typedef std::vector<RDMFrame> RDMFrames;

} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_RDMFRAME_H_