boinc/clientgui/MainDocument.h

// $Id$
//
// The contents of this file are subject to the BOINC Public License
// Version 1.0 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://boinc.berkeley.edu/license_1.0.txt
// 
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
// License for the specific language governing rights and limitations
// under the License. 
// 
// The Original Code is the Berkeley Open Infrastructure for Network Computing. 
// 
// The Initial Developer of the Original Code is the SETI@home project.
// Portions created by the SETI@home project are Copyright (C) 2002
// University of California at Berkeley. All Rights Reserved. 
// 
// Contributor(s):
//
// Revision History:
//

#ifndef _MAINDOCUMENT_H_
#define _MAINDOCUMENT_H_

#if defined(__GNUG__) && !defined(__APPLE__)
#pragma interface "MainDocument.cpp"
#endif

#include "gui_rpc_client.h"


class CMainDocument : public wxObject
{
    DECLARE_DYNAMIC_CLASS(CMainDocument)

public:
    CMainDocument();
    ~CMainDocument();

    wxInt32                     OnInit();
    wxInt32                     OnExit();
    wxInt32                     OnIdle();

    enum RESULTTYPES
    {
        RESULT_NEW = 0,
        RESULT_FILES_DOWNLOADING = 1,
        RESULT_FILES_DOWNLOADED = 2,
        RESULT_COMPUTE_ERROR = 3,
        RESULT_FILES_UPLOADING = 4,
        RESULT_FILES_UPLOADED = 5
    };

    enum CPUSCHEDTYPES
    {
        CPU_SCHED_UNINITIALIZED = 0,
        CPU_SCHED_PREEMPTED = 1,
        CPU_SCHED_SCHEDULED = 2
    };


    //
    // Global
    //
private:

    RPC_CLIENT                  rpc;
    CC_STATE                    state;
    HOST_INFO                   host;
    wxDateTime                  m_dtCachedStateTimestamp;
    wxDateTime                  m_dtCachedStateLockTimestamp;
    bool                        m_bCachedStateLocked;

    bool                        m_bIsConnected;

    wxInt32                     CachedStateUpdate();

public:

    wxInt32                     CachedStateLock();
    wxInt32                     CachedStateUnlock();


    //
    // Project Tab
    //
private:

    PROJECTS                    project_status;
    float                       m_fProjectTotalResourceShare;

    wxInt32                     CachedProjectStatusUpdate();

public:

    wxInt32                     GetProjectCount();
    wxInt32                     GetProjectProjectName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetProjectProjectURL(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetProjectAccountName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetProjectTeamName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetProjectTotalCredit(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetProjectAvgCredit(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetProjectResourceShare(wxInt32 iIndex,  float& fBuffer);
    wxInt32                     GetProjectTotalResourceShare(wxInt32 iIndex,  float& fBuffer);
    wxInt32                     GetProjectMinRPCTime(wxInt32 iIndex, wxInt32& iBuffer);
    wxInt32                     GetProjectWebsiteCount(wxInt32 iIndex);
    wxInt32                     GetProjectWebsiteName(wxInt32 iProjectIndex, wxInt32 iWebsiteIndex, wxString& strBuffer);
    wxInt32                     GetProjectWebsiteDescription(wxInt32 iProjectIndex, wxInt32 iWebsiteIndex, wxString& strBuffer);
    wxInt32                     GetProjectWebsiteLink(wxInt32 iProjectIndex, wxInt32 iWebsiteIndex, wxString& strBuffer);
    bool                        IsProjectSuspended(wxInt32 iIndex);
    bool                        IsProjectRPCPending(wxInt32 iIndex);

    wxInt32                     ProjectAttach( wxString& strURL, wxString& strAccountKey );
    wxInt32                     ProjectDetach( wxString& strURL );
    wxInt32                     ProjectUpdate( wxString& strURL );
    wxInt32                     ProjectReset( wxString& strURL );
    wxInt32                     ProjectSuspend( wxString& strURL );
    wxInt32                     ProjectResume( wxString& strURL );


    //
    // Work Tab
    //
private:
    RESULTS                     results;

    wxInt32                     CachedResultsStatusUpdate();

public:

    wxInt32                     GetWorkCount();
    wxInt32                     GetWorkProjectName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetWorkProjectURL(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetWorkApplicationName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetWorkApplicationVersion(wxInt32 iIndex, wxInt32& iBuffer);
    wxInt32                     GetWorkName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetWorkCurrentCPUTime(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetWorkEstimatedCPUTime(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetWorkFinalCPUTime(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetWorkFractionDone(wxInt32 iIndex, float& fBuffer);
    wxInt32                     GetWorkReportDeadline(wxInt32 iIndex, wxInt32& iBuffer);
    wxInt32                     GetWorkState(wxInt32 iIndex);
    wxInt32                     GetWorkSchedulerState(wxInt32 iIndex);
    bool                        IsWorkAcknowledged(wxInt32 iIndex);
    bool                        IsWorkActive(wxInt32 iIndex);
    bool                        IsWorkReadyToReport(wxInt32 iIndex);
    bool                        IsWorkSuspended(wxInt32 iIndex);

    wxInt32                     WorkSuspend( wxString& strProjectURL, wxString& strResultName );
    wxInt32                     WorkResume( wxString& strProjectURL, wxString& strResultName );
    wxInt32                     WorkShowGraphics( wxString& strProjectURL, wxString& strResultName, bool bFullScreen );
    wxInt32                     WorkAbort( wxString& strProjectURL, wxString& strResultName );


    //
    // Messages Tab
    //
private:

    MESSAGES                    messages;
    wxInt32                     m_iMessageSequenceNumber;

    wxInt32                     CachedMessageUpdate();

public:

    wxInt32                     GetMessageCount();
    wxInt32                     GetMessageProjectName(wxInt32 iIndex, wxString& strBuffer);
    wxInt32                     GetMessageTime(wxInt32 iIndex, wxDateTime& dtBuffer);
    wxInt32                     GetMessagePriority(wxInt32 iIndex, wxInt32& iBuffer);
    wxInt32                     GetMessageMessage(wxInt32 iIndex, wxString& strBuffer);


private:

    FILE_TRANSFERS              ft;

public:


    wxInt32                     GetTransferCount();
    wxString                    GetTransferFileName(wxInt32 iIndex);
    wxString                    GetTransferProgress(wxInt32 iIndex);
    wxString                    GetTransferProjectName(wxInt32 iIndex);
    wxString                    GetTransferSize(wxInt32 iIndex);
    wxString                    GetTransferSpeed(wxInt32 iIndex);
    wxString                    GetTransferStatus(wxInt32 iIndex);
    wxString                    GetTransferTime(wxInt32 iIndex);

};

#endif