A dialog box to search for object data on online astronomical database services. More...

#include <OnlineObjectSearchDialog.h>

Inheritance diagram for pcl::OnlineObjectSearchDialog:

Public Member Functions
	OnlineObjectSearchDialog ()

double	Dec () const

bool	IsValid () const

double	MuDec () const

double	MuRA () const

const String &	ObjectName () const

const String &	ObjectType () const

double	Parallax () const

double	RA () const

double	RadialVelocity () const

String	SearchText () const

String	ServerURL () const

const String &	SpectralType () const

double	VMagnitude () const

Public Member Functions inherited from pcl::Dialog
	Dialog (Control &parent=Control::Null())

	~Dialog () override

void	Cancel ()

void	DisableUserResizing (bool disable=true)

void	EnableUserResizing (bool=true)

int	Execute ()

bool	IsUserResizable () const

void	Ok ()

void	OnExecute (execute_event_handler handler, Control &receiver)

void	OnReturn (return_event_handler handler, Control &receiver)

void	Open ()

void	Return (int retCode)

Public Member Functions inherited from pcl::Control
	Control (const Control &)=delete

	Control (Control &&)=delete

	Control (Control &parent=Null(), uint32=0)

	~Control () override

void	ActivateRealTimePreview ()

void	ActivateTrackView ()

void	ActivateWindow ()

void	AdjustToContents ()

RGBA	AlternateCanvasColor () const

RGBA	BackgroundColor () const

pcl::Rect	BoundsRect () const

void	BringToFront ()

RGBA	ButtonColor () const

RGBA	ButtonTextColor () const

bool	CanUpdate () const

RGBA	CanvasColor ()

Control &	ChildByPos (const pcl::Point &p) const

Control &	ChildByPos (int x, int y) const

pcl::Rect	ChildrenRect () const

Control &	ChildToFocus () const

void	ClearInfoText ()

int	ClientHeight () const

pcl::Rect	ClientRect () const

int	ClientWidth () const

void	ControlToLocal (const Control &, int &x, int &y) const

pcl::Point	ControlToLocal (const Control &w, const pcl::Point &p) const

pcl::Cursor	Cursor () const

void	DeactivateRealTimePreview ()

void	DeactivateTrackView ()

void	Disable (bool disabled=true)

void	DisableExpansion (bool horzDisable=true, bool vertDisable=true)

void	DisableMouseTracking (bool disable=true)

void	DisableUpdates (bool disable=true)

double	DisplayPixelRatio () const

virtual void	Enable (bool enabled=true)

void	EnableExpansion (bool horzEnable=true, bool vertEnable=true)

void	EnableMouseTracking (bool=true)

void	EnableUpdates (bool enable=true)

void	EnsureLayoutUpdated ()

void	EnsureUnique () override

void	Focus (bool focus=true)

Control &	FocusedChild () const

FocusStyles	FocusStyle () const

pcl::Font	Font () const

RGBA	ForegroundColor () const

int	FrameHeight () const

pcl::Rect	FrameRect () const

int	FrameWidth () const

pcl::Cursor	GetCursor () const

pcl::Font	GetFont () const

void	GetMaxSize (int &w, int &h) const

void	GetMinSize (int &w, int &h) const

void	GetScaledMaxSize (int &w, int &h) const

void	GetScaledMinSize (int &w, int &h) const

pcl::Sizer	GetSizer () const

pcl::Point	GlobalToLocal (const pcl::Point &p) const

void	GlobalToLocal (int &x, int &y) const

int	Height () const

void	Hide ()

RGBA	HighlightColor () const

RGBA	HighlightedTextColor () const

String	InfoText () const

bool	IsActiveWindow () const

bool	IsAncestorOf (const Control &) const

virtual bool	IsEnabled () const

bool	IsFixedHeight () const

bool	IsFixedWidth () const

bool	IsFocused () const

bool	IsHidden () const

bool	IsHorizontalExpansionEnabled () const

bool	IsMaximized () const

bool	IsMinimized () const

bool	IsModal () const

bool	IsMouseTrackingEnabled () const

bool	IsRealTimePreviewActive () const

bool	IsTrackViewActive () const

bool	IsUnderMouse () const

bool	IsVerticalExpansionEnabled () const

bool	IsVisible () const

bool	IsWindow () const

void	LocalToControl (const Control &, int &x, int &y) const

pcl::Point	LocalToControl (const Control &w, const pcl::Point &p) const

pcl::Point	LocalToGlobal (const pcl::Point &p) const

void	LocalToGlobal (int &x, int &y) const

pcl::Point	LocalToParent (const pcl::Point &p) const

void	LocalToParent (int &x, int &y) const

