The VisAO Camera
VisAO::WollastonStatus Class Reference

The wollaston lift status maintainer. More...

#include <WollastonStatus.h>

+ Inheritance diagram for VisAO::WollastonStatus:

Public Member Functions

 WollastonStatus (std::string name, const std::string &conffile) throw (AOException)
 Standard constructor with a config file.
 WollastonStatus (int argc, char **argv) throw (AOException)
 Standard constructor with a command line.
void initApp ()
 Initialization common to both constructors. More...
int set_cur_pos (int cp)
 Set the value of cur_pos of the motor. More...
int get_cur_pos ()
 Get the current positon of the motor. More...
virtual int Run ()
 The main loop. More...
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.
std::string common_command (std::string com, int cmode)
 The common command processor for commands received by fifo. More...
std::string get_state_str ()
 Get the state string. More...
virtual int update_statusboard ()
 Update the status board. 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.
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::profilerget_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 void dataLogger (timeval tv)
 Log data at intervals.

Protected Attributes

int cur_pos
 The current position of the lift, -1 is down, 0 is intermediate, 1 is up.
int last_type
int prompt
int ignored
- 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.
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 {
 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.
- 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 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)
- 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

Tracks the status of the wollaston lift.

Definition at line 32 of file WollastonStatus.h.

Member Function Documentation

void VisAO::WollastonStatus::initApp ( )
int VisAO::WollastonStatus::set_cur_pos ( int  cp)

Does not move the motor.

cpthe current position.
Return values
0on success
-1on failure.

Referenced by common_command().

int VisAO::WollastonStatus::get_cur_pos ( )
Return values
thevalue of cur_pos.

Definition at line 67 of file WollastonStatus.h.

References cur_pos.

Referenced by common_command().

std::string VisAO::WollastonStatus::common_command ( std::string  com,
int  cmode 

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

  • POS? the return value is the current position, 1 for up, 0 for intermediate, -1 for down.
  • STATE? returns the result of get_state_str()
  • UP if control_mode allows it, and lift is not up, raises the lift, and returns "1\n". If lift is already up, returns "0\n". Otherwise returns the control_mode in 1 letter.
  • DOWN if control_mode allows it, and lift is not down, lowers the lift, and returns "1\n". If lift is already up, returns "0\n". Otherwise returns the control_mode in 1 letter.
  • For any other inputs returns "UNKNOWN COMMAND: (str)\n"

Definition at line 174 of file WollastonStatus.cpp.

References VisAO::VisAOApp_base::control_mode, VisAO::VisAOApp_base::control_mode_response(), get_cur_pos(), get_state_str(), and set_cur_pos().

Referenced by local_command(), and remote_command().

std::string VisAO::WollastonStatus::get_state_str ( )

The state string encodes the current state of the controller as: C P Where C is the current control_mode, P is the current position

the state string

Definition at line 222 of file WollastonStatus.cpp.

References VisAO::VisAOApp_base::control_mode_response(), and cur_pos.

Referenced by common_command().

int VisAO::WollastonStatus::update_statusboard ( )

Overridden versions should call this as VisAOApp_bas::update_statusboard so the basics are taken care of.

Return values
0on success
-1on failure

Reimplemented from VisAO::VisAOApp_base.

Definition at line 232 of file WollastonStatus.cpp.

References cur_pos, VisAO::VisAOApp_base::statusboard_shmemptr, and VisAO::VisAOApp_base::update_statusboard().

Referenced by Run().

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