#include <CFileSystemInfoProviderComp.h>

Inheritance diagram for ifile::CFileSystemInfoProviderComp:

Public Types
enum	ModelId { MI_RUNTIME_STATUS = 0 }

typedef ilog::CLoggerComponentBase	BaseClass

Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base	BaseClass
	Base class typedef for component functionality.

typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

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 iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for controlling constraints behavior. More...

Signals
void	EmitUpdate (const DriveInfos &driveInfos)

Public Member Functions
	CFileSystemInfoProviderComp ()

virtual const iprm::IOptionsList &	GetDriveList () const override
	Get the list of drives available on the local machine.

virtual const istd::CSystem::FileDriveInfo *	GetFileDriveInfo (int driveIndex=-1) const override
	Get info about a given file drive.

virtual int	GetOptionsFlags () const override
	Get constraints flags.

virtual int	GetOptionsCount () const override
	Get number of managed options.

virtual QString	GetOptionName (int index) const override
	Get name of specified option.

virtual QString	GetOptionDescription (int index) const override
	Get human-readable description for an option.

virtual QByteArray	GetOptionId (int index) const override
	Get option ID.

virtual bool	IsOptionEnabled (int index) const override
	Return true if the option is enabled and can be selected.

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::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

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::IChangeable >	CloneMe (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.

Protected Types
typedef std::vector< istd::CSystem::FileDriveDescriptor >	DriveInfos

Protected Member Functions
virtual void	OnComponentCreated () override
	Called when component is created.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

virtual void	OnModelChanged (int modelId, const istd::IChangeable::ChangeSet &changeSet) override
	Called when some model observed by dispatcher will be changed.

virtual void	run () override

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
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 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.

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.

bool	RegisterModel (IModel *modelPtr, int modelId=0, const istd::IChangeable::ChangeSet &relevantFlags=istd::IChangeable::GetAllChanges())
	Register the data model to be observed.

void	UnregisterModel (int modelId=0)
	Unregister the data model object.

void	UnregisterAllModels ()
	Unregister all observed data objects.

template<class Object >
Object *	GetObjectAt (int modelId) const
	Get concrete object instance of the obsered model.

Additional Inherited Members
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 Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

Definition at line 21 of file CFileSystemInfoProviderComp.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::CLoggerComponentBase ifile::CFileSystemInfoProviderComp::BaseClass

Definition at line 30 of file CFileSystemInfoProviderComp.h.

◆ DriveInfos

typedef std::vector<istd::CSystem::FileDriveDescriptor> ifile::CFileSystemInfoProviderComp::DriveInfos

protected

Definition at line 71 of file CFileSystemInfoProviderComp.h.

Member Enumeration Documentation

◆ ModelId

enum ifile::CFileSystemInfoProviderComp::ModelId

Enumerator
MI_RUNTIME_STATUS

Definition at line 32 of file CFileSystemInfoProviderComp.h.

Constructor & Destructor Documentation

◆ CFileSystemInfoProviderComp()

ifile::CFileSystemInfoProviderComp::CFileSystemInfoProviderComp ( )

Member Function Documentation

◆ EmitUpdate

void ifile::CFileSystemInfoProviderComp::EmitUpdate ( const DriveInfos & driveInfos )

signal

◆ GetDriveList()

virtual const iprm::IOptionsList & ifile::CFileSystemInfoProviderComp::GetDriveList ( ) const

overridevirtual

Get the list of drives available on the local machine.

Implements ifile::IFileSystemInfoProvider.

◆ GetFileDriveInfo()

virtual const istd::CSystem::FileDriveInfo * ifile::CFileSystemInfoProviderComp::GetFileDriveInfo ( int driveIndex = -1 ) const

overridevirtual

Get info about a given file drive.

Parameters

driveIndex Index of the file drive specified as index of the element inside of the list returned by GetDriveList. Negative values mean that information about all available file drives will be cummulated.

Implements ifile::IFileSystemInfoProvider.

◆ GetOptionDescription()

virtual QString ifile::CFileSystemInfoProviderComp::GetOptionDescription ( int index ) const

overridevirtual

Get human-readable description for an option.

Returns detailed description or tooltip text for an option.

Parameters

index Option index (0-based).

Returns: Option description as QString, or empty string if no description exists or index is out of range.

QString description = options->GetOptionDescription(2);
if (!description.isEmpty())
{
    qDebug() << "Description:" << description;
}

See also: GetOptionName

Implements iprm::IOptionsList.

◆ GetOptionId()

virtual QByteArray ifile::CFileSystemInfoProviderComp::GetOptionId ( int index ) const

overridevirtual

Get option ID.

Returns the unique identifier for an option. The ID is stable and doesn't change when options are reordered, making it suitable for persistent references.

Parameters

index Option index (0-based).

Returns: Option ID as QByteArray, or empty array if index is out of range.

Note: The ID must be unique if SCF_SUPPORT_UNIQUE_ID flag is set.; Use FindOptionIndexById() to find an option by its ID.

QByteArray id = options->GetOptionId(1);
qDebug() << "Option ID:" << id;
 
// Later, find the option by ID
int index = iprm::FindOptionIndexById(id, *options);

See also: OptionsFlags, FindOptionIndexById

Implements iprm::IOptionsList.

◆ GetOptionName()

virtual QString ifile::CFileSystemInfoProviderComp::GetOptionName ( int index ) const

overridevirtual

Get name of specified option.

Returns the display name for an option.

Parameters

index Option index (0-based).

Returns: Option name as QString, or empty string if index is out of range.

QString name = options->GetOptionName(0);

qDebug() << "First option:" << name;

See also: GetOptionDescription, GetOptionId

Implements iprm::IOptionsList.

◆ GetOptionsCount()

virtual int ifile::CFileSystemInfoProviderComp::GetOptionsCount ( ) const

overridevirtual

Get number of managed options.

Returns: Total count of options in the list (including disabled options).

int count = options->GetOptionsCount();
for (int i = 0; i < count; ++i)
{
    // Process each option
}

See also: GetOptionName

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

virtual int ifile::CFileSystemInfoProviderComp::GetOptionsFlags ( ) const

overridevirtual

Get constraints flags.

Returns flags that describe how the constraints object behaves and what features it supports.

Returns: Bitwise OR combination of OptionsFlags values.

int flags = options->GetOptionsFlags();
 
if (flags & iprm::IOptionsList::SCF_SUPPORT_UNIQUE_ID)
{
    qDebug() << "Options have unique IDs";
}
 
if (flags & iprm::IOptionsList::SFC_DISABLE_ALLOWED)
{
    qDebug() << "Options can be disabled";
}

See also: OptionsFlags

Implements iprm::IOptionsList.

◆ IsOptionEnabled()

virtual bool ifile::CFileSystemInfoProviderComp::IsOptionEnabled ( int index ) const

overridevirtual

Return true if the option is enabled and can be selected.

Checks whether an option is currently enabled. Disabled options cannot be selected but remain visible in the list.

Parameters

index Option index (0-based).

Returns: true if option is enabled and can be selected, false if disabled or index is out of range.

for (int i = 0; i < options->GetOptionsCount(); ++i)
{
    if (options->IsOptionEnabled(i))
    {
        QString name = options->GetOptionName(i);
        qDebug() << "Enabled option:" << name;
    }
}

See also: SFC_DISABLE_ALLOWED

Implements iprm::IOptionsList.

◆ OnComponentCreated()

virtual void ifile::CFileSystemInfoProviderComp::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

BaseClass::OnComponentCreated();

}

