<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::Util::OptionSet</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.Util.html" class="namespace">Poco::Util</a></h1> <h1 class="symbol">class OptionSet</h1> </div> <div class="body"> <p> <b>Library:</b> Util<br /> <b>Package:</b> Options<br /> <b>Header:</b> Poco/Util/OptionSet.h</p> <h2>Description</h2> <div class="description"> <p>A collection of <a href="Poco.Util.Option.html" title="class Poco::Util::Option">Option</a> objects. </p> </div> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.Util.OptionSet.html#17159" title="Poco::Util::OptionSet::addOption()">addOption</a>, <a href="Poco.Util.OptionSet.html#17167" title="Poco::Util::OptionSet::begin()">begin</a>, <a href="Poco.Util.OptionSet.html#17168" title="Poco::Util::OptionSet::end()">end</a>, <a href="Poco.Util.OptionSet.html#17164" title="Poco::Util::OptionSet::getOption()">getOption</a>, <a href="Poco.Util.OptionSet.html#17161" title="Poco::Util::OptionSet::hasOption()">hasOption</a>, <a href="Poco.Util.OptionSet.html#17157" title="Poco::Util::OptionSet::operator =()">operator =</a></p> <h2>Types</h2> <h3><a name="17152">Iterator</a></h3> <p class="decl">typedef OptionVec::const_iterator <a href="Poco.Util.OptionSet.html#17152" title="Poco::Util::OptionSet::Iterator">Iterator</a>;</p> <div class="description"> <p></p> </div> <h3><a name="17151">OptionVec</a></h3> <p class="decl">typedef std::vector < <a href="Poco.Util.Option.html" title="class Poco::Util::Option">Option</a> > <a href="Poco.Util.OptionSet.html#17151" title="Poco::Util::OptionSet::OptionVec">OptionVec</a>;</p> <div class="description"> <p></p> </div> <h2>Constructors</h2> <h3><a name="17153">OptionSet</a></h3> <p class="decl"><a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a>();</p> <div class="description"> <p>Creates the <a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a>. </p> </div> <h3><a name="17154">OptionSet</a></h3> <p class="decl"><a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a>(<br /> const <a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a> & options<br />);</p> <div class="description"> <p>Creates an option set from another one. </p> </div> <h2>Destructor</h2> <h3><a name="17156">~OptionSet</a></h3> <p class="decl">~<a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a>();</p> <div class="description"> <p>Destroys the <a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a>. </p> </div> <h2>Member Functions</h2> <h3><a name="17159">addOption</a></h3> <p class="decl">void addOption(<br /> const <a href="Poco.Util.Option.html" title="class Poco::Util::Option">Option</a> & option<br />);</p> <div class="description"> <p>Adds an option to the collection. </p> </div> <h3><a name="17167">begin</a></h3> <p class="decl"><a href="Poco.Util.OptionSet.html#17152" title="Poco::Util::OptionSet::Iterator">Iterator</a> begin() const;</p> <div class="description"> <p>Supports iterating over all options. </p> </div> <h3><a name="17168">end</a></h3> <p class="decl"><a href="Poco.Util.OptionSet.html#17152" title="Poco::Util::OptionSet::Iterator">Iterator</a> end() const;</p> <div class="description"> <p>Supports iterating over all options. </p> </div> <h3><a name="17164">getOption</a></h3> <p class="decl">const <a href="Poco.Util.Option.html" title="class Poco::Util::Option">Option</a> & getOption(<br /> const std::string & name,<br /> bool matchShort = false<br />) const;</p> <div class="description"> <p>Returns a reference to the option with the given name. </p> <p>The given name can either be a fully specified short name, or a partially specified full name. The name must either match the short or full name of an option. Comparison case sensitive for the short name and not case sensitive for the full name. Throws a <a href="Poco.NotFoundException.html" title="class Poco::NotFoundException">NotFoundException</a> if no matching option has been found. Throws an <a href="Poco.Util.UnknownOptionException.html" title="class Poco::Util::UnknownOptionException">UnknownOptionException</a> if a partial full name matches more than one option. </p> </div> <h3><a name="17161">hasOption</a></h3> <p class="decl">bool hasOption(<br /> const std::string & name,<br /> bool matchShort = false<br />) const;</p> <div class="description"> <p>Returns a true if and only if an option with the given name exists. </p> <p>The given name can either be a fully specified short name, or a partially specified full name. If a partial name matches more than one full name, false is returned. The name must either match the short or full name of an option. Comparison case sensitive for the short name and not case sensitive for the full name. </p> </div> <h3><a name="17157">operator =</a></h3> <p class="decl"><a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a> & operator = (<br /> const <a href="Poco.Util.OptionSet.html" title="class Poco::Util::OptionSet">OptionSet</a> & options<br />);</p> <div class="description"> <p>Assignment operator. </p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
