ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
ifile::CGeneratedFileNameParamComp Class Reference

Component for auto generated file path. More...

#include <CGeneratedFileNameParamComp.h>

Inheritance diagram for ifile::CGeneratedFileNameParamComp:
ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp > ifile::CRelativeFileNameParamComp ilog::CLoggerBase ifile::IRelativeFilePath ifile::CFileNameParamComp ilog::ILoggable istd::ILogger ifile::IFileNameParam icomp::CComponentBase ifile::CFileNameParam istd::IPolymorphic istd::IPolymorphic iser::ISerializable icomp::IComponent ifile::IFileNameParam istd::IChangeable istd::IPolymorphic iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic

Public Types

typedef ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamCompBaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >
typedef ifile::CRelativeFileNameParamComp BaseClass
 Base class typedef for component functionality.
 
typedef ilog::CLoggerBase BaseClass2
 Base class typedef for logger functionality.
 
- Public Types inherited from ifile::CRelativeFileNameParamComp
typedef ifile::CFileNameParamComp BaseClass
 
- Public Types inherited from ifile::IFileNameParam
enum  PathType { PT_UNKNOWN , PT_FILE , PT_DIRECTORY , PT_URL }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 
- Public Types inherited from ifile::CFileNameParamComp
typedef icomp::CComponentBase BaseClass
 
typedef CFileNameParam BaseClass2
 

Public Member Functions

virtual void SetPath (const QString &path) override
 Set path.
 
- Public Member Functions inherited from ifile::CRelativeFileNameParamComp
 CRelativeFileNameParamComp ()
 
virtual QString GetBasePath () const override
 
virtual const QString & GetPath () const override
 Get path.
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- 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 bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
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.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from ifile::CFileNameParamComp
virtual int GetPathType () const override
 Get intended type of the path.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
virtual const icomp::IComponentGetParentComponent (bool ownerOnly=false) const override
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
 Get access to specified component interface.
 
virtual IComponentContextSharedPtr GetComponentContext () const override
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
 Set component context of this component.
 
- Public Member Functions inherited from ifile::CFileNameParam
virtual int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
virtual bool IsEqual (const IChangeable &object) const override
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 Default constructor.
 
virtual void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Attach a message consumer for logging.
 
virtual ilog::IMessageConsumerGetLogPtr () const override
 Get the currently attached message consumer.
 

Protected Member Functions

virtual void OnComponentCreated () override
 Called when component is created.
 
virtual void OnComponentDestroyed () override
 Called when component is destroyed.
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >
bool IsVerboseEnabled (int tracingLevel=0) const
 Check if verbose messages are enabled for a given tracing level.
 
void SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
 Send a verbose message if enabled.
 
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message before sending.
 
- 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.
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const icomp::IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from ilog::CLoggerBase
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.
 
virtual bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const override
 Check if any log message is consumed.
 
virtual bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Protected Attributes inherited from ifile::CFileNameParam
QString m_path
 
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Component for auto generated file path.

Definition at line 18 of file CGeneratedFileNameParamComp.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 21 of file CGeneratedFileNameParamComp.h.

Member Function Documentation

◆ OnComponentCreated()

virtual void ifile::CGeneratedFileNameParamComp::OnComponentCreated ( )
overrideprotectedvirtual

Called when component is created.

Automatically connects the log consumer from the "Log" reference.

Note
Override to add initialization, but always call base class:
virtual void OnComponentCreated() override {
// Custom initialization
}
virtual void OnComponentCreated() override
Called when component is created.
virtual void OnComponentCreated() override
Called when component is created.

Reimplemented from ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >.

◆ OnComponentDestroyed()

virtual void ifile::CGeneratedFileNameParamComp::OnComponentDestroyed ( )
overrideprotectedvirtual

Called when component is destroyed.

Automatically disconnects the log consumer for cleanup.

Note
Override to add cleanup, but always call base class:
virtual void OnComponentDestroyed() override {
// Custom cleanup
}
virtual void OnComponentDestroyed() override
Called when component is destroyed.
virtual void OnComponentDestroyed() override
Called when component is destroyed.

Reimplemented from ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >.

◆ SetPath()

virtual void ifile::CGeneratedFileNameParamComp::SetPath ( const QString &  path)
overridevirtual

Set path.

Reimplemented from ifile::CRelativeFileNameParamComp.


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