imeas::CWavSamplesSaverComp Class Reference

#include <CWavSamplesSaverComp.h>

Inheritance diagram for imeas::CWavSamplesSaverComp:

Collaboration diagram for imeas::CWavSamplesSaverComp:

Public Types
typedef icomp::CComponentBase	BaseClass
Public Types inherited from ifile::IFilePersistence
enum	ErrorType { ET_NO_WRITE_PERMISSIONS , ET_NO_READ_PERMISSIONS , ET_FILE_NOT_EXIST }
	Possible file I/O errors. More...
enum	MessageId {   MI_BAD_OBJECT_TYPE = 0xabf0 , MI_CANNOT_LOAD , MI_CANNOT_SAVE , MI_BAD_EXTENSION ,   MI_FILE_NOT_EXIST , MI_UNSUPPORTED_VERSION }
	List of possible message IDs used in context of this interface. More...
Public Types inherited from ifile::IFileTypeInfo
enum	QueryFlags {   QF_LOAD = 1 << 0 , QF_SAVE = 1 << 1 , QF_FILE = 1 << 2 , QF_DIRECTORY = 1 << 3 ,   QF_ANONYMOUS = 1 << 4 }
	Describe detailed options of query. More...

Public Member Functions
bool	IsOperationSupported (const istd::IChangeable *dataObjectPtr, const QString *filePathPtr=nullptr, int flags=-1, bool beQuiet=true) const override
	Returns true if object dataObject can be loaded/saved.
iproc::CTaskState	LoadFromFile (istd::IChangeable &data, const QString &filePath=QString(), iproc::IProgressManager *progressManagerPtr=nullptr) const override
	This function loads data data from file filePath.
iproc::CTaskState	SaveToFile (const istd::IChangeable &data, const QString &filePath=QString(), iproc::IProgressManager *progressManagerPtr=nullptr) const override
	This function saves data data to file filePath.
bool	GetFileExtensions (QStringList &result, const istd::IChangeable *dataObjectPtr=nullptr, int flags=-1, bool doAppend=false) const override
	Get file extensions supported by this loader.
QString	GetTypeDescription (const QString *extensionPtr=nullptr) const override
	Get description of object type associated with single extension.
Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.
	CComponentBase (const CComponentBase &)=delete
CComponentBase &	operator= (const CComponentBase &)=delete
virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.
virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.
virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.
virtual void	SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
	Set component context of this component.
Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from ifile::IFilePersistence
Public Member Functions inherited from ifile::IFileTypeInfo

Protected Types
enum	WavContaints { WC_BYTES_PER_SAMPLE = 2 , WC_BITS_PER_SAMPLE = WC_BYTES_PER_SAMPLE * 8 , WC_WAVE_FORMAT_PCM = 1 }

Additional Inherited Members
Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.
virtual void	OnComponentCreated ()
virtual void	OnComponentDestroyed ()
virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.
Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)
static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Definition at line 19 of file CWavSamplesSaverComp.h.

Member Typedef Documentation

BaseClass

icomp::CComponentBase imeas::CWavSamplesSaverComp::BaseClass

Definition at line 24 of file CWavSamplesSaverComp.h.

Member Enumeration Documentation

WavContaints

enum imeas::CWavSamplesSaverComp::WavContaints

protected

Enumerator
WC_BYTES_PER_SAMPLE
WC_BITS_PER_SAMPLE
WC_WAVE_FORMAT_PCM

Definition at line 51 of file CWavSamplesSaverComp.h.

Member Function Documentation

GetFileExtensions()

bool imeas::CWavSamplesSaverComp::GetFileExtensions ( QStringList & result, const istd::IChangeable * dataObjectPtr = nullptr, int flags = -1, bool doAppend = false ) const

overridevirtual

Get file extensions supported by this loader.

Parameters

result	list of extensions, e.g. {"txt", "doc"}.
dataObjectPtr	optional pointer to data object for which all possible extensions are requested. It can be nullptr if any object is meant.
flags	set of flags

See also

QueryFlags.

Parameters

doAppend

if true, list of extensions should be appended to existing list.

Implements ifile::IFileTypeInfo.

GetTypeDescription()

QString imeas::CWavSamplesSaverComp::GetTypeDescription ( const QString * extensionPtr = nullptr ) const

overridevirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

IsOperationSupported()

bool imeas::CWavSamplesSaverComp::IsOperationSupported ( const istd::IChangeable * dataObjectPtr, const QString * filePathPtr = nullptr, int flags = -1, bool beQuiet = true ) const

overridevirtual

Returns true if object dataObject can be loaded/saved.

Parameters

dataObjectPtr	optional pointer to data object should be loaded/stored. It can be nullptr if any object is meant.
filePathPtr	optional pointer to file should be loaded/stored. It can be nullptr if any file is meant. If it points at empty string, anonymous loading is mean.
flags	combination of flags defined in QueryFlags and ifile::IFileTypeInfo::QueryFlags.
beQuiet	if true, no user message output is allowed.

Implements ifile::IFilePersistence.

LoadFromFile()

iproc::CTaskState imeas::CWavSamplesSaverComp::LoadFromFile ( istd::IChangeable & data, const QString & filePath = QString(), iproc::IProgressManager * progressManagerPtr = nullptr ) const

overridevirtual

This function loads data data from file filePath.

Returns

File loading state.

See also

Status

Implements ifile::IFilePersistence.

SaveToFile()

iproc::CTaskState imeas::CWavSamplesSaverComp::SaveToFile ( const istd::IChangeable & data, const QString & filePath = QString(), iproc::IProgressManager * progressManagerPtr = nullptr ) const

overridevirtual

This function saves data data to file filePath.

Returns

File saving state.

See also

Status

Implements ifile::IFilePersistence.

---

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

• imeas/CWavSamplesSaverComp.h