/usr/include/ola/rdm/RDMFrame.h is in libola-dev 0.10.5.nojsmin-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | /*
* 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 {
/**
* @brief The raw data for a RDM message and its associated timing information.
*
* A RDMFrame holds the raw data and timing metadata for a RDM message. If no
* timing data was available, the timing values will be 0.
*
* RDMFrames include the RDM Start Code (0xCC).
*/
class RDMFrame {
public:
struct Options {
public:
Options() : prepend_start_code(false) {}
explicit Options(bool _prepend_start_code)
: prepend_start_code(_prepend_start_code) {
}
/**
* @brief True if the source data does not include a start code.
*/
bool prepend_start_code;
};
/**
* @brief Create an RDMFrame from a uint8_t pointer.
* @param data A pointer to the frame data, the contents are copied.
* @param length The size of the frame data.
* @param options Options used when creating the RDMFrame.
*/
RDMFrame(const uint8_t *data, unsigned int length,
const Options &options = Options());
/**
* @brief Create a RDMFrame using a ByteString.
* string.
* @param data The ByteString with the RDM frame data.
* @param options Options used when creating the RDMFrame.
*/
explicit RDMFrame(const ola::io::ByteString &data,
const Options &options = Options());
/**
* @brief Test for equality.
* @param other The RDMFrame to test against.
* @returns True if two RDMFrames are equal, including any timing
* information.
*/
bool operator==(const RDMFrame &other) const;
/**
* @brief The raw RDM data, including the RDM start code.
*/
ola::io::ByteString data;
/**
* @brief The timing measurements for an RDM Frame.
*
* All times are measured in nanoseconds.
*
* For DUB responses, the break and mark values will be 0.
*/
struct {
/**
* @brief The time between the end of the last byte of the request to the
* start of the response.
*/
uint32_t response_time;
uint32_t break_time; //!< The duration of the break.
uint32_t mark_time; //!< The duration of the mark-after-break.
/**
* @brief The time between the first and last byte of the data.
*/
uint32_t data_time;
} timing;
};
/**
* @brief A vector of RDMFrames.
*/
typedef std::vector<RDMFrame> RDMFrames;
} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_RDMFRAME_H_
|