Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 166a9807065357168d48043297ca7304 > files > 33

ocamlviz-1.01-9.mga5.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Monitor_sig.Monitor.Point.html">
<link rel="next" href="Monitor_sig.Monitor.Time.html">
<link rel="Up" href="Monitor_sig.Monitor.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Binary" rel="Chapter" href="Binary.html">
<link title="Bproto" rel="Chapter" href="Bproto.html">
<link title="Db" rel="Chapter" href="Db.html">
<link title="Graph" rel="Chapter" href="Graph.html">
<link title="Monitor_sig" rel="Chapter" href="Monitor_sig.html">
<link title="Ocamlviz" rel="Chapter" href="Ocamlviz.html">
<link title="Ocamlviz_threads" rel="Chapter" href="Ocamlviz_threads.html">
<link title="Protocol" rel="Chapter" href="Protocol.html">
<link title="Timemap" rel="Chapter" href="Timemap.html"><title>Monitor_sig.Monitor.Tag</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Monitor_sig.Monitor.Point.html" title="Monitor_sig.Monitor.Point">Previous</a>
&nbsp;<a class="up" href="Monitor_sig.Monitor.html" title="Monitor_sig.Monitor">Up</a>
&nbsp;<a class="post" href="Monitor_sig.Monitor.Time.html" title="Monitor_sig.Monitor.Time">Next</a>
</div>
<h1>Module <a href="type_Monitor_sig.Monitor.Tag.html">Monitor_sig.Monitor.Tag</a></h1>

<pre><span class="keyword">module</span> Tag: <code class="code">sig</code> <a href="Monitor_sig.Monitor.Tag.html">..</a> <code class="code">end</code></pre><div class="info module top">
A module that allows to create tags and mark values.
      It calculates tags' cardinal and size in memory.<br>
</div>
<hr width="100%">

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
The abstract type for a tag.<br>
</div>


<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">?size:bool -><br>       ?count:bool -><br>       ?fct_size:(WeakHash.t -> Int64.t) -><br>       ?period:int -> string -> <a href="Monitor_sig.Monitor.Tag.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">create s</code> creates a tag called <code class="code">s</code>.<br>
</div>
<div class="param_info"><code class="code">size</code> : Chooses whether the tag will handle the size of its values</div>
<div class="param_info"><code class="code">count</code> : Chooses whether the tag will handle the number of its values</div>
<div class="param_info"><code class="code">fct_size</code> : Puts your own function to calculate the size</div>
<div class="param_info"><code class="code">period</code> : Sets the period to which the size and/or the count will be calculated (in milliseconds). Default is 100ms.</div>

<pre><span id="VALkill"><span class="keyword">val</span> kill</span> : <code class="type"><a href="Monitor_sig.Monitor.Tag.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">kill t</code> kills a tag <code class="code">t</code>. This means that this tag
	  won't be monitored anymore. This may improve considerably the program's speed.<br>
</div>

<pre><span id="VALset_period"><span class="keyword">val</span> set_period</span> : <code class="type"><a href="Monitor_sig.Monitor.Tag.html#TYPEt">t</a> -> int -> unit</code></pre><div class="info ">
<code class="code">set_period t p</code> changes the period to which the operations on the tag <code class="code">t</code> are made.<br>
</div>

<pre><span id="VALmark"><span class="keyword">val</span> mark</span> : <code class="type"><a href="Monitor_sig.Monitor.Tag.html#TYPEt">t</a> -> 'a -> 'a</code></pre><div class="info ">
<code class="code">mark t v</code> marks any value <code class="code">v</code> of type 'a with the tag <code class="code">t</code>.
	  One tag can mark many values.
	  One value can be marked by many tags.
	  A tag may contain any value of any type.<br>
</div>
</body></html>