jaula API Reference  version 1.4.0
jaula_value_array.h
1 
2 /*
3  * jaula_value_array.h : JSON Analysis User Library Acronym
4  * JSON array values definitions
5  *
6  * Copyright (C) 2007, 2008, 2009 Kombo Morongo <morongo666@gmail.com>
7  *
8  * This library is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or (at
11  * your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
16  * License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
21  *
22  * svn info:
23  * $Author: morongo $
24  * $HeadURL: https://jaula.svn.sourceforge.net/svnroot/jaula/tags/jaula-1.4.0/jaula/jaula_value_array.h $
25  * $Id: jaula_value_array.h 45 2009-01-11 16:17:03Z morongo $
26  * $Revision: 45 $
27  */
28 
29 #ifndef _JAULA_VALUE_ARRAY_H_
30 #define _JAULA_VALUE_ARRAY_H_
31 
32 #include <list>
33 
34 #include <jaula/jaula_value_complex.h>
35 
40 namespace JAULA
41 { // namespace JAULA
42 
53  class Value_Array : public Value_Complex
54  { // class Value_Array
55  public:
56 
66  typedef std::list<Value *> dataType;
67 
74  Value_Array(void);
75 
85  Value_Array(dataType const &data);
86 
95  virtual ~Value_Array();
96 
100  dataType const &getData(void) const;
101 
110  virtual void repr(std::ostream &ostr) const;
111 
118  virtual bool empty(void) const;
119 
125  virtual size_t size(void) const;
126 
136  void set(dataType const &data);
137 
151  virtual void set(Value const &origin) throw(Bad_Data_Type);
152 
161  void addItem(Value const &item);
162 
173  virtual void clear(void);
174 
175  private:
176 
181  }; // class Value_Array
182 
183 } // namespace JAULA
184 #endif
185 
186 // EOF $Id: jaula_value_array.h 45 2009-01-11 16:17:03Z morongo $
class for incompatible data type exceptions
Definition: jaula_bad_data_type.h:53
Class for handling array values.
Definition: jaula_value_array.h:54
dataType const & getData(void) const
Retrieves the array of values contained by the instance.
Definition: jaula_value_array.cc:61
virtual ~Value_Array()
Destructor.
Definition: jaula_value_array.cc:56
virtual void repr(std::ostream &ostr) const
Represents the instance in a stream.
Definition: jaula_value_array.cc:66
virtual size_t size(void) const
Number of elements contained.
Definition: jaula_value_array.cc:85
std::list< Value * > dataType
Data type for value contents.
Definition: jaula_value_array.h:66
virtual void clear(void)
Empties the contents of an instance.
Definition: jaula_value_array.cc:120
void set(dataType const &data)
Establishes the contents of the instance.
Definition: jaula_value_array.cc:90
dataType data_
Container to hold the value itself.
Definition: jaula_value_array.h:180
Value_Array(void)
Default Constructor.
Definition: jaula_value_array.cc:43
virtual bool empty(void) const
True if the instance is empty.
Definition: jaula_value_array.cc:80
void addItem(Value const &item)
Appends one item to the array.
Definition: jaula_value_array.cc:115
Base class for handling complex values.
Definition: jaula_value_complex.h:53
Base class for handling values.
Definition: jaula_value.h:53
Namespace for all library definitions.
Definition: jaula.h:439


Back to JAULA Project Documentation Page.

Go to JAULA Project Home Page.


Copyright (c) 2007, 2008, 2009 Kombo Morongo.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

API Reference Generated for jaula by

doxygen

jaula project hosted by

SourceForge.net