OperationData Class Reference

The base operation data for all client operations. More...

#include <client.h>

Inheritance diagram for OperationData:

Public Member Functions
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.

Public Attributes
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.

Additional Inherited Members
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 base operation data for all client operations.

Example of use of state changed and progress changed events:

// Request method
void LoadMyTask1(Client *client)
{
    // Prepare the command to load a task into a flash
    ClientStruct::FlashFileLoadData data;
    data.setFlags(ClientStruct::FlashFileLoadData::fOverwrite);
    data.setSource("C:\\Local\\MyTask1.elf");
    data.setTarget("/fa/mytask1.elf");
    data.progressChanged.connect(progressChanged);
    data.stateChanged.connect(stateChanged);
    // or if event handler are non static member function of class (e.g. MyClass *obj)
    // data.progressChanged.connect(obj, &MyClass::progressChanged);
    // data.stateChanged.connect(obj, &MyClass::stateChanged);
 
    // Execute the command
    if (client->flashFileLoad(data) == Globals::resSuccess)
    {
        // ...
    }
}
 
// Call back for the progress changed event
void progressChanged(uint64_t senderId, int32_t min, int32_t max, int32_t cur)
{
    // ...
}
 
// Call back for the state changed event
stateChanged(uint64_t senderId, RLibCpp::Bcc::ClientStruct::ActivityStates state, uint64_t param)
{
    // ...
}

Member Function Documentation

setProgress()

void setProgress	(	uint64_t	senderId,
		int32_t	min,
		int32_t	max,
		int32_t	cur )

Set the activity progress.

Parameters

senderId	The identifier of the object firing the event
min	Minimum progress value.
max	Maximum progress value.
cur	Current progress value.

setState()

void setState	(	uint64_t	senderId,
		ActivityStates	state,
		uint64_t	data = 0 )

Set the activity state.

Parameters

senderId	The identifier of the object firing the event
state	The activity state string.
data	Optional data for state

Member Data Documentation

progressChanged

Signal4<uint64_t, int32_t, int32_t, int32_t> progressChanged

Signal emitted when the progress of the operation changes.

Parameters

senderId	The identifier of the object firing the event
min	Minimum progress value.
max	Maximum progress value.
cur	Current progress value.

stateChanged

Signal3<uint64_t, ActivityStates, uint64_t> stateChanged

Signal emitted when the state of the operation changes.

Parameters

senderId	The identifier of the object firing the event
state	The activity state string
data	Optional data for state