ippGetPropCommand.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. 
/* ippGetPropCommand class ************************************************

A GetProp property must have three or four keys. Examples:
GetProp(Tool.GoToPars.Speed())
GetProp(Tool.GoToPars.Speed.Act())

If property n has only three keys, keys4[n] should be set to EmptyKey.

In the second constructor, this is assuming:
1. inNumberProps is positive.
2. the incoming arrays of keys (inKeys1, etc.) all have at least
   inNumberProps entries.

The setNumberProps method does not increase the size of the keys arrays
so setNumberProps should not be used to increase _numberProps. It is
unlikely that a situation will arise where it is useful to call
setNumberProps.

To make a usable command, either use the second constructor, or call
setNewProps and then make repeated calls to setKey1, setKey2, etc.

The setXXX functions all return 1 if everything is OK and 0 if the
the index n is out of range.

*/
#pragma once
#include "ippdme/Command/ippCommand.h"
#include "ippdme/ippProp.h"



class IPPDME_EXT_CLASS ippGetPropCommand : public ippCommand
{

public:
  ippGetPropCommand(unsigned int tgNum);

  void addProp(const ippProp&);  
  const ippProp& getProp(int i) const;
  
  int getNumberProps() const;

  virtual ~ippGetPropCommand();
  virtual std::string getCommandString() const;

protected:
  ippGetPropCommand(
    unsigned int inTagNumber,
    tagIdType inTagType,
          ippCommandNameType inCommandName
  );

private:
  std::vector<ippProp> _props;
  // prohibited copy constructor/operator
  ippGetPropCommand(const ippGetPropCommand&);
  void operator=(const ippGetPropCommand&);
};
IPP_DECLARE_SMARTPOINTER(ippGetPropCommand);

---