Point Class Reference

Class that represents one digitized point. The screen-to-graph coordinate transformation is always external to this class. More...

#include <Point.h>

Collaboration diagram for Point:

Public Member Functions
	Point ()
	Default constructor so this class can be used inside a container.
	Point (const QString &curveName, const QPointF &posScreen)
	Constructor for Checker temporary points, before real point gets added.
	Point (const QString &curveName, const QPointF &posScreen, const QPointF &posGraph, bool isXOnly)
	Constructor for temporary point used to pre-check transformation points, before real point gets added.
	Point (const QString &curveName, const QString &identifier, const QPointF &posScreen, const QPointF &posGraph, double ordinal, bool isXOnly)
	Constructor for axis points with identifier (after redo). The position, in screen coordinates, applies to the center of the Point.
	Point (const QString &curveName, const QPointF &posScreen, const QPointF &posGraph, double ordinal, bool isXOnly)
	Constructor for axis points without identifier (after redo). The position, in screen coordinates, applies to the center of the Point.
	Point (const QString &curveName, const QString &identifier, const QPointF &posScreen, double ordinal)
	Constructor for graph points with identifier (after redo).
	Point (const QString &curveName, const QPointF &posScreen, double ordinal)
	Constructor for graph points without identifier (after redo).
	Point (QXmlStreamReader &reader)
	Constructor when loading from serialized xml.
Point &	operator= (const Point &point)
	Assignment constructor.
	Point (const Point &point)
	Copy constructor.
bool	hasOrdinal () const
	True if ordinal is defined.
bool	hasPosGraph () const
	True if graph position is defined.
QString	identifier () const
	Unique identifier for a specific Point.
bool	isXOnly () const
	In DOCUMENT_AXES_POINTS_REQUIRED_4 modes, this is true/false if y/x coordinate is undefined.
bool	isAxisPoint () const
	True if point is an axis point. This is used only for sanity checks.
double	ordinal (ApplyHasCheck applyHasCheck=KEEP_HAS_CHECK) const
	Get method for ordinal. Skip check if copying one instance to another.
QPointF	posGraph (ApplyHasCheck applyHasCheck=KEEP_HAS_CHECK) const
	Accessor for graph position. Skip check if copying one instance to another.
QPointF	posScreen () const
	Accessor for screen position.
void	printStream (QString indentation, QTextStream &str) const
	Debugging method that supports print method of this class and printStream method of some other class(es).
void	saveXml (QXmlStreamWriter &writer) const
	Serialize to stream.
void	setCurveName (const QString &curveName)
	Update the point identifier to match the specified curve name.
void	setOrdinal (double ordinal)
	Set the ordinal used for ordering Points.
void	setPosGraph (const QPointF &posGraph)
	Set method for position in graph coordinates.
void	setPosScreen (const QPointF &posScreen)
	Set method for position in screen coordinates.

Static Public Member Functions
static QString	curveNameFromPointIdentifier (const QString &pointIdentifier)
	Parse the curve name from the specified point identifier. This does the opposite of uniqueIdentifierGenerator.
static unsigned int	identifierIndex ()
	Return the current index for storage in case we need to reset it later while performing a Redo.
static void	setIdentifierIndex (unsigned int identifierIndex)
	Reset the current index while performing a Redo.
static QString	temporaryPointIdentifier ()
	Point identifier for temporary point that is used by DigitzeStateAxis.
static double	UNDEFINED_ORDINAL ()
	Get method for undefined ordinal constant.

Detailed Description

Class that represents one digitized point. The screen-to-graph coordinate transformation is always external to this class.

Definition at line 25 of file Point.h.

Constructor & Destructor Documentation

Point() [1/9]

Point::Point

(

)

Default constructor so this class can be used inside a container.

Definition at line 29 of file Point.cpp.

{
}

Point() [2/9]

Point::Point	(	const QString &	curveName,
		const QPointF &	posScreen )

Constructor for Checker temporary points, before real point gets added.

The position, in screen coordinates, applies to the center of the Point

