XMLClass is a parser for a simplified XML syntax. More...

#include <XMLClass.h>

Inheritance diagram for QGpCoreTools::XMLClass:

Public Types
enum	Error { NoError, ErrorFileNotOpen, ErrorWritingFile, ErrorNoDocType, ErrorNoVersion, ErrorUnmatchedAmpSemiColon, ErrorUnknowSpecialCharacter, ErrorEmptyTag, ErrorUnmatchedTag, ErrorUnmatchedTopLevelTag, ErrorEmptyContextStack, ErrorParsingContent, ErrorParsingAttributes, ErrorSettingAttributes, ErrorSettingBinaryData, ErrorWrongBinaryOffset, ErrorWrongBinaryTag, ErrorBinaryFileNotFound, ErrorEndTruncatedTag, ErrorEndTruncatedString, ErrorEndTruncatedContext, ErrorEndStillInside, ErrorEndTagNotFound }
enum	FileType { TarFile, XmlFile }
Public Member Functions
XMLClass::Error	restore (const QChar &ptr, int &line, XMLStream s, XMLContext *context)
void	writeBinaryData (XMLStream &s, XMLContext *context) const
virtual void	xml_attributes (XML_ATTRIBUTES_ARGS) const
virtual bool	xml_inherits (const QString &tagName) const
virtual XMLMember	xml_member (XML_MEMBER_ARGS)
virtual void	xml_polish (XML_POLISH_ARGS)
virtual void	xml_polishChild (XML_POLISHCHILD_ARGS)
virtual bool	xml_polished (XML_POLISHED_ARGS)
void	xml_save (XMLStream &s, XMLContext *context, const XMLSaveAttributes &attributes=nullSaveAttributes) const
virtual bool	xml_setAttributes (XML_SETATTRIBUTES_ARGS)
virtual bool	xml_setBinaryData (XML_SETBINARYDATA_ARGS)
virtual bool	xml_setBinaryData200411 (XML_SETBINARYDATA_ARGS)
virtual bool	xml_setProperty (XML_SETPROPERTY_ARGS)
virtual const QString &	xml_tagName () const =0
virtual void	xml_writeBinaryData (XML_WRITEBINARYDATA_ARGS) const
virtual void	xml_writeChildren (XML_WRITECHILDREN_ARGS) const
virtual void	xml_writeProperties (XML_WRITEPROPERTIES_ARGS) const
	XMLClass ()
virtual	~XMLClass ()
Static Public Member Functions
static QString	message (Error err, const QString &file=QString::null, int line=0)
static QString	saveSpecChar (QString content)
static void	skipBlanks (const QChar *&ptr, int &line)
static void	writeChildren (XMLStream &s, QString name, QString children)
static void	writeChildren (XMLStream &s, QString name, const XMLSaveAttributes &attributes, QString children)
static void	writeProperty (XMLStream &s, QString name, const XMLSaveAttributes &attributes)
Static Public Attributes
static const QString	binData200510Tag = "binDataOffset"
static const QString	binDataTag = "binDataFile"
static const QString	closeBeginTagStr = "</"
static const QString	closeEndTagStr = "/>"
static const QString	endTagStr = ">"
static const QString	falseStr = "false"
static const QString	openBeginTagStr = "<"
static const QString	trueStr = "true"
Static Protected Member Functions
static XMLMember	qobject_member (QObject *o, XML_MEMBER_ARGS)
static bool	qobject_setProperty (QObject *o, XML_SETPROPERTY_ARGS)
static void	qobject_writeProperties (const QObject o, const XMLClass xmlo, XML_WRITEPROPERTIES_ARGS)

Detailed Description

XMLClass is a parser for a simplified XML syntax.

Member Enumeration Documentation

enum QGpCoreTools::XMLClass::Error

Enumerator:

