VParameterNode.hh

Go to the documentation of this file.

//Copyright 2013 Ben Loer
//This file is part of the ConfigHandler library
//It is released under the terms of the GNU General Public License v3

#ifndef VPARAMETERNODE_h
#define VPARAMETERNODE_h
#include  <iostream>

class VParameterNode{
public:
  VParameterNode(const std::string key="", const std::string helptext="") : 
    _default_key(key), _node_type(VIRTUAL) , _helptext(helptext),
    hasread(true), haswrite(true) {}
  virtual ~VParameterNode() {}
  
  virtual bool SaveToFile(const char* fname, bool showhelp=false);
  virtual bool ReadFromFile(const char* fname, const std::string& key="",
                            bool suppress_errs=false);
  virtual std::istream& ReadFrom( std::istream& in, bool single=false)=0;
  virtual std::istream& ReadFromByKey( std::istream& in, 
                                       const std::string& key,
                                       bool suppress_errs=false);
  virtual std::ostream& WriteTo( std::ostream& out , bool showhelp=false, 
                                 int indent=0) const =0;
  const std::string& GetDefaultKey() const { return _default_key; }
  void SetDefaultKey(const std::string& key){ _default_key = key; }
  int GetNodeType(){ return _node_type; }
  virtual int PrintHelp(const std::string& myname="") const;
  
  const std::string& GetHelpText(){ return _helptext; }
  void SetHelpText(const std::string& newtext){ _helptext = newtext; }
  
  virtual VParameterNode* Clone(const void* from, void* to) const =0;

protected:
  enum NODE_TYPES {VIRTUAL=0, PARAMETER=1, PARAMETER_LIST=2, FUNCTION=3};
  std::string _default_key;  
  int _node_type; 
  std::string _helptext; 
public:
  bool hasread; 
  bool haswrite; 
};

//inline the redirect overloads
inline std::istream& operator>>(std::istream& in, VParameterNode& p)
{
  return p.ReadFrom(in);
}

inline std::ostream& operator<<(std::ostream& out, const VParameterNode& p)
{
  return p.WriteTo(out);
}

#endif