Model for DlgSettingsGridRemoval and CmdSettingsGridRemoval. The settings are unstable until the user approves. More...

#include <DocumentModelGridRemoval.h>

Inheritance diagram for DocumentModelGridRemoval:

Collaboration diagram for DocumentModelGridRemoval:

Public Member Functions
	DocumentModelGridRemoval ()
	Default constructor. More...

	DocumentModelGridRemoval (double startX, double startY, double stepX, double stepY, int countX, int countY)
	Constructor fed by GridClassifier. More...

	DocumentModelGridRemoval (const Document &document)
	Initial constructor from Document. More...

	DocumentModelGridRemoval (const DocumentModelGridRemoval &other)
	Copy constructor. More...

DocumentModelGridRemoval &	operator= (const DocumentModelGridRemoval &other)
	Assignment constructor. More...

double	closeDistance () const
	Get method for close distance. More...

int	countX () const
	Get method for x count. More...

int	countY () const
	Get method for y count. More...

GridCoordDisable	gridCoordDisableX () const
	Get method for x coord parameter to disable. More...

GridCoordDisable	gridCoordDisableY () const
	Get method for y coord parameter to disable. More...

virtual void	loadXml (QXmlStreamReader &reader)
	Load model from serialized xml. 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...

bool	removeDefinedGridLines () const
	Get method for removing defined grid lines. More...

virtual void	saveXml (QXmlStreamWriter &writer) const
	Save entire model as xml into stream. More...

void	setCloseDistance (double closeDistance)
	Set method for close distance. More...

void	setCountX (int countX)
	Set method for x count. More...

void	setCountY (int countY)
	Set method for y count. More...

void	setGridCoordDisableX (GridCoordDisable gridCoordDisable)
	Set method for x coord parameter to disable. More...

void	setGridCoordDisableY (GridCoordDisable gridCoordDisable)
	Set method for y coord parameter to disable. More...

void	setRemoveDefinedGridLines (bool removeDefinedGridLines)
	Set method for removing defined grid lines. More...

void	setStable ()
	Set the stable flag to true. This public version has no argument since it cannot be undone. More...

void	setStartX (double startX)
	Set method for x start. More...

void	setStartY (double startY)
	Set method for y start. More...

void	setStepX (double stepX)
	Set method for x step. More...

void	setStepY (double stepY)
	Set method for y step. More...

void	setStopX (double stopX)
	Set method for x stop. More...

void	setStopY (double stopY)
	Set method for y stop. More...

bool	stable () const
	Get method for stable flag. More...

double	startX () const
	Get method for x start. More...

double	startY () const
	Get method for y start. More...

double	stepX () const
	Get method for x step. More...

double	stepY () const
	Get method for y step. More...

double	stopX () const
	Get method for x stop. More...

double	stopY () const
	Get method for y stop. More...

Public Member Functions inherited from DocumentModelAbstractBase
	DocumentModelAbstractBase ()
	Single constructor. More...

virtual	~DocumentModelAbstractBase ()
	Single destructor. More...

Additional Inherited Members

Detailed Description

Model for DlgSettingsGridRemoval and CmdSettingsGridRemoval. The settings are unstable until the user approves.

Definition at line 17 of file DocumentModelGridRemoval.h.

Constructor & Destructor Documentation

◆ DocumentModelGridRemoval() [1/4]

DocumentModelGridRemoval::DocumentModelGridRemoval ( )

Default constructor.

Definition at line 22 of file DocumentModelGridRemoval.cpp.

                                                    :
   m_stable (false),
   m_removeDefinedGridLines (false),
   m_closeDistance (CLOSE_DISTANCE_DEFAULT),
   m_gridCoordDisableX (GRID_COORD_DISABLE_COUNT),
   m_countX (DEFAULT_COUNT),
   m_startX (DEFAULT_NON_COUNT),
   m_stepX (DEFAULT_NON_COUNT),
   m_stopX (DEFAULT_NON_COUNT),
   m_gridCoordDisableY (GRID_COORD_DISABLE_COUNT),
   m_countY (DEFAULT_COUNT),
   m_startY (DEFAULT_NON_COUNT),
   m_stepY (DEFAULT_NON_COUNT),
   m_stopY (DEFAULT_NON_COUNT)
 {
 }

◆ DocumentModelGridRemoval() [2/4]

DocumentModelGridRemoval::DocumentModelGridRemoval	(	double	startX,
		double	startY,
		double	stepX,
		double	stepY,
		int	countX,
		int	countY
	)

Constructor fed by GridClassifier.