NoError
ErrorFileNotOpen
ErrorWritingFile
ErrorNoDocType
ErrorNoVersion
ErrorUnmatchedAmpSemiColon
ErrorUnknowSpecialCharacter
ErrorEmptyTag
ErrorUnmatchedTag
ErrorUnmatchedTopLevelTag
ErrorEmptyContextStack
ErrorParsingContent
ErrorParsingAttributes
ErrorSettingAttributes
ErrorSettingBinaryData
ErrorWrongBinaryOffset
ErrorWrongBinaryTag
ErrorBinaryFileNotFound
ErrorEndTruncatedTag
ErrorEndTruncatedString
ErrorEndTruncatedContext
ErrorEndStillInside
ErrorEndTagNotFound

             {
    NoError,
    ErrorFileNotOpen,
    ErrorWritingFile,
    ErrorNoDocType,
    ErrorNoVersion,
    ErrorUnmatchedAmpSemiColon,
    ErrorUnknowSpecialCharacter,
    ErrorEmptyTag,
    ErrorUnmatchedTag,
    ErrorUnmatchedTopLevelTag,
    ErrorEmptyContextStack,
    ErrorParsingContent,
    ErrorParsingAttributes,
    ErrorSettingAttributes,
    ErrorSettingBinaryData,
    ErrorWrongBinaryOffset,
    ErrorWrongBinaryTag,
    ErrorBinaryFileNotFound,
    ErrorEndTruncatedTag,
    ErrorEndTruncatedString,
    ErrorEndTruncatedContext,
    ErrorEndStillInside,
    ErrorEndTagNotFound
  };

enum QGpCoreTools::XMLClass::FileType

Enumerator:

TarFile
XmlFile

Reimplemented in SciFigs::XMLSciFigs.

                {
    TarFile,
    XmlFile
  };

Constructor & Destructor Documentation

QGpCoreTools::XMLClass::XMLClass ( ) [inline]

{}

virtual QGpCoreTools::XMLClass::~XMLClass ( ) [inline, virtual]

{}

Member Function Documentation

QString QGpCoreTools::XMLClass::message	(	Error	err,
		const QString &	file = `QString::null`,
		int	line = `0`
	)		`[static]`

Reports errors to user.

References ErrorBinaryFileNotFound, ErrorEmptyContextStack, ErrorEmptyTag, ErrorEndStillInside, ErrorEndTagNotFound, ErrorEndTruncatedContext, ErrorEndTruncatedString, ErrorEndTruncatedTag, ErrorFileNotOpen, ErrorNoDocType, ErrorNoVersion, ErrorParsingAttributes, ErrorParsingContent, ErrorSettingAttributes, ErrorSettingBinaryData, ErrorUnknowSpecialCharacter, ErrorUnmatchedAmpSemiColon, ErrorUnmatchedTag, ErrorUnmatchedTopLevelTag, ErrorWritingFile, ErrorWrongBinaryOffset, ErrorWrongBinaryTag, NoError, QGpCoreTools::tr(), and TRACE.

Referenced by QGpCoreTools::XMLErrorReport::exec().

{
  TRACE;
  QString msg;
  switch (err) {
  case NoError:
    return QString::null;
  case ErrorFileNotOpen:
    msg=tr("Cannot open file. Check file permissions");
    break;
  case ErrorWritingFile:
    msg=tr("Cannot write to file. Check disk space");
    break;
  case ErrorNoDocType:
    msg=tr("No doc type found at the beginning of the XML");
    break;
  case ErrorNoVersion:
    msg=tr("No version found at the beginning of the XML");
    break;
  case ErrorUnmatchedAmpSemiColon:
    msg=tr("Unmatched ampersand and semi colon for XML special characters");
    break;
  case ErrorUnknowSpecialCharacter:
    msg=tr("Unknwown XML special character");
    break;
  case ErrorEmptyTag:
    msg=tr("Empty XML tag");
    break;
  case ErrorUnmatchedTag:
    msg=tr("Unmatched XML tag");
    break;
  case ErrorUnmatchedTopLevelTag:
    msg=tr("Unmatched top level XML tag");
    break;
  case ErrorEmptyContextStack:
    msg=tr("Empty context stack");
    break;
  case ErrorParsingContent:
    msg=tr("Error parsing tag content");
    break;
  case ErrorParsingAttributes:
    msg=tr("Error parsing tag attributes");
    break;
  case ErrorSettingAttributes:
    msg=tr("Error setting tag attributes");
    break;
  case ErrorSettingBinaryData:
    msg=tr("Error setting binary data");
    break;
  case ErrorWrongBinaryOffset:
    msg=tr("Wrong offset in binary file");
    break;
  case ErrorWrongBinaryTag:
    msg=tr("Wrong binary tag");
    break;
  case ErrorBinaryFileNotFound:
    msg=tr("Binary file not found");
    break;
  case ErrorEndTruncatedTag:
    msg=tr("Truncated tag at the end of XML");
    break;
  case ErrorEndTruncatedString:
    msg=tr("Truncated string at the end of XML");
    break;
  case ErrorEndTruncatedContext:
    msg=tr("Truncated context at the end of XML");
    break;
  case ErrorEndStillInside:
    msg=tr("Object not completely restored at the end of XML");
    break;
  case ErrorEndTagNotFound:
    msg=tr("Object not found in XML");
    break;
  }
  if(!file.isEmpty()) {
    if(line>0) {
      msg+=tr(" (%1 at line %2).").arg(file).arg(line);
    } else {
      msg+=tr(" (%1).").arg(file);
    }
  } else if(line>0) {
    msg+=tr(" (at line %1).").arg(line);
  } else {
    msg+=".";
  }
  return msg;
}

