channel.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.

#ifndef _CHANNEL_H
#define _CHANNEL_H

class Section;

class StfioDll Channel {
public:

    //ctor/dtor---------------------------------------------------
    explicit Channel(void);


    explicit Channel(const Section& c_Section); 


    explicit Channel(const std::vector<Section>& SectionList); 


    explicit Channel(std::size_t c_n_sections, std::size_t section_size = 0);
    
    ~Channel();

    //operators---------------------------------------------------


    Section& operator[](std::size_t at_) { return SectionArray[at_]; }


    const Section& operator[](std::size_t at_) const { return SectionArray[at_]; }

    //member access: read-----------------------------------------


    const std::string& GetChannelName() const { return name; }


    const std::string& GetYUnits( ) const { return yunits; }


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


    const Section& at(std::size_t at_) const;


    Section& at(std::size_t at_);


    const std::vector< Section >& get() const { return SectionArray; }



    std::vector< Section >& get() { return SectionArray; }

    //member access: write----------------------------------------


    void SetChannelName(const std::string& value) { name = value; }
    

    void SetYUnits( const std::string& value ) { yunits = value; }

    //misc--------------------------------------------------------
    

    void InsertSection(const Section& c_Section, std::size_t pos);


    void resize(std::size_t newSize);


    void reserve(std::size_t resSize);

private:
    //private members---------------------------------------------
    
    std::string name, yunits;

    // An array of sections
    std::vector< Section > SectionArray;

};

#endif