svcore  1.9
Transform Class Reference

#include <Transform.h>

Inheritance diagram for Transform:
Collaboration diagram for Transform:

List of all members.

Public Types

enum  Type { FeatureExtraction, RealTimeEffect }
enum  SummaryType {
  Minimum = 0, Maximum = 1, Mean = 2, Median = 3,
  Mode = 4, Sum = 5, Variance = 6, StandardDeviation = 7,
  Count = 8, NoSummary = 999
}
typedef std::map< QString, float > ParameterMap
typedef std::map< QString,
QString > 
ConfigurationMap

Public Member Functions

 Transform ()
 Construct a new Transform with default data and no identifier.
 Transform (QString xml)
 Construct a Transform by parsing the given XML data string.
virtual ~Transform ()
bool operator== (const Transform &) const
 Compare two Transforms.
bool operator< (const Transform &) const
 Order two Transforms, so that they can be used as keys in containers.
void setIdentifier (TransformId id)
TransformId getIdentifier () const
Type getType () const
QString getPluginIdentifier () const
QString getOutput () const
void setPluginIdentifier (QString pluginIdentifier)
void setOutput (QString output)
const ParameterMapgetParameters () const
void setParameters (const ParameterMap &pm)
void setParameter (QString name, float value)
const ConfigurationMapgetConfiguration () const
void setConfiguration (const ConfigurationMap &cm)
void setConfigurationValue (QString name, QString value)
SummaryType getSummaryType () const
void setSummaryType (SummaryType type)
QString getPluginVersion () const
void setPluginVersion (QString version)
QString getProgram () const
void setProgram (QString program)
int getStepSize () const
void setStepSize (int s)
int getBlockSize () const
void setBlockSize (int s)
WindowType getWindowType () const
void setWindowType (WindowType type)
RealTime getStartTime () const
void setStartTime (RealTime t)
RealTime getDuration () const
void setDuration (RealTime d)
float getSampleRate () const
void setSampleRate (float rate)
void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Stream this exportable object out to XML on a text stream.
void setFromXmlAttributes (const QXmlAttributes &)
 Set the main transform data from the given XML attributes.
virtual QString toXmlString (QString indent="", QString extraAttributes="") const
 Convert this exportable object to XML in a string.

Static Public Member Functions

static TransformId getIdentifierForPluginOutput (QString pluginIdentifier, QString output="")
static SummaryType stringToSummaryType (QString)
static QString summaryTypeToString (SummaryType)
static QString encodeEntities (QString)
static QString encodeColour (int r, int g, int b)
static int getObjectExportId (const void *)

Protected Member Functions

template<typename A , typename B >
bool mapLessThan (const std::map< A, B > &a, const std::map< A, B > &b) const

Static Protected Member Functions

static QString createIdentifier (QString type, QString soName, QString label, QString output)
static void parseIdentifier (QString identifier, QString &type, QString &soName, QString &label, QString &output)

Protected Attributes

TransformId m_id
ParameterMap m_parameters
ConfigurationMap m_configuration
SummaryType m_summaryType
QString m_pluginVersion
QString m_program
int m_stepSize
int m_blockSize
WindowType m_windowType
RealTime m_startTime
RealTime m_duration
float m_sampleRate

Detailed Description

Definition at line 34 of file Transform.h.


Member Typedef Documentation

typedef std::map<QString, float> Transform::ParameterMap

Definition at line 85 of file Transform.h.

typedef std::map<QString, QString> Transform::ConfigurationMap

Definition at line 91 of file Transform.h.


Member Enumeration Documentation

Enumerator:
FeatureExtraction 
RealTimeEffect 

Definition at line 70 of file Transform.h.

Enumerator:
Minimum 
Maximum 
Mean 
Median 
Mode 
Sum 
Variance 
StandardDeviation 
Count 
NoSummary 

Definition at line 97 of file Transform.h.


Constructor & Destructor Documentation

Construct a new Transform with default data and no identifier.

The Transform object will be meaningless until some data and an identifier have been set on it.

To construct a Transform for use with a particular transform identifier, use TransformFactory::getDefaultTransformFor.

Definition at line 33 of file Transform.cpp.

Transform::Transform ( QString  xml)

Construct a Transform by parsing the given XML data string.

This is the inverse of toXml.

Definition at line 42 of file Transform.cpp.

References setConfigurationValue(), setFromXmlAttributes(), and setParameter().

Transform::~Transform ( ) [virtual]

Definition at line 107 of file Transform.cpp.


Member Function Documentation

bool Transform::operator== ( const Transform t) const

Compare two Transforms.

They only compare equal if every data element matches.

Definition at line 112 of file Transform.cpp.

References m_blockSize, m_configuration, m_duration, m_id, m_parameters, m_program, m_sampleRate, m_startTime, m_stepSize, m_summaryType, and m_windowType.

bool Transform::operator< ( const Transform t) const

Order two Transforms, so that they can be used as keys in containers.

Definition at line 137 of file Transform.cpp.

References m_blockSize, m_configuration, m_duration, m_id, m_parameters, m_program, m_sampleRate, m_startTime, m_stepSize, m_summaryType, and m_windowType.

void Transform::setPluginIdentifier ( QString  pluginIdentifier)

