~ubuntu-branches/ubuntu/intrepid/tcm/intrepid

« back to all changes in this revision

Viewing changes to doc/sourcecode/Subject.html

  • Committer: Bazaar Package Importer
  • Author(s): Otavio Salvador
  • Date: 2003-07-03 20:08:21 UTC
  • Revision ID: james.westby@ubuntu.com-20030703200821-se4xtqx25e5miczi
Tags: upstream-2.20
ImportĀ upstreamĀ versionĀ 2.20

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html><head><TITLE>Subject</TITLE></head>
 
2
<body>
 
3
<H2><A HREF ="#DOC.DOCU" > <IMG BORDER=0 SRC=down.gif></A>  class  Subject : public <!2><A HREF="Thing.html#DOC.385.2">Thing</A> </H2><BLOCKQUOTE>
 
4
 (abstract) graph element class (is either a node or an edge).
 
5
</BLOCKQUOTE>
 
6
<hr>
 
7
 <h2> Inheritance:</h2>
 
8
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
 
9
<param name=classes value="CThing,MThing.html,CSubject,MSubject.html,CNode,MNode.html,CEdge,MEdge.html">
 
10
<param name=before value="M,M,M|_,Mr_">
 
11
<param name=after value="Md_,M,M,M">
 
12
<param name=indent value="0,1,1,1">
 
13
<param name=arrowdir value="down">
 
14
</APPLET>
 
15
<hr>
 
16
 
 
17
<DL>
 
18
<TABLE>
 
19
<DT><h3>Public Classes</h3><DD><TR><TD VALIGN=top><A HREF="#DOC.360.6"> <IMG BORDER=0 SRC=icon1.gif></A>  enum </TD><TD><B>NameErrType</B> <br>
 
20
<I> The reasons why setting the subject name might fail (error codes)</I>
 
21
</TD></TR></TABLE><TABLE>
 
22
<DT><h3>Public Methods</h3><DD><TR><TD VALIGN=top><A HREF="#DOC.360.1"> <IMG BORDER=0 SRC=icon1.gif></A> </TD><TD><B>Subject</B> (<!1><A HREF="Graph.html">Graph</A> *g)<br>
 
23
<I></I>
 
24
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.2"> <IMG BORDER=0 SRC=icon1.gif></A> virtual  <!2><A HREF="Subject.html#DOC.360.1">Subject</A>* </TD><TD><B>Clone</B> ()<br>
 
25
<I></I>
 
26
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.3"> <IMG BORDER=0 SRC=icon1.gif></A> bool </TD><TD><B>IsSubject</B> () const <br>
 
27
<I> it is a subject</I>
 
28
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.4"> <IMG BORDER=0 SRC=icon1.gif></A> virtual  bool </TD><TD><B>IsEdge</B> () const <br>
 
29
<I> is it a node or an edge?</I>
 
30
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.5"> <IMG BORDER=0 SRC=icon1.gif></A> virtual  bool </TD><TD><B>InGraph</B> () const <br>
 
31
<I> return if subject is part of the graph.</I>
 
32
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.7"> <IMG BORDER=0 SRC=icon1.gif></A> const  <!1><A HREF="string.html">string</A>* </TD><TD><B>GetName</B> () const <br>
 
33
<I></I>
 
34
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.8"> <IMG BORDER=0 SRC=icon1.gif></A> virtual  <!2><A HREF="Subject.html#DOC.360.6">NameErrType</A> </TD><TD><B>SetName</B> (const <!1><A HREF="string.html">string</A> *s)<br>
 
35
<I> set and check the name</I>
 
36
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.9"> <IMG BORDER=0 SRC=icon1.gif></A> void </TD><TD><B>WriteMembers</B> (<!1><A HREF="OutputFile.html">OutputFile</A> *f)<br>
 
37
<I> write members of subject to file.</I>
 
38
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.10"> <IMG BORDER=0 SRC=icon1.gif></A> bool </TD><TD><B>ReadMembers</B> (<!1><A HREF="InputFile.html">InputFile</A> *f, double format)<br>
 
39
<I> read and parse members of subject from file.</I>
 
40
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.11"> <IMG BORDER=0 SRC=icon1.gif></A> bool </TD><TD><B>SetReferences</B> (<!1><A HREF="AssocList.html">AssocList</A> *)<br>
 
