DocumentModelCoords Class Reference

Model for DlgSettingsCoords and CmdSettingsCoords. More...

#include <DocumentModelCoords.h>

Inheritance diagram for DocumentModelCoords:

Collaboration diagram for DocumentModelCoords:

Public Member Functions
	DocumentModelCoords ()
	Default constructor. More...
	DocumentModelCoords (const Document &document)
	Initial constructor from Document. More...
	DocumentModelCoords (const DocumentModelCoords &other)
	Copy constructor. More...
DocumentModelCoords &	operator= (const DocumentModelCoords &other)
	Assignment constructor. More...
CoordScale	coordScaleXTheta () const
	Get method for linear/log scale on x/theta. More...
CoordScale	coordScaleYRadius () const
	Get method for linear/log scale on y/radius. More...
CoordsType	coordsType () const
	Get method for coordinates type. More...
CoordUnitsDate	coordUnitsDate () const
	Get method for date format when used. More...
CoordUnitsNonPolarTheta	coordUnitsRadius () const
	Get method for radius units. More...
CoordUnitsPolarTheta	coordUnitsTheta () const
	Get method for theta unit. More...
CoordUnitsTime	coordUnitsTime () const
	Get method for time format when used. More...
CoordUnitsNonPolarTheta	coordUnitsX () const
	Get method for x units. More...
CoordUnitsNonPolarTheta	coordUnitsY () const
	Get method for x units. More...
virtual void	loadXml (QXmlStreamReader &reader)
	Load model from serialized xml. More...
double	originRadius () const
	Get method for origin radius in polar mode. More...
void	printStream (QString indentation, QTextStream &str) const
	Debugging method that supports print method of this class and printStream method of some other class(es) More...
virtual void	saveXml (QXmlStreamWriter &writer) const
	Save entire model as xml into stream. More...
void	setCoordScaleXTheta (CoordScale coordScale)
	Set method for linear/log scale on x/theta. More...
void	setCoordScaleYRadius (CoordScale coordScale)
	Set method for linear/log scale on y/radius. More...
void	setCoordsType (CoordsType coordsType)
	Set method for coordinates type. More...
void	setCoordUnitsDate (CoordUnitsDate coordUnits)
	Set method for date units. More...
void	setCoordUnitsRadius (CoordUnitsNonPolarTheta coordUnits)
	Set method for radius units. More...
void	setCoordUnitsTheta (CoordUnitsPolarTheta coordUnits)
	Set method for theta units. More...
void	setCoordUnitsTime (CoordUnitsTime coordUnits)
	Set method for time units. More...
void	setCoordUnitsX (CoordUnitsNonPolarTheta coordUnits)
	Set method for x units. More...
void	setCoordUnitsY (CoordUnitsNonPolarTheta coordUnits)
	Set method for y units. More...
void	setOriginRadius (double originRadius)
	Set method for origin radius in polar mode. More...
double	thetaPeriod () const
	Return the period of the theta value for polar coordinates, consistent with CoordThetaUnits. More...
Public Member Functions inherited from DocumentModelAbstractBase
	DocumentModelAbstractBase ()
	Single constructor. More...
virtual	~DocumentModelAbstractBase ()
	Single destructor. More...

Additional Inherited Members

Detailed Description

Model for DlgSettingsCoords and CmdSettingsCoords.

Definition at line 20 of file DocumentModelCoords.h.

Constructor & Destructor Documentation

DocumentModelCoords() [1/3]

DocumentModelCoords::DocumentModelCoords

(

)

Default constructor.

Definition at line 27 of file DocumentModelCoords.cpp.

                                         :
  m_coordsType (COORDS_TYPE_CARTESIAN),
  m_originRadius (DEFAULT_ORIGIN_RADIUS_LINEAR),
  m_coordScaleXTheta (COORD_SCALE_LINEAR),
  m_coordScaleYRadius (COORD_SCALE_LINEAR),
  m_coordUnitsX (COORD_UNITS_NON_POLAR_THETA_NUMBER),
  m_coordUnitsY (COORD_UNITS_NON_POLAR_THETA_NUMBER),
  m_coordUnitsTheta (COORD_UNITS_POLAR_THETA_DEGREES),
  m_coordUnitsRadius (COORD_UNITS_NON_POLAR_THETA_NUMBER),
  m_coordUnitsDate (COORD_UNITS_DATE_YEAR_MONTH_DAY),
  m_coordUnitsTime (COORD_UNITS_TIME_HOUR_MINUTE_SECOND)
{
}

DocumentModelCoords() [2/3]

DocumentModelCoords::DocumentModelCoords

(

const Document &

document

)

