ICF 3.0.5.47
Technical documentation of ICF Libraries
ifileproc::CFileNamingComp Class Reference

Component for calculating of the new file name. More...

#include <CFileNamingComp.h>

Inheritance diagram for ifileproc::CFileNamingComp:
Collaboration diagram for ifileproc::CFileNamingComp:

Public Types

typedef ilog::CLoggerComponentBase BaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 

Public Member Functions

virtual QString CalculateFileName (const QString &inputFileName, const QString &outputDirectoryPath, const ifileproc::IFileNamingParams *fileNamingParamsPtr) const override
 Calculate the new file path for a given input file name.
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from ifileproc::IFileNaming

Static Public Member Functions

static QString CalculateNewFileName (const QString &inputFilePath, const QString &outputDirectoryPath, const QString &prefix, const QString &suffix, const QString &fileExtension, IFileNamingParams::OverwriteStrategy overwriteStrategy)
 

Additional Inherited Members

- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
bool SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send info message to log.
 
bool SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send warning message to log.
 
bool SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send error message to log.
 
bool SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send critical message to log.
 
bool SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once info message to log.
 
bool SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once warning message to log.
 
bool SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once error message to log.
 
bool SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once critical message to log.
 
bool SendUserMessage (const istd::IInformationProvider *messagePtr) const
 Send message with user object.
 
bool AllowMessageOnceAgain (int id)
 Reset message lock.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 
- Protected Member Functions inherited from istd::ILogger
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Component for calculating of the new file name.

See also
ifileproc::IFileNaming

Definition at line 26 of file CFileNamingComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CalculateFileName()

virtual QString ifileproc::CFileNamingComp::CalculateFileName ( const QString & inputFileName,
const QString & outputDirectoryPath,
const ifileproc::IFileNamingParams * fileNamingParamsPtr ) const
overridevirtual

Calculate the new file path for a given input file name.

Implements ifileproc::IFileNaming.

◆ CalculateNewFileName()

static QString ifileproc::CFileNamingComp::CalculateNewFileName ( const QString & inputFilePath,
const QString & outputDirectoryPath,
const QString & prefix,
const QString & suffix,
const QString & fileExtension,
IFileNamingParams::OverwriteStrategy overwriteStrategy )
static

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

© Witold Gantzke and Kirill Lepskiy