mlRasterFunctionList.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_RASTER_FUNCTION_LIST_H
#define ML_RASTER_FUNCTION_LIST_H
 
 
 
// This class maintains a list of raster functions.
// It uses an stl vector to manage the list.
// The class is derived from Base to have a common base class
// for some classes and to have the possibility to add persistence
// to the object later.
 
//ML-includes
#include "mlBaseInit.h"
#include "mlRasterFunction.h"
 
ML_START_NAMESPACE
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
class MLBASEEXPORT RasterFunctionList : public Base {
 
public:
    RasterFunctionList()                                   {};
 
    ~RasterFunctionList() override                          {};
 
    //virtual std::vector<RasterFunction> &getList()   { return objects; }
 
    virtual size_t getListSize()
    { return objects.size(); }
 
    virtual void setListElement(size_t idx, const RasterFunction &elem)
    { objects[idx]=elem; }
 
    virtual void appendToList(const RasterFunction &elem)
    { objects.push_back(elem); }
 
    virtual const RasterFunction &getListElement(size_t idx)
    { return objects[idx]; }
 
    std::string persistentState() const override { return {}; }
    
    void setPersistentState(const std::string& /*state*/) override { }
 
#if ML_DEPRECATED_SINCE(3,5,0)
    [[nodiscard]][[deprecated]] char* getPersistentState() const override { return nullptr; }
 
    [[deprecated]] void setPersistentState(const char* /*state*/) override { }
 
    [[deprecated]]void  clearPersistentState(char* /*state*/) const override { }
#endif
    RasterFunction* getPtr(MLssize_t index = -1);
 
    void setValue(MLssize_t index, const RasterFunction& obj);
 
    void removeValue(MLssize_t index = -1);
 
    void clear();
 
private:
 
    //--------------------------------------------------------------------------------
    //--------------------------------------------------------------------------------
    ML_CLASS_HEADER(RasterFunctionList);
 
    std::vector<RasterFunction> objects;
};
 
ML_END_NAMESPACE
 
#endif // of __mlRasterFunctionList_H