Initial constructor from Document.

Definition at line 41 of file DocumentModelCoords.cpp.

                                                                 :
  m_coordsType (document.modelCoords().coordsType()),
  m_originRadius(document.modelCoords().originRadius()),
  m_coordScaleXTheta(document.modelCoords().coordScaleXTheta()),
  m_coordScaleYRadius(document.modelCoords().coordScaleYRadius()),
  m_coordUnitsX(document.modelCoords().coordUnitsX()),
  m_coordUnitsY(document.modelCoords().coordUnitsY()),
  m_coordUnitsTheta(document.modelCoords().coordUnitsTheta()),
  m_coordUnitsRadius(document.modelCoords().coordUnitsRadius()),
  m_coordUnitsDate(document.modelCoords().coordUnitsDate()),
  m_coordUnitsTime(document.modelCoords().coordUnitsTime())
{
}

DocumentModelCoords() [3/3]

DocumentModelCoords::DocumentModelCoords

(

const DocumentModelCoords &

other

)

Copy constructor.

Definition at line 55 of file DocumentModelCoords.cpp.

                                                                         :
  m_coordsType (other.coordsType ()),
  m_originRadius (other.originRadius ()),
  m_coordScaleXTheta (other.coordScaleXTheta()),
  m_coordScaleYRadius (other.coordScaleYRadius ()),
  m_coordUnitsX (other.coordUnitsX()),
  m_coordUnitsY (other.coordUnitsY()),
  m_coordUnitsTheta (other.coordUnitsTheta ()),
  m_coordUnitsRadius (other.coordUnitsRadius ()),
  m_coordUnitsDate (other.coordUnitsDate ()),
  m_coordUnitsTime (other.coordUnitsTime ())
{
}

Member Function Documentation

coordScaleXTheta()

CoordScale DocumentModelCoords::coordScaleXTheta

(

)

const

Get method for linear/log scale on x/theta.

Definition at line 85 of file DocumentModelCoords.cpp.

{
  return m_coordScaleXTheta;
}

coordScaleYRadius()

CoordScale DocumentModelCoords::coordScaleYRadius

(

)

const

Get method for linear/log scale on y/radius.

Definition at line 90 of file DocumentModelCoords.cpp.

{
  return m_coordScaleYRadius;
}

coordsType()

CoordsType DocumentModelCoords::coordsType

(

)

const

Get method for coordinates type.

Definition at line 95 of file DocumentModelCoords.cpp.

{
  return m_coordsType;
}

coordUnitsDate()

CoordUnitsDate DocumentModelCoords::coordUnitsDate

(

)

const

Get method for date format when used.

Definition at line 100 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsDate;
}

coordUnitsRadius()

CoordUnitsNonPolarTheta DocumentModelCoords::coordUnitsRadius

(

)

const

Get method for radius units.

Definition at line 105 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsRadius;
}

coordUnitsTheta()

CoordUnitsPolarTheta DocumentModelCoords::coordUnitsTheta

(

)

const

Get method for theta unit.

Definition at line 110 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsTheta;
}

coordUnitsTime()

CoordUnitsTime DocumentModelCoords::coordUnitsTime

(

)

const

Get method for time format when used.

Definition at line 115 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsTime;
}

coordUnitsX()

CoordUnitsNonPolarTheta DocumentModelCoords::coordUnitsX

(

)

const

Get method for x units.

Definition at line 120 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsX;
}

coordUnitsY()

CoordUnitsNonPolarTheta DocumentModelCoords::coordUnitsY

(

)

const

Get method for x units.

Definition at line 125 of file DocumentModelCoords.cpp.

{
  return m_coordUnitsY;
}

loadXml()

void DocumentModelCoords::loadXml ( QXmlStreamReader &  reader )

virtual

Load model from serialized xml.

Implements DocumentModelAbstractBase.

