Branch.h

Go to the documentation of this file.

/*
 *
 * Branch.h header template automatically generated by a class generator
 * Creation date : lun. mai 4 2015
 *
 * This file is part of APRILContent libraries.
 * 
 * APRILContent 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 3 of the License, or
 * (at your option) any later version.
 * based upon these libraries are permitted. Any copy of these libraries
 * must include this copyright notice.
 * 
 * APRILContent 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 APRILContent.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Remi Ete
 * @copyright CNRS , IPNL
 */


#ifndef BRANCH_H
#define BRANCH_H

#include "Pandora/PandoraInternal.h"

#include "APRILApi/APRILInputTypes.h"

namespace april_content
{

class Branch 
{
public:
    typedef std::vector<const CaloHit *> List;
    typedef List::value_type              value_type;
    typedef List::iterator                iterator;
    typedef List::const_iterator          const_iterator;
    typedef List::reverse_iterator        reverse_iterator;
    typedef List::const_reverse_iterator  const_reverse_iterator;

    Branch();

    Branch(const_iterator first, const_iterator last);

    Branch(const Branch &branch);

    virtual ~Branch();

    pandora::StatusCode BuildFromCaloHit(const CaloHit *const pCaloHit);

    iterator begin();

    const_iterator begin() const;

    iterator end();

    const_iterator end() const;

    reverse_iterator rbegin();

    const_reverse_iterator rbegin() const;

    reverse_iterator rend();

    const_reverse_iterator rend() const;

    void clear();

    size_t size() const;

    pandora::StatusCode push_back(const CaloHit *const pCaloHit);

    pandora::StatusCode push_front(const CaloHit *const pCaloHit);

    pandora::StatusCode Cut(iterator position, bool keepForwardPart = true);

    bool IsValid() const;

    Branch &operator =(const Branch &branch);

private:

    std::vector<const CaloHit *>         m_caloHitList;
};

//------------------------------------------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::Branch()
{
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::~Branch()
{
    clear();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::iterator Branch::begin()
{
    return m_caloHitList.begin();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::const_iterator Branch::begin() const
{
    return m_caloHitList.begin();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::iterator Branch::end()
{
    return m_caloHitList.end();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::const_iterator Branch::end() const
{
    return m_caloHitList.end();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::reverse_iterator Branch::rbegin()
{
    return m_caloHitList.rbegin();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::const_reverse_iterator Branch::rbegin() const
{
    return m_caloHitList.rbegin();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::reverse_iterator Branch::rend()
{
    return m_caloHitList.rend();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline Branch::const_reverse_iterator Branch::rend() const
{
    return m_caloHitList.rend();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline void Branch::clear()
{
    return m_caloHitList.clear();
}

//------------------------------------------------------------------------------------------------------------------------------------------

inline size_t Branch::size() const
{
    return m_caloHitList.size();
}

} 

#endif  //  BRANCH_H