OnlineObjectSearchDialog.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.8.5
// ----------------------------------------------------------------------------
// pcl/OnlineObjectSearchDialog.h - Released 2024-12-28T16:53:48Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_OnlineObjectSearchDialog_h
#define __PCL_OnlineObjectSearchDialog_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ComboBox.h>
#include <pcl/Dialog.h>
#include <pcl/Edit.h>
#include <pcl/Label.h>
#include <pcl/PushButton.h>
#include <pcl/Sizer.h>
#include <pcl/TextBox.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS NetworkTransfer;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS OnlineObjectSearchDialog : public Dialog
{
public:
 
   OnlineObjectSearchDialog();
 
   const String& ObjectName() const
   {
      return m_objectName;
   }
 
   const String& ObjectType() const
   {
      return m_objectType;
   }
 
   const String& SpectralType() const
   {
      return m_spectralType;
   }
 
   double VMagnitude() const
   {
      return m_vmag;
   }
 
   double RA() const
   {
      return m_RA;
   }
 
   double Dec() const
   {
      return m_Dec;
   }
 
   double MuRA() const
   {
      return m_muRA;
   }
 
   double MuDec() const
   {
      return m_muDec;
   }
 
   double Parallax() const
   {
      return m_parallax;
   }
 
   double RadialVelocity() const
   {
      return m_radVel;
   }
 
   bool IsValid() const
   {
      return m_valid;
   }
 
   String SearchText() const
   {
      return ObjectName_Edit.Text();
   }
 
   String ServerURL() const;
 
protected:
 
   VerticalSizer       Global_Sizer;
      HorizontalSizer      Search_Sizer;
         Label                ObjectName_Label;
         Edit                 ObjectName_Edit;
         PushButton           Search_Button;
      HorizontalSizer      Server_Sizer;
         Label                Server_Label;
         ComboBox             Server_ComboBox;
      TextBox              SearchInfo_TextBox;
      HorizontalSizer      Buttons_Sizer;
         PushButton           Get_Button;
         PushButton           Cancel_Button;
 
   String    m_objectName;
   String    m_objectType;
   String    m_spectralType;
   double    m_vmag = 0;     // V magnitude
   double    m_RA = 0;       // degrees
   double    m_Dec = 0;      // degrees
   double    m_muRA = 0;     // mas/year
   double    m_muDec = 0;    // mas/year
   double    m_parallax = 0; // mas
   double    m_radVel = 0;   // km/s
   bool      m_valid = false;
   bool      m_downloading = false;
   bool      m_abort = false;
   IsoString m_downloadData;
 
   void e_Show( Control& sender );
   void e_GetFocus( Control& sender );
   void e_LoseFocus( Control& sender );
   bool e_Download( NetworkTransfer& sender, const void* buffer, fsize_type size );
   bool e_Progress( NetworkTransfer& sender,
                    fsize_type downloadTotal, fsize_type downloadCurrent,
                    fsize_type uploadTotal, fsize_type uploadCurrent );
   void e_Click( Button& sender, bool checked );
   void e_ItemSelected( ComboBox& sender, int itemIndex );
 
   void LoadSettings();
   void SaveSettings() const;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_OnlineObjectSearchDialog_h
 
// ----------------------------------------------------------------------------
// EOF pcl/OnlineObjectSearchDialog.h - Released 2024-12-28T16:53:48Z