Class used for local action request encapsulation. More...

#include <LocalActionRequest.h>

Inheritance diagram for ipsdk::core::LocalActionRequest:

Public Member Functions
eActionRequestType	getActionRequestType () const
	retrieve action request type

BoolResult	init (const ActionPtr &pAction, bool bIntermediateData)
	initialization of object More...

Constructors and destructors
	LocalActionRequest ()

	~LocalActionRequest ()

Public Member Functions inherited from ipsdk::core::BaseActionRequest
bool	isInit () const
	retrieve object initialization flag

const Guid &	getGuid () const
	retrieve guid associated to action request More...

eExecutionStatus	getStatus () const
	check for request execution status More...

void	addCompletionCB (const RequestCompletionCB &completionCB)
	add a completion callback associated to action request More...

ExecResult	executeAction ()
	launch execution of associated action More...

void	requestCancellation ()
	ask for cancellation of associated action More...

bool	isCancellationRequested () const
	check whether a cancellation has been requested More...

void	waitForCompletion ()
	method allowing to wait for execution end More...

ExecResult	getActionResult () const
	retrieve action result More...

void	clear ()
	clear of object data More...

	BaseActionRequest ()

virtual	~BaseActionRequest ()=0

Protected Member Functions
ExecResult	executeActionDerived ()
	launch execution of associated action in derived class More...

void	requestCancellationDerived ()
	ask for cancellation of associated action in derived class

void	clearDerived ()
	clear of object data in derived class

void	notifyActionCompletion (const ActionPtr &pAction)
	method used to notify of execution completion for action

Protected Member Functions inherited from ipsdk::core::BaseActionRequest
BoolResult	initBase (const Guid &requestGuid=Guid())
	base class initialization method More...

void	setStatusToWaiting ()
	method allowing to set request status to waiting for execution More...

void	notifyCompletion (const ExecResult &bResult)
	method used to notify of execution completion for request More...

Protected Attributes
ActionPtr	_pAction
	pointer to action associated to request

bool	_bIntermediateData

Detailed Description

Class used for local action request encapsulation.

Author: E. Noirfalise

Date: 2013/12/18

Copyright: 2013 Reactiv'IP, all right reserved.

Access to these actions is immediate

Member Function Documentation

◆ init()

BoolResult ipsdk::core::LocalActionRequest::init	(	const ActionPtr &	pAction,
		bool	bIntermediateData
	)

initialization of object

Exceptions

ipsdk::core::IPSDKCoreException if pAction->getStatus() != eExecutionStatus::eES_NotStarted && pAction->getStatus() != eExecutionStatus::eES_WaitingForExecution

Returns: false in case of failure

◆ executeActionDerived()

ExecResult ipsdk::core::LocalActionRequest::executeActionDerived ( )

protectedvirtual

launch execution of associated action in derived class

Returns: execution result

Implements ipsdk::core::BaseActionRequest.

Member Data Documentation

◆ _bIntermediateData

bool ipsdk::core::LocalActionRequest::_bIntermediateData

protected

flag indicating whether local action request is an intermediate data for execution. In this case output data will be deleted after execution

The documentation for this class was generated from the following file:

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKCore/Processing/ActionRequest/LocalActionRequest.h

Public Member Functions