IPSDKCore/html/a11474_source.html

 // ActionProviderTypes.h:
 // ----------------------
 //

 #ifndef __IPSDKCORE_ACTIONPROVIDERTYPES_H__
 #define __IPSDKCORE_ACTIONPROVIDERTYPES_H__

 #include <IPSDKUtil/Tools/Guid.h>
 #include <IPSDKUtil/Tools/ProcessingResult.h>
 #include <IPSDKUtil/Tools/EnumMacros.h>
 #include <IPSDKCore/Processing/ActionRequest/ActionRequestTypes.h>
 #include <boost/shared_ptr.hpp>
 #include <boost/function.hpp>
 #include <map>
 #include <list>

 namespace ipsdk {
 namespace core {

 class BaseActionProvider;


 IPSDK_ENUM(eQueryActionResult,
     (eQAR_Success)
     (eQAR_Failure)
     (eQAR_NoMore)
 )


 typedef ProcessingResult<eQueryActionResult> QueryResult;

 typedef boost::shared_ptr<BaseActionProvider> ActionProviderPtr;

 typedef std::map<Guid, ActionRequestPtr> ActionRequestColl;

 typedef boost::function1<void, const ActionProviderPtr&> ProviderCompletionCB;

 typedef std::list<ProviderCompletionCB> ProviderCompletionCBColl;


 } // end of namespace core
 } // end of namespace ipsdk

 #endif // __IPSDKCORE_ACTIONPROVIDERTYPES_H__
ipsdk::ProcessingResult
Class allowing to encapsulate a typed process result associated to a string description.
Definition: ProcessingResult.h:28

ipsdk
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22

ipsdk::core::ProviderCompletionCB
boost::function1< void, const ActionProviderPtr & > ProviderCompletionCB
function callback used to notify of action provider completion
Definition: ActionProviderTypes.h:64

ipsdk::core::eQAR_Success
Action query is successfull.
Definition: ActionProviderTypes.h:43

boost
Definition: DataItemNodeHdrMacrosDetails.h:48

ipsdk::core::eQAR_NoMore
No more action can be queried, all actions have already been queried.
Definition: ActionProviderTypes.h:47

ipsdk::core::BaseActionProvider
Base class for action providers.
Definition: BaseActionProvider.h:54

ipsdk::Guid
Class encapsulating an auto initialized uuid.
Definition: Guid.h:27

ipsdk::core::ActionRequestColl
std::map< Guid, ActionRequestPtr > ActionRequestColl
collection of action requests
Definition: ActionProviderTypes.h:61

ipsdk::core::eQAR_Failure
Action query has failed.
Definition: ActionProviderTypes.h:45

ActionRequestTypes.h
Predefined types for action resquests management.

ipsdk::core::ActionRequestPtr
boost::shared_ptr< BaseActionRequest > ActionRequestPtr
shared pointer for action requests
Definition: ActionRequestTypes.h:52

ipsdk::core::eQueryActionResult
eQueryActionResult
Enumerate describing result of an action query.
Definition: ActionProviderTypes.h:41

ipsdk::core::ProviderCompletionCBColl
std::list< ProviderCompletionCB > ProviderCompletionCBColl
collection of functions callback used to notify of action provider completion
Definition: ActionProviderTypes.h:67

ipsdk::core::ActionProviderPtr
boost::shared_ptr< BaseActionProvider > ActionProviderPtr
shared pointer to action provider
Definition: ActionProviderTypes.h:58

std
STL namespace.

EnumMacros.h
Predefined macros for enumerates management.

IPSDK_ENUM
#define IPSDK_ENUM(enumTypeStr, enumSeq)
macro allowing to declare an enumerate for library
Definition: EnumMacros.h:26