XMLMember QGpCoreTools::XMLClass::qobject_member	(	QObject *	o,
		XML_MEMBER_ARGS
	)		`[static, protected]`

This function is designed to restore from XML properties to QObject properties.

References TRACE, and QGpCoreTools::XMLMember::Unknown.

Referenced by MapProject::xml_member(), SciFigs::GraphContentLayer::xml_member(), SciFigs::ImageLayer::xml_member(), SciFigs::GraphicSheet::xml_member(), and SciFigs::GraphContent::xml_member().

{
  TRACE;
  Q_UNUSED(attributes);
  Q_UNUSED(context);
  const QMetaObject * meta=o->metaObject();
  int id=meta->indexOfProperty(tag.toString().toAscii().data());
  if(id==-1) {
    return XMLMember(XMLMember::Unknown);
  } else return XMLMember(id);
}

bool QGpCoreTools::XMLClass::qobject_setProperty	(	QObject *	o,
		XML_SETPROPERTY_ARGS
	)		`[static, protected]`

This function is designed to restore from XML properties to QObject properties.

References QGpCoreTools::endl(), QGpCoreTools::App::stream(), QGpCoreTools::tr(), and TRACE.

Referenced by MapProject::xml_setProperty().

{
  TRACE;
  Q_UNUSED(tag);
  Q_UNUSED(attributes);
  Q_UNUSED(context);
  const QMetaObject * meta=o->metaObject();
  QMetaProperty p=meta->property(memberID);
  if( !p.isValid()) {
    return false;
  }
  if( !p.isWritable()) {
    App::stream() << tr("read-only property : %1" ).arg(p.name()) << endl;
    return false;
  }
  if(p.type()==QVariant::Bool) {
    QVariant v(content=="true" );
    return p.write(o, v);
  } else {
    QVariant v(content.toString());
    return p.write(o, v);
  }
}

void QGpCoreTools::XMLClass::qobject_writeProperties	(	const QObject *	o,
		const XMLClass *	xmlo,
		XML_WRITEPROPERTIES_ARGS
	)		`[static, protected]`

This function is designed to save as XML properties all QObject properties.

References TRACE, and writeProperty().

Referenced by MapProject::xml_writeProperties(), SciFigs::GraphContentLayer::xml_writeProperties(), SciFigs::ImageLayer::xml_writeProperties(), and SciFigs::GraphContent::xml_writeProperties().

{
  TRACE;
  Q_UNUSED(context);
  const QMetaObject * meta=o->metaObject();
  // Ignore property with index 0 (objectName from QObject, replaced by objectName of the first base class from  library)
  int n=meta ->propertyCount();
  for(int i=meta ->indexOfProperty("objectName");i < n; i++ ) {
    QMetaProperty prop=meta ->property(i);
    if(prop.isStored()) {
      QVariant val=prop.read(o);
      if(val.type()==QVariant::String)
        xmlo->writeProperty(s, prop.name(), val.toString());
      else xmlo->writeProperty(s, prop.name(), val.toString());
    }
  }
}

XMLClass::Error QGpCoreTools::XMLClass::restore	(	const QChar *&	ptr,
		int &	line,
		XMLStream *	s,
		XMLContext *	context
	)

References QGpCoreTools::XMLParser::parse(), QGpCoreTools::XMLParser::setLine(), and QGpCoreTools::XMLParser::setPointer().

Referenced by QGpCoreTools::XMLHeader::xml_restoreByteArray(), QGpCoreTools::XMLHeader::xml_restoreFile(), and QGpCoreTools::XMLHeader::xml_restoreString().

