Skip to content

InscoperAPI/API/Base/Description/FunctionDescription.h

Namespaces

Name
Inscoper
Inscoper namespace.

Classes

Name
class Inscoper::FunctionDescription
FunctionDescription class provides function information coming from drivers.

Source code

#ifndef FUNCTIONDESCRIPTION_H
#define FUNCTIONDESCRIPTION_H

#include <Base/Description/ConnectionDescription.h>
#include <Base/Device/EFunctionType.h>
#include <Global.h>

#include <map>
#include <memory>
#include <string>
#include <vector>

namespace Inscoper {

class INSCOPER_EXPORT FunctionDescription {
public:
  FunctionDescription();

  Inscoper::EFunctionType getType() const;

  void setType(Inscoper::EFunctionType type);

  const std::string &getName() const;

  void setName(const std::string &name);

  void addInputParam(unsigned char pos, unsigned short tag);

  const std::map<unsigned short, unsigned char> &getInputParams() const;

  void addOutputParam(unsigned char pos, unsigned short tag);

  const std::map<unsigned short, unsigned char> &getOutputParams() const;

  void addConnection(unsigned short tag);

  const std::vector<unsigned short> &getConnections() const;

private:
  Inscoper::EFunctionType _type;
  std::string _name;
  std::map<unsigned short, unsigned char> _inputMap;
  std::map<unsigned short, unsigned char> _outputMap;
  std::vector<unsigned short> _connectionList;
};

typedef std::shared_ptr<FunctionDescription> FunctionDescriptionPtr;

} // namespace Inscoper

#endif // FUNCTIONDESCRIPTION_H

Updated on 2026-09-03 at 12:14:17 +0200