<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (Francy) - Chapter 10: Francy Util</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap10"  onload="jscontent()">


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap9.html">[Previous Chapter]</a>    <a href="chapInd.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap10_mj.html">[MathJax on]</a></p>
<p><a id="X7D19C8447955D526" name="X7D19C8447955D526"></a></p>
<div class="ChapSects"><a href="chap10.html#X7D19C8447955D526">10 <span class="Heading">Francy Util</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap10.html#X7DE8E16C7C2D387B">10.1 <span class="Heading">Operations</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap10.html#X7FDA25B980809FC3">10.1-1 JUPYTER_ViewString</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap10.html#X804E29DC830EE7B1">10.1-2 Sanitize</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap10.html#X84A26F95834C1C49">10.1-3 MergeObjects</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap10.html#X79A299E4878A701B">10.1-4 GenerateID</a></span>
</div></div>
</div>

<h3>10 <span class="Heading">Francy Util</span></h3>

<p>Utility functions used across the package.</p>

<p><a id="X7DE8E16C7C2D387B" name="X7DE8E16C7C2D387B"></a></p>

<h4>10.1 <span class="Heading">Operations</span></h4>

<p>In this section we show all Francy Util Operations. Contains utility methods to handle Object printing/viewing, Sanitizing, etc.</p>

<p><a id="X7FDA25B980809FC3" name="X7FDA25B980809FC3"></a></p>

<h5>10.1-1 JUPYTER_ViewString</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; JUPYTER_ViewString</code>( <var class="Arg">arg</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">String</code></p>

<p>This method will pretty print in jupyter environment.</p>

<p><a id="X804E29DC830EE7B1" name="X804E29DC830EE7B1"></a></p>

<h5>10.1-2 Sanitize</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Sanitize</code>( <var class="Arg">IsObject</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">rec</code></p>

<p>This method will clone an <code class="code">Object</code> and return a sanitized record. It traverses all the components sanitizing when appropriate. Sanitizing in this context means: replace everything that can't be converted into JSON, with its string representation!</p>

<p><a id="X84A26F95834C1C49" name="X84A26F95834C1C49"></a></p>

<h5>10.1-3 MergeObjects</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; MergeObjects</code>( <var class="Arg">IsFrancyObject</var>, <var class="Arg">IsFrancyObject</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">rec</code></p>

<p>This method will merge the properties of 2 <code class="code">IsFrancyObjects</code> into one <code class="code">rec</code>.</p>

<p><a id="X79A299E4878A701B" name="X79A299E4878A701B"></a></p>

<h5>10.1-4 GenerateID</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; GenerateID</code>(  )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">IsString</code></p>

<p>This method will generate a sequential ID to be used as object identifier. These IDs are used to identify the objects between the client and the server, and are crucial for the communication between both.</p>


<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap9.html">[Previous Chapter]</a>    <a href="chapInd.html">[Next Chapter]</a>   </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>