{
  XMLParser parser(s, context);
  parser.setLine(line);
  parser.setPointer(ptr);
  return parser.parse(this);
}

QString QGpCoreTools::XMLClass::saveSpecChar ( QString content ) [static]

This function is called when special characters are suspected. The following special characters are replaced by XML sequences (see http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references for a list XML predefined entities):

Replace:

'&' by '&'
'<' by '<'
'>' by '>'
'"' by '"'
''' by '''

Replacements are inlined due the small number of special characters to replace and to avoid time losses.

References QGpCoreTools::StringSection::appendTo(), QGpCoreTools::StringSection::data(), QGpCoreTools::StringSection::set(), QGpCoreTools::StringSection::setEnd(), and TRACE.

Referenced by QGpCoreTools::XMLSaveAttributes::toEncodedString().

{
  TRACE;
  QString dest;
  const QChar * ptr=content.data();
  StringSection cur (ptr, 0);
  while(true) {
    switch (ptr->unicode()) {
    case 0x0000:
      if(cur.data()==content.data()) { // no special character found
        return content;
      } else {
        cur.setEnd(ptr);
        cur.appendTo(dest);
        //App::stream() << "Content before replacements ---" << content << "---" << endl;
        //App::stream() << "Content after replacements ---" << dest << "---" << endl;
        return dest;
      }
    case 0x0026:    // '&'
      cur.setEnd(ptr);
      cur.appendTo(dest);
      dest += "&amp;";
      cur.set(ptr + 1, 0);
      break;
    case 0x003C:    // '<'
      cur.setEnd(ptr);
      cur.appendTo(dest);
      dest += "&lt;";
      cur.set(ptr + 1, 0);
      break;
    case 0x003E:    // '>'
      cur.setEnd(ptr);
      cur.appendTo(dest);
      dest += "&gt;";
      cur.set(ptr + 1, 0);
      break;
    case 0x0027:    // '''
      cur.setEnd(ptr);
      cur.appendTo(dest);
      dest += "&apos;";
      cur.set(ptr + 1, 0);
      break;
    case 0x0022:    // '"'
      cur.setEnd(ptr);
      cur.appendTo(dest);
      dest += "&quot;";
      cur.set(ptr + 1, 0);
      break;
    default:
      break;
    }
    ptr++;
  }
}

void QGpCoreTools::XMLClass::skipBlanks	(	const QChar *&	ptr,
		int &	line
	)		`[static]`

References TRACE.

{
  TRACE;
  while( *ptr!=0) {
    switch (ptr->unicode()) {
    case 0x000A:    // '\n'
      line++;
    case 0x0020:    // ' '
    case 0x0009:    // '\t'
    case 0x000D:    // '\r'
      break;
    default:
      return ;
    }
    ptr++;
  }
}

void QGpCoreTools::XMLClass::writeBinaryData	(	XMLStream &	s,
		XMLContext *	context
	)		const

References QGpCoreTools::XMLStream::addFile(), binDataTag, fileName, QGpCoreTools::XMLStream::isMultiFile(), TRACE, writeProperty(), xml_tagName(), and xml_writeBinaryData().

Referenced by GeopsyCore::XMLSignal::xml_writeProperties(), NAModelsPlot::xml_writeProperties(), SciFigs::XYPlot::xml_writeProperties(), SciFigs::XUniqueYColorLines::xml_writeProperties(), SciFigs::XYColorLines::xml_writeProperties(), and QGpCoreTools::IrregularGrid2D::xml_writeProperties().

{
  TRACE;
  if(s.isMultiFile()) {
    QString fileName=QString("bin_data_%1").arg(fileIndex++);
    writeProperty(s, binDataTag, fileName);
    QByteArray binArray;
    QDataStream binStream(&binArray, QIODevice::WriteOnly);
    binStream << xml_tagName();
    xml_writeBinaryData(binStream, context);
    s.addFile(fileName, binArray);
  }
}

static void QGpCoreTools::XMLClass::writeChildren	(	XMLStream &	s,
		QString	name,
		QString	children
	)		`[inline, static]`

Referenced by QGpCoreTools::CoreApplicationPrivate::reportBugNow().

                                                                          {
    writeChildren(s, name, nullSaveAttributes, children);
  }

void QGpCoreTools::XMLClass::writeChildren	(	XMLStream &	s,
		QString	name,
		const XMLSaveAttributes &	attributes,
		QString	children
	)		`[static]`

