Curve Class Reference

Container for one set of digitized Points. More...

#include <Curve.h>

Collaboration diagram for Curve:

Public Member Functions
	Curve (const QString &curveName, const ColorFilterSettings &colorFilterSettings, const CurveStyle &curveStyle)
	Constructor from scratch.
	Curve (QDataStream &str)
	Constructor from serialized binary pre-version 6 file.
	Curve (QXmlStreamReader &reader)
	Constructor for use when loading from serialized xml.
	Curve (const Curve &curve)
	Copy constructor. Copying a Curve only helps for making a copy, since access to any Points inside must be via functor.
Curve &	operator= (const Curve &curve)
	Assignment constructor.
void	addPoint (const Point &point)
	Add Point to this Curve.
ColorFilterSettings	colorFilterSettings () const
	Return the color filter.
QString	curveName () const
	Name of this Curve.
CurveStyle	curveStyle () const
	Return the curve style.
void	editPointAxis (const QPointF &posGraph, const QString &identifier)
	Edit the graph coordinates of an axis point. This method does not apply to a graph point.
void	editPointGraph (bool isX, bool isY, double x, double y, const QStringList &identifiers, const Transformation &transformation)
	Edit the graph coordinates of one or more graph points. This method does not apply to an axis point.
void	exportToClipboard (const QHash< QString, bool > &selectedHash, const Transformation &transformation, QTextStream &strCsv, QTextStream &strHtml, CurvesGraphs &curvesGraphs) const
	Export points in this Curve found in the specified point list.
bool	isXOnly (const QString &pointIdentifier) const
	Determine if specified point has just x coordinate. Otherwise has just y coordinate, or both x and y coordinates.
