Record.h

00001 /*
00002  * Record.h
00003  *
00004  * Created on: Nov 1, 2013
00005  * * Authors: Vincent Wochnik <v.wochnik@gmail.com>
00006  *
00007  * Copyright (c) 2013 Cumulocity GmbH
00008  *
00009  * Permission is hereby granted, free of charge, to any person obtaining
00010  * a copy of this software and associated documentation files (the
00011  * "Software"), to deal in the Software without restriction, including
00012  * without limitation the rights to use, copy, modify, merge, publish,
00013  * distribute, sublicense, and/or sell copies of the Software, and to
00014  * permit persons to whom the Software is furnished to do so, subject to
00015  * the following conditions:
00016  *
00017  * The above copyright notice and this permission notice shall be
00018  * included in all copies or substantial portions of the Software.
00019  *
00020  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00023  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
00024  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
00025  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00026  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00027  */
00028 
00029 #ifndef RECORD_H
00030 #define RECORD_H
00031 
00032 #include "config.h"
00033 #include "DataGenerator.h"
00034 #include "Value.h"
00035 
00036 /**
00037  * A record which can be read and serialized. 
00038  */
00039 class Record : public DataGenerator
00040 {
00041     public:
00042         virtual ~Record() { };
00043 
00044         /**
00045          * Returns the number of values in this record.
00046          * @return number of values in this record
00047          */
00048         virtual size_t values() const = 0;
00049 
00050         /**
00051          * Returns the value object by index
00052          * @param index the index of the value
00053          * @return a copy of a value object
00054          */
00055         virtual const Value& value(size_t) const = 0;
00056 
00057         size_t writeTo(AbstractDataSink&) const;
00058         size_t writtenLength() const;
00059 
00060         virtual Record* copy() const = 0;
00061 
00062         /**
00063          * Test if record contains any values.
00064          */
00065         operator bool() const;
00066 };
00067 
00068 #endif