CTCLChannelCommand.h

/*
    This software is Copyright by the Board of Trustees of Michigan
    State University (c) Copyright 2005.

    You may use this software under the terms of the GNU public license
    (GPL).  The terms of this license are described at:

     http://www.gnu.org/licenses/gpl.txt

     Author:
             Ron Fox
	     NSCL
	     Michigan State University
	     East Lansing, MI 48824-1321
*/

#ifndef __CTCLCHANNELCOMMAND_H
#define __CTCLCHANNELCOMMAND_H

#ifndef __TCLOBJECTPROCESSOR_H
#include <TCLObjectProcessor.h>
#endif

#ifndef __STL_VECTOR
#include <vector>
#ifndef __STL_VECTOR
#define __STL_VECTOR
#endif
#endif


#ifndef __STL_LIST
#include <list>
#ifndef __STL_LIST
#define __STL_LIST
#endif
#endif

#ifndef __STL_STRING
#include <string>
#ifndef __STL_STRING
#define __STL_STRING
#endif
#endif

class CTCLInterpreter;
class CTCLObject;
class CChannel;
class CChannelVariable;

/*!
   This class implements an epics channel command  Epics channel commands
   are created for each channel the user is interested in.
   These commands have names like the channel/field name and form an
   ensemble with the following subcommands:
   - get                   - Gets the current value of the channel.
   - set value  ?datatype? - Sets the value of the channel as shown.
                             The optional data type is one of 
                           - string to set a string value.
			   - int to set an integer value.
			   - real to set a real (double) value.
   - updatetime            - returns the last time the channel was updated,
                             in form suitable for use with [clock format].
   - delete                - Destroys this command and underlying data etc.
   - link tclvarname       - Links the channel to a Tcl variable.
   - listlinks ?pattern?   - List variable links.
   - unlink name           - Removes the link to the specified variable.
   - values                - returns info about the legal values the chan can have
   - size                  - Returns the # elements in the channel. Ths is 1 for
                             scalars and larger for vectors.
*/
class CTCLChannelCommand : public CTCLObjectProcessor 
{
  // TclEvent queued for changes:
public:
  struct ChangeEvent {
    Tcl_Event            rawEvent;
    CTCLChannelCommand*  pChangedChannel;
    char*                channelName;
  }; 
private:
  // Data types

  // Info about a linked variable:

  typedef struct  {
    std::string varname;
    CChannelVariable* m_pLinkedVar;
  } VariableInfo;
  typedef std::list<VariableInfo>     VariableInfoList;
  typedef VariableInfoList::iterator  VariableInfoIterator;

  // member variables

  CChannel*          m_pChannel;
  //  CChannelVariable*  m_pLinkedVar;
  VariableInfoList   m_linkedVariables;
  Tcl_ThreadId       m_interpreterThread;

  // Canonicals:
public:
  CTCLChannelCommand(CTCLInterpreter& interp,
		     std::string      name);
  virtual ~CTCLChannelCommand();
private:
  CTCLChannelCommand(const CTCLChannelCommand& rhs);
  CTCLChannelCommand& operator=(const CTCLChannelCommand& rhs);
  int operator==(const CTCLChannelCommand& rhs) const;
  int operator!=(const CTCLChannelCommand& rhs) const;
public:

  virtual int operator()(CTCLInterpreter& interp,
			 std::vector<CTCLObject>& objv);

  void UpdateLinkedVariable();

  // Utilties:

private:
  int Get(CTCLInterpreter& interp,
		  std::vector<CTCLObject>& objv);
  int Set(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  int Updatetime(CTCLInterpreter& interp);
  int Delete(CTCLInterpreter& interp);
  int Link(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  int Unlink(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  int ListLinks(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  int ValueList(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  int Size(CTCLInterpreter& interp, std::vector<CTCLObject>& objv);
  std::string Usage();
  static void markChange(CChannel* pChannel, 
			 void* pObject);        // Called in Epics thread
  static int update(Tcl_Event* pEvent, int flags);      // Called in Tcl thread.

  bool isLinked(std::string variableName);

  VariableInfoIterator find(std::string variableName);
};

#endif