vtkPlusCommand.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 __VTKPLUSCOMMAND_H
#define __VTKPLUSCOMMAND_H

#include "vtkPlusServerExport.h"

class vtkPlusDataCollector;
class vtkPlusCommandProcessor;
//class vtkIGSIOTransformRepository;
class vtkImageData;

#include "vtkPlusCommandResponse.h"

// igtl includes
#include "igtlMessageBase.h"

class vtkPlusServerExport vtkPlusCommand : public vtkObject
{
public:
  static const std::string DEVICE_NAME_COMMAND;
  static const std::string DEVICE_NAME_REPLY;

  virtual vtkPlusCommand* Clone() = 0;

  virtual void PrintSelf(ostream& os, vtkIndent indent);

  virtual PlusStatus Execute() = 0;

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* aConfig);

  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* aConfig);

  virtual void SetCommandProcessor(vtkPlusCommandProcessor* processor);

  vtkSetMacro(ClientId, int);
  vtkGetMacro(ClientId, int);

  virtual std::string GetDescription(const std::string& commandName) = 0;

  virtual void GetCommandNames(std::list<std::string>& cmdNames) = 0;

  void SetMetaData(const igtl::MessageBase::MetaDataMap& metaData);

  vtkGetMacro(RespondWithCommandMessage, bool);
  vtkSetMacro(RespondWithCommandMessage, bool);

  vtkSetStdStringMacro(Name);
  vtkGetStdStringMacro(Name);

  vtkSetStdStringMacro(DeviceName);
  vtkGetStdStringMacro(DeviceName);

  vtkGetMacro(Id, uint32_t);
  vtkSetMacro(Id, uint32_t);

  void PopCommandResponses(PlusCommandResponseList& responses);

  static std::string GenerateReplyDeviceName(uint32_t uid);

  static PlusStatus GenerateCommandDeviceName(const std::string& uid, std::string& outDeviceName);

  static bool IsCommandDeviceName(const std::string& deviceName);

  static bool IsReplyDeviceName(const std::string& deviceName, const std::string& uid = std::string(""));

  static std::string GetUidFromCommandDeviceName(const std::string& deviceName);

  static std::string GetPrefixFromCommandDeviceName(const std::string& deviceName);

protected:
  virtual vtkPlusDataCollector* GetDataCollector();

  virtual vtkIGSIOTransformRepository* GetTransformRepository();

  PlusStatus ValidateName();

  void QueueCommandResponse(PlusStatus status, const std::string& message, const std::string& error = "", const igtl::MessageBase::MetaDataMap* metaData = nullptr);

  vtkPlusCommand();
  virtual ~vtkPlusCommand();

  vtkPlusCommandProcessor* CommandProcessor;

  int ClientId;

  std::string DeviceName;

  uint32_t Id;

  bool RespondWithCommandMessage;

  std::string Name;

  igtl::MessageBase::MetaDataMap MetaData;

  // Contains a list of command responses that should be forwarded to the caller
  PlusCommandResponseList CommandResponseQueue;

private:
  vtkPlusCommand(const vtkPlusCommand&);
  void operator=(const vtkPlusCommand&);

};

#endif