Definition at line 39 of file DocumentModelGridRemoval.cpp.

                                                                 :
   m_stable (false),
   m_removeDefinedGridLines (false),
   m_closeDistance (CLOSE_DISTANCE_DEFAULT),
   m_gridCoordDisableX (GRID_COORD_DISABLE_COUNT),
   m_countX (countX),
   m_startX (startX),
   m_stepX (stepX),
   m_stopX (startX + (countX - 1.0) * stepX),
   m_gridCoordDisableY (GRID_COORD_DISABLE_COUNT),
   m_countY (countY),
   m_startY (startY),
   m_stepY (stepY),
   m_stopY (startY + (countY - 1.0) * stepY)
 {
 }

◆ DocumentModelGridRemoval() [3/4]

DocumentModelGridRemoval::DocumentModelGridRemoval ( const Document & document )

Initial constructor from Document.

Definition at line 61 of file DocumentModelGridRemoval.cpp.

                                                                            :
   m_stable (document.modelGridRemoval().stable()),
   m_removeDefinedGridLines (document.modelGridRemoval().removeDefinedGridLines()),
   m_closeDistance (document.modelGridRemoval().closeDistance()),
   m_gridCoordDisableX (document.modelGridRemoval().gridCoordDisableX()),
   m_countX (document.modelGridRemoval().countX()),
   m_startX (document.modelGridRemoval().startX()),
   m_stepX (document.modelGridRemoval().stepX()),
   m_stopX (document.modelGridRemoval().stopX()),
   m_gridCoordDisableY (document.modelGridRemoval().gridCoordDisableY()),
   m_countY (document.modelGridRemoval().countY()),
   m_startY (document.modelGridRemoval().startY()),
   m_stepY (document.modelGridRemoval().stepY()),
   m_stopY (document.modelGridRemoval().stopY())
 {
 }

◆ DocumentModelGridRemoval() [4/4]

DocumentModelGridRemoval::DocumentModelGridRemoval ( const DocumentModelGridRemoval & other )

Copy constructor.

Definition at line 78 of file DocumentModelGridRemoval.cpp.

                                                                                         :
   m_stable (other.stable()),
   m_removeDefinedGridLines (other.removeDefinedGridLines()),
   m_closeDistance (other.closeDistance()),
   m_gridCoordDisableX (other.gridCoordDisableX()),
   m_countX (other.countX()),
   m_startX (other.startX()),
   m_stepX (other.stepX()),
   m_stopX (other.stopX()),
   m_gridCoordDisableY (other.gridCoordDisableX()),
   m_countY (other.countY()),
   m_startY (other.startY()),
   m_stepY (other.stepY()),
   m_stopY (other.stopY())
 {
 }

Member Function Documentation

◆ closeDistance()

double DocumentModelGridRemoval::closeDistance ( ) const

Get method for close distance.

Definition at line 114 of file DocumentModelGridRemoval.cpp.

 {
   return m_closeDistance;
 }

◆ countX()

int DocumentModelGridRemoval::countX ( ) const

Get method for x count.

Definition at line 119 of file DocumentModelGridRemoval.cpp.

 {
   return m_countX;
 }

◆ countY()

int DocumentModelGridRemoval::countY ( ) const

Get method for y count.

Definition at line 124 of file DocumentModelGridRemoval.cpp.

 {
   return m_countY;
 }

◆ gridCoordDisableX()

GridCoordDisable DocumentModelGridRemoval::gridCoordDisableX ( ) const

Get method for x coord parameter to disable.

Definition at line 129 of file DocumentModelGridRemoval.cpp.

 {
   return m_gridCoordDisableX;
 }

◆ gridCoordDisableY()

GridCoordDisable DocumentModelGridRemoval::gridCoordDisableY ( ) const

Get method for y coord parameter to disable.

Definition at line 134 of file DocumentModelGridRemoval.cpp.

 {
   return m_gridCoordDisableY;
 }

◆ loadXml()

void DocumentModelGridRemoval::loadXml ( QXmlStreamReader & reader )

virtual

Load model from serialized xml.

Implements DocumentModelAbstractBase.

Definition at line 139 of file DocumentModelGridRemoval.cpp.

 {
   LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelGridRemoval::loadXml";
 
   bool success = true;
 
   QXmlStreamAttributes attributes = reader.attributes();
 
   if (attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STABLE) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_DEFINED_GRID_LINES) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_CLOSE_DISTANCE) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_X) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_X) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_X) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_X) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_X) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_Y) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_Y) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_Y) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_Y) &&
       attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_Y)) {
 
     // Boolean values
     QString stableValue = attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_STABLE).toString();
     QString definedValue = attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_DEFINED_GRID_LINES).toString();
 
     setStable (stableValue == DOCUMENT_SERIALIZE_BOOL_TRUE);
     setRemoveDefinedGridLines (definedValue == DOCUMENT_SERIALIZE_BOOL_TRUE);
     setCloseDistance (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_CLOSE_DISTANCE).toDouble());
     setGridCoordDisableX (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_X).toInt()));
     setCountX (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_X).toInt());
     setStartX (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_X).toDouble());
     setStepX (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_X).toDouble());
     setStopX (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_X).toDouble());
     setGridCoordDisableY (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_Y).toInt()));
     setCountY (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_Y).toInt());
     setStartY (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_Y).toDouble());
     setStepY (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_Y).toDouble());
     setStopY (attributes.value(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_Y).toDouble());
 
     // Read until end of this subtree
     while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
     (reader.name() != DOCUMENT_SERIALIZE_GRID_REMOVAL)){
       loadNextFromReader(reader);
       if (reader.atEnd()) {
         success = false;
         break;
       }
     }
   }
 
   if (!success) {
     reader.raiseError (QObject::tr ("Cannot read grid removal data"));
   }
 }