Convenient function to "manually" write some XML content

References closeBeginTagStr, endTagStr, QGpCoreTools::XMLStream::indent(), openBeginTagStr, QGpCoreTools::XMLSaveAttributes::toEncodedString(), and TRACE.

{
  TRACE;
  QString tmp=s.indent();
  tmp+=openBeginTagStr;
  tmp+=name;
  tmp+=attributes.toEncodedString();
  tmp+=endTagStr;
  tmp+="\n";
  tmp+=children;
  tmp+=s.indent() + closeBeginTagStr;
  tmp+=name;
  tmp+=endTagStr;
  tmp+="\n";
  s << tmp;
}

void QGpCoreTools::XMLClass::writeProperty	(	XMLStream &	s,
		QString	name,
		const XMLSaveAttributes &	attributes
	)		`[static]`

References TRACE.

{
  TRACE;
  QString tmp=s.indent();
  tmp+=openBeginTagStr;
  tmp+=name;
  tmp+=attributes.toEncodedString();
  tmp+=closeEndTagStr;
  tmp+="\n";
  s << tmp;
}

void QGpCoreTools::XMLClass::xml_attributes ( XML_ATTRIBUTES_ARGS ) const [inline, virtual]

Reimplemented in QGpCoreTools::GoogleEarthKML, GeopsyCore::TimeRangeParameters, QGpCoreTools::XMLGenericItem, QGpCoreTools::XMLHeader, GeopsyCore::MiniSeedSequence, GeopsySLink::SeedLinkStream, GeopsyGui::TimeWindow, GeopsySLink::SeedLinkStation, and GeopsySLink::SeedLinkServer.

Referenced by QGpCoreTools::XMLHeader::xml_saveByteArray(), QGpCoreTools::XMLHeader::xml_saveFile(), QGpCoreTools::XMLHeader::xml_saveString(), QGpCoreTools::XMLHeader::xml_writeChildren(), GeopsyCore::Signal::xml_writeChildren(), and GeopsyCore::Signal::xml_writeProperties().

{
  Q_UNUSED(attributes);
  Q_UNUSED(context);
}

bool QGpCoreTools::XMLClass::xml_inherits ( const QString & tagName ) const [virtual]

May be useful for classes that do not inherit QObject. Must be re-implemented in sub-classes

Reimplemented in GeopsyCore::SignalGroup, GeopsyCore::DefaultSignalGroup, GeopsyCore::MasterSignalGroup, and GeopsyCore::StationGroup.

Referenced by GeopsyGui::SignalGroupItem::data(), MonoStation::CategoryGroupItem::flags(), and GeopsyCore::StationGroup::xml_inherits().

{
  return tagName=="XMLClass";
}

XMLMember QGpCoreTools::XMLClass::xml_member ( XML_MEMBER_ARGS ) [inline, virtual]

Re-implement this function to offer XML restore (children and properties) support to your class.

From tag and map (with contains the attibute value) return a unique identifier under the format of a XMLMember. XMLMember is initialized with 3 types of contructors:

An integer: id number of a property
A XMLClass * : a child of this object identified by tag
Default constructor: error, unknow child or property

Map of attributes can be inspected in this way (can be achived also in xml_setProperty()):

    static const QString tmp("childrenName");
    XMLRestoreAttributeIterator it=map.find(tmp);
    if(it!=map.end()) {
      // found attribute "childrenName"
    }

If the map of attributes is not used:

    Q_UNUSED(attributes);
    if(tag=="x1") return XMLMember(0);
    else if(tag=="y1") return XMLMember(1);
    else if(tag=="x2") return XMLMember(2);
    else if(tag=="y2") return XMLMember(3);
    else return XMLMember(XMLMember::Unknown);

Arithmetic operations + and - apply to XMLMember to avoid confusion of property id numbers between inherited objects. Offset 3 corresponds to the number of properties defined in this object.

    if(tag=="anInteger") return XMLMember(0);
    else if(tag=="aString") return XMLMember(1);
    else if(tag=="aDouble") return XMLMember(2);
    return AbstractLine::xml_member(tag, attributes, context)+3;

For the arguments of this function use Macro XML_MEMBER_ARGS.

