summaryrefslogtreecommitdiff
path: root/doxygen/xml/classcmd2_1_1_output_trap.xml
blob: c788ba3f5ca96434e131bbc7abef9cdc0f8e5e13 (plain)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1">
  <compounddef id="classcmd2_1_1_output_trap" kind="class" prot="public">
    <compoundname>cmd2::OutputTrap</compoundname>
    <basecompoundref refid="classcmd2_1_1_borg" prot="public" virt="non-virtual">cmd2::Borg</basecompoundref>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="classcmd2_1_1_output_trap_1a9117a6d5bfa07f1eeade54f24eeba0ed" prot="public" static="no" mutable="no">
        <type></type>
        <definition>cmd2::OutputTrap::contents</definition>
        <argsstring></argsstring>
        <name>contents</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_output_trap_1ac7a0b848dc18c74b089bc0d4044996de" prot="public" static="no" mutable="no">
        <type></type>
        <definition>cmd2::OutputTrap::old_stdout</definition>
        <argsstring></argsstring>
        <name>old_stdout</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classcmd2_1_1_output_trap_1a0dc45d536432b07d7ec32da5755b5c85" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OutputTrap::__init__</definition>
        <argsstring></argsstring>
        <name>__init__</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="1465"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_output_trap_1aa3bec468fdc0d248cd43cb8e8e0d96cd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OutputTrap::write</definition>
        <argsstring></argsstring>
        <name>write</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1466" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1466" bodyend="1467"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_output_trap_1a492ceb8dfb3f6e90bf095a710ab56ad1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OutputTrap::read</definition>
        <argsstring></argsstring>
        <name>read</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1468" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1468" bodyend="1471"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_output_trap_1a06961b49c3e19e9984f077a08b3a75f2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OutputTrap::tearDown</definition>
        <argsstring></argsstring>
        <name>tearDown</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1472" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1472" bodyend="1475"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para><verbatim>Instantiate  an OutputTrap to divert/capture ALL stdout output.  For use in unit testing.
Call `tearDown()` to return to normal output.</verbatim> </para>    </detaileddescription>
    <inheritancegraph>
      <node id="28">
        <label>cmd2::Borg</label>
        <link refid="classcmd2_1_1_borg"/>
      </node>
      <node id="27">
        <label>cmd2::OutputTrap</label>
        <link refid="classcmd2_1_1_output_trap"/>
        <childnode refid="28" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="30">
        <label>cmd2::Borg</label>
        <link refid="classcmd2_1_1_borg"/>
      </node>
      <node id="29">
        <label>cmd2::OutputTrap</label>
        <link refid="classcmd2_1_1_output_trap"/>
        <childnode refid="30" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1461" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1459" bodyend="1476"/>
    <listofallmembers>
      <member refid="classcmd2_1_1_output_trap_1a0dc45d536432b07d7ec32da5755b5c85" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>__init__</name></member>
      <member refid="classcmd2_1_1_borg_1addff1031aaf78f5e1dc5ff0c6dba5137" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>__new__</name></member>
      <member refid="classcmd2_1_1_output_trap_1a9117a6d5bfa07f1eeade54f24eeba0ed" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>contents</name></member>
      <member refid="classcmd2_1_1_output_trap_1ac7a0b848dc18c74b089bc0d4044996de" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>old_stdout</name></member>
      <member refid="classcmd2_1_1_output_trap_1a492ceb8dfb3f6e90bf095a710ab56ad1" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>read</name></member>
      <member refid="classcmd2_1_1_output_trap_1a06961b49c3e19e9984f077a08b3a75f2" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>tearDown</name></member>
      <member refid="classcmd2_1_1_output_trap_1aa3bec468fdc0d248cd43cb8e8e0d96cd" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>write</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>