◆ operator=()

DocumentModelGridRemoval & DocumentModelGridRemoval::operator= ( const DocumentModelGridRemoval & other )

Assignment constructor.

Definition at line 95 of file DocumentModelGridRemoval.cpp.

 {
   m_stable = other.stable();
   m_removeDefinedGridLines = other.removeDefinedGridLines();
   m_closeDistance = other.closeDistance();
   m_gridCoordDisableX = other.gridCoordDisableX();
   m_countX = other.countX();
   m_startX = other.startX();
   m_stepX = other.stepX();
   m_stopX = other.stopX();
   m_gridCoordDisableY = other.gridCoordDisableY();
   m_countY = other.countY();
   m_startY = other.startY();
   m_stepY = other.stepY();
   m_stopY = other.stopY();
 
   return *this;
 }

◆ printStream()

void DocumentModelGridRemoval::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 195 of file DocumentModelGridRemoval.cpp.

 {
   str << indentation << "DocumentModelGridRemoval\n";
 
   indentation += INDENTATION_DELTA;
 
   str << indentation << "stable=" << (m_stable ? "true" : "false") << "\n";
   str << indentation << "removeDefinedGridLines=" << (m_removeDefinedGridLines ? "true" : "false") << "\n";
   str << indentation << "closeDistance=" << m_closeDistance << "\n";
   str << indentation << "gridCoordDisableX=" << gridCoordDisableToString (m_gridCoordDisableX) << "\n";
   str << indentation << "countX=" << m_countX << "\n";
   str << indentation << "startX=" << m_startX << "\n";
   str << indentation << "stepX=" << m_stepX << "\n";
   str << indentation << "stopX=" << m_stopX << "\n";
   str << indentation << "gridCoordDisableY=" << gridCoordDisableToString (m_gridCoordDisableY) << "\n";
   str << indentation << "countY=" << m_countY << "\n";
   str << indentation << "startY=" << m_startY << "\n";
   str << indentation << "stepY=" << m_stepY << "\n";
   str << indentation << "stopY=" << m_stopY << "\n";
 }

◆ removeDefinedGridLines()

bool DocumentModelGridRemoval::removeDefinedGridLines ( ) const

Get method for removing defined grid lines.

Definition at line 217 of file DocumentModelGridRemoval.cpp.

 {
   return m_removeDefinedGridLines;
 }

◆ saveXml()

void DocumentModelGridRemoval::saveXml ( QXmlStreamWriter & writer ) const

virtual

Save entire model as xml into stream.

Implements DocumentModelAbstractBase.

Definition at line 222 of file DocumentModelGridRemoval.cpp.

 {
   LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelGridRemoval::saveXml";
 
   writer.writeStartElement(DOCUMENT_SERIALIZE_GRID_REMOVAL);
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STABLE, m_stable ?
                           DOCUMENT_SERIALIZE_BOOL_TRUE :
                           DOCUMENT_SERIALIZE_BOOL_FALSE);
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_DEFINED_GRID_LINES, m_removeDefinedGridLines ?
                           DOCUMENT_SERIALIZE_BOOL_TRUE :
                           DOCUMENT_SERIALIZE_BOOL_FALSE);
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_CLOSE_DISTANCE, QString::number (m_closeDistance));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_X, QString::number (m_gridCoordDisableX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_X_STRING, gridCoordDisableToString (m_gridCoordDisableX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_X, QString::number (m_countX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_X, QString::number (m_startX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_X, QString::number (m_stepX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_X, QString::number (m_stopX));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_Y, QString::number (m_gridCoordDisableY));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COORD_DISABLE_Y_STRING, gridCoordDisableToString (m_gridCoordDisableY));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_COUNT_Y, QString::number (m_countY));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_START_Y, QString::number (m_startY));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STEP_Y, QString::number (m_stepY));
   writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_REMOVAL_STOP_Y, QString::number (m_stopY));
 
   writer.writeEndElement();
 }

◆ setCloseDistance()

void DocumentModelGridRemoval::setCloseDistance ( double closeDistance )