Reimplemented in GeopsyCore::Signal, SciFigs::GraphContent, SciFigs::GraphicSheet, SciFigs::Axis, QGpCompatibility::CompatVDataPointVector, SciFigs::GraphicObject, GeopsyGui::SignalLayer, QGpCompatibility::CompatDataPointVector, DinverDCCore::ParamLayer, QGpCoreTools::ColumnTextParser, QGpCoreTools::GoogleEarthKML, QGpCoreTools::IrregularGrid2D, SciFigs::ImageLayer, SciFigs::LineLayer, DinverDCCore::ParamProfile, QGpCoreTools::GoogleEarthKML::Document, SciFigs::GraphContentLayer, SciFigs::ImageLayer::ReferencePoint, DinverDCCore::TargetList, SciFigs::ColorPaletteWidget, InversionThread, SciFigs::LegendWidget, DinverCore::Parameter, QGpCoreTools::Grid3D< ValueType >, QGpCoreTools::GoogleEarthKML::Folder, GeopsyCore::SignalDB, SciFigs::AxisWindow, QGpCoreTools::Rect, SciFigs::GridPlot, SciFigs::CircleViewer, SciFigs::Legend, GeopsyCore::AsciiSignalFormat, QGpCoreTools::Grid2D< ValueType >, SciFigs::AbstractLine, QGpCoreTools::Grid2D< double >, DinverCore::RealSpace, MapProject, GeopsyCore::AbstractSignalGroup, GeopsyCore::SignalFile, GeopsyGui::PickLayer, NAModelsPlot, SciFigs::Pen, QGpCompatibility::CompatModalRefinedCurves, QGpCoreTools::StatisticalValue< numberType >, QGpCoreTools::StatisticalValue< double >, QGpCoreTools::StatisticalValue< Complex >, QGpCoreWave::ModalCurve, SciFigs::Symbol, DinverDCCore::ParamGroundModel, QGpCompatibility::CompatModalCurves, SciFigs::TextEdit, QGpGuiTools::ColorPalette, QGpCompatibility::CompatModalFrequency, SciFigs::ParallelBands, GeopsyGui::ChronogramLayer, QGpCoreTools::GoogleEarthKML::Placemark, SciFigs::XYValueLines, GeopsyCore::AbstractFileFormat, GeopsyCore::AsciiSignalFormatRule, QGpCoreWave::Mode, QGpCoreWave::RefractionCurve, QGpCompatibility::CompatModalEllipticity, SciFigs::XYValuePlot, SciFigs::AbstractNameLine, GeopsyCore::CustomFileFormats, GeopsyGui::TimeWindowLayer, QGpCoreWave::AutocorrCurves, QGpCoreWave::MagnetoTelluricCurve, SciFigs::ParallelBand, GeopsyCore::SignalGroup, GeopsySLink::SeedLinkStation, QGpCoreTools::ColumnTextDescription, QGpCoreTools::XMLGenericItem, SciFigs::LegendItem, QGpCoreTools::StatisticalPoint< numberType >, QGpCoreTools::StatisticalPoint< double >, QGpCoreTools::StatisticalPoint< Complex >, GeopsyGui::TimeWindowList, SciFigs::XMLSciFigs, GeopsySLink::SeedLinkServer, GeopsyCore::MiniSeedRecords, ControlPanel, QGpCompatibility::CompatDataPoint, DinverDCCore::Param3DGroundModel, ModelSlider, QGpCoreTools::XMLHeader, SciFigs::Brush, DinverCore::AbstractCondition, MatlabTarget, SciFigs::GridViewer, DinverDCCore::TargetList2D, GeopsyCore::SharedMetaData, QGpCoreWave::AutocorrRing, DinverCore::SimpleCondition, DinverDCCore::Target, GeopsyGui::PickFormat, GeopsyCore::AsciiSignalFormatComponent, GeopsyCore::DefaultSignalGroup, GeopsyCore::XMLSignal, DinverCore::ParamSpaceScript, SciFigs::HistogramLayer, ExtTarget, GeopsyCore::XMLSubSignalPool, QGpCoreTools::GoogleEarthKML::Point, DinverDCCore::AutocorrTarget, DinverDCCore::MagnetoTelluricTarget, DinverDCCore::ModalCurveTarget, DinverDCCore::RefractionTarget, DinverDCCore::ValueTarget, GeopsyCore::MasterSignalGroup, QGpCoreTools::XMLMap< Key, T >, DinverCore::XMLDinver, DinverCore::XMLDinverHeader, DinverCore::XMLVirtualPlugin, and XMLDinverGui.