int	LogicalPixelsToPhysical (int size) const

int	LogicalPixelsToResource (int size) const

int	MaxHeight () const

int	MaxWidth () const

int	MinHeight () const

int	MinWidth () const

void	Move (const pcl::Point &p)

void	Move (int x, int y)

Control &	NextSiblingToFocus () const

void	OnChildCreate (child_event_handler, Control &)

void	OnChildDestroy (child_event_handler, Control &)

void	OnClose (close_event_handler, Control &)

void	OnDestroy (event_handler, Control &)

void	OnEnter (event_handler, Control &)

void	OnFileDrag (file_drag_event_handler, Control &)

void	OnFileDrop (file_drop_event_handler, Control &)

void	OnGetFocus (event_handler, Control &)

void	OnHide (event_handler, Control &)

void	OnKeyPress (keyboard_event_handler, Control &)

void	OnKeyRelease (keyboard_event_handler, Control &)

void	OnLeave (event_handler, Control &)

void	OnLoseFocus (event_handler, Control &)

void	OnMouseDoubleClick (mouse_event_handler, Control &)

void	OnMouseMove (mouse_event_handler, Control &)

void	OnMousePress (mouse_button_event_handler, Control &)

void	OnMouseRelease (mouse_button_event_handler, Control &)

void	OnMouseWheel (mouse_wheel_event_handler, Control &)

void	OnMove (move_event_handler, Control &)

void	OnPaint (paint_event_handler, Control &)

void	OnResize (resize_event_handler, Control &)

void	OnShow (event_handler, Control &)

void	OnViewDrag (view_drag_event_handler, Control &)

void	OnViewDrop (view_drop_event_handler, Control &)

Control &	operator= (const Control &)=delete

Control &	operator= (Control &&)=delete

Control &	Parent () const

pcl::Point	ParentToLocal (const pcl::Point &p) const

void	ParentToLocal (int &x, int &y) const

int	PhysicalPixelsToLogical (int size) const

pcl::Point	Position () const

void	Repaint ()

void	Repaint (const pcl::Rect &r)

void	Repaint (int x0, int y0, int x1, int y1)

void	Resize (int w, int h)

double	ResourcePixelRatio () const

int	ResourcePixelsToLogical (int size) const

void	Restyle ()

Point	ScaledCursorHotSpot (const Point &hotSpot) const

Point	ScaledCursorHotSpot (int xHot, int yHot) const

int	ScaledMaxHeight () const

int	ScaledMaxWidth () const

int	ScaledMinHeight () const

int	ScaledMinWidth () const

template<class R >
String	ScaledResource (R resource) const

template<class S >
String	ScaledStyleSheet (S cssCode, int fontDPI=0) const

void	Scroll (const pcl::Point &d)

void	Scroll (const pcl::Point &d, const pcl::Rect &r)

void	Scroll (int dx, int dy)

void	Scroll (int dx, int dy, int x0, int y0, int x1, int y1)

void	SendToBack ()

void	SetAlternateCanvasColor (RGBA)

void	SetBackgroundColor (RGBA)

void	SetButtonColor (RGBA)

void	SetButtonTextColor (RGBA)

void	SetCanvasColor (RGBA)

void	SetChildToFocus (Control &)

void	SetClientRect (const pcl::Rect &r)

void	SetClientRect (int x0, int y0, int x1, int y1)

void	SetCursor (const pcl::Cursor &)

void	SetCursorToParent ()

void	SetFixedHeight ()

void	SetFixedHeight (int h)

void	SetFixedSize ()

void	SetFixedSize (int w, int h)

void	SetFixedWidth ()

void	SetFixedWidth (int w)

void	SetFocusStyle (FocusStyles)

void	SetFont (const pcl::Font &)

void	SetForegroundColor (RGBA)

void	SetHighlightColor (RGBA)

void	SetHighlightedTextColor (RGBA)

void	SetInfoText (const String &)

void	SetMaxHeight ()

void	SetMaxHeight (int h)

void	SetMaxSize ()

void	SetMaxSize (int w, int h)

void	SetMaxWidth ()

void	SetMaxWidth (int w)

void	SetMinHeight ()

void	SetMinHeight (int h)

void	SetMinSize ()

void	SetMinSize (int w, int h)

void	SetMinWidth ()

void	SetMinWidth (int w)

void	SetNextSiblingToFocus (Control &)

void	SetParent (Control &)

void	SetRealTimePreviewActive (bool=true)

void	SetScaledFixedHeight (int h)

void	SetScaledFixedSize (int w, int h)

void	SetScaledFixedWidth (int w)

void	SetScaledMaxHeight (int h)

void	SetScaledMaxSize (int w, int h)

