NidsIterators.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2006, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
#ifndef NIDAS_CORE_NIDSITERATORS_H
#define NIDAS_CORE_NIDSITERATORS_H

#include <list>
// #include <set>
#include <vector>

namespace nidas { namespace core {

class Project;
class DSMServer;
class DSMService;
class Site;
class Variable;

class SiteIterator
{
public:
    SiteIterator(const Project*);

    SiteIterator();

    bool hasNext();

    Site* next() { return *_siteItr++; }

private:

    const std::list<Site*>* _sites;

    std::list<Site*>::const_iterator _siteItr;
};

class DSMServerIterator
{
public:
    DSMServerIterator(const Project*);

    DSMServerIterator(const Site*);

    DSMServerIterator();

    bool hasNext();

    DSMServer* next() { return *_serverItr++; }

private:

    const std::list<DSMServer*>* _servers;

    std::list<DSMServer*>::const_iterator _serverItr;

    SiteIterator _siteIterator;
};

class DSMServiceIterator
{
public:
    DSMServiceIterator(const Project*);

    DSMServiceIterator(const Site*);

    DSMServiceIterator(const DSMServer*);

    DSMServiceIterator();

    bool hasNext();

    DSMService* next() { return *_dsmServiceItr++; }

private:

    DSMServerIterator _dsmServerIterator;

    const std::list<DSMService*>* _services;

    std::list<DSMService*>::const_iterator _dsmServiceItr;
};

class SampleIOProcessor;

class DSMConfig;


class DSMConfigIterator
{
public:
    DSMConfigIterator(const Project*);

    DSMConfigIterator(const Site*);

    DSMConfigIterator();

    bool hasNext();

    const DSMConfig* next() { return *_dsmItr++; }

private:

    SiteIterator _siteIterator;

    const std::list<const DSMConfig*>* _dsms;

    std::list<const DSMConfig*>::const_iterator _dsmItr;
};

class ProcessorIterator
{
public:
    ProcessorIterator(const Project*);

    ProcessorIterator(const Site*);

    ProcessorIterator(const DSMServer*);

    ProcessorIterator(const DSMService*);

    ProcessorIterator(const DSMConfig*);

    ProcessorIterator();

    bool hasNext();

    SampleIOProcessor* next() { return *_procItr++; }

private:

    DSMServiceIterator _serviceIterator;

    DSMConfigIterator _dsmIterator;

    const std::list<SampleIOProcessor*>* _processors;

    std::list<SampleIOProcessor*>::const_iterator _procItr;
};

class DSMSensor;

class SensorIterator
{
public:
    SensorIterator(const Project*);

    SensorIterator(const Site*);

    SensorIterator(const DSMConfig*);

    SensorIterator();

    bool hasNext();

    DSMSensor* next() { return *_sensorItr++; }

private:

    DSMConfigIterator _dsmIterator;

    const std::list<DSMSensor*>* _sensors;

    std::list<DSMSensor*>::const_iterator _sensorItr;
};

class SampleSource;
class SampleIOProcessor;
class SampleTag;

class SampleTagIterator
{
public:

    SampleTagIterator(const SampleTagIterator&x):
        _sensorIterator(x._sensorIterator),
        _processorIterator(x._processorIterator),
        _stags(x._stags),_sampleTagItr(_stags.begin())
    {
        /* Must define a copy constructor since _stags
         * is a list and not a pointer. The default copy
         * constructor is OK for all the other iterators, since they
         * contain a pointer to a container which is part of
         * Project::getInstance(), and so remains valid
         * (hopefully) over the life of the iterator.
         * In this class _stags is a new list, so we must reset
         * _sampleTagItr to point to the beginning of the new list.
         */
    }

    SampleTagIterator& operator=(const SampleTagIterator&x)
    {
        /* Must define an assignment operator for the same reason
         * mentioned above in the copy constructor.
         */
        if (this != &x) {
            _sensorIterator = x._sensorIterator;
            _stags = x._stags;
            _sampleTagItr = _stags.begin();
        }
        return *this;
    }
        
    SampleTagIterator(const Project*);

    SampleTagIterator(const DSMServer*);

    SampleTagIterator(const DSMService*);

    SampleTagIterator(const Site*);

    SampleTagIterator(const DSMConfig*);

    SampleTagIterator(const SampleSource*);

    SampleTagIterator();

    bool hasNext();

    const SampleTag* next() { return *_sampleTagItr++; }

private:

    SensorIterator _sensorIterator;

    ProcessorIterator _processorIterator;

    std::list<const SampleTag*> _stags;

    std::list<const SampleTag*>::const_iterator _sampleTagItr;
};

class VariableIterator
{
public:

    VariableIterator(const Project*);

    VariableIterator(const DSMServer*);

    VariableIterator(const DSMService*);

    VariableIterator(const Site*);

    VariableIterator(const DSMConfig*);

    VariableIterator(const SampleSource*);

    VariableIterator(const SampleTag*);

    VariableIterator(const VariableIterator& x):
        _sampleTagIterator(x._sampleTagIterator),
        _variables(x._variables),
        _variableItr(x._variableItr)
    {
    }

    VariableIterator& operator=(const VariableIterator& rhs)
    {
        if (&rhs != this) {
            _sampleTagIterator = rhs._sampleTagIterator;
            _variables = rhs._variables;
            _variableItr = rhs._variableItr;
        }
        return *this;
    }

    bool hasNext();

    const Variable* next() { return *_variableItr++; }

private:

    SampleTagIterator _sampleTagIterator;

    const std::vector<const Variable*>* _variables;

    std::vector<const Variable*>::const_iterator _variableItr;
};

}}  // namespace nidas namespace core

#endif