Definition at line 130 of file DocumentModelCoords.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelCoords::loadXml";

  bool success = true;

  QXmlStreamAttributes attributes = reader.attributes();

  if (attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_TYPE) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_ORIGIN_RADIUS) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_THETA) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_DATE) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_TIME)) {

    setCoordsType (static_cast<CoordsType> (attributes.value(DOCUMENT_SERIALIZE_COORDS_TYPE).toInt()));
    setOriginRadius (attributes.value(DOCUMENT_SERIALIZE_COORDS_ORIGIN_RADIUS).toDouble());
    setCoordScaleXTheta (static_cast<CoordScale> (attributes.value(DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA).toInt()));
    setCoordScaleYRadius (static_cast<CoordScale> (attributes.value(DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS).toInt()));
    setCoordUnitsX (static_cast<CoordUnitsNonPolarTheta> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_X).toInt()));
    setCoordUnitsY (static_cast<CoordUnitsNonPolarTheta> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_Y).toInt()));
    setCoordUnitsTheta (static_cast<CoordUnitsPolarTheta> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_THETA).toInt()));
    setCoordUnitsRadius (static_cast<CoordUnitsNonPolarTheta> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS).toInt()));
    setCoordUnitsDate (static_cast<CoordUnitsDate> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_DATE).toInt()));
    setCoordUnitsTime (static_cast<CoordUnitsTime> (attributes.value(DOCUMENT_SERIALIZE_COORDS_UNITS_TIME).toInt()));

    // Read until end of this subtree
    while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
    (reader.name() != DOCUMENT_SERIALIZE_COORDS)){
      loadNextFromReader(reader);
      if (reader.atEnd()) {
        success = false;
        break;
      }
    }
  }

  if (!success) {
    reader.raiseError (QObject::tr ("Cannot read coordinates data"));
  }
}

operator=()

DocumentModelCoords & DocumentModelCoords::operator=

(

const DocumentModelCoords &

other

)

Assignment constructor.

Definition at line 69 of file DocumentModelCoords.cpp.

{
  m_coordsType = other.coordsType();
  m_originRadius = other.originRadius();
  m_coordScaleXTheta = other.coordScaleXTheta();
  m_coordScaleYRadius = other.coordScaleYRadius();
  m_coordUnitsX = other.coordUnitsX();
  m_coordUnitsY = other.coordUnitsY();
  m_coordUnitsTheta = other.coordUnitsTheta();
  m_coordUnitsRadius = other.coordUnitsRadius();
  m_coordUnitsDate = other.coordUnitsDate();
  m_coordUnitsTime = other.coordUnitsTime();

  return *this;
}

originRadius()

double DocumentModelCoords::originRadius

(

)

const

Get method for origin radius in polar mode.

Definition at line 176 of file DocumentModelCoords.cpp.

{
  return m_originRadius;
}

printStream()

void DocumentModelCoords::printStream	(	QString	indentation,
		QTextStream &	str
	)		const

Debugging method that supports print method of this class and printStream method of some other class(es)

Definition at line 181 of file DocumentModelCoords.cpp.

{
  str << indentation << "DocumentModelCoords\n";

  indentation += INDENTATION_DELTA;

  str << indentation << "coordsType=" << coordsTypeToString (m_coordsType) << "\n";
  str << indentation << "originRadius=" << m_originRadius << "\n";
  str << indentation << "coordScaleXTheta=" << coordScaleToString (m_coordScaleXTheta) << "\n";
  str << indentation << "coordScaleYRadius=" << coordScaleToString (m_coordScaleYRadius) << "\n";
  str << indentation << "coordUnitsX=" << coordUnitsNonPolarThetaToString (m_coordUnitsX) << "\n";
  str << indentation << "coordUnitsY=" << coordUnitsNonPolarThetaToString (m_coordUnitsY) << "\n";
  str << indentation << "coordUnitsTheta=" << coordUnitsPolarThetaToString (m_coordUnitsTheta) << "\n";
  str << indentation << "coordUnitsRadius=" << coordUnitsNonPolarThetaToString (m_coordUnitsRadius) << "\n";
  str << indentation << "coordUnitsDate=" << coordUnitsDateToString (m_coordUnitsDate) << "\n";
  str << indentation << "coordUnitsTime=" << coordUnitsTimeToString (m_coordUnitsTime) << "\n";
}

saveXml()

void DocumentModelCoords::saveXml ( QXmlStreamWriter &  writer ) const

virtual

Save entire model as xml into stream.

Implements DocumentModelAbstractBase.

Definition at line 200 of file DocumentModelCoords.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelCoords::saveXml";

  writer.writeStartElement(DOCUMENT_SERIALIZE_COORDS);
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_TYPE, QString::number (m_coordsType));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_TYPE_STRING, coordsTypeToString (m_coordsType));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_ORIGIN_RADIUS, QString::number (m_originRadius));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA, QString::number (m_coordScaleXTheta));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA_STRING, coordScaleToString (m_coordScaleXTheta));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS, QString::number (m_coordScaleYRadius));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS_STRING, coordScaleToString (m_coordScaleYRadius));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_X, QString::number (m_coordUnitsX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_X_STRING, coordUnitsNonPolarThetaToString (m_coordUnitsX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_Y, QString::number (m_coordUnitsY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_Y_STRING, coordUnitsNonPolarThetaToString (m_coordUnitsY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_THETA, QString::number (m_coordUnitsTheta));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_THETA_STRING, coordUnitsPolarThetaToString (m_coordUnitsTheta));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS, QString::number (m_coordUnitsRadius));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS_STRING, coordUnitsNonPolarThetaToString (m_coordUnitsRadius));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_DATE, QString::number (m_coordUnitsDate));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_DATE_STRING, coordUnitsDateToString (m_coordUnitsDate));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_TIME, QString::number (m_coordUnitsTime));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_TIME_STRING, coordUnitsTimeToString (m_coordUnitsTime));
  writer.writeEndElement();
}

