Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

List Class Reference

This class represents the list of the Device Parameter Data together with the functions to access it. Check here for int List::putvar(int, char *,char *), int List::getvar(int *,char *,char *) and int List::enabled(char *,char *) functions. More...

#include <list.hh>

List of all members.

Public Methods

 List ()
 ~List ()
void initialize ()
void insert (int, char *,char *,int, int)
void insert (double, char *,char *,int, int)
void append (int, char *,char *,int, int, int, int)
void append (double,char *,char *,int, int, int, int)
Elementexist (char *,char *)
void remove ()
int is_active (char *)
int getvar (int *,char *,char *)
int getvar (double *,char *,char *)
int putvar (int,char *,char *)
int putvar (double,char *,char *)
int varcomp (Element *,char *,char *)
void putvar (int, int)
void putvar (double, int)
void putvar (char *,int)
int enabled (char *,char *)
int plotstatus (int)
char* get_data_type (char *)
devDataPacketGetPacketElement (char *)
devDataPacketGetNextPacket (void)
void ResetHelpPointer (void)
int AdvanceHelpPointer (void)
void reset_data_buffer ()
void printlist ()
ElementEnd_Of_List ()
char* getstring (int)
int get_type (int)
char* get_name (int)
char* get_var_name (int)
int get_store_flag (int)
int get_plot_flag (int)
int get_enabled_flag (int)
void set_enabled_flag (int, bool)
void set_plot_flag (int, bool)
int get_number_plotvars (char *)
string get_plotvar_namelist (char *)
 List ()
 ~List ()
void initialize ()
void insert (int, char *,char *,int, int)
void insert (double, char *,char *,int, int)
void append (int, char *,char *,int, int, int, int)
void append (double,char *,char *,int, int, int, int)
Elementexist (char *,char *)
void SortPlotProperties (void)
void remove ()
int is_active (char *)
int remove (int)
int remove (double)
int getvar (int *,char *,char *)
int getvar (double *,char *,char *)
int putvar (int,char *,char *)
int putvar (double,char *,char *)
int varcomp (Element *,char *,char *)
void putvar (int, int)
void putvar (double, int)
void putvar (char *,int)
int enabled (char *,char *)
int plotstatus (int)
int getint (int)
double getdouble (int)
char getchr (int)
char* getstr (int)
char* get_data_type (char *)
devDataPacketGetPacketElement (char *)
devDataPacketGetNextPacket (void)
void ResetHelpPointer (void)
int AdvanceHelpPointer (void)
char* getAllDeviceParameters (char *)
void reset_data_buffer ()
void printlist ()
int initlist (char *)
int initPlotOptions (FILE *fp, PlotProps *)
ElementEnd_Of_List ()
char* getstring (int)
int get_type (int)
char* get_name (int)
char* get_var_name (int)
int get_store_flag (int)
int get_plot_flag (int)
int get_enabled_flag (int)
void set_enabled_flag (int, bool)
void set_plot_flag (int, bool)
int get_number_plotvars (char *)
string get_plotvar_namelist (char *)

Public Attributes

QList<PlotProps>* PlotPropList


Detailed Description

This class represents the list of the Device Parameter Data together with the functions to access it. Check here for int List::putvar(int, char *,char *), int List::getvar(int *,char *,char *) and int List::enabled(char *,char *) functions.

The Device Parameter Data is the data that is given in the initfile, which is read by MAX at startup. This data can be edited in the left listbox of the MainGUI. Each device parameter is uniquely defined by two arguments. A Device-Name and a Variable-Name. These are always given as arguments when accessing the value. See also the default initfile "initfile" on how to set up a database. Only the class-functions that are important for the user are documented. You may not want to call the other functions. A documentation for the rest can be found in the source code directly. (see : list.cpp, list.cpp)


Constructor & Destructor Documentation

List::List ( ) [inline]
 

List::~List ( ) [inline]
 

List::List ( ) [inline]
 

List::~List ( ) [inline]
 


Member Function Documentation

int List::AdvanceHelpPointer ( void )
 

int List::AdvanceHelpPointer ( void )
 

Element * List::End_Of_List ( )
 

Element * List::End_Of_List ( )
 

devDataPacket * List::GetNextPacket ( void )
 

devDataPacket * List::GetNextPacket ( void )
 

devDataPacket * List::GetPacketElement ( char * dev_name )
 

devDataPacket * List::GetPacketElement ( char * dev_name )
 

void List::ResetHelpPointer ( void )
 

void List::ResetHelpPointer ( void )
 

void List::SortPlotProperties ( void )
 

void List::append ( double d_var,
char * dev_name,
char * var_name,
int save_flag,
int var_type,
int scale,
int offset )
 

void List::append ( int i_var,
char * dev_name,
char * var_name,
int save_flag,
int var_type,
int scale,
int offset )
 

void List::append ( double d_var,
char * dev_name,
char * var_name,
int save_flag,
int var_type,
int scale,
int offset )
 

void List::append ( int i_var,
char * dev_name,
char * var_name,
int save_flag,
int var_type,
int scale,
int offset )
 

int List::enabled ( char * dev_name,
char * var_name )
 

This function is very important! It checks the ENABLED field of the STORE section in the initfile, which is read by MAX at startup. The device_module checks via this function, wether a specific channel is "enabled", This way the device knows, if it should take data on this channel or not. (See also Int Scheduler::store(int ) ) , the file laser.cpp and the descrption of the initfile

Parameters:
Device_Name, the   name of the device
Variable_Name, the   name of the STORE variable to check
Returns:
TRUE if this "channel" is enabled, FALSE if not

int List::enabled ( char * dev_name,
char * var_name )
 

