MainFrame Class Reference

extends wxFrame and serves as our primary (and only) window for this application. Note that this is AUI managed. More...

#include <wxguipoc.h>

List of all members.

Public Member Functions

MainFrame (wxWindow *parent, wxWindowID id=FRAME_MAIN_FRAME, const wxString &title=wxT("VetSim Serial PoC"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(1036, 585), long style=wxDEFAULT_FRAME_STYLE|wxTAB_TRAVERSAL)

~MainFrame ()

Public Attributes

wxAuiManager m_mgr

wxString validator_echo_data

wxString validator_track_data

wxString validator_device_data

wxString validator_duration_data

Protected Types

FRAME_MAIN_FRAME = 1000

WXPANEL_SERIAL_CONTROLS

TEXT_SERIAL_DEVICE

STATIC_LABEL_BAUD

CHOICE_BAUD_RATE

CHOICE_SERIAL_PARITY

CHOICE_SERIAL_DATA_BITS

CHOICE_SERIAL_STOP_BITS

BUTTON_CONNECT

BUTTON_DISCONNECT

WXPANEL_PROTO_CONTROLS

RAD_PROTO_CNTRL_REQ

RAD_PROTO_STATUS_REQ

RAD_PROTO_PLAY_MP3_REQ

RAD_PROTO_STOP_MP3_REQ

TXT_MP3OPTS_DEVICE

TXT_MP3OPTS_TRACK

TXT_MP3OPTS_DURATION

CHKBX_PACKETOPTS_ACK

CHKBX_PACKETOPTS_NAK

CHKBX_PACKETOPTS_ECHO

TXT_PACKETOPTS_ECHO_VALUE

BUT_PACKET_TRANSMIT

BUT_PACKET_RESET

LISTBOX_RX_OUTPUT

LISTBOX_TX_OUTPUT

STATUS_MAIN_FRAME

MENU_MAIN_MENU

MENU_FILE_SERIAL_CONNECT

MENU_FILE_SERIAL_DISCONNECT

MENU_FILE_QUIT

MENU_HELP_ABOUT

PANEL_TX_OUTPUT

PANEL_RX_OUTPUT

WXPANEL_PACKET_EXPLORER

LISTCTRL_PACKET_EXPLORER

enum {
  FRAME_MAIN_FRAME = 1000, WXPANEL_SERIAL_CONTROLS, TEXT_SERIAL_DEVICE, STATIC_LABEL_BAUD,
  CHOICE_BAUD_RATE, CHOICE_SERIAL_PARITY, CHOICE_SERIAL_DATA_BITS, CHOICE_SERIAL_STOP_BITS,
  BUTTON_CONNECT, BUTTON_DISCONNECT, WXPANEL_PROTO_CONTROLS, RAD_PROTO_CNTRL_REQ,
  RAD_PROTO_STATUS_REQ, RAD_PROTO_PLAY_MP3_REQ, RAD_PROTO_STOP_MP3_REQ, TXT_MP3OPTS_DEVICE,
  TXT_MP3OPTS_TRACK, TXT_MP3OPTS_DURATION, CHKBX_PACKETOPTS_ACK, CHKBX_PACKETOPTS_NAK,
  CHKBX_PACKETOPTS_ECHO, TXT_PACKETOPTS_ECHO_VALUE, BUT_PACKET_TRANSMIT, BUT_PACKET_RESET,
  LISTBOX_RX_OUTPUT, LISTBOX_TX_OUTPUT, STATUS_MAIN_FRAME, MENU_MAIN_MENU,
  MENU_FILE_SERIAL_CONNECT, MENU_FILE_SERIAL_DISCONNECT, MENU_FILE_QUIT, MENU_HELP_ABOUT,
  PANEL_TX_OUTPUT, PANEL_RX_OUTPUT, WXPANEL_PACKET_EXPLORER, LISTCTRL_PACKET_EXPLORER
}

GUI control and event IDs. More...

Protected Member Functions

virtual void doSerialConnect (wxCommandEvent &event)

determines the current serial configuration and attempts to establish a connection.

virtual void doSerialQuit (wxCommandEvent &event)

disconnects the current serial connection

virtual void onRadioCntrlPktSelect (wxCommandEvent &event)

sets the current serial protocol command to a control packet

virtual void onRadioStatusPktSelect (wxCommandEvent &event)

sets the current serial protocol command to a status packet

virtual void onRadioPlayMp3PktSelect (wxCommandEvent &event)

sets the current serial protocol command to a play mp3 packet (mp3 opts get enabled)

virtual void onRadioStopMp3PktSelect (wxCommandEvent &event)

sets the current serial protocol command to a stop mp3 playback packet (appropriate mp3 options enabled)

virtual void onMp3OptsDeviceText (wxCommandEvent &event)

validates the domain of the data as it is typed (see validator below for domain info)

virtual void onMp3OptsDeviceEnter (wxCommandEvent &event)

currently unused; bit of a bug as the ENTER event appears to be getting lost

virtual void onMp3OptsTrackText (wxCommandEvent &event)

validates the domain of the data as it is typed (see validator below for domain info)

virtual void onMp3OptsTrackEnter (wxCommandEvent &event)

currently unused; bit of a bug as the ENTER event appears to be getting lost

virtual void onMp3OptsDurationText (wxCommandEvent &event)

validates the domain of the data as it is typed (see validator below for domain info)

virtual void onMp3OptsDurationEnter (wxCommandEvent &event)

currently unused; bit of a bug as the ENTER event appears to be getting lost

virtual void onSelectPacketOptsAck (wxCommandEvent &event)

unused for now; used to accumulate the flags as set but altered the model. keeping the event in case its needed later since its already plugged in. Event is currently set to skip.

virtual void onSelectPacketOptsNak (wxCommandEvent &event)

unused for now; used to accumulate the flags as set but altered the model. keeping the event in case its needed later since its already plugged in. Event is currently set to skip.

virtual void onSelectPacketOptsEcho (wxCommandEvent &event)

unused for now; used to accumulate the flags as set but altered the model. keeping the event in case its needed later since its already plugged in. Event is currently set to skip.

virtual void onPacketOptsEchoText (wxCommandEvent &event)

validates the domain of the data as it is typed (see validator below for domain info)

virtual void onPacketOptsEchoEnter (wxCommandEvent &event)

currently unused; bit of a bug as the ENTER event appears to be getting lost

virtual void onPacketTransmit (wxCommandEvent &event)

determines the currently configured protocol command then if the serial connection is viable, processes the command according to protocol rules. The result is the passed to DoProtocolTx() as a parent class pointer to be transmitted and displayed.

virtual void onPacketReset (wxCommandEvent &event)

resets all of the packet/command/protocol options to their default state

virtual void doApplicationQuit (wxCommandEvent &event)

shuts down the application according to wxApp semantics.

virtual void doApplicationAbout (wxCommandEvent &event)

launches an inane dialogue with the appname/description on it.

virtual void onRxListBoxDblClk (wxCommandEvent &event)

dbl-clicks on packets should send the data to the new packet explorer wondow for dissection.

virtual void onTxListBoxDblClk (wxCommandEvent &event)

dbl-clicks on packets should send the data to the new packet explorer wondow for dissection.

Protected Attributes

wxPanel * m_panel_serial

wxStaticText * m_label_serport

wxTextCtrl * m_text_serial_device

wxStaticText * m_label_baud

wxChoice * m_choice_baud

wxStaticText * m_label_parity

wxChoice * m_choice_parity

wxStaticText * m_label_data_bits

wxChoice * m_choice_data_bits

wxStaticText * m_label_stop_bits

wxChoice * m_choice_stop_bits

wxButton * m_button_connect

wxButton * m_button_disconnect

wxPanel * m_panel_proto_controls

wxRadioButton * m_radio_control_req

wxRadioButton * m_radio_status_req

wxRadioButton * m_radio_play_mp3_req

wxRadioButton * m_radio_stop_mp3_req

wxStaticText * m_label_mp3opts_device

wxTextCtrl * m_txt_mp3opts_device

wxStaticText * m_label_device_hint

wxStaticText * m_label_mp3opts_track

wxTextCtrl * m_txt_mp3opts_track

wxStaticText * m_label_track_hint

wxStaticText * m_label_mp3opts_duration

wxTextCtrl * m_txt_mp3opts_duration

wxStaticText * m_label_duration_hint

wxCheckBox * m_checkBox_packetopts_ack

wxCheckBox * m_checkBox_packetopts_nak

wxCheckBox * m_checkBox_packetopts_echo

wxStaticText * m_label_packetopts_echo_value

wxTextCtrl * m_text_packetopts_echo_value

wxStaticText * m_label_echo_value_hint

wxButton * m_button_packet_transmit

wxButton * m_button_packet_reset

wxListBox * m_listBox_rx_output

wxListBox * m_listBox_tx_output

wxStatusBar * m_status_main

wxMenuBar * m_menubar_main

wxMenu * m_menu_file

wxMenu * m_menu_file_serial

wxMenu * m_menu_help

wxPanel * m_panel_tx_output

wxPanel * m_panel_rx_output

wxPanel * m_panel_packet_explorer

cu::PacketExplorer * m_packet_explorer

Detailed Description

extends wxFrame and serves as our primary (and only) window for this application. Note that this is AUI managed.

Member Enumeration Documentation

anonymous enum [protected]

GUI control and event IDs.

Enumerator:

FRAME_MAIN_FRAME	the applications only frame control
WXPANEL_SERIAL_CONTROLS	the wxPanel container for the serial controls
TEXT_SERIAL_DEVICE	serial port/device name text box
STATIC_LABEL_BAUD	baud rate label
CHOICE_BAUD_RATE	choice/menu control for baudrate
CHOICE_SERIAL_PARITY	choice/menu control for parity
CHOICE_SERIAL_DATA_BITS	choice/menu control for data bits
CHOICE_SERIAL_STOP_BITS	choice/menu control for stop bits
BUTTON_CONNECT	serial connection button
BUTTON_DISCONNECT	serial disconnect button
WXPANEL_PROTO_CONTROLS	wxPanel container for the protocol config controls
RAD_PROTO_CNTRL_REQ	protocol control request radio button
RAD_PROTO_STATUS_REQ	protocol status request radio button
RAD_PROTO_PLAY_MP3_REQ	protocol play mp3 track request radio button
RAD_PROTO_STOP_MP3_REQ	protocol stop mp3 track request radio button
TXT_MP3OPTS_DEVICE	mp3 device text control
TXT_MP3OPTS_TRACK	mp3 track text control
TXT_MP3OPTS_DURATION	mp3 play duration text control
CHKBX_PACKETOPTS_ACK	ACK packet option checkbox control
CHKBX_PACKETOPTS_NAK	NAK packet option checkbox control
CHKBX_PACKETOPTS_ECHO	echo packet option checkbox control
TXT_PACKETOPTS_ECHO_VALUE	echo packet option value text control
BUT_PACKET_TRANSMIT	transmit packet button
BUT_PACKET_RESET	reset packet configuration controls button
LISTBOX_RX_OUTPUT	wxListBox control for Rx data
LISTBOX_TX_OUTPUT	wxListBox control for Tx data
STATUS_MAIN_FRAME	status bar for the main frame
MENU_MAIN_MENU	main menu bar
MENU_FILE_SERIAL_CONNECT	serial connect sub menu
MENU_FILE_SERIAL_DISCONNECT	serial disconnect sub menu
MENU_FILE_QUIT	quit command under the file menu
MENU_HELP_ABOUT	about command under the help menu
PANEL_TX_OUTPUT	wxPanel container for the Tx wxListBox
PANEL_RX_OUTPUT	wxPanel container for the Rx wxListBox
WXPANEL_PACKET_EXPLORER	wxPanel container for the packet explorer
LISTCTRL_PACKET_EXPLORER	wxListCtrl control for the packet explorer

Constructor & Destructor Documentation

MainFrame::MainFrame	(	wxWindow *	parent,
		wxWindowID	id = `FRAME_MAIN_FRAME`,
		const wxString &	title = `wxT("VetSim Serial PoC")`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxSize(1036, 585)`,
		long	style = `wxDEFAULT_FRAME_STYLE\|wxTAB_TRAVERSAL`
	)

MainFrame::~MainFrame ( )

Member Function Documentation

virtual void MainFrame::doApplicationAbout ( wxCommandEvent & event ) [protected, virtual]

launches an inane dialogue with the appname/description on it.

Parameters:

event