Moved doxygen output from doc/doxygen to doc. Commented out manuals generation in...
[vlp.git] / doc / html-old / machine.html
diff --git a/doc/html-old/machine.html b/doc/html-old/machine.html
new file mode 100644 (file)
index 0000000..4ebad20
--- /dev/null
@@ -0,0 +1,37 @@
+<HTML>
+<HEAD>
+</HEAD>
+<BODY>
+<B> Class MACHINE </B><BR>
+<BR>
+Class <B> Machine </B> is the set of functions designed to 
+give informations about Virtual LOGLAN Machine. 
+<UL>
+<LI> unit <B>LocalNode</B>:function:integer<BR>
+Returns the ID  of local Virtual Processor.
+<LI> unit <B>NodesNum</B>:function:integer<BR>
+Returns the number of Virtual Processors actually available
+in the Machine.<BR>
+Warning! The local VLP is not counted, so function returns
+0 if there are no other Processors.
+<LI> unit <B>NodeExists</B>:function(<I>node</I>:integer):boolean<BR>
+Returns TRUE if the Virtual Processor with the ID equal to the
+<I>node</I> is connected to the Machine.
+<LI> unit <B>MachineInfo</B>:function:NodeInfo<BR>
+This function returns full information about all connected Virtual
+Processors. Information is given as a list of <I>NodeInfo</I>
+structures.<BR>
+The <I>NodeInfo</I> structure is defined in the class Machine
+as follow:
+<PRE>
+unit NodeInfo:class;
+var num:integer,        (* an ID of a Virtual Processor *)
+    addr:arrayof char   (* IP address of a VLP *)
+    next:NodeInfo       (* next structure on the list *)
+end NodeInfo;
+</PRE>
+</UL>
+<HR>
+<A HREF="index.html">Return to Index</A>
+</BODY>
+</HTML>