section.h

Go to the documentation of this file.

// 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.
 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

 
/*------------------------------------------------------------------------
 *  References:
 *  [1] Stroustrup, B.: The C++ Programming Language. 3rd ed. 1997
 *  [2] Meyers, S.: Effective C++. 3rd ed. 2005
--------------------------------------------------------------------------*/
// only compile once, even if included more often:
#ifndef _SECTION_H
#define _SECTION_H
#include "./core.h"
#include "./annotation.h"

class StfioDll Section {
public:
    // Construction/Destruction-----------------------------------------------
    explicit Section();


    explicit Section(
            const Vector_double& valA,
            const std::string& label="\0"
    );


    explicit Section(
            std::size_t size,
            const std::string& label="\0"
    );

    ~Section();
 
    // Operators--------------------------------------------------------------

    double& operator[](std::size_t at) { return data[at]; }


    double operator[](std::size_t at) const { return data[at]; }
 
    // Public member functions------------------------------------------------


    double at(std::size_t at_) const;


    double& at(std::size_t at_);


    const Vector_double& get() const { return data; }


    Vector_double& get_w() { return data; }


    void resize(std::size_t new_size) { data.resize(new_size); }


    size_t size() const { return data.size(); }


    void SetXScale(double value);


    double GetXScale() const { return x_scale; }
    

    const std::string& GetSectionDescription() const { return section_description; }


    void SetSectionDescription(const std::string& value) { section_description=value; }
    



    std::size_t GetSectionSize();
 
    // Annotation operations //
    // Add Annotation to the current section
    void AddAnnotation(Annotation annotation);
    // Change position of Annotation[index] to new sample number 'position'
    void MoveAnnotation(size_t index, int new_position);
    // Remove Annotation[index] from list of Annotations
    void RemoveAnnotation(size_t index);
    //Erase all annotation in the list of Annotations
    void EraseAllAnnotations();
    //Get list of all annotation in this section.
    std::vector<Annotation> GetAnnotationList();
 
    std::size_t GetFirstAnnotationPosition();
    std::size_t GetLastAnnotationPosition();
 
 private:
    //Private members-------------------------------------------------------
 
    // A description that is specific to this section:
    std::string section_description;
 
    // The sampling interval:
    double x_scale;
 
    // The data:
    Vector_double data;
 
    // list of annotations in this section
    std::size_t firstAnnotationPos, lastAnnotationPos;
    std::vector<Annotation> AnnotationsList;
};

 
#endif