wxGISTask Class Reference

#include <task.h>

Inheritance diagram for wxGISTask:

Collaboration diagram for wxGISTask:

Classes
struct	_message

Public Types
typedef struct wxGISTask::_message	MESSAGE

Public Member Functions
	wxGISTask (wxGISTaskBase *pParentTask=NULL, const wxJSONValue &TaskConfig=wxJSONValue())
virtual wxString	GetDescription (void) const
virtual wxString	GetExecutable (void) const
virtual wxDateTime	GetDateBegin (void) const
virtual wxDateTime	GetDateEnd (void) const
virtual wxDateTime	GetDateCreated (void) const
virtual wxULongLong	GetVolume (void) const
virtual long	GetPriority (void) const
virtual void	SetPriority (long nPriority)
virtual double	GetDone (void) const
virtual void	SetState (wxGISEnumTaskStateType eState)
virtual int	GetChildrenCount () const
virtual wxJSONValue	GetParameters (void) const
virtual wxJSONValue	GetConfig (void)
virtual void	AddSubTask (wxGISTask *pTask)
virtual void	ChangeTask (const wxJSONValue &val)
virtual wxGISTaskMessagesArray	GetMessages (void) const
virtual wxGISTaskMessage	GetMessage (long nMessageId) const
virtual void	AddMessage (wxGISTaskMessage *pMessage)
virtual bool	StartTask (bool bWait=false)
virtual bool	StopTask (bool bWait=false)
	wxGISTask (wxGISTaskBase *pParentTask, const wxString &sPath)
virtual int	GetGroupId (void) const
virtual bool	Load (void)
virtual bool	Delete (long nMessageId=-2, int nUserId=-2)
virtual void	GetChildren (long nMessageId, int nUserId)
virtual bool	StartTask (long nMessageId, int nUserId)
virtual bool	StopTask (long nMessageId, int nUserId)
virtual bool	ChangeTask (const wxJSONValue &TaskVal, long nMessageId, int nUserId)
virtual bool	Create (const wxJSONValue &TaskConfig)
virtual wxJSONValue	GetAsJSON (void)
virtual long	GetCommonPriority (void)
virtual void	OnDestroy (void)
virtual void	OnStart (void)
virtual void	OnStop (void)
virtual void	OnTerminate (int pid, int status)
virtual int	GetRunningTaskCount (void) const
virtual void	GetQueredTasks (wxGISQueredTasksArray &oaTasks)
virtual void	ChangeTask (void)
virtual void	ChangeTaskMsg (wxGISEnumMessageType nType, const wxString &sInfoData)
virtual long	Execute (void)
virtual bool	IsGroupIdExecuting (int nGroupId) const
virtual void	AddInfo (wxGISEnumMessageType nType, const wxString &sInfoData)
virtual void	UpdatePercent (const wxString &sPercentData)
virtual bool	Start (void)
virtual void	SendNetMessage (wxGISNetCommand eCmd, wxGISNetCommandState eCmdState, wxGISMessagePriority ePrio, const wxJSONValue &val, const wxString &sMsg, long nMessageId=wxNOT_FOUND, int nUserId=wxNOT_FOUND)
virtual void	NetMessage (wxGISNetCommand eCmd, wxGISNetCommandState eCmdState, const wxJSONValue &val, long nMessageId=wxNOT_FOUND, int nUserId=wxNOT_FOUND)
virtual void	NetCommand (wxGISNetCommandState eCmdState, const wxJSONValue &val, long nMessageId=wxNOT_FOUND, int nUserId=wxNOT_FOUND)
Public Member Functions inherited from wxGISTaskBase
	wxGISTaskBase (wxGISTaskBase *pParentTask=NULL)
virtual wxString	GetName () const
virtual wxString	GetLastError () const
virtual int	GetId (void) const
virtual wxGISEnumTaskStateType	GetState (void) const
virtual bool	Delete (void)
virtual void	NetMessage (wxGISNetCommand eCmd, wxGISNetCommandState eCmdState, const wxJSONValue &val)
virtual size_t	GetSubTaskCount (void) const
virtual wxGISTaskBase *	GetSubTask (size_t nIndex) const
virtual wxGISTaskBase *	GetSubTask (int nId) const
virtual int	GetRunTaskCount (void) const
virtual void	AddTask (const wxJSONValue &val)
virtual bool	RenameTask (const wxString &sNewName)
virtual void	OnSubTaskChanged (int nId)
virtual void	SendNetMessageAsync (wxGISNetCommand eCmd, wxGISNetCommandState eCmdState, const wxJSONValue &val)
virtual wxGISNetCommandState	SendNetMessageSync (wxGISNetCommand eCmd, wxGISNetCommandState eCmdState, const wxJSONValue &val)
	wxGISTaskBase (wxGISTaskBase *pParentTask)