41
<I> set subject references using the assoclist.</I>
 
42
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.12"> <IMG BORDER=0 SRC=icon1.gif></A> bool </TD><TD><B>CheckReferences</B> ()<br>
 
43
<I> Check if parent reference exists as graph node element.</I>
 
44
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.13"> <IMG BORDER=0 SRC=icon1.gif></A> void </TD><TD><B>SetParent</B> (<!1><A HREF="Node.html">Node</A> *p)<br>
 
45
<I> Set the parent node (parent may be 0).</I>
 
46
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.14"> <IMG BORDER=0 SRC=icon1.gif></A> <!1><A HREF="Node.html">Node</A>* </TD><TD><B>GetParent</B> () const <br>
 
47
<I></I>
 
48
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.15"> <IMG BORDER=0 SRC=icon1.gif></A> void </TD><TD><B>SetAnnotation</B> (<!1><A HREF="string.html">string</A> *s)<br>
 
49
<I></I>
 
50
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.16"> <IMG BORDER=0 SRC=icon1.gif></A> const  <!1><A HREF="string.html">string</A>* </TD><TD><B>GetAnnotation</B> () const <br>
 
51
<I></I>
 
52
</TD></TR><TR><TD VALIGN=top><A HREF="#DOC.360.17"> <IMG BORDER=0 SRC=icon1.gif></A> <!1><A HREF="Graph.html">Graph</A>* </TD><TD><B>GetGraph</B> () const <br>
 
53
<I></I>
 
54
</TD></TR></TABLE></DL>
 
55
<hr><H3>Inherited from <A HREF="Thing.html">Thing:</A></h3>
 
56
 
 
57
<DL>
 
58
<DL>
 
59
<DT><h3>Public Classes</h3><DD><DT><IMG SRC=icon2.gif>  enum  <B>AssocType</B>
 
60
</DL><DL>
 
61
<DT><h3>Public Methods</h3><DD><DT><IMG SRC=icon2.gif> unsigned  long  <B>GetId</B>()
 
62
<DT><IMG SRC=icon2.gif> void  <B>SetId</B>(unsigned long val)
 
63
<DT><IMG SRC=icon2.gif> virtual  bool  <B>IsShape</B>() const 
 
64
<DT><IMG SRC=icon2.gif> virtual  bool  <B>IsView</B>() const 
 
65
<DT><IMG SRC=icon2.gif> virtual  int  <B>GetClassType</B>() const 
 
66
<DT><IMG SRC=icon2.gif> void  <B>Write</B>(<!1><A HREF="OutputFile.html">OutputFile</A> *ofile)
 
67
</DL></DL>
 
68
<A NAME="DOC.DOCU">
 
69
<hr>
 
70
 <h2> Documentation </h2>
 
71
<BLOCKQUOTE>
 
72
 (abstract) graph element class (is either a node or an edge).
 
73
 
 
74
</BLOCKQUOTE>
 
75
<DL>
 
76
 
 
77
<A NAME="Subject">
 
78
<A NAME ="DOC.360.1">
 
79
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B>  Subject(<!1><A HREF="Graph.html">Graph</A> *g)</B></TT>
 
80
<DL></DL><P>
 
81
<A NAME="Clone">
 
82
<A NAME ="DOC.360.2">
 
83
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual  <!2><A HREF="Subject.html#DOC.360.1">Subject</A>*  Clone()</B></TT>
 
84
<DL></DL><P>
 
85
<A NAME="IsSubject">
 
86
<A NAME ="DOC.360.3">
 
87
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool  IsSubject() const </B></TT>
 
88
<DD> it is a subject
 
89
<DL></DL><P>
 
90
<A NAME="IsEdge">
 
91
<A NAME ="DOC.360.4">
 
92
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual  bool  IsEdge() const </B></TT>
 
93
<DD> is it a node or an edge?
 
94
<DL></DL><P>
 
95
<A NAME="InGraph">
 
96
<A NAME ="DOC.360.5">
 
97
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual  bool  InGraph() const </B></TT>
 
98
<DD> return if subject is part of the graph.
 
99
<DL></DL><P>
 
