Connector.h

Go to the documentation of this file.

/*
 *
 * Connector.h header template automatically generated by a class generator
 * Creation date : ven. mars 20 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 CONNECTOR_H
#define CONNECTOR_H

#include "Pandora/StatusCodes.h"
#include "Objects/CartesianVector.h"

#include "APRILApi/APRILInputTypes.h"
#include "APRILApi/APRILContentApi.h"

namespace april_content
{

class Connector
{
public:
    const april_content::CaloHit *GetFrom() const;

    const april_content::CaloHit *GetTo() const;

    const april_content::CaloHit *Get(ConnectorDirection direction) const;

    float GetLength() const;

    float GetReferenceLength() const;

    float GetNormalizedLength() const;

    pandora::CartesianVector GetVector(ConnectorDirection direction = FORWARD_DIRECTION) const;

    bool IsFrom(const april_content::CaloHit *const pCaloHit) const;

    bool IsTo(const april_content::CaloHit *const pCaloHit) const;

    float GetOpeningAngle(const Connector *const pConnector) const;

    unsigned int GetCreationStage() const;

private:
    Connector(const april_content::CaloHit *const pFromCaloHit, const april_content::CaloHit *const pToCaloHit,
        float referenceLength = 1.f, unsigned int creationStage = -1);

    ~Connector();

private:
    const CaloHit                        *m_pFromCaloHit;     
    const CaloHit                        *m_pToCaloHit;       
    float                                 m_referenceLength;  
        unsigned int                          m_creationStage;    

    // friendship
    friend class CaloHit;
    friend class ::APRILContentApi;
};

} 

#endif  //  CONNECTOR_H