JAULA::Value_Array Class Reference
[JAULA: JSON Values containers]

Class for handling array values. More...

#include <jaula_value_array.h>

Inheritance diagram for JAULA::Value_Array:

[legend]Collaboration diagram for JAULA::Value_Array:

[legend]

Public Types
typedef std::list< Value * >	dataType
	Data type for value contents.
Public Member Functions
void	addItem (Value const &item)
	Appends one item to the array.
virtual void	clear (void)
	Empties the contents of an instance.
virtual bool	empty (void) const
	True if the instance is empty.
dataType const &	getData (void) const
	Retrieves the array of values contained by the instance.
virtual void	repr (std::ostream &ostr) const
	Represents the instance in a stream.
virtual void	set (Value const &origin) throw (Bad_Data_Type)
	Copies the contents of one instance into anothe.
void	set (dataType const &data)
	Establishes the contents of the instance.
virtual size_t	size (void) const
	Number of elements contained.
	Value_Array (dataType const &data)
	Data Constructor.
	Value_Array (void)
	Default Constructor.
virtual	~Value_Array ()
	Destructor.
Private Attributes
dataType	data_
	Container to hold the value itself.

---

Detailed Description

Class for handling array values.

This class is a container for JSON arrays

Author:

Kombo Morongo <morongo666@gmail.com>

---

Member Typedef Documentation

typedef std::list<Value *> JAULA::Value_Array::dataType

Data type for value contents.

Description

Definition for the data container internal structure.

This data type defines a list of pointers to any kind of values (including arrays).

---

Constructor & Destructor Documentation

JAULA::Value_Array::Value_Array

(

void

)

Default Constructor.

Description

The default constructor initializes an empty array.

JAULA::Value_Array::Value_Array

(

dataType const &

data

)

Data Constructor.

Parameters:

data

Reference to the data to be copied

Description

This constructor generates a new instance by making a deep copy of the original data.

JAULA::Value_Array::~Value_Array

(

)

[virtual]

Destructor.

Note:

The destruction process releases all the memory associated to the data structure so any reference to the array or any element in it will be void.

---

Member Function Documentation

void JAULA::Value_Array::addItem

(

Value const &

item

)

Appends one item to the array.

Parameters:

item

Item to be appended

Description

Appends a deep copy of the item value at the end of the array.

void JAULA::Value_Array::clear

(

void

)

[virtual]

Empties the contents of an instance.

Description

Erases the contained array.

Note:

As the array is destroyed by the process, any references to it or to its elements will be void.

Implements JAULA::Value_Complex.

bool JAULA::Value_Array::empty

(

void

)

const [virtual]

True if the instance is empty.

Returns:

true if there are no single elements contained in the array and false otherwise.

Implements JAULA::Value_Complex.

Value_Array::dataType const & JAULA::Value_Array::getData

(

void

)

const

Retrieves the array of values contained by the instance.

void JAULA::Value_Array::repr

(

std::ostream &

ostr

)

const [virtual]

Represents the instance in a stream.

Parameters:

ostr

Stream where the instance is to be represented.

Description

writes the instance content in JSON notation in a stream.

Implements JAULA::Value.

void JAULA::Value_Array::set

(

Value const &

origin

)

throw (Bad_Data_Type) [virtual]

Copies the contents of one instance into anothe.

Parameters:

origin

Reference to the value to be copied.

Exceptions:

Bad_Data_Type

This exception is launched in case that origin and destination value types are different.

Note:

The destination array is destroyed during the asignment process so, any references to it or to its former elements will be void.

Reimplemented from JAULA::Value.

void JAULA::Value_Array::set

(

dataType const &

data

)

Establishes the contents of the instance.

Parameters:

data

Array to assign to the instance

Note:

The destination array is destroyed during the asignment process so, any references to it or to its former elements will be void.

size_t JAULA::Value_Array::size

(

void

)

const [virtual]

Number of elements contained.

Returns:

the number of single elements contained by the array.

Implements JAULA::Value_Complex.

---

Field Documentation

dataType JAULA::Value_Array::data_ [private]

Container to hold the value itself.

---

The documentation for this class was generated from the following files:

• jaula_value_array.h
• jaula_value_array.cc

---

Back to JAULA Project Documentation Page.

Go to JAULA Project Home Page.

---

Copyright (c) 2007 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".