void	iterateThroughCurvePoints (const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
	Apply functor to Points on Curve.
void	iterateThroughCurveSegments (const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
	Apply functor to successive Points, as line segments, on Curve. This could be a bit slow.
void	movePoint (const QString &pointIdentifier, const QPointF &deltaScreen)
	Translate the position of a point by the specified distance vector.
int	numPoints () const
	Number of points.
const Points	points () const
	Return a shallow copy of the Points.
QPointF	positionGraph (const QString &pointIdentifier) const
	Return the position, in graph coordinates, of the specified Point.
QPointF	positionScreen (const QString &pointIdentifier) const
	Return the position, in screen coordinates, of the specified Point.
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	removePoint (const QString &identifier)
	Perform the opposite of addPointAtEnd.
void	saveXml (QXmlStreamWriter &writer) const
	Serialize curve.
void	setColorFilterSettings (const ColorFilterSettings &colorFilterSettings)
	Set color filter.
void	setCurveName (const QString &curveName)
	Change the curve name.
void	setCurveStyle (const CurveStyle &curveStyle)
	Set curve style.
void	updatePointOrdinals (const Transformation &transformation)
	See CurveGraphs::updatePointOrdinals.

Detailed Description

Container for one set of digitized Points.

Definition at line 33 of file Curve.h.

Constructor & Destructor Documentation

Curve() [1/4]

Curve::Curve	(	const QString &	curveName,
		const ColorFilterSettings &	colorFilterSettings,
		const CurveStyle &	curveStyle )

Constructor from scratch.

Definition at line 36 of file Curve.cpp.

                                           :
  m_curveName (curveName),
  m_colorFilterSettings (colorFilterSettings),
  m_curveStyle (curveStyle)
{
}

Curve() [2/4]

Curve::Curve

(

QDataStream &

str

)

Constructor from serialized binary pre-version 6 file.

Definition at line 53 of file Curve.cpp.

{
  const int CONVERT_ENUM_TO_RADIUS = 6;
  MigrateToVersion6 migrate;
 
  qint32 int32, xScreen, yScreen;
  double xGraph, yGraph;
 
  str >> m_curveName;
 
  // Scale bar points are handled as if they are axis points
  if (m_curveName == SCALE_CURVE_NAME) {
    m_curveName = AXIS_CURVE_NAME;
  }
 
  str >> int32;
  m_curveStyle.setPointShape(migrate.pointShape (int32));
  str >> int32;
  m_curveStyle.setPointRadius(int32 + CONVERT_ENUM_TO_RADIUS);
  str >> int32;
  m_curveStyle.setPointLineWidth (int32);
  str >> int32;
  m_curveStyle.setPointColor(migrate.colorPalette (int32));
  str >> int32; // Point interior color
  str >> int32;
  m_curveStyle.setLineWidth(int32);
  str >> int32;
  if (m_curveName == AXIS_CURVE_NAME) {
    m_curveStyle.setLineColor(migrate.colorPalette (int32));
  } else {
    m_curveStyle.setLineColor(COLOR_PALETTE_TRANSPARENT);
  }
  str >> int32;
  m_curveStyle.setLineConnectAs(migrate.curveConnectAs (int32));
 
  str >> int32;
  int count = int32;
  int ordinal = 0;
  for (int i = 0; i < count; i++) {
 
    str >> xScreen;
    str >> yScreen;
    str >> xGraph;
    str >> yGraph;
    if (m_curveName == AXIS_CURVE_NAME) {
 
      // Axis point, with graph coordinates set by user and managed here
      Point point (m_curveName,
                   QPointF (xScreen, yScreen),
                   QPointF (xGraph, yGraph),
                   ordinal++,
                   false);
 
      addPoint(point);
    } else {
 
      // Curve point, with graph coordinates managed elsewhere
      Point point (m_curveName,
                   QPointF (xScreen, yScreen));
      point.setOrdinal (ordinal++);
 
      addPoint(point);
    }
  }
}

Curve() [3/4]

Curve::Curve

(

QXmlStreamReader &

reader

)

Constructor for use when loading from serialized xml.

Definition at line 119 of file Curve.cpp.

{
  loadXml(reader);
}

Curve() [4/4]

Curve::Curve

(

const Curve &

curve

)

Copy constructor. Copying a Curve only helps for making a copy, since access to any Points inside must be via functor.

Definition at line 45 of file Curve.cpp.

                                :
  m_curveName (curve.curveName ()),
  m_points (curve.points ()),
  m_colorFilterSettings (curve.colorFilterSettings ()),
  m_curveStyle (curve.curveStyle ())
{
}

Member Function Documentation

addPoint()

void Curve::addPoint

(

const Point &

point

)

Add Point to this Curve.

Definition at line 134 of file Curve.cpp.

{
  m_points.push_back (point);
}

colorFilterSettings()

ColorFilterSettings Curve::colorFilterSettings

(

)

const

Return the color filter.

Definition at line 139 of file Curve.cpp.

{
  return m_colorFilterSettings;
}

curveName()

QString Curve::curveName

(

)

const

Name of this Curve.

Definition at line 144 of file Curve.cpp.

{
  return  m_curveName;
}

curveStyle()

CurveStyle Curve::curveStyle

(

)

const

Return the curve style.

Definition at line 149 of file Curve.cpp.

{
  return m_curveStyle;
}

editPointAxis()

void Curve::editPointAxis	(	const QPointF &	posGraph,
		const QString &	identifier )

Edit the graph coordinates of an axis point. This method does not apply to a graph point.

Definition at line 154 of file Curve.cpp.

{
  // Search for the point with matching identifier
  QList<Point>::iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
 
    Point &point = *itr;
    if (point.identifier () == identifier) {
 
      point.setPosGraph (posGraph);
      break;
 
    }
  }
}

editPointGraph()

void Curve::editPointGraph	(	bool	isX,
		bool	isY,
		double	x,
		double	y,
		const QStringList &	identifiers,
		const Transformation &	transformation )

Edit the graph coordinates of one or more graph points. This method does not apply to an axis point.

Definition at line 171 of file Curve.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Curve::editPointGraph"
                              << " identifiers=" << identifiers.join(" ").toLatin1().data();
 
  if (transformation.transformIsDefined()) {
 
    // Search for the point with matching identifier
    QList<Point>::iterator itr;
    for (itr = m_points.begin(); itr != m_points.end(); itr++) {
 
      Point &point = *itr;
 
      if (identifiers.contains (point.identifier ())) {
 
        // Although one or more graph coordinates are specified, it is the screen coordinates that must be
        // moved. This is because only the screen coordinates of the graph points are tracked (not the graph coordinates).
        // So we compute posScreen and call Point::setPosScreen instead of Point::setPosGraph
 
        // Get original graph coordinates
        QPointF posScreen = point.posScreen ();
        QPointF posGraph;
        transformation.transformScreenToRawGraph (posScreen,
                                                  posGraph);
 
        // Override one or both coordinates
        if (isX) {
          posGraph.setX (x);
        }
 
        if (isY) {
          posGraph.setY (y);
        }
 
        // Set the screen coordinates
        transformation.transformRawGraphToScreen(posGraph,
                                                 posScreen);
 
        point.setPosScreen (posScreen);
      }
    }
  }
}

