igtlCommandMessage.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   The OpenIGTLink Library
  Language:  C++
  Web page:  http://openigtlink.org/
 
  Copyright (c) Insight Software Consortium. All rights reserved.
 
  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
 
#ifndef __igtlCommandMessage_h
#define __igtlCommandMessage_h
 
#include "igtlObject.h"
#include "igtlMacro.h"
#include "igtlMath.h"
#include "igtlMessageBase.h"
#include "igtl_command.h"
 
namespace igtl
{
 
class IGTLCommon_EXPORT CommandMessage : public MessageBase
{
public:
  static const int validEncodings[257];
 
public:
  typedef CommandMessage            Self;
  typedef MessageBase               Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
 
  igtlTypeMacro(igtl::CommandMessage, igtl::MessageBase)
  igtlNewMacro(igtl::CommandMessage);
 
public:
 
  int        SetCommandId(igtlUint32 aId);
 
  int        SetCommandName(const char* aCommandName);
 
  int        SetCommandName(const std::string& aCommandName);
 
  int        SetCommandContent(const char* string);
 
  int        SetCommandContent(const std::string & string);
 
  int        SetContentEncoding(igtlUint16 enc);
 
  igtlUint32  GetCommandId() const;
 
  std::string GetCommandName() const;
 
  std::string GetCommandContent() const;
 
  igtlUint32 GetCommandContentLength() const;
 
  igtlUint16  GetContentEncoding() const;
 
protected:
  CommandMessage();
  ~CommandMessage();
 
protected:
  virtual int  CalculateContentBufferSize();
  virtual int  PackContent();
  virtual int  UnpackContent();
 
  igtlUint32   m_CommandId;
 
  igtlUint8    m_CommandName[IGTL_COMMAND_NAME_SIZE];
 
  igtlUint16   m_Encoding;
 
  std::string  m_Command;
};
 
class IGTLCommon_EXPORT RTSCommandMessage : public CommandMessage
{
public:
  typedef RTSCommandMessage            Self;
  typedef CommandMessage               Superclass;
  typedef SmartPointer<Self>           Pointer;
  typedef SmartPointer<const Self>     ConstPointer;
 
  igtlTypeMacro(igtl::RTSCommandMessage, igtl::CommandMessage)
  igtlNewMacro(igtl::RTSCommandMessage);
 
public:
 
  int        SetCommandErrorString(const char* aCommandName);
 
  int        SetCommandErrorString(const std::string& aCommandName);
 
  std::string GetCommandErrorString() const;
 
protected:
  RTSCommandMessage();
  ~RTSCommandMessage();
};
 
} // namespace igtl
 
#endif // _igtlCommandMessage_h