SpectrumRecord.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __SpectrumRecord_h
#define __SpectrumRecord_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef GVXR_CONFIG_H
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <iostream>

#ifndef GVXR_TYPES_H
#include "gVirtualXRay/Types.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//******************************************************************************
//  Class declaration
//******************************************************************************
class SpectrumRecord;


//******************************************************************************
//  Function declaration
//******************************************************************************
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
std::istream& operator>>(std::istream& is, SpectrumRecord& obj);


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

//------------------------------------------------------------------------------
std::ostream& operator<<(std::ostream& os, const SpectrumRecord& obj);


//==============================================================================
//==============================================================================
class SpectrumRecord
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    SpectrumRecord(const RATIONAL_NUMBER& aPhotonNumber = 0,
                   const RATIONAL_NUMBER& anIncidentEnergy = 0);


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

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER getPhotonNumber() const;


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

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER getPhotonEnergy() const;


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

    //--------------------------------------------------------------------------
    bool operator<(const SpectrumRecord& aRecord) const;


//******************************************************************************
protected:
    RATIONAL_NUMBER m_photon_number;


    RATIONAL_NUMBER m_energy;


    //**************************************************************************
    //  Friend class
    //**************************************************************************
    friend class XRayBeam;


    //**************************************************************************
    //  Friend operators
    //**************************************************************************
    friend std::istream& operator>>(std::istream& is, SpectrumRecord& obj);
    friend std::ostream& operator<<(std::ostream& os, const SpectrumRecord& obj);
};


} // namespace gVirtualXRay


//******************************************************************************
#include "SpectrumRecord.inl"


#endif // __SpectrumRecord_h