setCoordScaleXTheta()

void DocumentModelCoords::setCoordScaleXTheta

(

CoordScale

coordScale

)

Set method for linear/log scale on x/theta.

Definition at line 227 of file DocumentModelCoords.cpp.

{
  m_coordScaleXTheta = coordScale;
}

setCoordScaleYRadius()

void DocumentModelCoords::setCoordScaleYRadius

(

CoordScale

coordScale

)

Set method for linear/log scale on y/radius.

Definition at line 232 of file DocumentModelCoords.cpp.

{
  m_coordScaleYRadius = coordScale;
}

setCoordsType()

void DocumentModelCoords::setCoordsType

(

CoordsType

coordsType

)

Set method for coordinates type.

Definition at line 237 of file DocumentModelCoords.cpp.

{
  m_coordsType = coordsType;
}

setCoordUnitsDate()

void DocumentModelCoords::setCoordUnitsDate

(

CoordUnitsDate

coordUnits

)

Set method for date units.

Definition at line 242 of file DocumentModelCoords.cpp.

{
  m_coordUnitsDate = coordUnits;
}

setCoordUnitsRadius()

void DocumentModelCoords::setCoordUnitsRadius

(

CoordUnitsNonPolarTheta

coordUnits

)

Set method for radius units.

Definition at line 247 of file DocumentModelCoords.cpp.

{
  m_coordUnitsRadius = coordUnits;
}

setCoordUnitsTheta()

void DocumentModelCoords::setCoordUnitsTheta

(

CoordUnitsPolarTheta

coordUnits

)

Set method for theta units.

Definition at line 252 of file DocumentModelCoords.cpp.

{
  m_coordUnitsTheta = coordUnits;
}

setCoordUnitsTime()

void DocumentModelCoords::setCoordUnitsTime

(

CoordUnitsTime

coordUnits

)

Set method for time units.

Definition at line 257 of file DocumentModelCoords.cpp.

{
  m_coordUnitsTime = coordUnits;
}

setCoordUnitsX()

void DocumentModelCoords::setCoordUnitsX

(

CoordUnitsNonPolarTheta

coordUnits

)

Set method for x units.

Definition at line 262 of file DocumentModelCoords.cpp.

{
  m_coordUnitsX = coordUnits;
}

setCoordUnitsY()

void DocumentModelCoords::setCoordUnitsY

(

CoordUnitsNonPolarTheta

coordUnits

)

Set method for y units.

Definition at line 267 of file DocumentModelCoords.cpp.

{
  m_coordUnitsY = coordUnits;
}

setOriginRadius()

void DocumentModelCoords::setOriginRadius

(

double

originRadius

)

Set method for origin radius in polar mode.

Definition at line 272 of file DocumentModelCoords.cpp.

{
  m_originRadius = originRadius;
}

thetaPeriod()

double DocumentModelCoords::thetaPeriod

(

)

const

Return the period of the theta value for polar coordinates, consistent with CoordThetaUnits.

Definition at line 277 of file DocumentModelCoords.cpp.

{
  switch (m_coordUnitsTheta) {
    case COORD_UNITS_POLAR_THETA_DEGREES:
    case COORD_UNITS_POLAR_THETA_DEGREES_MINUTES:
    case COORD_UNITS_POLAR_THETA_DEGREES_MINUTES_SECONDS:
    case COORD_UNITS_POLAR_THETA_DEGREES_MINUTES_SECONDS_NSEW:
      return 360;

    case COORD_UNITS_POLAR_THETA_GRADIANS:
      return 400;

    case COORD_UNITS_POLAR_THETA_RADIANS:
      return TWO_PI;

    case COORD_UNITS_POLAR_THETA_TURNS:
      return 1;

    default:
      break;
  }

  LOG4CPP_ERROR_S ((*mainCat)) << "DocumentModelCoords::thetaPeriod";

  ENGAUGE_ASSERT(false);
  return 0;
}

---

The documentation for this class was generated from the following files:

• Document/DocumentModelCoords.h
• Document/DocumentModelCoords.cpp