100
<A NAME="NameErrType">
 
101
<A NAME ="DOC.360.6">
 
102
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B>  enum  NameErrType</B></TT>
 
103
<DD> The reasons why setting the subject name might fail (error codes)
 
104
<DL></DL><P>
 
105
<A NAME="GetName">
 
106
<A NAME ="DOC.360.7">
 
107
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> const  <!1><A HREF="string.html">string</A>*  GetName() const </B></TT>
 
108
<DL></DL><P>
 
109
<A NAME="SetName">
 
110
<A NAME ="DOC.360.8">
 
111
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual  <!2><A HREF="Subject.html#DOC.360.6">NameErrType</A>  SetName(const <!1><A HREF="string.html">string</A> *s)</B></TT>
 
112
<DD> set and check the name
 
113
<DL></DL><P>
 
114
<A NAME="WriteMembers">
 
115
<A NAME ="DOC.360.9">
 
116
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> void  WriteMembers(<!1><A HREF="OutputFile.html">OutputFile</A> *f)</B></TT>
 
117
<DD> write members of subject to file.
 
118
<DL></DL><P>
 
119
<A NAME="ReadMembers">
 
120
<A NAME ="DOC.360.10">
 
121
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool  ReadMembers(<!1><A HREF="InputFile.html">InputFile</A> *f, double format)</B></TT>
 
122
<DD> read and parse members of subject from file.
 
123
<DL></DL><P>
 
124
<A NAME="SetReferences">
 
125
<A NAME ="DOC.360.11">
 
126
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool  SetReferences(<!1><A HREF="AssocList.html">AssocList</A> *)</B></TT>
 
127
<DD> set subject references using the assoclist.
 
128
<DL></DL><P>
 
129
<A NAME="CheckReferences">
 
130
<A NAME ="DOC.360.12">
 
131
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool  CheckReferences()</B></TT>
 
132
<DD> Check if parent reference exists as graph node element.
 
133
<DL></DL><P>
 
134
<A NAME="SetParent">
 
135
<A NAME ="DOC.360.13">
 
136
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> void  SetParent(<!1><A HREF="Node.html">Node</A> *p)</B></TT>
 
137
<DD> Set the parent node (parent may be 0).
 
138
<DL></DL><P>
 
139
<A NAME="GetParent">
 
140
<A NAME ="DOC.360.14">
 
141
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> <!1><A HREF="Node.html">Node</A>*  GetParent() const </B></TT>
 
142
<DL></DL><P>
 
143
<A NAME="SetAnnotation">
 
144
<A NAME ="DOC.360.15">
 
145
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> void  SetAnnotation(<!1><A HREF="string.html">string</A> *s)</B></TT>
 
146
<DL></DL><P>
 
147
<A NAME="GetAnnotation">
 
148
<A NAME ="DOC.360.16">
 
149
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> const  <!1><A HREF="string.html">string</A>*  GetAnnotation() const </B></TT>
 
150
<DL></DL><P>
 
151
<A NAME="GetGraph">
 
152
<A NAME ="DOC.360.17">
 
153
<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> <!1><A HREF="Graph.html">Graph</A>*  GetGraph() const </B></TT>
 
154
<DL></DL><P></DL>
 
155
<hr>
 
156
<DL><DT><B>Direct child classes:
 
157
</B><DD><A HREF="Node.html"> Node </A><br>
 
158
<A HREF="Edge.html"> Edge </A><br>
 
159
</DL>
 
160
<DL></DL><P><I><A HREF="aindex.html"> alphabetic index</A></I>  <I><A HREF="HIER.html"> hierarchy of classes</A></I><P><hr>
 
161
<A HREF="http://www.zib.de/Visual/software/doc++/index.html"><IMG BORDER=0 ALIGN=RIGHT SRC=logo.gif></A>
 
162
<P Align=Center><I>this page has been generated automatically by doc++</I>
 
163
<P Align=Center><I>(c)opyright by <A HREF="http://www.zib.de/zoeckler/"> Malte  Z&ouml;ckler</A>, <A HREF="mailto:wunderling@zib.de"> Roland Wunderling </A><br>contact: <A HREF="mailto:doc++@zib.de"> doc++@zib.de</a></I>
 
164
</BODY>