Class to manage access to a digital input/output device. More...

#include <dioserver.h>

Inheritance diagram for VisAO::dioserver:

Public Member Functions
	dioserver (int argc, char **argv) throw (AOException)
	Command line constructor.

	dioserver (std::string name, const std::string &conffile) throw (AOException)
	Config file constructor.

int	init_dioserver ()
	Initialize the dioserver structure.

int	set_dioserver_channel (int chnum, int hwchan, int dir, int enab)
	Set a single channel of the server. More...

int	setup_dioserver ()
	Setup the dioserver. More...

virtual int	Run ()
	Take all the actions needed to start the server.

std::string	remote_command (std::string)
	Overridden from VisAOApp_base::remote_command.

std::string	local_command (std::string)
	Overridden from VisAOApp_base::local_command.

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.

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_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)
	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...

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
dioserver_ch	diosch [DIO_CHANNELS]
	The channels being managed.

int	n_enabled
	Number of channel enabled.

std::string	fifo_path
	The base path names for the fifos.

void *	diocard_info
	The generic DIO interface. This pointer is passed unaltered to the diocard_* functions.

int(*	diocard_init )(void *)
	Initialize the card.

int(*	diocard_sd )(void *)
	Shutdown the card.

int(*	diocard_write )(void *card, int ch, int bit)
	Write a bit to a channel.

int(*	diocard_read )(void *card, int ch)
	Read a bit from the channel.

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

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.

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 ()

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)

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

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

Allows us to map "software channels" to "hardware channels", so that if we have to rewire we only have to change the config file.

Uses a generic DIO interface, consisting of a void * and various function pointers which take said void * as an argument. To adapt to a new card, just provide the relevant functions (diocard_init, diocard_sd, diocard_write, and diocard_read). dioserver does the rest.

Provides only remote and local command fifos. Most interaction with dioserver will be via the dio channel fifos.

See VisAOApp_standalone for command line arguments. There are no additional command line arguments for dioserver.

This is a standalone VisAOApp, so it doesn't depend on MsgD. In addition to the optional standard config options inherited from VisAOApp_standalone this class REQUIRES:

DIOCHAN_XX array of int - XX is the software channel number (how fifos are labeled). The array consists of [hw,dir,en] where hw is hardware channel, dir is the direction (0=out, 1=in), and en is the enable status.

The following config setting is optional:

fifo_path string - the base bath, relative to VISAO_ROOT, where the dio fifos are created.

Definition at line 73 of file dioserver.h.

Member Function Documentation

int VisAO::dioserver::set_dioserver_channel	(	int	chnum,
		int	hwchan,
		int	dir,
		int	enab
	)

Called for each channel in the configuration file. Update n_enabled.

Parameters

chnum	the software channel number
hwchan	the hardware channel number
dir	the direction (0 = output, 1 = input)
enab	whether or not the channel is enabled.

Return values

0	on success
-1	on failure

Definition at line 113 of file dioserver.cpp.

References diosch, VisAO::dioserver_ch::direction, VisAO::dioserver_ch::enabled, VisAO::dioserver_ch::hwchannel, and n_enabled.

Referenced by init_dioserver().

int VisAO::dioserver::setup_dioserver ( )

Sets up the fifo_list, and installs the channels

Definition at line 123 of file dioserver.cpp.

References diosch, fifo_path, VisAO::VisAOApp_base::fl, MAX_FNAME_SZ, n_enabled, VisAO::read_diofifo(), RWBUFF_SZ, set_fifo_list_channel(), VisAO::VisAOApp_base::setup_baseApp(), and VisAO::VisAOApp_base::setup_fifo_list().

Referenced by Run().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation