CurvesGraphs Class Reference

Container for all graph curves. The axes point curve is external to this class. More...

#include <CurvesGraphs.h>

Collaboration diagram for CurvesGraphs:

Public Member Functions
	CurvesGraphs ()
void	addGraphCurveAtEnd (const Curve &curve)
	Append new graph Curve to end of Curve list. More...
void	addPoint (const Point &point)
	Append new Point to the specified Curve. More...
Curve *	curveForCurveName (const QString &curveName)
	Return the axis or graph curve for the specified curve name. More...
const Curve *	curveForCurveName (const QString &curveName) const
	Return the axis or graph curve for the specified curve name. More...
QStringList	curvesGraphsNames () const
	List of graph curve names. More...
int	curvesGraphsNumPoints (const QString &curveName) const
	Point count. More...
void	editPointGraph (bool isX, bool isY, double x, double y, const QStringList &identifiers, const Transformation &transformation)
	Set the x and/or y coordinate values of the specified points. More...
void	iterateThroughCurvePoints (const QString &curveNameWanted, const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
	Apply functor to Points in the specified axis or graph Curve. More...
void	iterateThroughCurveSegments (const QString &curveNameWanted, const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
	Apply functor to segments on the specified axis or graph Curve. More...
void	iterateThroughCurvesPoints (const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
	Apply functor to Points on all of the Curves. More...
void	iterateThroughCurvesPoints (const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
	Apply functor to Points on all of the Curves. More...
void	loadPreVersion6 (QDataStream &str)
	Load from serialized binary pre-version 6 file. More...
void	loadXml (QXmlStreamReader &reader)
	Load from serialized xml post-version 5 file. More...
int	numCurves () const
	Current number of graphs curves. 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...
void	removePoint (const QString &pointIdentifier)
	Remove the Point from its Curve. More...
void	saveXml (QXmlStreamWriter &writer) const
	Serialize curves. More...
void	updatePointOrdinals (const Transformation &transformation)
	Update point ordinals to be consistent with their CurveStyle and x/theta coordinate. More...

Detailed Description

Container for all graph curves. The axes point curve is external to this class.

Definition at line 24 of file CurvesGraphs.h.

Constructor & Destructor Documentation

CurvesGraphs()

CurvesGraphs::CurvesGraphs

(

)

Definition at line 20 of file CurvesGraphs.cpp.

{
}

Member Function Documentation

addGraphCurveAtEnd()

void CurvesGraphs::addGraphCurveAtEnd

(

const Curve &

curve

)

Append new graph Curve to end of Curve list.

Definition at line 24 of file CurvesGraphs.cpp.

{
  m_curvesGraphs.push_back (curve);
}

addPoint()

void CurvesGraphs::addPoint

(

const Point &

point

)

Append new Point to the specified Curve.

Definition at line 29 of file CurvesGraphs.cpp.

{
  QString curveName = Point::curveNameFromPointIdentifier (point.identifier());

  Curve *curve = curveForCurveName (curveName);
  curve->addPoint (point);
}

curveForCurveName() [1/2]

Curve * CurvesGraphs::curveForCurveName

(

const QString &

curveName

)

Return the axis or graph curve for the specified curve name.

Definition at line 37 of file CurvesGraphs.cpp.

{
  // Search for curve with matching name
  CurveList::iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    Curve &curve = *itr;
    if (curveName == curve.curveName ()) {
      return &curve;
    }
  }

  return nullptr;
}

curveForCurveName() [2/2]

const Curve * CurvesGraphs::curveForCurveName

(

const QString &

curveName

)

const

Return the axis or graph curve for the specified curve name.

Definition at line 52 of file CurvesGraphs.cpp.

{
  // Search for curve with matching name
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    if (curveName == curve.curveName ()) {
      return &curve;
    }
  }

  return nullptr;
}

curvesGraphsNames()

QStringList CurvesGraphs::curvesGraphsNames

(

)

const

List of graph curve names.

Definition at line 67 of file CurvesGraphs.cpp.

{
  QStringList names;

  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    names << curve.curveName ();
  }

  return names;
}

curvesGraphsNumPoints()

int CurvesGraphs::curvesGraphsNumPoints

(

const QString &

curveName

)

const

Point count.

Definition at line 81 of file CurvesGraphs.cpp.

{
  // Search for curve with matching name
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    if (curve.curveName () == curveName) {
      return curve.numPoints ();
    }
  }

  return 0;
}

editPointGraph()

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

Set the x and/or y coordinate values of the specified points.

Definition at line 96 of file CurvesGraphs.cpp.

{
  CurveList::iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    Curve &curve = *itr;
    curve.editPointGraph (isX,
                          isY,
                          x,
                          y,
                          identifiers,
                          transformation);
  }
}

iterateThroughCurvePoints()

void CurvesGraphs::iterateThroughCurvePoints	(	const QString &	curveNameWanted,
		const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &	ftorWithCallback
	)

Apply functor to Points in the specified axis or graph Curve.

Definition at line 116 of file CurvesGraphs.cpp.

{
  // Search for curve with matching name
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    if (curve.curveName () == curveNameWanted) {

      curve.iterateThroughCurvePoints (ftorWithCallback);
      return;
    }
  }

  ENGAUGE_ASSERT (false);
}

