File: Poco.Configurable.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (68 lines) | stat: -rw-r--r-- 6,573 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!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::Configurable</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.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class Configurable</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/Configurable.h</p>
<h2>Description</h2>
<div class="description">
<p>A simple interface that defines <a href="Poco.Configurable.html#4278" title="Poco::Configurable::getProperty()">getProperty</a>() and <a href="Poco.Configurable.html#4275" title="Poco::Configurable::setProperty()">setProperty</a>() methods. </p>
<p>This interface is implemented by <a href="Poco.Formatter.html" title="class Poco::Formatter">Formatter</a> and <a href="Poco.Channel.html" title="class Poco::Channel">Channel</a> and is used to configure arbitrary channels and formatters. </p>
<p>A property is basically a name-value pair. For simplicity, both names and values are strings. Every property controls a certain aspect of a <a href="Poco.Formatter.html" title="class Poco::Formatter">Formatter</a> or <a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>. For example, the <a href="Poco.PatternFormatter.html" title="class Poco::PatternFormatter">PatternFormatter</a>'s formatting pattern is set via a property. </p>
<p>NOTE: The following property names are use internally by the logging framework and must not be used by channels or formatters: </p>
<ul>
<li>class </li>
<li>pattern (<a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>) </li>
<li>formatter (<a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>) </li>
</ul>
</div>
<h2>Inheritance</h2>
<p><b>Known Derived Classes: </b><a href="Poco.AsyncChannel.html" title="class Poco::AsyncChannel">AsyncChannel</a>, <a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>, <a href="Poco.ConsoleChannel.html" title="class Poco::ConsoleChannel">ConsoleChannel</a>, <a href="Poco.EventLogChannel.html" title="class Poco::EventLogChannel">EventLogChannel</a>, <a href="Poco.FileChannel.html" title="class Poco::FileChannel">FileChannel</a>, <a href="Poco.FormattingChannel.html" title="class Poco::FormattingChannel">FormattingChannel</a>, <a href="Poco.Formatter.html" title="class Poco::Formatter">Formatter</a>, <a href="Poco.Logger.html" title="class Poco::Logger">Logger</a>, <a href="Poco.NullChannel.html" title="class Poco::NullChannel">NullChannel</a>, <a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a>, <a href="Poco.PatternFormatter.html" title="class Poco::PatternFormatter">PatternFormatter</a>, <a href="Poco.SimpleFileChannel.html" title="class Poco::SimpleFileChannel">SimpleFileChannel</a>, <a href="Poco.SplitterChannel.html" title="class Poco::SplitterChannel">SplitterChannel</a>, <a href="Poco.StreamChannel.html" title="class Poco::StreamChannel">StreamChannel</a>, <a href="Poco.SyslogChannel.html" title="class Poco::SyslogChannel">SyslogChannel</a>, <a href="Poco.WindowsConsoleChannel.html" title="class Poco::WindowsConsoleChannel">WindowsConsoleChannel</a>, <a href="Poco.Net.RemoteSyslogChannel.html" title="class Poco::Net::RemoteSyslogChannel">Poco::Net::RemoteSyslogChannel</a>, <a href="Poco.Net.RemoteSyslogListener.html" title="class Poco::Net::RemoteSyslogListener">Poco::Net::RemoteSyslogListener</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Configurable.html#4278" title="Poco::Configurable::getProperty()">getProperty</a>, <a href="Poco.Configurable.html#4275" title="Poco::Configurable::setProperty()">setProperty</a></p>
<h2>Constructors</h2>
<h3><a name="4273">Configurable</a></h3>
<p class="decl"><a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="4274">~Configurable</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="4278">getProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual std::string getProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />) const = 0;</p>
<div class="description">
<p>Returns the value of the property with the given name. If a property with the given name is not supported, a <a href="Poco.PropertyNotSupportedException.html" title="class Poco::PropertyNotSupportedException">PropertyNotSupportedException</a> is thrown. </p>
</div>
<h3><a name="4275">setProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void setProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; value<br />) = 0;</p>
<div class="description">
<p>Sets the property with the given name to the given value. If a property with the given name is not supported, a <a href="Poco.PropertyNotSupportedException.html" title="class Poco::PropertyNotSupportedException">PropertyNotSupportedException</a> is thrown. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>