Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
Public Types | Public Member Functions | List of all members
FlashFolderInfoData Class Reference

The data for the flashFolderInfo method. More...

#include <client.h>

Inheritance diagram for FlashFolderInfoData:
OperationData ErrorData

Public Types

enum  Flagss {
  fDateTimeMask = 0x3 , fDefault = 0x0 , fDateTimeCreation = 0x1 , fDateTimeModify = 0x2 ,
  fDateTimeAccess = 0x3
}
 The variable flags for the operation. More...
 

Public Member Functions

 FlashFolderInfoData ()
 Class constructor.
 
String path () const
 Get the target folder path. [IN].
 
void setPath (String value)
 Set the target folder path. [IN].
 
Flagss flags () const
 Get the operation flags. [IN].
 
void setFlags (Flagss value)
 Set the operation flags. [IN].
 
FlashIteminfo ()
 Get the obtained folder infomation. [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 flashFolderInfo method.

See also
Client.flashFolderInfo()

Member Enumeration Documentation

◆ Flagss

enum Flagss

The variable flags for the operation.

Enumerator
fDateTimeMask 

The date and time type mask.

fDefault 

The date and time default mask.

fDateTimeCreation 

Get date and time of file creation.

fDateTimeModify 

Get date and time of last file modification.

fDateTimeAccess 

Get date and time of file creation.

Constructor & Destructor Documentation

◆ FlashFolderInfoData()

Class constructor.

Member Function Documentation

◆ flags()

Flagss flags ( ) const

Get the operation flags. [IN].

Returns
The parameter value

◆ info()

FlashItem & info ( )

Get the obtained folder infomation. [OUT].

Returns
The parameter value

◆ path()

String path ( ) const

Get the target folder path. [IN].

Returns
The parameter value

◆ setFlags()

void setFlags ( Flagss value)

Set the operation flags. [IN].

Parameters
valueThe value to set

◆ setPath()

void setPath ( String value)

Set the target folder path. [IN].

Parameters
valueThe value to set