xacc::OptionsProvider Class Reference

#include <OptionsProvider.hpp>

Inheritance diagram for xacc::OptionsProvider:

Public Member Functions
virtual OptionPairs	getOptions ()
virtual bool	handleOptions (const std::map< std::string, std::string > &arg_map)
virtual	~OptionsProvider ()

Detailed Description

The OptionsProvider interface enables derived subclasses to provide a description of any and all command line options that they can take to drive and control their execution and behavior.

Constructor & Destructor Documentation

virtual xacc::OptionsProvider::~OptionsProvider ( )

inlinevirtual

The destructor

Member Function Documentation

virtual OptionPairs xacc::OptionsProvider::getOptions ( )

inlinevirtual

Return a Boost options_description instance that describes the options available for this derived subclass.

Reimplemented in xacc::Compiler, and xacc::quantum::DefaultParameterSetter.

virtual bool xacc::OptionsProvider::handleOptions ( const std::map< std::string, std::string > &  arg_map )

inlinevirtual

Given user-input command line options, perform some operation. Returns true if runtime should exit, false otherwise.

Parameters

map	The mapping of options to values

Returns

exit True if exit, false otherwise

Reimplemented in xacc::Compiler.

---

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

• /home/cades/dev/xacc/xacc/utils/OptionsProvider.hpp