exportToClipboard()

void Curve::exportToClipboard	(	const QHash< QString, bool > &	selectedHash,
		const Transformation &	transformation,
		QTextStream &	strCsv,
		QTextStream &	strHtml,
		CurvesGraphs &	curvesGraphs ) const

Export points in this Curve found in the specified point list.

Definition at line 220 of file Curve.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Curve::exportToClipboard"
                              << " hashCount=" << selectedHash.count();
 
  // This method assumes Copy is only allowed when Transformation is valid
 
  bool isFirst = true;
  QList<Point>::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
 
    const Point &point = *itr;
    if (selectedHash.contains (point.identifier ())) {
 
      if (isFirst) {
 
        // Insert headers to identify the points that follow
        isFirst = false;
        strCsv << "X" << TAB_DELIMITER << m_curveName << "\n";
        strHtml << "<table>\n"
                << "<tr><th>X</th><th>" << m_curveName << "</th></tr>\n";
      }
 
      // Default curve style
      CurveStyle curveStyleDefault;
      curveStyleDefault.setLineStyle(LineStyle::defaultAxesCurve());
      curveStyleDefault.setPointStyle(PointStyle::defaultGraphCurve (curvesGraphs.numCurves ()));
 
      // Check if this curve already exists from a previously exported point
      if (curvesGraphs.curveForCurveName (m_curveName) == nullptr) {
        Curve curve(m_curveName,
                    ColorFilterSettings::defaultFilter (),
                    curveStyleDefault);
        curvesGraphs.addGraphCurveAtEnd(curve);
      }
 
      // Start with screen coordinates
      QPointF pos = point.posScreen();
      if (transformation.transformIsDefined()) {
 
        // Replace with graph coordinates which are almost always more useful
        QPointF posGraph;
        transformation.transformScreenToRawGraph(pos,
                                                 posGraph);
        pos = posGraph;
      }
 
      // Add point to text going to clipboard
      strCsv << pos.x() << TAB_DELIMITER << pos.y() << "\n";
      strHtml << "<tr><td>" << pos.x() << "</td><td>" << pos.y() << "</td></tr>\n";
 
      // Add point to list for undo/redo
      curvesGraphs.curveForCurveName (m_curveName)->addPoint (point);
    }
  }
 
  if (!isFirst) {
    strHtml << "</table>\n";
  }
}

isXOnly()

bool Curve::isXOnly

(

const QString &

pointIdentifier

)

const

Determine if specified point has just x coordinate. Otherwise has just y coordinate, or both x and y coordinates.

Definition at line 285 of file Curve.cpp.

