Verovio
Source code documentation
vrv::OptionJson Class Reference

This class is for Json input params. More...

#include <options.h>

Inheritance diagram for vrv::OptionJson:
vrv::Option

Public Member Functions

JsonSource GetSource () const
 Member access.
 
jsonxx::Object GetValue (bool getDefault=false) const
 
Constructor, destructor and initialization
 OptionJson ()=default
 
virtual ~OptionJson ()=default
 
void CopyTo (Option *option) override
 
void Init (JsonSource source, const std::string &defaultValue)
 
bool SetValue (const std::string &value) override
 Interface methods: accessing values as string.
 
std::string GetStrValue () const override
 
std::string GetDefaultStrValue () const override
 
void Reset () override
 
bool IsSet () const override
 
bool HasValue (const std::vector< std::string > &jsonNodePath) const
 Accessing values as json node path.
 
int GetIntValue (const std::vector< std::string > &jsonNodePath, bool getDefault=false) const
 
double GetDblValue (const std::vector< std::string > &jsonNodePath, bool getDefault=false) const
 
std::string GetStrValue (const std::vector< std::string > &jsonNodePath, bool getDefault=false) const
 
bool UpdateNodeValue (const std::vector< std::string > &jsonNodePath, const std::string &value)
 
std::set< std::string > GetKeys () const
 Accessing all keys.
 
std::set< std::string > GetKeysByNode (const std::string &nodeName, std::list< std::string > &jsonNodePath) const
 
- Public Member Functions inherited from vrv::Option
void SetKey (const std::string &key)
 
std::string GetKey () const
 
virtual bool SetValueBool (bool value)
 
virtual bool SetValueDbl (double value)
 
virtual bool SetValueArray (const std::vector< std::string > &values)
 
void SetInfo (const std::string &title, const std::string &description)
 
std::string GetTitle () const
 
std::string GetDescription () const
 
void SetShortOption (char shortOption, bool isCmdOnly)
 
char GetShortOption () const
 
bool IsCmdOnly () const
 
virtual bool IsArgumentRequired () const
 
jsonxx::Object ToJson () const
 Return a JSON object for the option.
 

Protected Member Functions

JsonPath StringPath2NodePath (const jsonxx::Object &obj, const std::vector< std::string > &jsonNodePath) const
 
const jsonxx::Object * FindNodeByName (const jsonxx::Object &obj, const std::string &jsonNodeName, std::list< std::string > &jsonNodePath) const
 
bool ReadJson (jsonxx::Object &output, const std::string &input) const
 Read json from string or file.
 

Additional Inherited Members

- Static Public Attributes inherited from vrv::Option
static const std::map< int, std::string > s_breaks
 Static maps used my OptionIntMap objects. More...
 
static const std::map< int, std::string > s_condense
 
static const std::map< int, std::string > s_durationEq
 
static const std::map< int, std::string > s_elision
 
static const std::map< int, std::string > s_fontFallback
 
static const std::map< int, std::string > s_footer
 
static const std::map< int, std::string > s_header
 
static const std::map< int, std::string > s_ligatureOblique
 
static const std::map< int, std::string > s_multiRestStyle
 
static const std::map< int, std::string > s_pedalStyle
 
static const std::map< int, std::string > s_systemDivider
 
static const std::map< int, std::string > s_smuflTextFont
 
- Protected Attributes inherited from vrv::Option
std::string m_title
 
std::string m_description
 

Detailed Description

This class is for Json input params.


The documentation for this class was generated from the following file: