vtkPlusCommandProcessor.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __vtkPlusCommandProcessor_h
#define __vtkPlusCommandProcessor_h

#include "vtkPlusServerExport.h"

#include "vtkMultiThreader.h"
#include "vtkObject.h"
#include "vtkPlusCommand.h"
#include "vtkPlusCommandResponse.h"
#include "vtkPlusOpenIGTLinkServer.h"
#include <string>

class vtkImageData;
class vtkMatrix4x4;

class vtkPlusServerExport vtkPlusCommandProcessor : public vtkObject
{
public:
  static vtkPlusCommandProcessor* New();
  vtkTypeMacro(vtkPlusCommandProcessor, vtkObject);
  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  int ExecuteCommands();

  virtual PlusStatus Start();

  virtual PlusStatus Stop();

  virtual bool IsRunning();

  virtual PlusStatus RegisterPlusCommand(vtkPlusCommand* cmd);

  virtual PlusStatus QueueCommand(bool respondUsingIGTLCommand, unsigned int clientId, const std::string& commandName, const std::string& commandString, const std::string& deviceName, uint32_t uid, const igtl::MessageBase::MetaDataMap& metaData);

  virtual PlusStatus QueueStringResponse(PlusStatus status, const std::string& deviceName, unsigned int clientId, const std::string& replyString);

  virtual PlusStatus QueueCommandResponse(PlusStatus status, const std::string& deviceName, unsigned int clientId, const std::string& commandName, uint32_t uid, const std::string& replyString, const std::string& errorString);

  PlusStatus QueueGetImageMetaData(unsigned int clientId, const std::string& deviceName);

  PlusStatus QueueGetImage(unsigned int clientId, const std::string& deviceName);

  virtual void PopCommandResponses(PlusCommandResponseList& responses);

  vtkGetObjectMacro(PlusServer, vtkPlusOpenIGTLinkServer);
  vtkSetObjectMacro(PlusServer, vtkPlusOpenIGTLinkServer);

protected:
  vtkPlusCommand* CreatePlusCommand(const std::string& commandName, const std::string& commandStr, const igtl::MessageBase::MetaDataMap& metaData);

  static void* CommandExecutionThread(vtkMultiThreader::ThreadInfo* data);

  vtkPlusCommandProcessor();
  virtual ~vtkPlusCommandProcessor();

private:
  vtkPlusOpenIGTLinkServer* PlusServer;

  vtkSmartPointer<vtkMultiThreader> Threader;

  vtkSmartPointer<vtkIGSIORecursiveCriticalSection> Mutex;

  // Active flag for threads (first: request, second: respond )
  std::pair<bool, bool> CommandExecutionActive;

  // Thread identifier
  int CommandExecutionThreadId;

  std::map<std::string, vtkPlusCommand*> RegisteredCommands;

  //std::list<vtkPlusCommand*> CommandQueue;
  typedef std::list< vtkSmartPointer<vtkPlusCommand> > PlusCommandList;
  PlusCommandList CommandQueue;
  PlusCommandResponseList CommandResponseQueue;

  vtkPlusCommandProcessor(const vtkPlusCommandProcessor&);  // Not implemented.
  void operator=(const vtkPlusCommandProcessor&);  // Not implemented.
};

#endif