ippOnScanReportCommand.h

Go to the documentation of this file.

// 
// DISCLAIMER: 
//  This software was produced by the National Institute of Standards 
//  and Technology (NIST), an agency of the U.S. government, and by statute is 
//  not subject to copyright in the United States.  Recipients of this 
//  software assume all responsibility associated with its operation,
//  modification,maintenance, and subsequent redistribution. 
//
//  See NIST Administration Manual 4.09.07 b and Appendix I. 
//
// History
// V1.40
// V1.42-6.3.3.8  IJK also for OnScanReport() 
// V1.5 -6.3.2.30 IJKAct as reporting parameter (ipptestsuite#7)
#pragma once
#include "ippCommand.h"
#include <map>

/*
 *  Defines the format (sequence) and properties reported while scanning.
 *  also IJK(), IJKAct(), Q() and ER()
 */
class  IPPDME_EXT_CLASS ippOnScanReportCommand : public ippCommand {

public:

  enum Key { 

    ER     = ipp::ER,
    IJK    = ipp::_IJK,
    Q      = ipp::Q,
    R      = ipp::_R,
    X      = ipp::_X,
    Y      = ipp::_Y,
    Z      = ipp::_Z,
    IJKAct = ipp::_IJKAct,
    ToolA  = ipp::_A,
    ToolB  = ipp::_B,
    ToolC  = ipp::_C,
 };

 ippOnScanReportCommand(
    unsigned int tgNum
 );

 virtual  ~ippOnScanReportCommand();
  
 void setDefault();
 // set the object with the default configuration (i.e X,Y,Z,Q) as specified by i++

 // Precondition: key must be one of the valid key ER , IJK Q R X Y Z A B C IJKAct
 void append(Key property);

 // returns the number of values that would be reported by a frame
 // IJK counts for 3.
 int getNumberOfReportedValues() const;

 // returns the index at which the key will appear
 // or -1 if the key is not present in the OnScanReport object
 // Precondition: key must be one of the valid key ER , IJK Q R X Y Z A B C IJKAct
 int getIndexOf(Key key) const;

 bool getHasER() const;
 bool getHasIJK() const;
 bool getHasQ() const;
 bool getHasR() const;
 bool getHasX() const;
 bool getHasY() const;
 bool getHasZ() const;
 bool getHasToolA()const;
 bool getHasToolB()const;
 bool getHasToolC()const;
 bool getHasIJKAct()const;

 virtual std::string getCommandString() const;

 void reset();

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

  std::vector<Key> _orderedKey;
  std::map<Key,int> _usedKey;
  int _lastIndex;

};
IPP_DECLARE_SMARTPOINTER(ippOnScanReportCommand);

---