class Environment

This is the base-class for all environments

Inheritance:

Environment


Public Methods

[more] Environment()
Default constructor
[more]virtual ~Environment()
Destructor
[more]void read(ifstream *input)
This method builds the environment from the given input filestream
[more]void write(ofstream *output, int parameter=0)
This method writes the environment to the given output filestream
[more]int shouldBeWrittenOneByOne()
This method indicates, if the elements of the environment should be written one-by-one
[more]int getNumberOfElements()
This method returns the number of elements in the environment

Protected Fields

[more] elements_
A vector which contains pointers to the elements.


Documentation

This is the base-class for all environments. It provides a common interface for reading an environment from an input filestream and writing it to an output filestream. There is also a method, which returns the number of elements in the environment and a method which return-value indicates, if the elements of the environment should be written one-by-one or not.
o Environment()
Default constructor

ovirtual ~Environment()
Destructor

ovoid read(ifstream *input)
This method builds the environment from the given input filestream. The input filestream will be read until an end-of-environment tag is reached.
Parameters:
input - The input filestream

ovoid write(ofstream *output, int parameter=0)
This method writes the environment to the given output filestream.
Parameters:
output - The output filestream
parameter - An integer-parameter, which has a special meaning for each derivated environment.

oint shouldBeWrittenOneByOne()
This method indicates, if the elements of the environment should be written one-by-one.
Returns:
1, if the elements should be written one-by-one, else 0.

oint getNumberOfElements()
This method returns the number of elements in the environment.
Returns:
The number of elements

o elements_
A vector which contains pointers to the elements.


Direct child classes:
RawEnvironment
ItemizeEnvironment
ImageEnvironment
HBoxEnvironment
GridEnvironment

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.