cpp_introspection: cpp_introspection: field.h Source File

00001 //=================================================================================================
00002 // Copyright (c) 2011, Johannes Meyer, TU Darmstadt
00003 // All rights reserved.
00004 
00005 // Redistribution and use in source and binary forms, with or without
00006 // modification, are permitted provided that the following conditions are met:
00007 //     * Redistributions of source code must retain the above copyright
00008 //       notice, this list of conditions and the following disclaimer.
00009 //     * Redistributions in binary form must reproduce the above copyright
00010 //       notice, this list of conditions and the following disclaimer in the
00011 //       documentation and/or other materials provided with the distribution.
00012 //     * Neither the name of the Flight Systems and Automatic Control group,
00013 //       TU Darmstadt, nor the names of its contributors may be used to
00014 //       endorse or promote products derived from this software without
00015 //       specific prior written permission.
00016 
00017 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00018 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00019 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00020 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
00021 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00022 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00023 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00024 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00026 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027 //=================================================================================================
00028 
00029 #ifndef CPP_INTROSPECTION_FIELD_H
00030 #define CPP_INTROSPECTION_FIELD_H
00031 
00032 #include <introspection/forwards.h>
00033 #include <introspection/type.h>
00034 
00035 namespace cpp_introspection {
00036 
00037   class Field
00038   {
00039   public:
00040     virtual ~Field() { }
00041 
00042     virtual const Message& message() const = 0;
00043 
00044     virtual const char* getName() const = 0;
00045     virtual const char* getDataType() const = 0;
00046     virtual const char* getValueType() const = 0;
00047     virtual std::size_t getIndex() const = 0;
00048     virtual const std::type_info& getTypeId() const = 0;
00049     virtual TypePtr getType() const { return type(getValueType()); }
00050 
00051     virtual bool isArray() const = 0;
00052     virtual bool isVector() const = 0;
00053     virtual bool isContainer() const = 0;
00054     virtual bool isSimple() const = 0;
00055     virtual bool isFixedSize() const = 0;
00056     virtual bool isMessage() const = 0;
00057 
00058     virtual bool hasInstance() const { return false; }
00059     virtual boost::any get(std::size_t i = 0) const { return boost::any(); }
00060     template <typename T> T as(std::size_t i = 0) const { return getType()->as<T>(get(i)); }
00061 
00062     virtual void setAny(const boost::any& value, std::size_t i = 0) const { }
00063     template <typename T> void set(const T& value, std::size_t i = 0) const { setAny(getType()->from(value), i); }
00064 
00065     virtual std::size_t size() const { return 1; }
00066     virtual void resize(size_t new_size) const {}
00067     virtual bool empty() const { return false; }
00068     virtual std::size_t capacity() const { return 1; }
00069 
00070     virtual MessagePtr expand(std::size_t i = 0) const;
00071     virtual FieldPtr access(AccessorBase& accessor) const = 0;
00072   };
00073 
00074 } // namespace cpp_introspection
00075 
00076 #endif // CPP_INTROSPECTION_FIELD_H