Kwave::MemoryPlugin Class Reference

#include <MemoryPlugin.h>

Inheritance diagram for Kwave::MemoryPlugin:

Collaboration diagram for Kwave::MemoryPlugin:

Public Member Functions
	MemoryPlugin (QObject *parent, const QVariantList &args)
virtual	~MemoryPlugin () Q_DECL_OVERRIDE
virtual void	load (QStringList &params) Q_DECL_OVERRIDE
virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Plugin
	Plugin (QObject *parent, const QVariantList &args)
virtual	~Plugin () Q_DECL_OVERRIDE
virtual QString	name () const
virtual QString	description () const
virtual QString	progressText ()
virtual bool	canClose () const
bool	isRunning () const
bool	shouldStop () const
virtual void	unload ()
virtual int	start (QStringList &params)
virtual int	stop ()
virtual void	run (QStringList params)
Kwave::PluginManager &	manager () const
Kwave::SignalManager &	signalManager ()
QWidget *	parentWidget () const
QString	signalName ()
virtual sample_index_t	signalLength ()
virtual double	signalRate ()
virtual const QList< unsigned int >	selectedTracks ()
virtual sample_index_t	selection (QList< unsigned int > *tracks=Q_NULLPTR, sample_index_t *left=Q_NULLPTR, sample_index_t *right=Q_NULLPTR, bool expand_if_empty=false)
virtual void	selectRange (sample_index_t offset, sample_index_t length)
virtual void	migrateToActiveContext ()
Public Member Functions inherited from Kwave::Runnable
virtual	~Runnable ()

Protected Member Functions
int	interpreteParameters (QStringList &params)
void	applySettings ()
Protected Member Functions inherited from Kwave::Plugin
int	execute (QStringList &params)
void	emitCommand (const QString &command)
void	use ()
void	setPluginManager (Kwave::PluginManager *new_plugin_manager)
virtual void	run_wrapper (const QVariant &params) Q_DECL_OVERRIDE

Private Attributes
bool	m_physical_limited
unsigned int	m_physical_limit
bool	m_virtual_enabled
bool	m_virtual_limited
unsigned int	m_virtual_limit
QString	m_virtual_directory
unsigned int	m_undo_limit

Additional Inherited Members
Public Slots inherited from Kwave::Plugin
virtual void	setProgressDialogEnabled (bool enable)
virtual void	updateProgress (qreal progress)
virtual void	cancel ()
virtual void	close ()
void	release ()
Signals inherited from Kwave::Plugin
void	sigRunning (Kwave::Plugin *plugin)
void	sigDone (Kwave::Plugin *plugin)
void	sigClosed (Kwave::Plugin *p)
void	sigCommand (const QString &command)
void	setProgressText (const QString &text)

Detailed Description

Setup plugin for Kwave's memory manager.

Definition at line 36 of file MemoryPlugin.h.

Constructor & Destructor Documentation

MemoryPlugin()

Kwave::MemoryPlugin::MemoryPlugin	(	QObject *	parent,
		const QVariantList &	args
	)

Constructor

Parameters

parent	reference to our plugin manager
args	argument list [unused]

Definition at line 46 of file MemoryPlugin.cpp.

    :Kwave::Plugin(parent, args),
     m_physical_limited(true),
     m_physical_limit(DEFAULT_PHYSICAL_LIMIT),
     m_virtual_enabled(true),
     m_virtual_limited(false),
     m_virtual_limit(DEFAULT_VIRTUAL_LIMIT),
     m_virtual_directory(_("/var/tmp")),
     m_undo_limit(DEFAULT_UNDO_LIMIT)
{
}

~MemoryPlugin()

Kwave::MemoryPlugin::~MemoryPlugin ( )

virtual

Destructor

Definition at line 60 of file MemoryPlugin.cpp.

{
}

Member Function Documentation

applySettings()

void Kwave::MemoryPlugin::applySettings ( )

protected

Applies the current settings by passing them to Kwave's global MemoryManager

Definition at line 125 of file MemoryPlugin.cpp.

References Kwave::MemoryManager::instance(), m_physical_limit, m_physical_limited, m_undo_limit, m_virtual_directory, m_virtual_enabled, m_virtual_limit, m_virtual_limited, Kwave::MemoryManager::setPhysicalLimit(), Kwave::MemoryManager::setSwapDirectory(), Kwave::MemoryManager::setUndoLimit(), and Kwave::MemoryManager::setVirtualLimit().

Referenced by load(), and setup().

{
    Kwave::MemoryManager &mem = Kwave::MemoryManager::instance();
    mem.setPhysicalLimit(m_physical_limited ? m_physical_limit : 4096);
    mem.setVirtualLimit(m_virtual_enabled ?
                       (m_virtual_limited ? m_virtual_limit : INT_MAX) :
                       0);
    mem.setSwapDirectory(m_virtual_directory);
    mem.setUndoLimit(m_undo_limit);
}

Here is the call graph for this function:

Here is the caller graph for this function:

interpreteParameters()

int Kwave::MemoryPlugin::interpreteParameters ( QStringList &  params )

protected

