VisAO::framewriter< dataT > Class Template Reference

A class for writing image frames from shared memory to disk. More...

#include <framewriter.h>

Inheritance diagram for VisAO::framewriter< dataT >:

Public Member Functions
	framewriter (int argc, char **argv) throw (AOException)
	framewriter (std::string name, const std::string &conffile) throw (AOException)
int	Create ()
int	set_ping_fifo_path (std::string &)
std::string	get_ping_fifo_path ()
int	set_save_path (std::string &)
std::string	get_save_path ()
int	set_name_base (std::string &)
std::string	get_name_base ()
int	set_sharedim_stack (sharedim_stack< dataT > *)
sharedim_stack< dataT > *	get_sharedim_stack ()
int	set_shmem_key (int sk)
int	get_shmem_key ()
int	connect_shmem ()
int	set_sim (sharedim< dataT > s)
sharedim< dataT >	get_sim ()
int	get_total_skipped ()
virtual int	Run ()
	The application main loop, to be re-implemented in derived classes.
int	write_frame ()
virtual int	kill_me ()
	Handle a timetodie condition upon exiting the signal catcher thread (e.g. tell main thread it is about to die) More...
Public Member Functions inherited from VisAO::VisAOApp_standalone
	VisAOApp_standalone () throw (AOException)
	Default constructor.
	VisAOApp_standalone (string name, int id, int logLevel=Logger::LOG_LEV_INFO) throw (AOException)
	Complicated constructor.
void	set_conffile (std::string name) throw (AOException)
	VisAOApp_standalone (std::string name, const std::string &conffile) throw (AOException)
	Config file constructor.
void	set_conffile (std::string name, const std::string &conffile) throw (AOException)
	For use if default constructed.
	VisAOApp_standalone (int argc, char **argv) throw (AOException)
	Command line constructor.
void	usage ()
virtual std::string	get_app_name ()
	Get the application name.
void	log_msg (int LogLevel, std::string lmsg)
	Report an error. Also calls log_msg. Overloaded from VisAOApp_base. More...
virtual int	Exec ()
	Installs the term and XXXX signal handlers, and calls Run(). More...
void	signal_catcher ()
	Signal loop, normally won't need to be overridden. More...
virtual int	start_signal_catcher (bool inherit_sched=true)
	Starts the signal catching loop. More...
virtual int	install_sig_mainthread_catcher ()
	Install the SIG_MAINTHREAD signal catcher.
virtual int	block_signal (int signum)
	Sets the signal mask to block signal signum.
virtual int	block_sigio ()
	Sets the signal mask to block SIGIO and RTSIGIO.
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 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, 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, 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, char *seqmsg)
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...
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.

Public Attributes
pthread_cond_t	frame_ready_cond
Public Attributes inherited from VisAO::VisAOApp_base
pthread_mutex_t	my_mutex
	Mutex used by the threaded versions of the standard command handlers.

Protected Member Functions
int	change_subdir (std::string sd)
int	attach_status_boards ()
virtual std::string	remote_command (std::string com)
	Overridden from VisAOApp_base::remote_command, here just calls common_command.
virtual std::string	local_command (std::string com)
	Overridden from VisAOApp_base::local_command, here just calls common_command.
virtual std::string	script_command (std::string com)
	Overridden from VisAOApp_base::script_command, here just calls common_command.
std::string	auto_command (std::string com, char *seqmsg)
	Overridden from VisAOApp_base::auto_command, here just calls common_command.
std::string	common_command (std::string com, int cmode)
	The common command processor for commands received by fifo. More...
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	ping_fifo_path
std::string	save_path
std::string	name_base
std::string	path_name
std::string	subdir
sharedim_stack< dataT > *	sis
	Manages a VisAO shared memory image stack.
int	shmem_key
bool	attached_to_shmem
sharedim< dataT >	sim
	The sharedim structure retreived from the stack.
int	behind
	The number of frames currently behind.
int	total_skipped
	The total number of frames skipped.
visao_imheader	imhead
bool	write_aosys_head
bool	write_visao_head
pthread_mutex_t	frame_ready_mutex
Protected Attributes inherited from VisAO::VisAOApp_standalone
std::string	init_file
Config_File *	init_vars
pthread_t	main_thread
	Identifier for the main thread.
pthread_t	signal_thread
	Identifier for the separate signal handling thread.
pthread_mutex_t	signal_mutex
	Mutex for the condition signaling.
pthread_cond_t	signal_cond
	Condition for telling main thread that something changed.
double	signalth_sleeptime
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.
Static Public Member Functions inherited from VisAO::VisAOApp_standalone
static const std::string &	ConfigFile ()
static const std::string &	MyName ()
static const std::string &	MyFullName ()
static int	ID ()
static Config_File &	ConfigDictionary ()
static int	Verbosity ()
static string	getConffile (string identity)
	Return configuration file path based on identity.
Static Protected Member Functions inherited from VisAO::VisAOApp_standalone
static void	SetMyName (const std::string &name)
static void	SetConfigFile (const std::string &conffile) throw (Config_File_Exception)
static void	SetID (int id)
Static Protected Attributes inherited from VisAO::VisAOApp_standalone
static Logger *	_logger = NULL
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

template<class dataT>
class VisAO::framewriter< dataT >

Begins writing to disk when a frame ready notification is received via the ping fifo.

In addition to the VisAOApp_standalone config file options, has:

Required:

• name_base string - the prefix of the data files, e.g. V47_ for ccd47 data
• shmem_key int - the share memory key to write from.

Optional:

• ping_fifo_path string [fifos] - the directory containing the ping fifo, relative to VISAO_ROOT
• save_path string [data] - the directory, relative to VISAO_ROOT, where to write the data
• write_aosys_head int [1] - whether or not to write AO system header data
• write_visao_head int [1] - whether or not to write VisAO camera header data
• origin string [Magellan AO System]- the value of the FITS ORIGIN keyword for this data
• telescope string [Magellan Clay]- the value of the FITS TELESCOP keyword for this data
• instrument string [Magellan VisAO] - the value of the FITS INSTRUME keyword for this data

See VisAOApp_standalone for command line arguments. There are no additional command line arguments for a basic framegrabber, though derived clases may add them.

Commands:

• "subdir s" changes the directory where data is saved to s, which is relative to the data directory specified in the configuration by save_path. "subdir ." resets to save_path. The subdirectory is created if it doesn't exist.
• "subdir?" returns the current subdirectory

Definition at line 58 of file framewriter.h.

Member Function Documentation

template<class dataT >

int VisAO::framewriter< dataT >::kill_me ( )

virtual

This isn't usually necessary, but see framewriter for an example of using it.

Reimplemented from VisAO::VisAOApp_standalone.

Definition at line 658 of file framewriter.h.

template<class dataT >

std::string VisAO::framewriter< dataT >::common_command ( std::string  com, int  cmode  )

protected

The return value depends on the command received. Recognized commands are:

• subdir? the return value is the current subdirectory"
• subdir xxxxx sets the subdirectory to xxxxx
• For any other inputs returns "UNKNOWN COMMAND: (str)\n"

Definition at line 642 of file framewriter.h.

---

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

• framewriter.h