The data for the FlashDir method. More...

#include <client.h>

Inheritance diagram for FlashDirData:

Public Types
enum	Flagss { fAbsPath = 0x1 , fRecursive = 0x2 , fListFolders = 0x4 , fListFiles = 0x8 , fDateTimeMask = 0x30 , fDateTimeCreation = 0x10 , fDateTimeModify = 0x20 , fDateTimeAccess = 0x30 , fFullyQualified = 0x40 , fListHiddens = 0x80 }
	The available operation flags. More...

Public Member Functions
	FlashDirData ()
	Class constructor.

String	path () const
	Get the source path, with optionally jolly characters. [IN].

void	setPath (String value)
	Set the source path, with optionally jolly characters. [IN].

Flagss	flags () const
	Get the operation flags. [IN].

void	setFlags (Flagss value)
	Set the operation flags. [IN].

FlashItem::Vector &	items ()
	Get the result list of flash items. [OUT].

Public Member Functions inherited from OperationData
void	setState (uint64_t senderId, ActivityStates state, uint64_t data=0)
	Set the activity state.

void	setProgress (uint64_t senderId, int32_t min, int32_t max, int32_t cur)
	Set the activity progress.

Public Member Functions inherited from ErrorData
	ErrorData ()
	Class contructor.

void	setErrorFromMessage (Message *src)
	Set error information from a source message.

void	clearError ()
	Clear the error information.

void	setError (Message::ErrCodes errCode)
	Set the error information.

void	setError (Message::ErrCodes errCode, uint16_t errExtra)
	Set the error information.

Message::ErrCodes	nackErrCode () const
	Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.

uint16_t	nackErrExtra () const
	Get the optional error extra data of the last NACK message received from the remote device.

Additional Inherited Members
Public Attributes inherited from OperationData
Signal3< uint64_t, ActivityStates, uint64_t >	stateChanged
	Signal emitted when the state of the operation changes.

Signal4< uint64_t, int32_t, int32_t, int32_t >	progressChanged
	Signal emitted when the progress of the operation changes.

Protected Member Functions inherited from ErrorData
void	setNackErrCode (Message::ErrCodes value)
	Set the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.

void	setNackErrExtra (uint16_t value)
	Set the optional error extra data of the last NACK message received from the remote device.

uint16_t	nackErrFlags () const
	Get the error information validity flags.

void	setNackErrFlags (uint16_t value)
	Set the error information validity flags.

Detailed Description

The data for the FlashDir method.

See also: Client::flashDir()

Member Enumeration Documentation

◆ Flagss

enum Flagss

The available operation flags.

Enumerator
fAbsPath	List items with absolute path.
fRecursive	List items recursively.
fListFolders	List folders.
fListFiles	List files.
fDateTimeMask	Request date/time type mask.
fDateTimeCreation	Date/time of file creation.
fDateTimeModify	Date/time of last file modification.
fDateTimeAccess	Date/time of file creation.
fFullyQualified	List items with fully qualified name.
fListHiddens	List hidden items.

Constructor & Destructor Documentation

◆ FlashDirData()

FlashDirData ( )

Class constructor.

Member Function Documentation

◆ flags()

Flagss flags ( ) const

Get the operation flags. [IN].

Returns: The parameter value

◆ items()

FlashItem::Vector & items ( )

Get the result list of flash items. [OUT].

Returns: The parameter value

◆ path()

String path ( ) const

Get the source path, with optionally jolly characters. [IN].

Returns: The parameter value

◆ setFlags()

void setFlags ( Flagss value )

Set the operation flags. [IN].

Parameters

value The value to set

◆ setPath()

void setPath ( String value )

Set the source path, with optionally jolly characters. [IN].