berryParameterizedCommand.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef BERRYPARAMETERIZEDCOMMAND_H_
#define BERRYPARAMETERIZEDCOMMAND_H_

#include <berryObject.h>
#include <berryMacros.h>

#include "common/berryCommandExceptions.h"
#include <org_blueberry_core_commands_Export.h>

#include <list>
#include <map>

namespace berry
{

struct IParameter;
class Command;
class Parameterization;

class BERRY_COMMANDS ParameterizedCommand: public Object
{ //implements Comparable {

public:

  berryObjectMacro(ParameterizedCommand);

  static  const int INDEX_PARAMETER_ID; // = 0;

  static const int INDEX_PARAMETER_NAME; // = 1;

  static const int INDEX_PARAMETER_VALUE_NAME; // = 2;

  static const int INDEX_PARAMETER_VALUE_VALUE; // = 3;

  ParameterizedCommand(const SmartPointer<Command>& command,
                       const QList<Parameterization>& parameterizations);

  bool operator<(const Object* object) const override;

  bool operator==(const Object* object) const override;

  Object::Pointer ExecuteWithChecks(const Object::ConstPointer& trigger,
                                    const Object::Pointer& applicationContext);

  SmartPointer<Command> GetCommand() const;

  QString GetId() const;

  QString GetName() const;

  QHash<QString, QString> GetParameterMap() const;

  uint HashCode() const override;

  QString Serialize();

  QString ToString() const override;

  static QList<ParameterizedCommand::Pointer>
  GenerateCombinations(const SmartPointer<Command> command);

  static ParameterizedCommand::Pointer GenerateCommand(const SmartPointer<Command> command,
                                                       const QHash<QString, Object::Pointer>& parameters);

private:

  static const uint HASH_CODE_NOT_COMPUTED; // = 0;

  static const uint HASH_FACTOR; // = 89;

  static const uint HASH_INITIAL;

  static QString Escape(const QString& rawText);

  static QList<QList<Parameterization> > ExpandParameters(unsigned int startIndex,
                                                          const QList<SmartPointer<IParameter> >& parameters);

  const SmartPointer<Command> command;

  mutable uint hashCode;

  QList<Parameterization> parameterizations;

  mutable QString name;

};

}

#endif /* BERRYPARAMETERIZEDCOMMAND_H_ */