Definition at line 230 of file Transform.cpp.

References getOutput(), and m_id.

Referenced by RDFTransformFactoryImpl::getTransforms().

void Transform::setOutput ( QString  output)

Definition at line 236 of file Transform.cpp.

References getPluginIdentifier(), and m_id.

Referenced by areTransformsSimilar(), and RDFTransformFactoryImpl::setOutput().

TransformId Transform::getIdentifierForPluginOutput ( QString  pluginIdentifier,
QString  output = "" 
) [static]

Definition at line 242 of file Transform.cpp.

Referenced by TransformFactory::populateUninstalledTransforms().

void Transform::setParameters ( const ParameterMap pm)

Definition at line 255 of file Transform.cpp.

References m_parameters.

Referenced by TransformFactory::setParametersFromPlugin().

void Transform::setParameter ( QString  name,
float  value 
)

Definition at line 261 of file Transform.cpp.

References m_parameters.

Referenced by RDFTransformFactoryImpl::setParameters(), and Transform().

Definition at line 274 of file Transform.cpp.

References m_configuration.

Referenced by TransformFactory::setParametersFromPlugin().

void Transform::setConfigurationValue ( QString  name,
QString  value 
)

Definition at line 280 of file Transform.cpp.

References m_configuration, and SVDEBUG.

Referenced by Transform().

QString Transform::getPluginVersion ( ) const

Definition at line 287 of file Transform.cpp.

References m_pluginVersion.

Referenced by FeatureExtractionModelTransformer::initialise().

void Transform::setPluginVersion ( QString  version)

Definition at line 293 of file Transform.cpp.

References m_pluginVersion.

Referenced by TransformFactory::getDefaultTransformFor(), and setFromXmlAttributes().

Definition at line 347 of file Transform.cpp.

References m_windowType.

Referenced by FeatureExtractionModelTransformer::run().

Definition at line 353 of file Transform.cpp.

References m_windowType.

Referenced by RDFTransformFactoryImpl::getTransforms(), and setFromXmlAttributes().

Definition at line 365 of file Transform.cpp.

References m_startTime.

Referenced by RDFTransformFactoryImpl::getTransforms(), and setFromXmlAttributes().

Definition at line 377 of file Transform.cpp.

References m_duration.

Referenced by RDFTransformFactoryImpl::getTransforms().

void Transform::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const [virtual]
void Transform::setFromXmlAttributes ( const QXmlAttributes &  attrs)

Set the main transform data from the given XML attributes.

This does not set the parameters or configuration, which are exported to separate XML elements rather than attributes of the transform element.

Note that this only sets those attributes which are actually present in the argument. Any attributes not defined in the attribute will remain unchanged in the Transform. If your aim is to create a transform exactly matching the given attributes, ensure you start from an empty transform rather than one that has already been configured.

Definition at line 491 of file Transform.cpp.

References RealTime::fromString(), setBlockSize(), setIdentifier(), setPluginVersion(), setProgram(), setSampleRate(), setStartTime(), setStepSize(), setSummaryType(), setWindowType(), and stringToSummaryType().

Referenced by Transform().

QString Transform::createIdentifier ( QString  type,
QString  soName,
QString  label,
QString  output 
) [static, protected]

Definition at line 188 of file Transform.cpp.

void Transform::parseIdentifier ( QString  identifier,
QString &  type,
QString &  soName,
QString &  label,
QString &  output 
) [static, protected]

Definition at line 196 of file Transform.cpp.

template<typename A , typename B >
bool Transform::mapLessThan ( const std::map< A, B > &  a,
const std::map< A, B > &  b 
) const [inline, protected]

Definition at line 173 of file Transform.h.

QString XmlExportable::toXmlString ( QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

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().

QString XmlExportable::encodeColour ( int  r,
int  g,
int  b 
) [static, inherited]

Definition at line 54 of file XmlExportable.cpp.

int XmlExportable::getObjectExportId ( const void *  object) [static, inherited]

Member Data Documentation

QString Transform::m_pluginVersion [protected]

Definition at line 190 of file Transform.h.

Referenced by getPluginVersion(), setPluginVersion(), and toXml().

QString Transform::m_program [protected]

Definition at line 191 of file Transform.h.

Referenced by getProgram(), operator<(), operator==(), setProgram(), and toXml().

int Transform::m_stepSize [protected]

Definition at line 192 of file Transform.h.

Referenced by getStepSize(), operator<(), operator==(), setStepSize(), and toXml().

int Transform::m_blockSize [protected]

Definition at line 193 of file Transform.h.

Referenced by getBlockSize(), operator<(), operator==(), setBlockSize(), and toXml().

Definition at line 194 of file Transform.h.

Referenced by getWindowType(), operator<(), operator==(), setWindowType(), and toXml().

Definition at line 195 of file Transform.h.

Referenced by getStartTime(), operator<(), operator==(), setStartTime(), and toXml().

Definition at line 196 of file Transform.h.

Referenced by getDuration(), operator<(), operator==(), setDuration(), and toXml().

float Transform::m_sampleRate [protected]

Definition at line 197 of file Transform.h.

Referenced by getSampleRate(), operator<(), operator==(), setSampleRate(), and toXml().


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