Set method for close distance.

Definition at line 250 of file DocumentModelGridRemoval.cpp.

 {
   m_closeDistance = closeDistance;
 }

◆ setCountX()

void DocumentModelGridRemoval::setCountX ( int countX )

Set method for x count.

Definition at line 255 of file DocumentModelGridRemoval.cpp.

 {
   m_countX = countX;
 }

◆ setCountY()

void DocumentModelGridRemoval::setCountY ( int countY )

Set method for y count.

Definition at line 260 of file DocumentModelGridRemoval.cpp.

 {
   m_countY = countY;
 }

◆ setGridCoordDisableX()

void DocumentModelGridRemoval::setGridCoordDisableX ( GridCoordDisable gridCoordDisable )

Set method for x coord parameter to disable.

Definition at line 265 of file DocumentModelGridRemoval.cpp.

 {
   m_gridCoordDisableX = gridCoordDisable;
 }

◆ setGridCoordDisableY()

void DocumentModelGridRemoval::setGridCoordDisableY ( GridCoordDisable gridCoordDisable )

Set method for y coord parameter to disable.

Definition at line 270 of file DocumentModelGridRemoval.cpp.

 {
   m_gridCoordDisableY = gridCoordDisable;
 }

◆ setRemoveDefinedGridLines()

void DocumentModelGridRemoval::setRemoveDefinedGridLines ( bool removeDefinedGridLines )

Set method for removing defined grid lines.

Definition at line 275 of file DocumentModelGridRemoval.cpp.

 {
   m_removeDefinedGridLines = removeDefinedGridLines;
 }

◆ setStable()

void DocumentModelGridRemoval::setStable ( )

Set the stable flag to true. This public version has no argument since it cannot be undone.

Definition at line 280 of file DocumentModelGridRemoval.cpp.

 {
   m_stable = true;
 }

◆ setStartX()

void DocumentModelGridRemoval::setStartX ( double startX )

Set method for x start.

Definition at line 290 of file DocumentModelGridRemoval.cpp.

 {
   m_startX = startX;
 }

◆ setStartY()

void DocumentModelGridRemoval::setStartY ( double startY )

Set method for y start.

Definition at line 295 of file DocumentModelGridRemoval.cpp.

 {
   m_startY = startY;
 }

◆ setStepX()

void DocumentModelGridRemoval::setStepX ( double stepX )

Set method for x step.

Definition at line 300 of file DocumentModelGridRemoval.cpp.

 {
   m_stepX = stepX;
 }

◆ setStepY()

void DocumentModelGridRemoval::setStepY ( double stepY )

Set method for y step.

Definition at line 305 of file DocumentModelGridRemoval.cpp.

 {
   m_stepY = stepY;
 }

◆ setStopX()

void DocumentModelGridRemoval::setStopX ( double stopX )

Set method for x stop.

Definition at line 310 of file DocumentModelGridRemoval.cpp.

 {
   m_stopX = stopX;
 }

◆ setStopY()

void DocumentModelGridRemoval::setStopY ( double stopY )

Set method for y stop.

Definition at line 315 of file DocumentModelGridRemoval.cpp.

 {
   m_stopY = stopY;
 }

◆ stable()

bool DocumentModelGridRemoval::stable ( ) const

Get method for stable flag.

The flag is false to let the settings get automatically updated, until the user selects settings - at which point the stable flag is set to true

Definition at line 320 of file DocumentModelGridRemoval.cpp.

 {
   return m_stable;
 }

◆ startX()

double DocumentModelGridRemoval::startX ( ) const

Get method for x start.

Definition at line 325 of file DocumentModelGridRemoval.cpp.

 {
   return m_startX;
 }

◆ startY()

double DocumentModelGridRemoval::startY ( ) const

Get method for y start.

Definition at line 330 of file DocumentModelGridRemoval.cpp.

 {
   return m_startY;
 }

◆ stepX()

double DocumentModelGridRemoval::stepX ( ) const

Get method for x step.

Definition at line 335 of file DocumentModelGridRemoval.cpp.

 {
   return m_stepX;
 }

◆ stepY()

double DocumentModelGridRemoval::stepY ( ) const

Get method for y step.

Definition at line 340 of file DocumentModelGridRemoval.cpp.

 {
   return m_stepY;
 }

◆ stopX()

double DocumentModelGridRemoval::stopX ( ) const

Get method for x stop.

Definition at line 345 of file DocumentModelGridRemoval.cpp.

 {
   return m_stopX;
 }

◆ stopY()

double DocumentModelGridRemoval::stopY ( ) const

Get method for y stop.

Definition at line 350 of file DocumentModelGridRemoval.cpp.

 {
   return m_stopY;
 }

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

Document/DocumentModelGridRemoval.h
Document/DocumentModelGridRemoval.cpp

Public Member Functions