Interpretes a given parameter list and sets up internal parameters accordingly.

Parameters

params

reference to a QStringList with parameters

Returns

0 if ok, or an error code if failed

Definition at line 65 of file MemoryPlugin.cpp.

References m_physical_limit, m_physical_limited, m_undo_limit, m_virtual_directory, m_virtual_enabled, m_virtual_limit, and m_virtual_limited.

Referenced by load(), and setup().

{
    bool ok;
    QString param;

    // evaluate the parameter list
    if (params.count() < 6) return -EINVAL;

    // parameter #0: physical memory is limited ?
    param = params[0];
    m_physical_limited = param.toUInt(&ok) != 0;
    if (!ok) return -EINVAL;

    // parameter #1: limit for physical memory
    param = params[1];
    m_physical_limit = param.toUInt(&ok);
    if (!ok) return -EINVAL;

    // parameter #2: virtual memory is enabled ?
    param = params[2];
    m_virtual_enabled = param.toUInt(&ok) != 0;
    if (!ok) return -EINVAL;

    // parameter #3: virtual memory is limited ?
    param = params[3];
    m_virtual_limited = param.toUInt(&ok) != 0;
    if (!ok) return -EINVAL;

    // parameter #4: limit for virtual memory
    if (m_virtual_limited) {
        param = params[4];
        m_virtual_limit = param.toUInt(&ok);
        if (!ok) return -EINVAL;
    } else {
        m_virtual_limit = INT_MAX;
    }

    // parameter #5: directory for virtual memory files
    param = params[5];
    m_virtual_directory = param;

    // parameter #6: limit for undo/redo
    if (params.count() >= 7)
    {
        param = params[6];
        m_undo_limit = param.toUInt(&ok);
        if (!ok) return -EINVAL;
    }

    return 0;
}

Here is the caller graph for this function:

load()

void Kwave::MemoryPlugin::load ( QStringList &  params )

virtual

Gets called when the plugin is first loaded.

Reimplemented from Kwave::Plugin.

Definition at line 118 of file MemoryPlugin.cpp.

References applySettings(), and interpreteParameters().

{
    interpreteParameters(params);
    applySettings();
}

Here is the call graph for this function:

setup()

QStringList * Kwave::MemoryPlugin::setup ( QStringList &  previous_params )

virtual

See also

Kwave::Plugin::setup()

Reimplemented from Kwave::Plugin.

Definition at line 137 of file MemoryPlugin.cpp.

References applySettings(), interpreteParameters(), m_physical_limit, m_physical_limited, m_undo_limit, m_virtual_directory, m_virtual_enabled, m_virtual_limit, m_virtual_limited, Kwave::MemoryDialog::params(), and Kwave::Plugin::parentWidget().

{
    QStringList *result = Q_NULLPTR;

    // try to interpret the list of previous parameters, ignore errors
    if (previous_params.count()) interpreteParameters(previous_params);

    Kwave::MemoryDialog *dlg = new Kwave::MemoryDialog(
        parentWidget(), m_physical_limited,
        m_physical_limit, m_virtual_enabled, m_virtual_limited,
        m_virtual_limit, m_virtual_directory, m_undo_limit);
    Q_ASSERT(dlg);
    if (!dlg) return Q_NULLPTR;

    if (dlg->exec() == QDialog::Accepted) {
        // get the new parameters and let them take effect
        result = new QStringList();
        Q_ASSERT(result);
        if (result) {
            dlg->params(*result);
            interpreteParameters(*result);
            applySettings();
        }
    };

    delete dlg;
    return result;
}

Here is the call graph for this function:

Member Data Documentation

m_physical_limit

unsigned int Kwave::MemoryPlugin::m_physical_limit

private

Maximum amount of physical memory [MB]. Only of interest if m_physical_limited is set to true, otherwise reflects the user's last setting.

Definition at line 87 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_physical_limited

bool Kwave::MemoryPlugin::m_physical_limited

private

If true, the physical memory is limited

Definition at line 80 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_undo_limit

unsigned int Kwave::MemoryPlugin::m_undo_limit

private

Maximum amount of memory [MB] available for undo/redo

Definition at line 112 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_virtual_directory

QString Kwave::MemoryPlugin::m_virtual_directory

private

Directory for page files. Default = /tmp

Definition at line 107 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_virtual_enabled

bool Kwave::MemoryPlugin::m_virtual_enabled

private

If true, virtual memory is enabled

Definition at line 90 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_virtual_limit

unsigned int Kwave::MemoryPlugin::m_virtual_limit

private

Maximum amount of virtual memory [MB]. Only of interest if m_virtual_enabled and m_virtual_limited are set to true, otherwise reflects the user's last setting.

Definition at line 104 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

m_virtual_limited

bool Kwave::MemoryPlugin::m_virtual_limited

private

If true, virtual memory is limited. Only of interest if m_virtual_enabled is set to true, otherwise reflects the user's last setting.

Definition at line 97 of file MemoryPlugin.h.

Referenced by applySettings(), interpreteParameters(), and setup().

---

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

• plugins/memory/MemoryPlugin.h
• plugins/memory/MemoryPlugin.cpp