add examples for flex_data_message

Author: Franz Detro

docs/flex_data_message.examples.cpp

@@ -1,3 +1,95 @@
 #include <midi/flex_data_message.h>
 
-void run_flex_data_message_examples() { /* TODO */ }
+void flex_data_message_examples()
+{
+    using namespace midi;
+
+    auto a = make_flex_data_message(0, packet_format::complete, packet_address::channel, 5, 0x20, 0x01, 0x123456);
+    assert(is_flex_data_message(a));
+
+    if (auto m = as_flex_data_message_view(a))
+    {
+        // inspect message fields
+        assert(m->group() == 0);
+        assert(m->format() == packet_format::complete);
+        assert(m->address() == packet_address::channel);
+        assert(m->channel() == 5);
+        assert(m->status_bank() == 0x20);
+        assert(m->status() == 0x01);
+        assert(m->data1() == 0x123456);
+        assert(m->data2() == 0);
+        assert(m->data3() == 0);
+    }
+
+    auto t =
+      make_flex_data_text_message(0, packet_format::complete, packet_address::channel, 5, 0x20, 0x01, "Hello World!");
+    if (auto m = as_flex_data_message_view(t))
+    {
+        assert(m->payload_as_string() == "Hello World!");
+    }
+
+    auto tmpo = make_set_tempo_message(0, 5000000);
+    if (auto m = as_flex_data_message_view(tmpo))
+    {
+        assert(m->status_bank() == 0x00);
+        assert(m->status() == 0x00);
+        assert(m->data1() == 5000000);
+    }
+
+    constexpr uint8_t numerator     = 4;
+    constexpr uint8_t denominator   = 2; // 4 (2^2) denominator
+    constexpr uint8_t nr_32rd_notes = 8; // 4/4 time signature
+
+    auto tsig = make_set_time_signature_message(0, numerator, denominator, nr_32rd_notes);
+    if (auto m = as_flex_data_message_view(tsig))
+    {
+        assert(m->status_bank() == 0x00);
+        assert(m->status() == 0x01);
+        assert(m->data_byte1() == numerator);
+        assert(m->data_byte2() == denominator);
+        assert(m->data_byte3() == nr_32rd_notes);
+    }
+
+    constexpr uint8_t num_clocks_per_primary_click = 24;
+    constexpr uint8_t bar_accent_part1             = 3;
+    constexpr uint8_t bar_accent_part2             = 2;
+    constexpr uint8_t bar_accent_part3             = 0;
+    constexpr uint8_t num_subdivision_clicks1      = 2;
+    constexpr uint8_t num_subdivision_clicks2      = 0;
+
+    auto metro = make_set_metronome_message(0,
+                                            num_clocks_per_primary_click,
+                                            bar_accent_part1,
+                                            bar_accent_part2,
+                                            bar_accent_part3,
+                                            num_subdivision_clicks1,
+                                            num_subdivision_clicks2);
+    if (auto m = as_flex_data_message_view(metro))
+    {
+        assert(m->status_bank() == 0x00);
+        assert(m->status() == 0x02);
+        assert(m->data_byte1() == num_clocks_per_primary_click);
+        assert(m->data_byte2() == bar_accent_part1);
+        assert(m->data_byte3() == bar_accent_part2);
+        assert(m->data_byte4() == bar_accent_part3);
+        assert(m->data_byte5() == num_subdivision_clicks1);
+        assert(m->data_byte6() == num_subdivision_clicks2);
+    }
+
+    constexpr uint4_t sharps_or_flats = 5;   // 5 sharps
+    constexpr uint4_t tonic_note      = 0x4; // tonic D
+
+    auto ksig = make_set_key_signature_message(0, packet_address::channel, 5, sharps_or_flats, tonic_note); // D major
+    if (auto m = as_flex_data_message_view(ksig))
+    {
+        assert(m->status_bank() == 0x00);
+        assert(m->status() == 0x05);
+        assert((m->data_byte1() >> 4) == sharps_or_flats);
+        assert((m->data_byte1() & 0x0F) == tonic_note);
+    }
+}
+
+void run_flex_data_message_examples()
+{
+    flex_data_message_examples();
+}

docs/flex_data_message.md

@@ -2,12 +2,14 @@
 
 _WORK IN PROGRESS_
 
+Code examples can be found in [`flex_data_message.examples.cpp`](flex_data_message.examples.cpp).
+
 ## Base Type
 
     struct flex_data_message : universal_packet
     {
         flex_data_message(
-        group_t, packet_format, packet_address, uint4_t, status_t, status_t, uint32_t = 0, uint32_t = 0, uint32_t = 0);
+            group_t, packet_format, packet_address, uint4_t, status_t, status_t, uint32_t = 0, uint32_t = 0, uint32_t = 0);
 
         packet_format  format() const;
         packet_address address() const;
@@ -53,9 +55,9 @@ _WORK IN PROGRESS_
                                                 uint8_t num_subdivision_clicks1,
                                                 uint8_t num_subdivision_clicks2);
     flex_data_message make_set_key_signature_message(
-    group_t, packet_address, uint4_t channel, uint4_t sharps_or_flats, uint4_t tonic_note);
+        group_t, packet_address, uint4_t channel, uint4_t sharps_or_flats, uint4_t tonic_note);
     flex_data_message make_set_chord_message(
-    group_t, packet_address, uint4_t channel, uint32_t data1, uint32_t data2, uint32_t data3);
+        group_t, packet_address, uint4_t channel, uint32_t data1, uint32_t data2, uint32_t data3);
 
 
 ### Flex Data Message Data View:
@@ -73,6 +75,16 @@ _WORK IN PROGRESS_
         uint32_t       data1() const;
         uint32_t       data2() const;
         uint32_t       data3() const;
+        uint8_t        data_byte1() const;
+        uint8_t        data_byte2() const;
+        uint8_t        data_byte2() const;
+        uint8_t        data_byte3() const;
+        uint8_t        data_byte2() const;
+        uint8_t        data_byte4() const;
+        uint8_t        data_byte5() const;
+        uint8_t        data_byte6() const;
+        uint8_t        data_byte7() const;
+        uint8_t        data_byte8() const;
 
         const std::string payload_as_string() const;
     };