ifile::CFileSystemInfoProviderComp::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.

ilog::TLoggerCompWrap::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.
Definition TLoggerCompWrap.h:330

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnComponentDestroyed()

virtual void ifile::CFileSystemInfoProviderComp::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

BaseClass::OnComponentDestroyed();

}

ifile::CFileSystemInfoProviderComp::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.

ilog::TLoggerCompWrap::OnComponentDestroyed
virtual void OnComponentDestroyed() override
Called when component is destroyed.
Definition TLoggerCompWrap.h:341

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ OnModelChanged()

virtual void ifile::CFileSystemInfoProviderComp::OnModelChanged	(	int	modelId,
		const istd::IChangeable::ChangeSet &	changeSet
	)

overrideprotectedvirtual

Called when some model observed by dispatcher will be changed.

Implements imod::CMultiModelDispatcherBase.

◆ run()

virtual void ifile::CFileSystemInfoProviderComp::run ( )

overrideprotectedvirtual

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

Acf/Include/ifile/CFileSystemInfoProviderComp.h

Public Types

Signals

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ DriveInfos

Member Enumeration Documentation

◆ ModelId

Constructor & Destructor Documentation

◆ CFileSystemInfoProviderComp()

Member Function Documentation

◆ EmitUpdate

◆ GetDriveList()

◆ GetFileDriveInfo()

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ IsOptionEnabled()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ OnModelChanged()

◆ run()