Definition at line 33 of file Point.cpp.

                                       :
  m_isAxisPoint (curveName == AXIS_CURVE_NAME),
  m_identifier (uniqueIdentifierGenerator(curveName)),
  m_posScreen (posScreen),
  m_hasPosGraph (false),
  m_posGraph (MISSING_POSGRAPH_VALUE, MISSING_POSGRAPH_VALUE),
  m_hasOrdinal (false),
  m_ordinal (MISSING_ORDINAL_VALUE),
  m_isXOnly (false)
{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point"
                               << " curveName=" << curveName.toLatin1().data()
                               << " identifierGenerated=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data();
 
  ENGAUGE_ASSERT (!curveName.isEmpty ());
}

Point() [3/9]

Point::Point	(	const QString &	curveName,
		const QPointF &	posScreen,
		const QPointF &	posGraph,
		bool	isXOnly )

Constructor for temporary point used to pre-check transformation points, before real point gets added.

The position, in screen coordinates, applies to the center of the Point

Definition at line 52 of file Point.cpp.

                           :
  m_isAxisPoint (true),
  m_identifier (uniqueIdentifierGenerator(curveName)),
  m_posScreen (posScreen),
  m_hasPosGraph (true),
  m_posGraph (posGraph),
  m_hasOrdinal (false),
  m_ordinal (MISSING_ORDINAL_VALUE),
  m_isXOnly (isXOnly)
{
  ENGAUGE_ASSERT (curveName == AXIS_CURVE_NAME ||
                  curveName == DUMMY_CURVE_NAME);
 
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point"
                               << " curveName=" << curveName.toLatin1().data()
                               << " identifierGenerated=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data()
                               << " posGraph=" << QPointFToString (posGraph).toLatin1().data()
                               << " isXOnly=" << (isXOnly ? "true" : "false");
 
  ENGAUGE_ASSERT (!curveName.isEmpty ());
}

Point() [4/9]

Point::Point	(	const QString &	curveName,
		const QString &	identifier,
		const QPointF &	posScreen,
		const QPointF &	posGraph,
		double	ordinal,
		bool	isXOnly )

Constructor for axis points with identifier (after redo). The position, in screen coordinates, applies to the center of the Point.

Definition at line 78 of file Point.cpp.

                           :
  m_isAxisPoint (true),
  m_identifier (identifier),
  m_posScreen (posScreen),
  m_hasPosGraph (true),
  m_posGraph (posGraph),
  m_hasOrdinal (true),
  m_ordinal (ordinal),
  m_isXOnly (isXOnly)
{
  ENGAUGE_ASSERT (curveName == AXIS_CURVE_NAME);
 
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point"
                               << " curveName=" << curveName.toLatin1().data()
                               << " identifier=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data()
                               << " posGraph=" << QPointFToString (posGraph).toLatin1().data()
                               << " ordinal=" << ordinal
                               << " isXOnly=" << (isXOnly ? "true" : "false");
 
  ENGAUGE_ASSERT (!curveName.isEmpty ());
}

Point() [5/9]

Point::Point	(	const QString &	curveName,
		const QPointF &	posScreen,
		const QPointF &	posGraph,
		double	ordinal,
		bool	isXOnly )

Constructor for axis points without identifier (after redo). The position, in screen coordinates, applies to the center of the Point.

Definition at line 106 of file Point.cpp.

                           :
  m_isAxisPoint (true),
  m_identifier (uniqueIdentifierGenerator(curveName)),
  m_posScreen (posScreen),
  m_hasPosGraph (true),
  m_posGraph (posGraph),
  m_hasOrdinal (true),
  m_ordinal (ordinal),
  m_isXOnly (isXOnly)
{
  ENGAUGE_ASSERT (curveName == AXIS_CURVE_NAME);
 
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point"
                               << " curveName=" << curveName.toLatin1().data()
                               << " identifierGenerated=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data()
                               << " posGraph=" << QPointFToString (posGraph).toLatin1().data()
                               << " ordinal=" << ordinal
                               << " isXOnly=" << (isXOnly ? "true" : "false");
 
  ENGAUGE_ASSERT (!curveName.isEmpty ());
}

Point() [6/9]

Point::Point	(	const QString &	curveName,
		const QString &	identifier,
		const QPointF &	posScreen,
		double	ordinal )

Constructor for graph points with identifier (after redo).

