FlashDiskCreateData Class Reference

The data for the flashDiskCreate method. More...

#include <client.h>

Inheritance diagram for FlashDiskCreateData:

Public Types
enum	Flagss { fQueryOnly = 0x1 , fOverwrite = 0x2 }
	The avaiable operation flags. More...

Public Member Functions
	FlashDiskCreateData ()
	Class constructor.
String	name () const
	Get the flash device name. [IN].
void	setName (String value)
	Set the flash device name. [IN].
uint32_t	size () const
	Get the flash request size [bytes]. [IN/OUT].
void	setSize (uint32_t value)
	Set the flash request size [bytes]. [IN/OUT].
Flagss	flags () const
	Get the operation flags. [IN].
void	setFlags (Flagss value)
	Set the operation flags. [IN].
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 flashDiskCreate method.

See also

Client.flashDiskCreate()

Member Enumeration Documentation

Flagss

enum Flagss

The avaiable operation flags.

Enumerator
fQueryOnly	Query only the effective configuration (does not create the flash).
fOverwrite	Overwrite existing flash.

Constructor & Destructor Documentation

FlashDiskCreateData()

FlashDiskCreateData

(

)

Class constructor.

Member Function Documentation

flags()

Flagss flags

(

)

const

Get the operation flags. [IN].

Returns

The parameter value

name()

String name

(

)

const

Get the flash device name. [IN].

Returns

The parameter value

setFlags()

void setFlags

(

Flagss

value

)

Set the operation flags. [IN].

Parameters

value

The value to set

setName()

void setName

(

String

value

)

Set the flash device name. [IN].

Parameters

value

The value to set

setSize()

void setSize

(

uint32_t

value

)

Set the flash request size [bytes]. [IN/OUT].

Parameters

value

The value to set

Remarks

This value will be updated with the effective flash size.

size()

uint32_t size

(

)

const

Get the flash request size [bytes]. [IN/OUT].

Returns

The parameter value

Remarks

This value will be updated with the effective flash size.