void	SetScaledMaxWidth (int w)

void	SetScaledMinHeight (int h)

void	SetScaledMinSize (int w, int h)

void	SetScaledMinWidth (int w)

void	SetSizer (pcl::Sizer &)

void	SetStyleSheet (const String &css)

void	SetTextColor (RGBA)

void	SetToolTip (const String &)

void	SetTrackViewActive (bool=true)

void	SetVariableHeight ()

void	SetVariableSize ()

void	SetVariableWidth ()

void	SetVisible (bool visible)

void	SetWindowOpacity (double)

void	SetWindowTitle (const String &)

void	Show ()

pcl::Sizer	Sizer () const

void	StackUnder (Control &)

String	StyleSheet () const

RGBA	TextColor () const

String	ToolTip () const

void	Unfocus ()

void	Update ()

void	Update (const pcl::Rect &r)

void	Update (int x0, int y0, int x1, int y1)

pcl::Rect	VisibleRect () const

int	Width () const

Control &	Window () const

double	WindowOpacity () const

String	WindowTitle () const

int	X () const

int	Y () const

Public Member Functions inherited from pcl::UIObject
virtual	~UIObject () noexcept(false)

bool	IsAlias () const

bool	IsGarbage () const

bool	IsNull () const

bool	IsSameObject (const UIObject &o) const

bool	IsUnique () const

String	ObjectId () const

IsoString	ObjectType () const

bool	operator< (const UIObject &o) const

bool	operator== (const UIObject &o) const

size_type	RefCount () const

void	SetObjectId (const String &id)

Additional Inherited Members
Public Types inherited from pcl::Dialog
using	execute_event_handler = void(Control::*)(Dialog &sender)

using	return_event_handler = void(Control::*)(Dialog &sender, int retCode)

using	std_code = StdDialogCode::value_type

Public Types inherited from pcl::Control
using	child_event_handler = void(Control::*)(Control &sender, Control &child)

using	close_event_handler = void(Control::*)(Control &sender, bool &allowClose)

using	event_handler = void(Control::*)(Control &sender)

using	file_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers, bool &wantsFiles)

using	file_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers)

using	keyboard_event_handler = void(Control::*)(Control &sender, int key, unsigned modifiers, bool &wantsKey)

using	mouse_button_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int button, unsigned buttons, unsigned modifiers)

using	mouse_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, unsigned buttons, unsigned modifiers)

using	mouse_wheel_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int delta, unsigned buttons, unsigned modifiers)

using	move_event_handler = void(Control::*)(Control &sender, const pcl::Point &newPos, const pcl::Point &oldPos)

using	paint_event_handler = void(Control::*)(Control &sender, const pcl::Rect &updateRect)

using	resize_event_handler = void(Control::*)(Control &sender, int newWidth, int newHeight, int oldWidth, int oldHeight)

using	view_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers, bool &wantsView)

using	view_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers)

Static Public Member Functions inherited from pcl::Dialog
static void	ProcessEvents (bool excludeUserInputEvents=false)

Static Public Member Functions inherited from pcl::Control
static void	HideToolTip ()

static Control &	Null ()