Definition at line 133 of file Point.cpp.

                             :
  m_isAxisPoint (false),
  m_identifier (identifier),
  m_posScreen (posScreen),
  m_hasPosGraph (false),
  m_posGraph (MISSING_POSGRAPH_VALUE, MISSING_POSGRAPH_VALUE),
  m_hasOrdinal (true),
  m_ordinal (ordinal),
  m_isXOnly (false)
{
  ENGAUGE_ASSERT (curveName != AXIS_CURVE_NAME);
 
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point"
                               << " curveName=" << curveName.toLatin1().data()
                               << " identifier=" << identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data()
                               << " ordinal=" << ordinal;
 
  ENGAUGE_ASSERT (!curveName.isEmpty ());
}

Point() [7/9]

Point::Point	(	const QString &	curveName,
		const QPointF &	posScreen,
		double	ordinal )

Constructor for graph points without identifier (after redo).

Definition at line 157 of file Point.cpp.

                              :
  m_isAxisPoint (false),
  m_identifier (uniqueIdentifierGenerator(curveName)),
  m_posScreen (posScreen),
  m_hasPosGraph (false),
  m_posGraph (MISSING_POSGRAPH_VALUE, MISSING_POSGRAPH_VALUE),
  m_hasOrdinal (true),
  m_ordinal (ordinal),
  m_isXOnly (false)
{
  ENGAUGE_ASSERT (curveName != AXIS_CURVE_NAME);
 
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point(identifier,posScreen,posGraph,ordinal)"
                               << " identifierGenerated=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString (posScreen).toLatin1().data()
                               << " ordinal=" << ordinal;
}

Point() [8/9]

Point::Point

(

QXmlStreamReader &

reader

)

Constructor when loading from serialized xml.

Definition at line 177 of file Point.cpp.

{
  loadXml(reader);
}

Point() [9/9]

Point::Point

(

const Point &

point

)

Copy constructor.

Definition at line 182 of file Point.cpp.

{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::Point(const Point &other)"
                               << " isAxisPoint=" << (other.isAxisPoint() ? "true" : "false")
                               << " identifier=" << other.identifier ().toLatin1().data()
                               << " posScreen=" << QPointFToString (other.posScreen ()).toLatin1().data()
                               << " hasPosGraph=" << (other.hasPosGraph() ? "true" : "false")
                               << " posGraph=" << QPointFToString (other.posGraph (SKIP_HAS_CHECK)).toLatin1().data()
                               << " hasOrdinal=" << (other.hasOrdinal() ? "true" : "false")
                               << " ordinal=" << other.ordinal (SKIP_HAS_CHECK)
                               << " isXOnly=" << other.isXOnly ();
 
  m_isAxisPoint = other.isAxisPoint ();
  m_identifier = other.identifier ();
  m_posScreen = other.posScreen ();
  m_hasPosGraph = other.hasPosGraph ();
  m_posGraph = other.posGraph (SKIP_HAS_CHECK);
  m_hasOrdinal = other.hasOrdinal ();
  m_ordinal = other.ordinal (SKIP_HAS_CHECK);
  m_isXOnly = other.isXOnly ();
}

Member Function Documentation

curveNameFromPointIdentifier()

QString Point::curveNameFromPointIdentifier ( const QString & pointIdentifier )

static

Parse the curve name from the specified point identifier. This does the opposite of uniqueIdentifierGenerator.

Definition at line 227 of file Point.cpp.

{
  QStringList tokens;
 
  if (pointIdentifier.contains (POINT_IDENTIFIER_DELIMITER_SAFE)) {
 
    tokens = pointIdentifier.split (POINT_IDENTIFIER_DELIMITER_SAFE);
 
  } else {
 
    // Yes, this is a hack - underscores could have been inserted by user (in the curve name) and/or this source code,
    // but there are many dig files laying around that have underscores so we need to support them
    tokens = pointIdentifier.split (POINT_IDENTIFIER_DELIMITER_XML);
 
  }
 
  return tokens.value (0);
}

hasOrdinal()

bool Point::hasOrdinal

(

)

const

True if ordinal is defined.

Definition at line 258 of file Point.cpp.

{
  return m_hasOrdinal;
}

hasPosGraph()

bool Point::hasPosGraph

(

)

const

True if graph position is defined.

Definition at line 263 of file Point.cpp.

{
  return m_hasPosGraph;
}

identifier()

QString Point::identifier

(

)

const

Unique identifier for a specific Point.

