hyperboloid.h

Go to the documentation of this file.

#ifndef HYPERBOLOID_H
#define HYPERBOLOID_H

#include <QObject>
#include <QtXml>

#include "geometry.h"
#include "position.h"
#include "direction.h"

namespace oi{

class OI_CORE_EXPORT Hyperboloid : public Geometry
{
    Q_OBJECT

public:
    Hyperboloid(const bool &isNominal, QObject *parent = 0);
    Hyperboloid(const bool &isNominal, const Position &center, const Direction &axis, const double &a, const double &c, QObject *parent = 0);

    Hyperboloid(const Hyperboloid &copy, QObject *parent = 0);

    Hyperboloid &operator=(const Hyperboloid &copy);

    ~Hyperboloid();

    //########################################
    //order of unknown parameters (Qxx-matrix)
    //########################################

    enum HyperboloidUnknowns{
        unknownCenterX = 0,
        unknownCenterY,
        unknownCenterZ,
        unknownAxisI,
        unknownAxisJ,
        unknownAxisK,
        unknownA,
        unknownC
    };

    //###################################################################
    //check wether this geometry has a direction, a position and a radius
    //###################################################################

    bool hasDirection() const;
    bool hasPosition() const;

    //#################################
    //get or set hyperboloid parameters
    //#################################

    const Direction &getDirection() const;
    const Position &getPosition() const;

    const double &getA() const;
    const double &getC() const;

    void setHyperboloid(const Position &center, const Direction &axis, const double &a, const double &c);

    //#############################
    //get or set unknown parameters
    //#############################

    virtual QMap<GeometryParameters, QString> getUnknownParameters(const QMap<DimensionType, UnitType> &displayUnits,
                                                          const QMap<DimensionType, int> &displayDigits) const;
    virtual void setUnknownParameters(const QMap<GeometryParameters, double> &parameters);

    //###########################
    //reexecute the function list
    //###########################

    void recalc();

    //#################
    //save and load XML
    //#################

    QDomElement toOpenIndyXML(QDomDocument &xmlDoc) const;
    bool fromOpenIndyXML(QDomElement &xmlElem);

    //###############
    //display methods
    //###############

    QString getDisplayX(const UnitType &type, const int &digits, const bool &showDiff = false) const;
    QString getDisplayY(const UnitType &type, const int &digits, const bool &showDiff = false) const;
    QString getDisplayZ(const UnitType &type, const int &digits, const bool &showDiff = false) const;
    QString getDisplayPrimaryI(const int &digits, const bool &showDiff = false) const;
    QString getDisplayPrimaryJ(const int &digits, const bool &showDiff = false) const;
    QString getDisplayPrimaryK(const int &digits, const bool &showDiff = false) const;
    QString getDisplayA(const UnitType &type, const int &digits, const bool &showDiff = false) const;
    QString getDisplayC(const UnitType &type, const int &digits, const bool &showDiff = false) const;

private:

    //######################
    //hyperboloid attributes
    //######################

    Position center; //center
    Direction axis; //the rotation axis
    double a;
    double c;

};

}

#endif // HYPERBOLOID_H