static void	ShowToolTip (const Point &pos, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static void	ShowToolTip (int x, int y, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static String	ToolTipText ()

Static Public Member Functions inherited from pcl::UIObject
static UIObject &	Null ()

Protected Member Functions inherited from pcl::UIObject
	UIObject ()=default

	UIObject (const UIObject &x)

	UIObject (UIObject &&x)

UIObject &	operator= (const UIObject &x)

UIObject &	operator= (UIObject &&x)

Detailed Description

OnlineObjectSearchDialog allows the user to enter the name or identifier of an object to search for, such as 'M31', 'Pleiades', 'NGC 253', 'Orion Nebula', 'Antares', or 'alpha Lyr'. The dialog sends an ADQL query to a public SIMBAD database service to retrieve several object properties, including ICRS equatorial coordinates, proper motions and visual magnitude, among others.

This class is a useful component for processes requiring a flexible and fast way to retrieve data for user-selected objects. Currently two public SIMBAD database services can be used: the master SIMBAD service in France (Centre de Données Astronomiques de Strasbourg) and its mirror site in the USA (Harvard-Smithsonian Center for Astrophysics).

References

SIMBAD Astronomical Database - CDS Strasbourg:
http://simbad.u-strasbg.fr/simbad/

SIMBAD mirror site in the USA - CFA Harvard:
http://simbad.cfa.harvard.edu/

SIMBAD TAP Service:
http://simbad.u-strasbg.fr/simbad/sim-tap

ADQL Cheat sheet:
http://simbad.u-strasbg.fr/simbad/tap/help/adqlHelp.html

Definition at line 109 of file OnlineObjectSearchDialog.h.

Constructor & Destructor Documentation

◆ OnlineObjectSearchDialog()

pcl::OnlineObjectSearchDialog::OnlineObjectSearchDialog ( )

Default constructor.

Member Function Documentation

◆ Dec()

double pcl::OnlineObjectSearchDialog::Dec ( ) const

inline

Returns the ICRS declination coordinate in degrees, or zero if no object has been found or searched for.

Definition at line 172 of file OnlineObjectSearchDialog.h.

◆ IsValid()

bool pcl::OnlineObjectSearchDialog::IsValid ( ) const

inline

Returns true iff an object has been specified and valid data have been found. In such case valid right ascension and declination coordinates are always available. Other data items (proper motions, etc) are optional, depending on the type of the object that has been searched for.

Definition at line 223 of file OnlineObjectSearchDialog.h.

◆ MuDec()

double pcl::OnlineObjectSearchDialog::MuDec ( ) const

inline

Returns the proper motion in declination in mas/year, or zero if no object has been found or searched for, or if proper motions are not available for the specified object.

Definition at line 192 of file OnlineObjectSearchDialog.h.

◆ MuRA()

double pcl::OnlineObjectSearchDialog::MuRA ( ) const

inline

Returns the proper motion in right ascension in mas/year, or zero if no object has been found or searched for, or if proper motions are not available for the specified object.

Definition at line 182 of file OnlineObjectSearchDialog.h.

◆ ObjectName()

const String& pcl::OnlineObjectSearchDialog::ObjectName ( ) const

inline

Returns the name of the object that has been found, or an empty string if no object has been found or searched for.

Definition at line 122 of file OnlineObjectSearchDialog.h.

◆ ObjectType()

const String& pcl::OnlineObjectSearchDialog::ObjectType ( ) const

inline

Returns a code representing the type of the object, or an empty string if no object has been found or searched for.

Object type codes are abbreviations standardized on the SIMBAD database, such as 'GlC' (globular cluster), 'G' (galaxy), or '*' (star).

Definition at line 134 of file OnlineObjectSearchDialog.h.

◆ Parallax()

double pcl::OnlineObjectSearchDialog::Parallax ( ) const

inline

Returns the parallax in mas, or zero if no object has been found or searched for, or if the parallax is not available for the specified object.

Definition at line 202 of file OnlineObjectSearchDialog.h.

◆ RA()

double pcl::OnlineObjectSearchDialog::RA ( ) const

inline

Returns the ICRS right ascension coordinate in degrees, or zero if no object has been found or searched for.

Definition at line 163 of file OnlineObjectSearchDialog.h.

◆ RadialVelocity()

double pcl::OnlineObjectSearchDialog::RadialVelocity ( ) const

inline

Returns the radial velocity in km/s, or zero if no object has been found or searched for, or if the radial velocity is not available for the specified object.

Definition at line 212 of file OnlineObjectSearchDialog.h.

◆ SearchText()

String pcl::OnlineObjectSearchDialog::SearchText ( ) const

inline

Returns the user-defined text that has been searched for during the latest dialog execution. Typically this is either an empty string or the name or identifier of an astronomical object, such as 'M31', 'Pleiades', 'NGC 253', 'Orion Nebula', 'Antares', or 'alpha Lyr'.

Definition at line 234 of file OnlineObjectSearchDialog.h.

◆ ServerURL()

String pcl::OnlineObjectSearchDialog::ServerURL ( ) const

Returns the URL of the online database service provider that is currently selected on this dialog.

The database server URL selected by the user on these dialogs is a global item stored in core application settings. It is restored by each instance of this class upon creation.

◆ SpectralType()

const String& pcl::OnlineObjectSearchDialog::SpectralType ( ) const

inline

Returns a string representing the spectral type, or an empty string if no object has been found or searched for, or if the spectral type is not available for the specified object.

Definition at line 144 of file OnlineObjectSearchDialog.h.

◆ VMagnitude()

double pcl::OnlineObjectSearchDialog::VMagnitude ( ) const

inline

Returns the V (visual) magnitude of the object, or zero if no object has been found or searched for, or if the V magnitude is not available for the specified object.

Definition at line 154 of file OnlineObjectSearchDialog.h.

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

OnlineObjectSearchDialog.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OnlineObjectSearchDialog()

Member Function Documentation

◆ Dec()

◆ IsValid()

◆ MuDec()

◆ MuRA()

◆ ObjectName()

◆ ObjectType()

◆ Parallax()

◆ RA()

◆ RadialVelocity()

◆ SearchText()

◆ ServerURL()

◆ SpectralType()

◆ VMagnitude()