VisAO::ShutterRemoteControl Class Reference

Class to provide remote control (via the AO system) of the Shutter. More...

#include <ShutterRemoteControl.h>

Inheritance diagram for VisAO::ShutterRemoteControl:

Public Member Functions
	ShutterRemoteControl (std::string name, const std::string &conffile) throw (AOException)
	ShutterRemoteControl (int argc, char **argv) throw (AOException)
int	send_shutter_command (const char *com)
int	parse_state_string (std::string ansstr)
Public Member Functions inherited from VisAO::VisAOApp_base
	VisAOApp_base ()
	Default constructor.
virtual	~VisAOApp_base ()
	Virtual destructor.
int	set_euid_called ()
	Changes the user id of the process to euid_called.
int	set_euid_real ()
	Changes the user id fo the process to the real user id.
int	set_RT_priority (int prio)
	Set the real-time priority of the current process. More...
int	get_RT_priority ()
	Get the real-time priority of the current process.
int	set_app_name (std::string an)
	Set the application name.
virtual std::string	get_app_name ()
	Get the application name.
virtual int	setup_baseApp (bool usethreads=false)
	Install fifo channels. More...
virtual int	setup_baseApp (bool remfifo, bool locfifo, bool scrfifo, bool autfifo, bool usethreads=false)
	Create fifo names, then installs the fifo channels. More...
int	setup_fifo_list (int nfifos)
	Allocate the fifo_list. More...
int	connect_fifo_list ()
	Connect the fifo_list with exclusive locking. More...
int	connect_fifo_list_nolock ()
	Connect the fifo_list without exclusive locking. More...
int	setup_sigio ()
	Setup the SIGIO signal handling. More...
int	setup_RTsigio ()
	Setup SIGIO signal handling using realtime signals. More...
int	check_fifo_list_RTpending ()
	Check for pending reads for the fifo list while using the RT signals.
int	write_fifo_channel (int ch, const char *com, int comlen, std::string *resp)
	Write data to a fifo_channel, and get a response if desired. More...
int	write_fifo_channel (int ch, const char *com, int comlen, std::string *resp, char *sm)
	Write data to a fifo_channel, with a sequence message attached, and get a response if desired. More...
int	get_fifo_channel_response (std::string *resp, int ch)
	Check, and wait if neccessary, for data on a fifo channel. More...
int	set_wait_to (double to)
	Set the wait timeout for fifo channel responses. More...
double	get_wait_to ()
	Get the wait timeout for fifo channel responses. More...
virtual int	request_control (int cmode)
	Calls request_control(cmode, 0).
virtual int	request_control (int cmode, bool override)
	Attempts to change the control type. More...
virtual std::string	__remote_command (std::string com, char *seqmsg)
	Processing for remote commands. More...
virtual std::string	remote_command (std::string com)
	Called by __remote_command after control state logic. More...
virtual std::string	remote_command (std::string com, char *seqmsg)
virtual std::string	__local_command (std::string com, char *seqmsg)
	Processing for local commands. More...
virtual std::string	local_command (std::string com)
	Called by __local_command after control state logic. More...
virtual std::string	local_command (std::string com, char *seqmsg)
virtual std::string	__script_command (std::string com, char *seqmsg)
	Processing for script commands - not normally overriden. More...
virtual std::string	script_command (std::string com)
	Called by __script_command after control state logic. More...
virtual std::string	script_command (std::string com, char *seqmsg)
virtual std::string	auto_command (std::string com, char *seqmsg)
	Processing for auto commands - to be overriden. More...
virtual std::string	post_auto_command (std::string com, char *seqmsg=0)
	Processing for auto commands - not normally overriden. More...
std::string	control_mode_string ()
	Convenience function to return the control type string, e.g. "REMOTE".
std::string	control_mode_response ()
	Convenience function to return the control type response string, e.g. "A\n".
virtual void	error_report (int LogLevel, std::string emsg)
	Report an error. Also calls log_msg. More...
virtual void	log_msg (int LogLevel, std::string lmsg)
	Log a message. More...
VisAO::profiler *	get_profile ()
int	get_use_profiler ()
int	start_profiler ()
void *	get_statusboard_shmemptr ()
	Get the status board shared memory pointer. More...
int	set_statusboard_shmemkey (key_t mkey)
	Set the status board shared memory key. Does nothing else. More...
key_t	get_statusboard_shmemkey ()
	Get the status board shared memory key. More...
virtual int	update_statusboard ()
	Update the status board. More...
virtual void	dataLogger (timeval tv)
	Log data at intervals.

Static Public Member Functions
static int	StateReqChanged (void *pt, Variable *msgb)
static int	CModeReqChanged (void *pt, Variable *msgb)

Protected Member Functions
void	Create (void) throw (AOException)
void	updateState (bool force=false)
int	LoadConfig ()
void	SetupVars ()
void	Run ()
virtual int	TestNetwork (void)
int	DoFSM ()
Protected Member Functions inherited from VisAO::VisAOApp_base
int	create_statusboard (size_t sz)
	Creates and attaches to the statusboard shared memory. More...
std::string	getDataFileName ()
int	checkDataFileOpen ()

Protected Attributes
std::string	fifo_path
double	wait_to
double	wait_sleep
const char *	errmsg
int	ERRMSG_LEN
int	_shutter_state
int	_shutter_sw_state
int	_shutter_hw_state
int	_shutter_cmode
RTDBvar	var_state_cur
RTDBvar	var_state_req
RTDBvar	var_sw_state
RTDBvar	var_hw_state
RTDBvar	var_cmode_cur
RTDBvar	var_cmode_req
pthread_mutex_t	mutex
Protected Attributes inherited from VisAO::VisAOApp_base
std::string	app_name
	The name of the application.
double	pause_time
	Time to pause during application main loop.
fifo_list	fl
	The list of named-pipe fifos used for inter-process comms.
std::string	com_path
	The control fifo path base name.
std::string	com_path_remote
	The path for the remote control fifos.
std::string	com_path_local
	The path for the local control fifos.
std::string	com_path_script
	The path for the script control fifos.
std::string	com_path_auto
	The path for the auto control fifos.
double	wait_to
	The timeout for waiting on responses from FIFOs in seconds.
std::ostringstream	logss
	Conveninence string stream for building log messages.
VisAO::profiler *	profile
std::string	profile_path
int	use_profiler
void *	statusboard_shmemptr
	The pointer to the shared memory block for the statusboard.
key_t	statusboard_shmemkey
	The key used to lookup the shared memory.
int	statusboard_shmemid
	The ID of the shared memory block.
std::ofstream	dataof
bool	dataFileOpen
double	dataFileOpenTime
double	data_log_time_length
std::string	data_save_path
std::string	data_file_prefix

Additional Inherited Members
Public Types inherited from VisAO::VisAOApp_base
enum	control_modes {   CMODE_NONE, CMODE_REMOTE, CMODE_LOCAL, CMODE_SCRIPT,   CMODE_AUTO, CMODE_max }
	The control modes.
Public Attributes inherited from VisAO::VisAOApp_base
pthread_mutex_t	my_mutex
	Mutex used by the threaded versions of the standard command handlers.
Static Protected Attributes inherited from VisAO::VisAOApp_base
static int	control_mode = VisAOApp_base::CMODE_NONE
	The current control mode. More...
static int	default_control_mode = -1
	The default control mode. More...

Detailed Description

Definition at line 48 of file ShutterRemoteControl.h.

---

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

• ShutterRemoteControl.h
• ShutterRemoteControl.cpp