This function is very important! It checks the ENABLED field of the STORE section in the initfile, which is read by MAX at startup. The device_module checks via this function, wether a specific channel is "enabled", This way the device knows, if it should take data on this channel or not. (See also Int Scheduler::store(int ) ) , the file laser.cpp and the descrption of the initfile

Parameters:
Device_Name, the   name of the device
Variable_Name, the   name of the STORE variable to check
Returns:
TRUE if this "channel" is enabled, FALSE if not

Element * List::exist ( char * dev_name,
char * var_name )
 

Element * List::exist ( char * dev_name,
char * var_name )
 

char * List::getAllDeviceParameters ( char * dev_name )
 

char * List::get_data_type ( char * dev_name )
 

char * List::get_data_type ( char * dev_name )
 

int List::get_enabled_flag ( int position )
 

int List::get_enabled_flag ( int position )
 

char * List::get_name ( int position )
 

char * List::get_name ( int position )
 

int List::get_number_plotvars ( char * dev_name )
 

int List::get_number_plotvars ( char * dev_name )
 

int List::get_plot_flag ( int position )
 

int List::get_plot_flag ( int position )
 

string List::get_plotvar_namelist ( char * dev_name )
 

string List::get_plotvar_namelist ( char * dev_name )
 

int List::get_store_flag ( int position )
 

int List::get_store_flag ( int position )
 

int List::get_type ( int position )
 

int List::get_type ( int position )
 

char * List::get_var_name ( int position )
 

char * List::get_var_name ( int position )
 

char List::getchr ( int position )
 

double List::getdouble ( int position )
 

int List::getint ( int position )
 

char * List::getstr ( int position )
 

char * List::getstring ( int position )
 

char * List::getstring ( int position )
 

int List::getvar ( double * d_var,
char * dev_name,
char * var_name )
 

This function is called from the device module to retrieve a device Parameter from the Device Parameter Database.

Parameters:
Value, a   reference to the double variable to be received
Device_Name, the   device name
Variable_Name, the   variable name
Returns:
-1 if variable was not found(argument is zero), 1 if variable was found

int List::getvar ( int * i_var,
char * dev_name,
char * var_name )
 

This function is called from the device module to retrieve a device Parameter from the Device Parameter Database.

An Example from the the file laser.cpp :

How to read the variable "laser", "phase" into the integer value b :

result = device_data ->getvar(&b,"laser","phase")

Parameters:
Value, a   reference to the integer variable to be received
Device_Name, the   device name
Variable_Name, the   variable name
Returns:
-1 if variable was not found(argument is zero), \reuturn 1 if variable was found

int List::getvar ( double * d_var,
char * dev_name,
char * var_name )
 

This function is called from the device module to retrieve a device Parameter from the Device Parameter Database.

Parameters:
Value, a   reference to the double variable to be received
Device_Name, the   device name
Variable_Name, the   variable name
Returns:
-1 if variable was not found(argument is zero), 1 if variable was found

int List::getvar ( int * i_var,
char * dev_name,
char * var_name )
 

This function is called from the device module to retrieve a device Parameter from the Device Parameter Database.

An Example from the the file laser.cpp :

How to read the variable "laser", "phase" into the integer value b :

result = device_data ->getvar(&b,"laser","phase")

Parameters:
Value, a   reference to the integer variable to be received
Device_Name, the   device name
Variable_Name, the   variable name
Returns:
-1 if variable was not found(argument is zero), \reuturn 1 if variable was found

int List::initPlotOptions ( FILE * fp,
PlotProps * PP )
 

void List::initialize ( )
 

void List::initialize ( )
 

int List::initlist ( char * filename )
 

void List::insert ( double d_var,
char * dev_name,
char * var_name,
int save_flag,
int type )
 

void List::insert ( int i_var,
char * dev_name,
char * var_name,
int save_flag,
int type )
 

void List::insert ( double d_var,
char * dev_name,
char * var_name,
int save_flag,
int type )
 

void List::insert ( int i_var,
char * dev_name,
char * var_name,
int save_flag,
int type )
 

int List::is_active ( char * dev_name )
 

int List::is_active ( char * dev_name )
 

int List::plotstatus ( int position )
 

int List::plotstatus ( int position )
 

void List::printlist ( void )
 

void List::printlist ( void )
 

void List::putvar ( char * string,
int position )
 

void List::putvar ( double value,
int position )
 

void List::putvar ( int value,
int position )
 

int List::putvar ( double d_var,
char * dev_name,
char * var_name )
 

int List::putvar ( int i_var,
char * dev_name,
char * var_name )
 

void List::putvar ( char * string,
int position )
 

void List::putvar ( double value,
int position )
 

void List::putvar ( int value,
int position )
 

int List::putvar ( double d_var,
char * dev_name,
char * var_name )
 

int List::putvar ( int i_var,
char * dev_name,
char * var_name )
 

int List::remove ( double d_var )
 

int List::remove ( int i_var )
 

void List::remove ( void )
 

void List::remove ( void )
 

void List::reset_data_buffer ( )
 

void List::reset_data_buffer ( )
 

void List::set_enabled_flag ( int position,
bool state )
 

void List::set_enabled_flag ( int position,
bool state )
 

void List::set_plot_flag ( int position,
bool state )
 

void List::set_plot_flag ( int position,
bool state )
 

int List::varcomp ( Element * currentPtr,
char * device_name,
char * var_name )
 

int List::varcomp ( Element * currentPtr,
char * device_name,
char * var_name )
 


Member Data Documentation

QList< PlotProps > * List::PlotPropList<PlotProps>
 


The documentation for this class was generated from the following files:
Generated at Mon Sep 2 18:21:11 2002 for MAX by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001