File: ttystream.3cc

package info (click to toggle)
libcommoncpp2 1.0.13-5
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,740 kB
  • ctags: 2,860
  • sloc: cpp: 18,857; sh: 8,451; ansic: 1,546; makefile: 299; xml: 5
file content (90 lines) | stat: -rw-r--r-- 2,001 bytes parent folder | download
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
.TH "ttystream" 3 "19 Jul 2003" "CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ttystream \- A more natural C++ 'ttystream' class for use by non-threaded applications. C++ 'fstream' style ttystream class. 
.SH SYNOPSIS
.br
.PP
\fC#include <serial.h>\fP
.PP
Inherits \fBTTYStream\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBttystream\fP ()"
.br
.RI "\fIConstruct an unopened 'ttystream' object.\fP"
.ti -1c
.RI "\fBttystream\fP (const char *name)"
.br
.RI "\fIConstruct and 'open' a tty stream object.\fP"
.ti -1c
.RI "void \fBopen\fP (const char *name)"
.br
.RI "\fIOpen method for a tty stream.\fP"
.ti -1c
.RI "void \fBclose\fP (void)"
.br
.RI "\fIClose method for a tty stream.\fP"
.ti -1c
.RI "bool \fBoperator!\fP ()"
.br
.RI "\fITest to see if stream is opened.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
A more natural C++ 'ttystream' class for use by non-threaded applications. C++ 'fstream' style ttystream class.
.PP
This class behaves a lot more like fstream and similar classes.
.PP
\fBAuthor: \fP
.in +1c
David Sugar <dyfet@ostel.com> 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "ttystream::ttystream ()"
.PP
Construct an unopened 'ttystream' object.
.PP
.SS "ttystream::ttystream (const char * name)"
.PP
Construct and 'open' a tty stream object.
.PP
A filename in the form 'device:options[,options]' may be used to pass device options as part of the open.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIname\fP\fP
of file and serial options. 
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "void ttystream::close (void)"
.PP
Close method for a tty stream.
.PP
Reimplemented from \fBSerial\fP.
.SS "void ttystream::open (const char * name)"
.PP
Open method for a tty stream.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIname\fP\fP
filename to open. 
.PP
Reimplemented from \fBSerial\fP.
.SS "bool ttystream::operator! (void)\fC [inline]\fP"
.PP
Test to see if stream is opened.
.PP


.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for CommonC++ from the source code.