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
|
<refentry id="xmlroff-FoPcw">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoPcw.top_of_page">FoPcw</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoPcw</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoPcw.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoPcw">FoPcw</link>;
<link linkend="FoPcwClass">FoPcwClass</link>;
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-pcw-new">fo_pcw_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-pcw-new-with-value">fo_pcw_new_with_value</link> (<link linkend="gdouble">gdouble</link> value);
<link linkend="gdouble">gdouble</link> <link linkend="fo-pcw-get-value">fo_pcw_get_value</link> (<link linkend="FoDatatype">FoDatatype</link> *pcw);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-pcw-get-pcw-zero">fo_pcw_get_pcw_zero</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoPcw.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoPcw.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoPcw" role="struct">
<title>FoPcw</title>
<indexterm zone="FoPcw"><primary>FoPcw</primary></indexterm><programlisting>typedef struct _FoPcw FoPcw;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoPcwClass" role="struct">
<title>FoPcwClass</title>
<indexterm zone="FoPcwClass"><primary>FoPcwClass</primary></indexterm><programlisting>typedef struct _FoPcwClass FoPcwClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-pcw-new" role="function">
<title>fo_pcw_new ()</title>
<indexterm zone="fo-pcw-new"><primary>fo_pcw_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_pcw_new (void);</programlisting>
<para>
Creates a new <link linkend="FoPcw"><type>FoPcw</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoPcw"><type>FoPcw</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-pcw-new-with-value" role="function">
<title>fo_pcw_new_with_value ()</title>
<indexterm zone="fo-pcw-new-with-value"><primary>fo_pcw_new_with_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_pcw_new_with_value (<link linkend="gdouble">gdouble</link> value);</programlisting>
<para>
Creates a new <link linkend="FoPcw"><type>FoPcw</type></link> set to <parameter>value</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> Value of the new <link linkend="FoPcw"><type>FoPcw</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoPcw"><type>FoPcw</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-pcw-get-value" role="function">
<title>fo_pcw_get_value ()</title>
<indexterm zone="fo-pcw-get-value"><primary>fo_pcw_get_value</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> fo_pcw_get_value (<link linkend="FoDatatype">FoDatatype</link> *pcw);</programlisting>
<para>
Get the value of <parameter>pcw</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pcw</parameter> :</term>
<listitem><simpara> <link linkend="FoPcw"><type>FoPcw</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Numeric value of <parameter>pcw</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-pcw-get-pcw-zero" role="function">
<title>fo_pcw_get_pcw_zero ()</title>
<indexterm zone="fo-pcw-get-pcw-zero"><primary>fo_pcw_get_pcw_zero</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_pcw_get_pcw_zero (void);</programlisting>
<para>
Create and return an <link linkend="FoPcw"><type>FoPcw</type></link> with the well-known value 0.
</para>
<para>
This saves creation of multiple <link linkend="FoPcw"><type>FoPcw</type></link> objects that all have the
value 0.0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FoPcw"><type>FoPcw</type></link> with value 0
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
