inv_hpi_model_parameters.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_HPI_MODEL_PARAMETERS_H
#define INV_HPI_MODEL_PARAMETERS_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
#include "../inv_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QVector>
#include <QSharedPointer>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
// DEFINE NAMESPACE HPILIBE
//=============================================================================================================
 
namespace INVLIB {
 
//=============================================================================================================
// HPILIBE FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
class INVSHARED_EXPORT InvHpiModelParameters
{
public:
    typedef QSharedPointer<InvHpiModelParameters> SPtr;            
    typedef QSharedPointer<const InvHpiModelParameters> ConstSPtr; 
 
    //=========================================================================================================
    InvHpiModelParameters() = default;
 
    //=========================================================================================================
    explicit InvHpiModelParameters(const QVector<int> vecHpiFreqs,
                                const int iSampleFreq,
                                const int iLineFreq,
                                const bool bBasic);
 
    //=========================================================================================================
    InvHpiModelParameters(const InvHpiModelParameters &hpiModelParameter);
 
    //=========================================================================================================
 
    InvHpiModelParameters operator= (const InvHpiModelParameters& other);
    inline bool operator== (const InvHpiModelParameters &b) const;
    inline bool operator!= (const InvHpiModelParameters &b) const;
 
    //=========================================================================================================
 
    inline QVector<int> vecHpiFreqs() const;
    inline int iNHpiCoils() const;
    inline int iSampleFreq() const;
    inline int iLineFreq() const;
    inline bool bBasic() const;
 
private:
    //=========================================================================================================
    void computeNumberOfCoils();
 
    //=========================================================================================================
    void checkForLineFreq();
 
    QVector<int> m_vecHpiFreqs{QVector<int>()};
    int m_iNHpiCoils{0};
    int m_iSampleFreq{0};
    int m_iLineFreq{0};
    bool m_bBasic{true};
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline QVector<int> InvHpiModelParameters::vecHpiFreqs() const
{
    return m_vecHpiFreqs;
}
 
//=============================================================================================================
 
inline int InvHpiModelParameters::iNHpiCoils() const
{
    return m_iNHpiCoils;
}
 
//=============================================================================================================
 
inline int InvHpiModelParameters::iSampleFreq() const
{
    return m_iSampleFreq;
}
 
//=============================================================================================================
 
inline int InvHpiModelParameters::iLineFreq() const
{
    return m_iLineFreq;
}
 
//=============================================================================================================
 
inline bool InvHpiModelParameters::bBasic() const
{
    return m_bBasic;
}
 
//=============================================================================================================
 
inline bool InvHpiModelParameters::operator== (const InvHpiModelParameters &b) const
{
    return (this->vecHpiFreqs() == b.vecHpiFreqs() &&
            this->iNHpiCoils() == b.iNHpiCoils() &&
            this->iSampleFreq() == b.iSampleFreq() &&
            this->iLineFreq() == b.iLineFreq() &&
            this->bBasic() == b.bBasic());
}
 
//=============================================================================================================
 
inline bool InvHpiModelParameters::operator!= (const InvHpiModelParameters &b) const
{
    return !(*this==b);
}
 
} // namespace INVLIBE
 
#endif // INV_HPI_MODEL_PARAMETERS_H