find-face.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NFD_TOOLS_NFDC_FIND_FACE_HPP
#define NFD_TOOLS_NFDC_FIND_FACE_HPP

#include "execute-command.hpp"

namespace nfd {
namespace tools {
namespace nfdc {

using ndn::nfd::FaceQueryFilter;
using ndn::nfd::FaceStatus;

class FindFace : noncopyable
{
public:
  enum class Code {
    OK = 0, 
    ERROR = 1, 
    NOT_FOUND = 3, 
    CANONIZE_ERROR = 4, 
    AMBIGUOUS = 5, 
    NOT_STARTED = -1, 
    IN_PROGRESS = -2, 
  };

  enum class DisambiguationStyle
  {
    LOCAL_URI = 1 
  };

  explicit
  FindFace(ExecuteContext& ctx);

  Code
  execute(const FaceUri& faceUri, bool allowMulti = false);

  Code
  execute(uint64_t faceId);

  Code
  execute(const boost::any& faceIdOrUri, bool allowMulti = false);

  Code
  execute(const FaceQueryFilter& filter, bool allowMulti = false);

  const std::vector<FaceStatus>&
  getResults() const
  {
    return m_results;
  }

  std::set<uint64_t>
  getFaceIds() const;

  const FaceStatus&
  getFaceStatus() const;

  uint64_t
  getFaceId() const
  {
    return this->getFaceStatus().getFaceId();
  }

  const std::string&
  getErrorReason() const
  {
    return m_errorReason;
  }

  void
  printDisambiguation(std::ostream& os, DisambiguationStyle style) const;

private:
  ndn::optional<FaceUri>
  canonize(const std::string& fieldName, const FaceUri& input);

  void
  query();

private:
  ExecuteContext& m_ctx;
  FaceQueryFilter m_filter;
  Code m_res = Code::NOT_STARTED;
  std::vector<FaceStatus> m_results;
  std::string m_errorReason;
};

} // namespace nfdc
} // namespace tools
} // namespace nfd

#endif // NFD_TOOLS_NFDC_FIND_FACE_HPP