#include <CFileNamingParams.h>

Inheritance diagram for ifileproc::CFileNamingParams:

Collaboration diagram for ifileproc::CFileNamingParams:

Public Member Functions
	CFileNamingParams ()

OverwriteStrategy	GetOverwriteStrategy () const override
	Get used strategy for possible overwriting of existing files.

void	SetOverwriteStrategy (OverwriteStrategy overwriteStrategy) override
	Set renaming mode.

QString	GetPrefix () const override
	Get prefix of the file.

void	SetPrefix (const QString &prefix) override
	Set prefix of the file.

QString	GetSuffix () const override
	Set suffix of the file.

void	SetSuffix (const QString &suffix) override
	Get suffix of the file.

QStringList	GetPatternsToRemove () const override
	Get list of text patterns, that must be removed from the output file name.

void	SetPatternsToRemove (const QStringList &patternsToRemove) override
	Set list of text patterns, that must be removed from the output file name.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

int	GetSupportedOperations () const override
	Get set of flags for supported operations.

bool	CopyFrom (const istd::IChangeable &object, istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) override
	Copy this object from another one.

bool	IsEqual (const istd::IChangeable &object) const override
	Compare this object with another object.

std::unique_ptr< istd::IChangeable >	CloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
	Make a copy of this object.

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

Public Member Functions inherited from ifileproc::IFileNamingParams
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Protected Attributes
OverwriteStrategy	m_overwriteStrategy

QString	m_suffix

QString	m_prefix

QStringList	m_patternsToRemove

Additional Inherited Members
Public Types inherited from ifileproc::IFileNamingParams
enum	OverwriteStrategy { RM_OVERWRITE , RM_NUMBERING }
	Strategy mode. More...

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Definition at line 24 of file CFileNamingParams.h.

Constructor & Destructor Documentation

◆ CFileNamingParams()

ifileproc::CFileNamingParams::CFileNamingParams ( )

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > ifileproc::CFileNamingParams::CloneMe ( istd::IChangeable::CompatibilityMode mode = istd::IChangeable::CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns: new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

◆ CopyFrom()

bool ifileproc::CFileNamingParams::CopyFrom	(	const istd::IChangeable &	object,
		istd::IChangeable::CompatibilityMode	mode = istd::IChangeable::CM_WITHOUT_REFS )

overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

◆ GetOverwriteStrategy()

OverwriteStrategy ifileproc::CFileNamingParams::GetOverwriteStrategy ( ) const

overridevirtual

Get used strategy for possible overwriting of existing files.

See also: OverwriteStrategy

Implements ifileproc::IFileNamingParams.

◆ GetPatternsToRemove()

QStringList ifileproc::CFileNamingParams::GetPatternsToRemove ( ) const

overridevirtual

Get list of text patterns, that must be removed from the output file name.

See also: SetPatternsToRemove

Implements ifileproc::IFileNamingParams.

◆ GetPrefix()

QString ifileproc::CFileNamingParams::GetPrefix ( ) const

overridevirtual

Get prefix of the file.

Implements ifileproc::IFileNamingParams.

◆ GetSuffix()

QString ifileproc::CFileNamingParams::GetSuffix ( ) const

overridevirtual

Set suffix of the file.

Implements ifileproc::IFileNamingParams.

◆ GetSupportedOperations()

int ifileproc::CFileNamingParams::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also: SupportedOperations

Reimplemented from istd::IChangeable.

◆ IsEqual()

bool ifileproc::CFileNamingParams::IsEqual ( const istd::IChangeable & object ) const

overridevirtual

Compare this object with another object.

Parameters

object Object to be compared You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the objects are identical and false otherwise.

Reimplemented from istd::IChangeable.

◆ ResetData()

bool ifileproc::CFileNamingParams::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

◆ Serialize()

bool ifileproc::CFileNamingParams::Serialize ( iser::IArchive & archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also: iser::IArchive

Implements iser::ISerializable.

◆ SetOverwriteStrategy()

void ifileproc::CFileNamingParams::SetOverwriteStrategy ( OverwriteStrategy overwriteStrategy )

overridevirtual

Set renaming mode.

See also: OverwriteStrategy

Implements ifileproc::IFileNamingParams.

◆ SetPatternsToRemove()

void ifileproc::CFileNamingParams::SetPatternsToRemove ( const QStringList & patternsToRemove )

overridevirtual

Set list of text patterns, that must be removed from the output file name.

For example, the file name foo_some.txt will be transformed into foo.txt if _some pattern is set.

See also: GetPatternsToRemove

Implements ifileproc::IFileNamingParams.

◆ SetPrefix()

void ifileproc::CFileNamingParams::SetPrefix ( const QString & prefix )

overridevirtual

Set prefix of the file.

Implements ifileproc::IFileNamingParams.

◆ SetSuffix()

void ifileproc::CFileNamingParams::SetSuffix ( const QString & suffix )

overridevirtual

Get suffix of the file.

Implements ifileproc::IFileNamingParams.

Member Data Documentation

◆ m_overwriteStrategy

OverwriteStrategy ifileproc::CFileNamingParams::m_overwriteStrategy

protected

Definition at line 50 of file CFileNamingParams.h.

◆ m_patternsToRemove

QStringList ifileproc::CFileNamingParams::m_patternsToRemove

protected

Definition at line 53 of file CFileNamingParams.h.

◆ m_prefix

QString ifileproc::CFileNamingParams::m_prefix

protected

Definition at line 52 of file CFileNamingParams.h.

◆ m_suffix

QString ifileproc::CFileNamingParams::m_suffix

protected

Definition at line 51 of file CFileNamingParams.h.

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

ifileproc/CFileNamingParams.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CFileNamingParams()

Member Function Documentation

◆ CloneMe()

◆ CopyFrom()

◆ GetOverwriteStrategy()

◆ GetPatternsToRemove()

◆ GetPrefix()

◆ GetSuffix()

◆ GetSupportedOperations()

◆ IsEqual()

◆ ResetData()

◆ Serialize()

◆ SetOverwriteStrategy()

◆ SetPatternsToRemove()

◆ SetPrefix()

◆ SetSuffix()

Member Data Documentation

◆ m_overwriteStrategy

◆ m_patternsToRemove

◆ m_prefix

◆ m_suffix