Definition at line 268 of file Point.cpp.

{
  return m_identifier;
}

identifierIndex()

unsigned int Point::identifierIndex ( )

static

Return the current index for storage in case we need to reset it later while performing a Redo.

Definition at line 273 of file Point.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Point::identifierIndex"
                              << " identifierIndex=" << m_identifierIndex;
 
  return m_identifierIndex;
}

isAxisPoint()

bool Point::isAxisPoint

(

)

const

True if point is an axis point. This is used only for sanity checks.

Definition at line 281 of file Point.cpp.

{
  return m_isAxisPoint;
}

isXOnly()

bool Point::isXOnly

(

)

const

In DOCUMENT_AXES_POINTS_REQUIRED_4 modes, this is true/false if y/x coordinate is undefined.

Definition at line 286 of file Point.cpp.

{
  return m_isXOnly;
}

operator=()

Point & Point::operator=

(

const Point &

point

)

Assignment constructor.

Definition at line 204 of file Point.cpp.

{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::operator="
                               << " isAxisPoint=" << (point.isAxisPoint() ? "true" : "false")
                               << " identifier=" << point.identifier ().toLatin1().data()
                               << " posScreen=" << QPointFToString (point.posScreen ()).toLatin1().data()
                               << " hasPosGraph=" << (point.hasPosGraph() ? "true" : "false")
                               << " posGraph=" << QPointFToString (point.posGraph (SKIP_HAS_CHECK)).toLatin1().data()
                               << " hasOrdinal=" << (point.hasOrdinal() ? "true" : "false")
                               << " ordinal=" << point.ordinal (SKIP_HAS_CHECK);
 
  m_isAxisPoint = point.isAxisPoint ();
  m_identifier = point.identifier ();
  m_posScreen = point.posScreen ();
  m_hasPosGraph = point.hasPosGraph ();
  m_posGraph = point.posGraph (SKIP_HAS_CHECK);
  m_hasOrdinal = point.hasOrdinal ();
  m_ordinal = point.ordinal (SKIP_HAS_CHECK);
  m_isXOnly = point.isXOnly ();
 
  return *this;
}

ordinal()

double Point::ordinal

(

ApplyHasCheck

applyHasCheck = KEEP_HAS_CHECK

)

const

Get method for ordinal. Skip check if copying one instance to another.

Definition at line 386 of file Point.cpp.

{
  if (applyHasCheck == KEEP_HAS_CHECK) {
    ENGAUGE_ASSERT (m_hasOrdinal);
  }
 
  return m_ordinal;
}

posGraph()

QPointF Point::posGraph

(

ApplyHasCheck

applyHasCheck = KEEP_HAS_CHECK

)

const

Accessor for graph position. Skip check if copying one instance to another.

Definition at line 395 of file Point.cpp.

{
  if (applyHasCheck == KEEP_HAS_CHECK) {
    ENGAUGE_ASSERT (m_hasPosGraph);
  }
 
  return m_posGraph;
}

posScreen()

QPointF Point::posScreen

(

)

const

Accessor for screen position.

Definition at line 404 of file Point.cpp.

{
  return m_posScreen;
}

printStream()

void Point::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 409 of file Point.cpp.

{
  const QString UNDEFINED ("undefined");
 
  str << indentation << "Point\n";
 
  indentation += INDENTATION_DELTA;
 
  str << indentation << "identifier=" << m_identifier << "\n";
  str << indentation << "posScreen=" << QPointFToString (m_posScreen) << "\n";
  if (m_hasPosGraph) {
    str << indentation << "posGraph=" << QPointFToString (m_posGraph) << "\n";
  } else {
    str << indentation << "posGraph=" << UNDEFINED << "\n";
  }
  if (m_hasOrdinal) {
    str << indentation << "ordinal=" << m_ordinal << "\n";
  } else {
    str << indentation << "ordinal=" << UNDEFINED << "\n";
  }
}

saveXml()

void Point::saveXml

(

QXmlStreamWriter &

writer

)

const

Serialize to stream.