{
  // Search for point with matching identifier
  Points::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    const Point &point = *itr;
    if (pointIdentifier == point.identifier ()) {
      return point.isXOnly();
    }
  }
 
  LOG4CPP_ERROR_S ((*mainCat)) << "Curve::isXOnly encountered unknown indentifier "
                               << pointIdentifier.toLatin1().data();
  ENGAUGE_ASSERT (false);
 
  return false;
}

iterateThroughCurvePoints()

void Curve::iterateThroughCurvePoints

(

const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &

ftorWithCallback

)

const

Apply functor to Points on Curve.

Definition at line 303 of file Curve.cpp.

{
  QList<Point>::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
 
    const Point &point = *itr;
 
    CallbackSearchReturn rtn = ftorWithCallback (m_curveName, point);
 
    if (rtn == CALLBACK_SEARCH_RETURN_INTERRUPT) {
      break;
    }
  }
}

iterateThroughCurveSegments()

void Curve::iterateThroughCurveSegments

(

const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &

ftorWithCallback

)

const

Apply functor to successive Points, as line segments, on Curve. This could be a bit slow.

Definition at line 318 of file Curve.cpp.

{
  // Loop through Points. They are assumed to be already sorted by their ordinals, but we do NOT
  // check the ordinal ordering since this could be called before, or while, the ordinal sorting is done
  QList<Point>::const_iterator itr;
  const Point *pointBefore = nullptr;
  for (itr = m_points.begin(); itr != m_points.end(); itr++) {
 
    const Point &point = *itr;
 
    if (pointBefore != nullptr) {
 
      CallbackSearchReturn rtn = ftorWithCallback (*pointBefore,
                                                   point);
 
      if (rtn == CALLBACK_SEARCH_RETURN_INTERRUPT) {
        break;
      }
 
    }
    pointBefore = &point;
  }
}

movePoint()

void Curve::movePoint	(	const QString &	pointIdentifier,
		const QPointF &	deltaScreen )

Translate the position of a point by the specified distance vector.

Definition at line 425 of file Curve.cpp.

{
  Point *point = pointForPointIdentifier (pointIdentifier);
 
  QPointF posScreen = deltaScreen + point->posScreen ();
  point->setPosScreen (posScreen);
}

numPoints()

int Curve::numPoints

(

)

const

Number of points.

Definition at line 434 of file Curve.cpp.

{
  return m_points.count ();
}

operator=()

Curve & Curve::operator=

(

const Curve &

curve

)

Assignment constructor.

Definition at line 124 of file Curve.cpp.

{
  m_curveName = curve.curveName ();
  m_points = curve.points ();
  m_colorFilterSettings = curve.colorFilterSettings ();
  m_curveStyle = curve.curveStyle ();
 
  return *this;
}

points()

const Points Curve::points

(

)

const

Return a shallow copy of the Points.

Definition at line 455 of file Curve.cpp.

{
  return m_points;
}

positionGraph()

QPointF Curve::positionGraph

(

const QString &

pointIdentifier

)

const

Return the position, in graph coordinates, of the specified Point.

Definition at line 460 of file Curve.cpp.

{
  QPointF posGraph;
 
  // Search for point with matching identifier
  Points::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    const Point &point = *itr;
    if (pointIdentifier == point.identifier ()) {
      posGraph = point.posGraph ();
      break;
    }
  }
 
  return posGraph;
}

positionScreen()

QPointF Curve::positionScreen

(

const QString &

pointIdentifier

)

const

Return the position, in screen coordinates, of the specified Point.

Definition at line 477 of file Curve.cpp.

{
  QPointF posScreen;
 
  // Search for point with matching identifier
  Points::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    const Point &point = *itr;
    if (pointIdentifier == point.identifier ()) {
      posScreen = point.posScreen ();
      break;
    }
  }
 
  return posScreen;
}

printStream()

void Curve::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 494 of file Curve.cpp.

