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

The data for the flashSetAttributes method. More...

#include <client.h>

Inheritance diagram for FlashSetAttributesData:
OperationData ErrorData

Public Types

enum  Flagss {
  flagAbsPath = 0x00000001 , flagRecursive = 0x00000002 , flagSetFolder = 0x00000004 , flagSetFile = 0x00000008 ,
  flagSetHidden = 0x00000010
}
 Flags. More...
 
enum  Attributess { attribSystem = 0x00000004 , attribHidden = 0x00000020 , attribReadOnly = 0x00000040 }
 Attributes. More...
 

Public Member Functions

String & filemask ()
 Get the mask of the files/folder to set. [IN].
 
void setFilemask (const String &value)
 Set the mask of the files/folder to set. [IN].
 
Flagss flags () const
 Get the operating flags. [IN].
 
void setFlags (Flagss value)
 Set the operating flags. [IN].
 
Attributess attributes () const
 Get the attributes to set. [IN].
 
void setAttributes (Attributess value)
 Set the attributes to set. [IN].
 
Attributess attributesMask () const
 Get the mask of attributes to set. [IN].
 
void setAttributesMask (Attributess value)
 Set the mask of attributes to set. [IN].
 
uint32_t count () const
 Get the number of modified objects [OUT].
 
void setCount (uint32_t value)
 Set the number of modified objects. [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 flashSetAttributes method.

See also
Client.flashSetAttributes

Member Enumeration Documentation

◆ Attributess

Attributes.

Enumerator
attribSystem 
attribHidden 
attribReadOnly 

◆ Flagss

enum Flagss

Flags.

Enumerator
flagAbsPath 
flagRecursive 
flagSetFolder 
flagSetFile 
flagSetHidden 

Member Function Documentation

◆ attributes()

Attributess attributes ( ) const

Get the attributes to set. [IN].

Returns
The parameter value

◆ attributesMask()

Attributess attributesMask ( ) const

Get the mask of attributes to set. [IN].

Returns
The parameter value

◆ count()

uint32_t count ( ) const

Get the number of modified objects [OUT].

Returns
The parameter value

◆ filemask()

String & filemask ( )

Get the mask of the files/folder to set. [IN].

Returns
The parameter value

◆ flags()

Flagss flags ( ) const

Get the operating flags. [IN].

Returns
The parameter value

◆ setAttributes()

void setAttributes ( Attributess value)

Set the attributes to set. [IN].

Parameters
valueThe value to set

◆ setAttributesMask()

void setAttributesMask ( Attributess value)

Set the mask of attributes to set. [IN].

Parameters
valueThe value to set

◆ setCount()

void setCount ( uint32_t value)

Set the number of modified objects. [OUT].

Parameters
valueThe value to set

◆ setFilemask()

void setFilemask ( const String & value)

Set the mask of the files/folder to set. [IN].

Parameters
valueThe value to set

/*!

◆ setFlags()

void setFlags ( Flagss value)

Set the operating flags. [IN].

Parameters
valueThe value to set