File: spatialite_network.1.xml

package info (click to toggle)
spatialite-tools 5.1.0a-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,340 kB
  • sloc: ansic: 45,591; sh: 4,007; xml: 1,920; makefile: 97
file content (192 lines) | stat: -rw-r--r-- 6,955 bytes parent folder | download | duplicates (5)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id='spatialite_network'>

  <refmeta>
    <refentrytitle>spatialite_network</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>spatialite_network</refname>
    <refpurpose>analysis/validation tool for topological networks</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>spatialite_network</command>
      <arg choice='opt'><option>-h</option></arg>
      <arg choice='opt'><option>-d</option> <replaceable>pathname</replaceable></arg>
      <arg choice='opt'><option>-T</option> <replaceable>table_name</replaceable></arg>
      <arg choice='opt'><option>-f</option> <replaceable>col_name</replaceable></arg>
      <arg choice='opt'><option>-t</option> <replaceable>col_name</replaceable></arg>
      <arg choice='opt'><option>-g</option> <replaceable>col_name</replaceable></arg>
      <arg choice='opt'><option>-c</option> <replaceable>col_name</replaceable></arg>
      <group>
        <arg choice='opt'><option>--a-star-supported</option></arg>
        <arg choice='opt'><option>--a-star-excluded</option></arg>
      </group>
      <arg choice='opt'><option>-n</option> <replaceable>col_name</replaceable></arg>
      <group>
        <arg choice='opt'><option>--bidirectional</option></arg>
        <arg choice='opt'><option>--unidirectional</option>
          <arg choice='opt'><option>--oneway-tofrom</option> <replaceable>col_name</replaceable></arg>
          <arg choice='opt'><option>--oneway-fromto</option> <replaceable>col_name</replaceable></arg>
        </arg>
      </group>
      <arg choice='opt'><option>-o</option> <replaceable>table_name</replaceable></arg>
      <arg choice='opt'><option>--overwrite-output</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      <command>spatialite_network</command> is an analysis / validation tool
      for topological networks
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <variablelist>

      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show help message</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option> <replaceable>pathname</replaceable></term>
        <term><option>--db-path</option> <replaceable>pathname</replaceable></term>
        <listitem>
          <para>the SpatiaLite db path</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-T</option> <replaceable>table_name</replaceable></term>
        <term><option>--table</option> <replaceable>table_name</replaceable></term>
        <listitem>
          <para>the db table to be validated</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-f</option> <replaceable>col_name</replaceable></term>
        <term><option>--from-column</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>the column for FromNode</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t</option> <replaceable>col_name</replaceable></term>
        <term><option>--to-column</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>the column for ToNode</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g</option> <replaceable>col_name</replaceable></term>
        <term><option>--geometry-column</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>the column for Geometry</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option> <replaceable>col_name</replaceable></term>
        <term><option>--cost-column</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>the column for Cost</para>
          <para>if omitted, GLength(g) will be used by default</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--a-star-supported</option></term>
        <listitem>
          <para>support the A* algorithm (default)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--a-star-excluded</option></term>
        <listitem>
          <para>no support for the A* algorithm</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option> <replaceable>col_name</replaceable></term>
        <term><option>--name-column</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>the column for RoadName</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--bidirectional</option></term>
        <listitem>
          <para>assume bidirectional arcs (default)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--unidirectional</option></term>
        <listitem>
          <para>don't assume bidirectional arcs</para>
          <para>
            if *bidirectional* each arc connecting FromNode to ToNode is
            implicitly connecting ToNode to FromNode as well; in this case
            you can select the following further options:
            <option>--oneway-tofrom</option> &amp;
            <option>--oneway-fromto</option>
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--oneway-tofrom</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>OneWay To->From column name</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--oneway-fromto</option> <replaceable>col_name</replaceable></term>
        <listitem>
          <para>OneWay From->To column name</para>
          <para>
            both columns are expected to contain BOOLEAN values [1-0];
            1 means that the arc connection in the given direction is valid,
            otherwise 0 means a forbidden connection
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-o</option> <replaceable>table_name</replaceable></term>
        <term><option>--output-table</option> <replaceable>table_name</replaceable></term>
        <listitem>
          <para>create a permanent NETWORK-DATA table</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--overwrite-output</option></term>
        <listitem>
          <para>drop and recreate <replaceable>table_name</replaceable> if it exists</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

</refentry>