svcore  1.9
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PluginXml Class Reference

#include <PluginXml.h>

Inheritance diagram for PluginXml:
Inheritance graph
[legend]
Collaboration diagram for PluginXml:
Collaboration graph
[legend]

Public Member Functions

 PluginXml (Vamp::PluginBase *plugin)
 
virtual ~PluginXml ()
 
virtual void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Export plugin settings to XML. More...
 
virtual void setParameters (const QXmlAttributes &)
 Set the parameters and program of a plugin from a set of XML attributes. More...
 
virtual void setParametersFromXml (QString xml)
 Set the parameters and program of a plugin from an XML plugin element as returned by toXml. More...
 
virtual QString toXmlString (QString indent="", QString extraAttributes="") const
 Convert this exportable object to XML in a string. More...
 

Static Public Member Functions

static QString encodeConfigurationChars (QString text)
 
static QString decodeConfigurationChars (QString text)
 
static QString encodeEntities (QString)
 
static QString encodeColour (int r, int g, int b)
 
static int getObjectExportId (const void *)
 

Protected Member Functions

QString stripInvalidParameterNameCharacters (QString) const
 

Protected Attributes

Vamp::PluginBase * m_plugin
 

Detailed Description

Definition at line 24 of file PluginXml.h.

Constructor & Destructor Documentation

◆ PluginXml()

PluginXml::PluginXml ( Vamp::PluginBase *  plugin)

Definition at line 33 of file PluginXml.cpp.

◆ ~PluginXml()

PluginXml::~PluginXml ( )
virtual

Definition at line 38 of file PluginXml.cpp.

Member Function Documentation

◆ toXml()

void PluginXml::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const
virtual

Export plugin settings to XML.

Implements XmlExportable.

Definition at line 59 of file PluginXml.cpp.

References encodeConfigurationChars(), XmlExportable::encodeEntities(), RealTimePluginInstance::getConfigurePairs(), m_plugin, and stripInvalidParameterNameCharacters().

Referenced by TransformFactory::getPluginConfigurationXml().

◆ setParameters()

void PluginXml::setParameters ( const QXmlAttributes &  attrs)
virtual

Set the parameters and program of a plugin from a set of XML attributes.

This is a partial inverse of toXml.

Definition at line 127 of file PluginXml.cpp.

References CHECK_ATTRIBUTE, RealTimePluginInstance::configure(), decodeConfigurationChars(), m_plugin, and stripInvalidParameterNameCharacters().

Referenced by setParametersFromXml().

◆ setParametersFromXml()

void PluginXml::setParametersFromXml ( QString  xml)
virtual

Set the parameters and program of a plugin from an XML plugin element as returned by toXml.

This is a partial inverse of toXml.

Definition at line 194 of file PluginXml.cpp.

References setParameters().

Referenced by ModelTransformerFactory::getConfigurationForTransform(), and TransformFactory::setParametersFromPluginConfigurationXml().

◆ encodeConfigurationChars()

QString PluginXml::encodeConfigurationChars ( QString  text)
static

Definition at line 41 of file PluginXml.cpp.

Referenced by toXml().

◆ decodeConfigurationChars()

QString PluginXml::decodeConfigurationChars ( QString  text)
static

Definition at line 50 of file PluginXml.cpp.

Referenced by setParameters().

◆ stripInvalidParameterNameCharacters()

QString PluginXml::stripInvalidParameterNameCharacters ( QString  s) const
protected

Definition at line 228 of file PluginXml.cpp.

Referenced by setParameters(), and toXml().

◆ toXmlString()

QString XmlExportable::toXmlString ( QString  indent = "",
QString  extraAttributes = "" 
) const
virtualinherited

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by ModelTransformerFactory::getConfigurationForTransform(), and RDFTransformFactoryImpl::getTransforms().

◆ encodeEntities()

QString XmlExportable::encodeEntities ( QString  s)
staticinherited

Definition at line 41 of file XmlExportable.cpp.

Referenced by TextMatcher::test(), toXml(), OneDimensionalPoint::toXml(), TimeValuePoint::toXml(), ImagePoint::toXml(), TextPoint::toXml(), RegionRec::toXml(), Note::toXml(), FlexiNote::toXml(), WritableWaveFileModel::toXml(), WaveFileModel::toXml(), SparseValueModel< RegionRec >::toXml(), Transform::toXml(), and Model::toXml().

◆ encodeColour()

QString XmlExportable::encodeColour ( int  r,
int  g,
int  b 
)
staticinherited

Definition at line 54 of file XmlExportable.cpp.

◆ getObjectExportId()

int XmlExportable::getObjectExportId ( const void *  object)
staticinherited

Definition at line 71 of file XmlExportable.cpp.

References mutex.

Referenced by FFTDataServer::generateFileBasename(), AlignmentModel::toXml(), EditableDenseThreeDimensionalModel::toXml(), and Model::toXml().

Member Data Documentation

◆ m_plugin

Vamp::PluginBase* PluginXml::m_plugin
protected

Definition at line 56 of file PluginXml.h.

Referenced by setParameters(), and toXml().

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