FlashFileLoadData Class Reference

The data for the flashFileLoad method. More...

#include <client.h>

Inheritance diagram for FlashFileLoadData:

Public Types
enum	Flagss {   fOverwrite = 0x1 , fRecover = 0x2 , fAsBoot = 0x8 , fAsBios = 0x10 ,   fAsMain = 0x20 , fAsCfg = 0x40 }
	The available operation flags. More...
enum	PostOperations { postOpNone = 0 , postOpReload , postOpRestart , postOpSyncRestart }
	The available post operations. More...

Public Member Functions
	FlashFileLoadData ()
	Class constructor.
String	source () const
	Get the source file name. [IN].
void	setSource (String value)
	Set the source file name. [IN].
String	target () const
	Get the target file name. [IN].
void	setTarget (String value)
	Set the target file name. [IN].
Flagss	flags () const
	Get the operation flags. [IN].
void	setFlags (Flagss value)
	Set the operation flags. [IN].
PostOperations	postOperation () const
	Get the post operation indentifier. [IN].
void	setPostOperation (PostOperations value)
	Set the post operation indentifier. [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 flashFileLoad method.

See also

Client::flashFileLoad()

Member Enumeration Documentation

Flagss

enum Flagss

The available operation flags.

Enumerator
fOverwrite	Overwrite target file.
fRecover	Try to recover the operation.
fAsBoot	Load file as BOOT.
fAsBios	Load file as BIOS.
fAsMain	Load file as MAIN.
fAsCfg	Load file as CFG.

PostOperations

enum PostOperations

The available post operations.

Enumerator
postOpNone	No post-operation.
postOpReload	Reload of the file, if supported.
postOpRestart	Reload and restart of the file, if supported.
postOpSyncRestart	Reload and synchronized restart of the file, if supported.

Constructor & Destructor Documentation

FlashFileLoadData()

FlashFileLoadData

(

)

Class constructor.

Member Function Documentation

flags()

Flagss flags

(

)

const

Get the operation flags. [IN].

Returns

The parameter value

postOperation()

PostOperations postOperation

(

)

const

Get the post operation indentifier. [IN].

Returns

The parameter value

Remarks

The post operation will be executed only after a successfully completation of the load operation.

setFlags()

void setFlags

(

Flagss

value

)

Set the operation flags. [IN].

Parameters

value

The value to set

setPostOperation()

void setPostOperation

(

PostOperations

value

)

Set the post operation indentifier. [IN].

Parameters

value

The value to set

Remarks

The post operation will be executed only after a successfully completation of the load operation.

setSource()

void setSource

(

String

value

)

Set the source file name. [IN].

Parameters

value

The value to set

setTarget()

void setTarget

(

String

value

)

Set the target file name. [IN].

Parameters

value

The value to set

source()

String source

(

)

const

Get the source file name. [IN].

Returns

The parameter value

target()

String target

(

)

const

Get the target file name. [IN].

Returns

The parameter value