References QGpCoreTools::XMLMember::Unknown.

Referenced by DinverCore::XMLDinverHeader::xml_member().

{
  Q_UNUSED(tag);
  Q_UNUSED(attributes);
  Q_UNUSED(context);
  return XMLMember(XMLMember::Unknown);
}

void QGpCoreTools::XMLClass::xml_polish ( XML_POLISH_ARGS ) [inline, virtual]

Reimplemented in SciFigs::GraphContent, SciFigs::GraphicSheet, SciFigs::GraphicObject, GeopsyGui::SignalLayer, QGpCoreTools::ColumnTextParser, SciFigs::ImageLayer, DinverDCCore::TargetList, InversionThread, GeopsyCore::SignalDB, DinverCore::RealSpace, GeopsyCore::SignalFile, DinverDCCore::ParamGroundModel, SciFigs::AxisWindow, GeopsySLink::SeedLinkServer, and DinverDCCore::AutocorrTarget.

{
  Q_UNUSED(context);
}

void QGpCoreTools::XMLClass::xml_polishChild ( XML_POLISHCHILD_ARGS ) [inline, virtual]

Reimplemented in SciFigs::GraphContent, SciFigs::GraphicSheet, GeopsyGui::SignalLayer, DinverDCCore::TargetList, SciFigs::ColorPaletteWidget, SciFigs::GridPlot, GeopsyCore::AbstractSignalGroup, GeopsyGui::ChronogramLayer, SciFigs::XYValueLines, SciFigs::XYValuePlot, QGpCoreTools::XMLHeader, DinverCore::XMLDinver, DinverCore::XMLDinverHeader, and DinverCore::XMLVirtualPlugin.

Referenced by DinverCore::XMLVirtualPlugin::xml_polishChild(), and DinverCore::XMLDinverHeader::xml_polishChild().

{
  Q_UNUSED(child);
  Q_UNUSED(context);
}

bool QGpCoreTools::XMLClass::xml_polished ( XML_POLISHED_ARGS ) [inline, virtual]

Reimplemented in QGpCoreTools::XMLHeader.

{
  return false;
}

void QGpCoreTools::XMLClass::xml_save	(	XMLStream &	s,
		XMLContext *	context,
		const XMLSaveAttributes &	attributes = `nullSaveAttributes`
	)		const

All output must execute this function that add header and footer to the XML

Called by each child to export its data into the XML stream.

s current active XML stream
attributes any string with format keyword1="value1" keyword2="value2" ..., may be null.

Do not call this function directly with an empty QTextStream: the produced XML will not contain the header.

References closeBeginTagStr, QGpCoreTools::XMLStream::decrementIndent(), endTagStr, QGpCoreTools::XMLStream::incrementIndent(), QGpCoreTools::XMLStream::indent(), openBeginTagStr, QGpCoreTools::XMLSaveAttributes::toEncodedString(), TRACE, xml_tagName(), xml_writeChildren(), and xml_writeProperties().

{
  TRACE;
  QString tmp=s.indent();
  tmp+=openBeginTagStr;
  tmp+=xml_tagName();
  tmp+=attributes.toEncodedString();
  tmp+=endTagStr;
  tmp+="\n";
  s << tmp;

  s.incrementIndent();
  xml_writeProperties(s, context);
  xml_writeChildren(s, context);
  s.decrementIndent();

  tmp=s.indent();
  tmp+=closeBeginTagStr;
  tmp+=xml_tagName();
  tmp+=endTagStr;
  tmp+="\n";
  s << tmp;
}

bool QGpCoreTools::XMLClass::xml_setAttributes ( XML_SETATTRIBUTES_ARGS ) [inline, virtual]

Reimplemented in GeopsyCore::TimeRangeParameters, QGpCoreTools::XMLGenericItem, QGpCoreTools::XMLHeader, GeopsyCore::MiniSeedSequence, GeopsySLink::SeedLinkStream, GeopsyGui::TimeWindow, GeopsySLink::SeedLinkStation, and GeopsySLink::SeedLinkServer.

{
  Q_UNUSED(attributes);
  Q_UNUSED(context);
  return true;
}

bool QGpCoreTools::XMLClass::xml_setBinaryData ( XML_SETBINARYDATA_ARGS ) [inline, virtual]

This function must be re-implemented in all classes dealing with binary data that cannot be saved in an ASCII xml file (e.g. due to the amount of data).