Open Lighting Architecture: include/ola/messaging/DescriptorVisitor.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
DescriptorVisitor.h
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * DescriptorVisitor.h
17 * The interface for the class which visits Descriptors & FieldDescriptors.
18 * Copyright (C) 2011 Simon Newton
19 */
20
21#ifndef INCLUDE_OLA_MESSAGING_DESCRIPTORVISITOR_H_
22#define INCLUDE_OLA_MESSAGING_DESCRIPTORVISITOR_H_
23
24#include <stdint.h>
25
26namespace ola {
27namespace messaging {
28
29
30class BoolFieldDescriptor;
31class FieldDescriptorGroup;
32class IPV4FieldDescriptor;
33class MACFieldDescriptor;
34class StringFieldDescriptor;
35class UIDFieldDescriptor;
36
37template <typename type>
38class IntegerFieldDescriptor;
39
43 class FieldDescriptorVisitor {
44 public:
45 virtual ~FieldDescriptorVisitor() {}
46
47 // return true if you want groups to be recursively expanded
48 virtual bool Descend() const = 0;
49
50 virtual void Visit(const BoolFieldDescriptor*) = 0;
51 virtual void Visit(const IPV4FieldDescriptor*) = 0;
52 virtual void Visit(const MACFieldDescriptor*) = 0;
53 virtual void Visit(const UIDFieldDescriptor*) = 0;
54 virtual void Visit(const StringFieldDescriptor*) = 0;
55 virtual void Visit(const IntegerFieldDescriptor<uint8_t>*) = 0;
56 virtual void Visit(const IntegerFieldDescriptor<uint16_t>*) = 0;
57 virtual void Visit(const IntegerFieldDescriptor<uint32_t>*) = 0;
58 virtual void Visit(const IntegerFieldDescriptor<int8_t>*) = 0;
59 virtual void Visit(const IntegerFieldDescriptor<int16_t>*) = 0;
60 virtual void Visit(const IntegerFieldDescriptor<int32_t>*) = 0;
61 virtual void Visit(const FieldDescriptorGroup*) = 0;
62 virtual void PostVisit(const FieldDescriptorGroup*) = 0;
63};
64} // namespace messaging
65} // namespace ola
66#endif // INCLUDE_OLA_MESSAGING_DESCRIPTORVISITOR_H_
ola::messaging::BoolFieldDescriptor
Definition Descriptor.h:84
ola::messaging::FieldDescriptorGroup
Definition Descriptor.h:320
ola::messaging::FieldDescriptorVisitor
Definition DescriptorVisitor.h:43
ola::messaging::IPV4FieldDescriptor
Definition Descriptor.h:103
ola::messaging::IntegerFieldDescriptor
Definition Descriptor.h:190
ola::messaging::MACFieldDescriptor
Definition Descriptor.h:122
ola::messaging::StringFieldDescriptor
Definition Descriptor.h:160
ola::messaging::UIDFieldDescriptor
Definition Descriptor.h:141
ola::messaging
A framework for serializing simple message structures.
Definition Descriptor.cpp:25
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44