{
  str << indentation << "Curve=" << m_curveName << "\n";
 
  indentation += INDENTATION_DELTA;
 
  Points::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    const Point &point = *itr;
    point.printStream (indentation, 
                       str);
  }
 
  m_colorFilterSettings.printStream (indentation,
                                     str);
  m_curveStyle.printStream (indentation,
                            str);
}

removePoint()

void Curve::removePoint

(

const QString &

identifier

)

Perform the opposite of addPointAtEnd.

Definition at line 514 of file Curve.cpp.

{
  // Search for point with matching identifier
  Points::iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    Point point = *itr;
    if (point.identifier () == identifier) {
      m_points.erase (itr);
      break;
    }
  }
}

saveXml()

void Curve::saveXml

(

QXmlStreamWriter &

writer

)

const

Serialize curve.

Definition at line 527 of file Curve.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "Curve::saveXml";
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_CURVE);
  writer.writeAttribute(DOCUMENT_SERIALIZE_CURVE_NAME, m_curveName);
  m_colorFilterSettings.saveXml (writer,
                                 m_curveName);
  m_curveStyle.saveXml (writer,
                        m_curveName);
 
  // Loop through points
  writer.writeStartElement(DOCUMENT_SERIALIZE_CURVE_POINTS);
  Points::const_iterator itr;
  for (itr = m_points.begin (); itr != m_points.end (); itr++) {
    const Point &point = *itr;
    point.saveXml (writer);
  }
  writer.writeEndElement();
 
  writer.writeEndElement();
}

setColorFilterSettings()

void Curve::setColorFilterSettings

(

const ColorFilterSettings &

colorFilterSettings

)

Set color filter.

Definition at line 550 of file Curve.cpp.

{
  m_colorFilterSettings = colorFilterSettings;
}

setCurveName()

void Curve::setCurveName

(

const QString &

curveName

)

Change the curve name.

Definition at line 555 of file Curve.cpp.

{
  m_curveName = curveName;
 
  // Pass to member objects
  QList<Point>::iterator itr;
  for (itr = m_points.begin(); itr != m_points.end(); itr++) {
    Point &point = *itr;
    point.setCurveName (curveName);
  }
}

setCurveStyle()

void Curve::setCurveStyle

(

const CurveStyle &

curveStyle

)

Set curve style.

Definition at line 567 of file Curve.cpp.

{
  m_curveStyle = curveStyle;
}

updatePointOrdinals()

void Curve::updatePointOrdinals

(

const Transformation &

transformation

)

See CurveGraphs::updatePointOrdinals.

Same algorithm as GraphicsLinesForCurve::updatePointOrdinalsAfterDrag, although graph coordinates of points have been updated before this is called so the graph coordinates are not updated by this method

Definition at line 572 of file Curve.cpp.

{
  CurveConnectAs curveConnectAs = m_curveStyle.lineStyle().curveConnectAs();
 
  LOG4CPP_INFO_S ((*mainCat)) << "Curve::updatePointOrdinals"
                              << " curve=" << m_curveName.toLatin1().data()
                              << " connectAs=" << curveConnectAsToString(curveConnectAs).toLatin1().data();
 
  // Make sure ordinals are properly ordered. Sorting is done afterward
 
  if (curveConnectAs == CONNECT_AS_FUNCTION_SMOOTH ||
      curveConnectAs == CONNECT_AS_FUNCTION_STRAIGHT) {
 
    updatePointOrdinalsFunctions (transformation);
 
  } else if (curveConnectAs == CONNECT_AS_RELATION_SMOOTH ||
             curveConnectAs == CONNECT_AS_RELATION_STRAIGHT) {
 
    updatePointOrdinalsRelations ();
 
  } else {
 
    LOG4CPP_ERROR_S ((*mainCat)) << "Curve::updatePointOrdinals encountered unexpected connection configuration";
    ENGAUGE_ASSERT (false);
 
  }
 
  std::sort (m_points.begin(),
             m_points.end(),
             PointComparator());
}

---

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

• Curve/Curve.h
• Curve/Curve.cpp