Definition at line 432 of file Point.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Point::saveXml";
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_POINT);
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_IDENTIFIER, m_identifier);
  if (m_hasOrdinal) {
    writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_ORDINAL, QString::number (m_ordinal));
  }
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_IS_AXIS_POINT,
                        m_isAxisPoint ? DOCUMENT_SERIALIZE_BOOL_TRUE : DOCUMENT_SERIALIZE_BOOL_FALSE);
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_IS_X_ONLY,
                        m_isXOnly ? DOCUMENT_SERIALIZE_BOOL_TRUE : DOCUMENT_SERIALIZE_BOOL_FALSE);
 
  // Variable m_identifierIndex is static, but for simplicity this is handled like other values. Those values are all
  // the same, but simplicity wins over a few extra bytes of storage
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_IDENTIFIER_INDEX, QString::number (m_identifierIndex));
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_POINT_POSITION_SCREEN);
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_X, QString::number (m_posScreen.x()));
  writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_Y, QString::number (m_posScreen.y()));
  writer.writeEndElement();
 
  if (m_hasPosGraph) {
 
    // For time coordinates, many digits of precision are needed since a typical date is 1,246,870,000 = July 6, 2009
    // and we want seconds of precision
    const char FORMAT = 'g';
    const int PRECISION = 16;
 
    writer.writeStartElement(DOCUMENT_SERIALIZE_POINT_POSITION_GRAPH);
    writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_X, QString::number (m_posGraph.x(), FORMAT, PRECISION));
    writer.writeAttribute(DOCUMENT_SERIALIZE_POINT_Y, QString::number (m_posGraph.y(), FORMAT, PRECISION));
    writer.writeEndElement();
  }
 
  writer.writeEndElement();
}

setCurveName()

void Point::setCurveName

(

const QString &

curveName

)

Update the point identifier to match the specified curve name.

Definition at line 471 of file Point.cpp.

{
  // Replace the old curve name at the start of the string
  QString curveNameOld = Point::curveNameFromPointIdentifier (m_identifier);
  m_identifier = curveNameNew  + m_identifier.mid (curveNameOld.length());
}

setIdentifierIndex()

void Point::setIdentifierIndex ( unsigned int identifierIndex )

static

Reset the current index while performing a Redo.

Definition at line 478 of file Point.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Point::setIdentifierIndex"
                              << " identifierIndex=" << identifierIndex;
 
  m_identifierIndex = identifierIndex;
}

setOrdinal()

void Point::setOrdinal

(

double

ordinal

)

Set the ordinal used for ordering Points.

Definition at line 486 of file Point.cpp.

{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::setOrdinal"
                               << " identifier=" << m_identifier.toLatin1().data()
                               << " ordinal=" << ordinal;
 
  m_hasOrdinal = true;
  m_ordinal = ordinal;
}

setPosGraph()

void Point::setPosGraph

(

const QPointF &

posGraph

)

Set method for position in graph coordinates.

Definition at line 496 of file Point.cpp.

{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::setPosGraph"
                               << " identifier=" << m_identifier.toLatin1().data()
                               << " posGraph=" << QPointFToString(posGraph).toLatin1().data();
 
  // Curve point graph coordinates should always be computed on the fly versus stored in this class, to reduce the
  // chances for stale information
  ENGAUGE_ASSERT (m_isAxisPoint);
 
  m_hasPosGraph = true;
  m_posGraph = posGraph;
}

setPosScreen()

void Point::setPosScreen

(

const QPointF &

posScreen

)

Set method for position in screen coordinates.

Definition at line 510 of file Point.cpp.

{
  LOG4CPP_DEBUG_S ((*mainCat)) << "Point::setPosScreen"
                               << " identifier=" << m_identifier.toLatin1().data()
                               << " posScreen=" << QPointFToString(posScreen).toLatin1().data();
 
  m_posScreen = posScreen;
}

temporaryPointIdentifier()

QString Point::temporaryPointIdentifier ( )

static

Point identifier for temporary point that is used by DigitzeStateAxis.

Definition at line 519 of file Point.cpp.

{
  return QString ("%1%2%3")
      .arg (AXIS_CURVE_NAME)
      .arg (POINT_IDENTIFIER_DELIMITER_SAFE)
      .arg (0);
}

UNDEFINED_ORDINAL()

double Point::UNDEFINED_ORDINAL ( )

inlinestatic

Get method for undefined ordinal constant.

Definition at line 134 of file Point.h.

{ return -1.0; }

---

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

• Point/Point.h
• Point/Point.cpp