iterateThroughCurveSegments()

void CurvesGraphs::iterateThroughCurveSegments	(	const QString &	curveNameWanted,
		const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &	ftorWithCallback
	)		const

Apply functor to segments on the specified axis or graph Curve.

Definition at line 134 of file CurvesGraphs.cpp.

{
  // Search for curve with matching name
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    if (curve.curveName () == curveNameWanted) {

      curve.iterateThroughCurveSegments (ftorWithCallback);
      return;
    }
  }

  ENGAUGE_ASSERT (false);
}

iterateThroughCurvesPoints() [1/2]

void CurvesGraphs::iterateThroughCurvesPoints

(

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

ftorWithCallback

)

Apply functor to Points on all of the Curves.

Definition at line 152 of file CurvesGraphs.cpp.

{
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    curve.iterateThroughCurvePoints (ftorWithCallback);
  }
}

iterateThroughCurvesPoints() [2/2]

void CurvesGraphs::iterateThroughCurvesPoints

(

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

ftorWithCallback

)

const

Apply functor to Points on all of the Curves.

Definition at line 162 of file CurvesGraphs.cpp.

{
  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    curve.iterateThroughCurvePoints (ftorWithCallback);
  }
}

loadPreVersion6()

void CurvesGraphs::loadPreVersion6

(

QDataStream &

str

)

Load from serialized binary pre-version 6 file.

Definition at line 172 of file CurvesGraphs.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "CurvesGraphs::loadPreVersion6";

  int i;

  // Remove previous Curves. There is a DEFAULT_GRAPH_CURVE_NAME by default
  m_curvesGraphs.clear();

  qint32 numberCurvesGraphs;
  str >> numberCurvesGraphs;
  for (i = 0; i < numberCurvesGraphs; i++) {
    Curve curve (str);
    m_curvesGraphs.append (curve);
  }

  qint32 numberCurvesMeasures;
  str >> numberCurvesMeasures;
  for (i = 0; i < numberCurvesMeasures; i++) {
    Curve curve (str);

    // Measures get dropped on the floor
  }
}

loadXml()

void CurvesGraphs::loadXml

(

QXmlStreamReader &

reader

)

Load from serialized xml post-version 5 file.

Definition at line 197 of file CurvesGraphs.cpp.

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

  bool success = true;

  // Remove previous Curves. There is a DEFAULT_GRAPH_CURVE_NAME by default
  m_curvesGraphs.clear();

  // Read until end of this subtree
  while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
  (reader.name() != DOCUMENT_SERIALIZE_CURVES_GRAPHS)){

    loadNextFromReader(reader);
    if (reader.atEnd()) {
      success = false;
      break;
    }

    if ((reader.tokenType() == QXmlStreamReader::StartElement) &&
        (reader.name () == DOCUMENT_SERIALIZE_CURVE)) {

      Curve curve (reader);

      // Version 6 of Engauge let users create multiple curves with the same name. Reading a file with duplicate
      // curve names can result in crashes and/or corruption, so we deconflict duplicate curve names here
      QString DUPLICATE = QString ("-%1").arg (QObject::tr ("DUPLICATE"));
      QString curveName = curve.curveName();
      while (curvesGraphsNames().contains (curveName)) {
        curveName += DUPLICATE;
      }
      curve.setCurveName (curveName); // No effect if curve name was not a duplicate

      // Add the curve
      m_curvesGraphs.push_back (curve);

    }
  }

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

numCurves()

int CurvesGraphs::numCurves

(

)

const

Current number of graphs curves.

Definition at line 241 of file CurvesGraphs.cpp.

{
  return m_curvesGraphs.count ();
}

printStream()

void CurvesGraphs::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 246 of file CurvesGraphs.cpp.

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

  indentation += INDENTATION_DELTA;

  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    curve.printStream (indentation,
                       str);
  }
}

removePoint()

void CurvesGraphs::removePoint

(

const QString &

pointIdentifier

)

Remove the Point from its Curve.

Definition at line 262 of file CurvesGraphs.cpp.

{
  QString curveName = Point::curveNameFromPointIdentifier(pointIdentifier);

  Curve *curve = curveForCurveName (curveName);
  curve->removePoint (pointIdentifier);
}

saveXml()

void CurvesGraphs::saveXml

(

QXmlStreamWriter &

writer

)

const

Serialize curves.

Definition at line 270 of file CurvesGraphs.cpp.

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

  writer.writeStartElement(DOCUMENT_SERIALIZE_CURVES_GRAPHS);

  CurveList::const_iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    const Curve &curve = *itr;
    curve.saveXml (writer);
  }

  writer.writeEndElement();
}

updatePointOrdinals()

void CurvesGraphs::updatePointOrdinals

(

const Transformation &

transformation

)

Update point ordinals to be consistent with their CurveStyle and x/theta coordinate.

Definition at line 286 of file CurvesGraphs.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "CurvesGraphs::updatePointOrdinals";

  CurveList::iterator itr;
  for (itr = m_curvesGraphs.begin (); itr != m_curvesGraphs.end (); itr++) {

    Curve &curve = *itr;
    curve.updatePointOrdinals (transformation);
  }
}

---

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

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