[rkward-cvs] rkward/rkward/rbackend rcommand.h,1.13,1.14

Thomas Friedrichsmeier tfry at users.sourceforge.net
Wed Apr 27 17:11:31 UTC 2005


Update of /cvsroot/rkward/rkward/rkward/rbackend
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv22883/rkward/rbackend

Modified Files:
	rcommand.h 
Log Message:
Release preparations

Index: rcommand.h
===================================================================
RCS file: /cvsroot/rkward/rkward/rkward/rbackend/rcommand.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** rcommand.h	24 Apr 2005 16:03:33 -0000	1.13
--- rcommand.h	27 Apr 2005 17:11:28 -0000	1.14
***************
*** 28,32 ****
  class RCommand;
  class RChainOrCommand;
! /// this struct is needed by the rthread.
  class RCommandChain {
  protected:
--- 28,36 ----
  class RCommand;
  class RChainOrCommand;
! 
! /** this simple struct is used to ensure a sequence of RCommand s does not get interrupted by unrelated RCommands.
! @see \ref UsingTheInterfaceToR
! @see RInterface::startChain
! @see RInterface::closeChain */
  class RCommandChain {
  protected:
***************
*** 37,41 ****
  };
  
! /** this struct is needed by the RCommandStrack. It is only a wrapper, which stores a pointer to _either_ a command _or_ a chain. Its sole purpose is to
  be able to insert either a command or a chain using the same mechanism, easily. You don't want to use this class outside of RCommandStack (TODO: move it to rcommandstack.h, then!) */
  class RChainOrCommand {
--- 41,45 ----
  };
  
! /** this struct is needed by the RCommandStack. It is only a wrapper, which stores a pointer to _either_ a command _or_ a chain. Its sole purpose is to
  be able to insert either a command or a chain using the same mechanism, easily. You don't want to use this class outside of RCommandStack (TODO: move it to rcommandstack.h, then!) */
  class RChainOrCommand {
***************
*** 84,91 ****
  	on the command (including the reply) from the object that is passed to your handler.
  	
- 	The type-parameter is used to indicate the type of command (e.g. direct User input vs. generated by a Plugin vs.
- 	command generated by the main application vs. command used merely to sync data back and forth), and also how the command
- 	should retrieve information (as a usual string, or as a data vector). @see RCommand::CommandTypes
- 	
  	There are several ways to identify a command when it's finished (needed, if a single RCommandReceiver needs to handle the results of
  	several different commands):
--- 88,91 ----
***************
*** 103,107 ****
  /** constructs an RCommand.
  @param command The command (string) to be run in the backend. This may include newlines and ";". The command should be a complete statement. If it is an incomplete statement, the backend will not wait for the rest of the command to come in, but rather the command will fail with RCommand::errorIncomplete.
! @param type An integer being the result of a bit-wise OR combination of the values in RCommand::CommandTypes, determining, how the command will be dealt with, and what type of output it will return.
  @param rk_equiv Not yet used: a short descriptive string attached to the RCommand, that allows the user to make some sense of what this command is all about.
  @param receiver The RCommandReceiver this command should be passed on to, when finished.
--- 103,107 ----
  /** constructs an RCommand.
  @param command The command (string) to be run in the backend. This may include newlines and ";". The command should be a complete statement. If it is an incomplete statement, the backend will not wait for the rest of the command to come in, but rather the command will fail with RCommand::errorIncomplete.
! @param type An integer being the result of a bit-wise OR combination of the values in RCommand::CommandTypes. The type-parameter is used to indicate the type of command, and also how the command should retrieve information (as a usual string, or as a data vector). See \ref RCommand::CommandTypes
  @param rk_equiv Not yet used: a short descriptive string attached to the RCommand, that allows the user to make some sense of what this command is all about.
  @param receiver The RCommandReceiver this command should be passed on to, when finished.





More information about the rkward-tracker mailing list