virtual wxString	GetName () const
virtual int	GetId (void) const
virtual int	GetNewId (void)
virtual void	Delete (wxGISTaskBase *pTask)
virtual bool	HasName (const wxString &sName) const
virtual void	StartNextQueredTask (void)
virtual wxString	GetNewStorePath (const wxString &sAddToName, const wxString &sSubDir=wxEmptyString)
virtual wxString	GetStorePath () const
virtual bool	Save (void)
Public Member Functions inherited from wxGISConnectionPointContainer
virtual long	Advise (wxEvtHandler *pEvtHandler)
virtual void	Unadvise (long nCookie)
Public Member Functions inherited from wxGISProcess
	wxGISProcess (IGISProcessParent *pParent=NULL)
virtual void	Stop (void)
virtual void	ProcessInput (wxString &sInputData)
virtual wxGISEnumTaskStateType	GetState (void) const
virtual wxDateTime	GetStart (void) const
virtual wxDateTime	GetFinish (void) const

Protected Member Functions
virtual void	NetNote (wxGISNetCommandState eCmdState, const wxJSONValue &val)
virtual wxJSONValue	GetStoreConfig (void)
Protected Member Functions inherited from wxGISTaskBase
virtual void	Delete (wxGISTaskBase *pTask)
virtual void	ClearTasks (void)
virtual void	NetCommand (wxGISNetCommandState eCmdState, const wxJSONValue &val)
virtual void	ClearTasks (void)
Protected Member Functions inherited from wxGISConnectionPointContainer
virtual void	AddEvent (const wxEvent &event)
virtual void	PostEvent (wxEvent *event)
Protected Member Functions inherited from wxGISProcess
virtual wxThread::ExitCode	Entry ()
bool	CreateAndRunReadThread (void)
void	DestroyReadThread (void)

Protected Attributes
wxString	m_sDescription
wxDateTime	m_dtBeg
wxDateTime	m_dtEnd
wxDateTime	m_dtCreated
wxString	m_sExecPath
wxULongLong	m_nVolume
long	m_nPriority
int	m_nGroupId
double	m_dfDone
wxJSONValue	m_Params
wxGISTaskMessagesArray	m_oaMessages
int	m_nChildrenCount
double	m_dfPrevDone
Protected Attributes inherited from wxGISTaskBase
wxGISTaskBase *	m_pParentTask
int	m_nId
wxString	m_sName
wxGISEnumTaskStateType	m_nState
wxString	m_sLastError
wxGISTaskMap	m_omSubTasks
int	m_nTaskCounter
wxString	m_sStoragePath
Protected Attributes inherited from wxGISConnectionPointContainer
wxVector< wxEvtHandler * >	m_pPointsArray
wxCriticalSection	m_CritSectEvt
Protected Attributes inherited from wxGISProcess
IGISProcessParent *	m_pParent
wxCriticalSection	m_ExitLock
wxDateTime	m_dtBeg
wxDateTime	m_dtEstEnd
wxGISEnumTaskStateType	m_nState
double	m_dfDone
bool	m_bKill

Detailed Description

The task is class which controls executing geoprocessing operation (tool). The tasks add to the quere. Then user start executing the task, the task state changes to the quered and task is waiting for the task manager tool. The task really starts it state changes to the working.

Library:  wxGISGeoprocessing

The task class.

Library:  wxGISGeoprocessing

Member Function Documentation

void wxGISTask::NetCommand ( wxGISNetCommandState  eCmdState, const wxJSONValue &  val, long  nMessageId = wxNOT_FOUND, int  nUserId = wxNOT_FOUND  )

virtual

• case enumGISCmdStPriority: TODO:

Implements wxGISTaskBase.

---

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

• /home/bishop/work/projects/nextgismanager/include/wxgis/geoprocessing/task.h
• /home/bishop/work/projects/nextgismanager/src/geoprocessing/task.cpp