Source

cappuccino-docs / cappuccino docs / cappuccino.org / learn / documentation / class_c_p_coder.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_coder.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:16:58 GMT -->
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cappuccino API: CPCoder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>CPCoder Class Reference<br/>
<small>
[<a class="el" href="group__foundation.html">Foundation</a>]</small>
</h1><!-- doxytag: class="CPCoder" -->
<p>Defines methods for use when archiving &amp; restoring (enc/decoding).  
<a href="#_details">More...</a></p>

<p><a href="class_c_p_coder-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a42d4a3d3347c8fb3047d830c73b648c3">encodeBycopyObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a33cc1773e8d82bb119b353b38eedf1a0">encodeConditionalObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a7aa8cfdea5d51c69e0001aa9d2a0f638">encodeDataObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a84ebd7baed44333160b23f29bafe901b">encodeObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a581508384488b9cefc9052f71aa49be6">encodePoint:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#ab2bedd2fb213d474b1fa9bc56bdafeb2">encodePropertyList:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a691b22e9b1d056a60f5b24e11d76cb36">encodeRect:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#ad66e6daeb7002a3a6caaed7d92a74c29">encodeRootObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a173642698b22e6df2ab3647ae035f4cf">encodeSize:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_coder.html#a2d6f875899af462553a85d7b4440431d">encodeValueOfObjCType:at:</a><code> [implementation]</code></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Defines methods for use when archiving &amp; restoring (enc/decoding). </p>
<p>Top-level class defining methods for use when archiving (encoding) objects to a byte array or file, and when restoring (decoding) objects. </p>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00035">35</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a42d4a3d3347c8fb3047d830c73b648c3"></a><!-- doxytag: member="CPCoder::encodeBycopyObject:" ref="a42d4a3d3347c8fb3047d830c73b648c3" args="(id anObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeBycopyObject: </td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>anObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes an object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>anObject</em>&nbsp;</td><td>the object to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00131">131</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a33cc1773e8d82bb119b353b38eedf1a0"></a><!-- doxytag: member="CPCoder::encodeConditionalObject:" ref="a33cc1773e8d82bb119b353b38eedf1a0" args="(id anObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeConditionalObject: </td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>anObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes an object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>anObject</em>&nbsp;</td><td>the object to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00140">140</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a7aa8cfdea5d51c69e0001aa9d2a0f638"></a><!-- doxytag: member="CPCoder::encodeDataObject:" ref="a7aa8cfdea5d51c69e0001aa9d2a0f638" args="(CPData aData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeDataObject: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="class_c_p_data.html">CPData</a>)&nbsp;</td>
          <td class="paramname"> <em>aData</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a data object. Subclasses must override this method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aData</em>&nbsp;</td><td>the object to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00065">65</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a84ebd7baed44333160b23f29bafe901b"></a><!-- doxytag: member="CPCoder::encodeObject:" ref="a84ebd7baed44333160b23f29bafe901b" args="(id anObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeObject: </td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>anObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes an object. Subclasses must override this method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>anObject</em>&nbsp;</td><td>the object to be encoded </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00074">74</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a581508384488b9cefc9052f71aa49be6"></a><!-- doxytag: member="CPCoder::encodePoint:" ref="a581508384488b9cefc9052f71aa49be6" args="(CPPoint aPoint)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodePoint: </td>
          <td></td>
          <td class="paramtype">(CPPoint)&nbsp;</td>
          <td class="paramname"> <em>aPoint</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a point </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aPoint</em>&nbsp;</td><td>the point to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00083">83</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="ab2bedd2fb213d474b1fa9bc56bdafeb2"></a><!-- doxytag: member="CPCoder::encodePropertyList:" ref="ab2bedd2fb213d474b1fa9bc56bdafeb2" args="(id aPropertyList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodePropertyList: </td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>aPropertyList</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a property list. Not yet implemented. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aPropertyList</em>&nbsp;</td><td>the property list to be encoded </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00113">113</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a691b22e9b1d056a60f5b24e11d76cb36"></a><!-- doxytag: member="CPCoder::encodeRect:" ref="a691b22e9b1d056a60f5b24e11d76cb36" args="(CGRect aRect)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeRect: </td>
          <td></td>
          <td class="paramtype">(CGRect)&nbsp;</td>
          <td class="paramname"> <em>aRect</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a CGRect </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aRect</em>&nbsp;</td><td>the rectangle to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00093">93</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="ad66e6daeb7002a3a6caaed7d92a74c29"></a><!-- doxytag: member="CPCoder::encodeRootObject:" ref="ad66e6daeb7002a3a6caaed7d92a74c29" args="(id anObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeRootObject: </td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>anObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes the root object of a group of Obj-J objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>rootObject</em>&nbsp;</td><td>the root object to be encoded. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00122">122</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a173642698b22e6df2ab3647ae035f4cf"></a><!-- doxytag: member="CPCoder::encodeSize:" ref="a173642698b22e6df2ab3647ae035f4cf" args="(CPSize aSize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeSize: </td>
          <td></td>
          <td class="paramtype">(CPSize)&nbsp;</td>
          <td class="paramname"> <em>aSize</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a CGSize </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aSize</em>&nbsp;</td><td>the size to be encoded </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00103">103</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<a class="anchor" id="a2d6f875899af462553a85d7b4440431d"></a><!-- doxytag: member="CPCoder::encodeValueOfObjCType:at:" ref="a2d6f875899af462553a85d7b4440431d" args="(CPString aType,[at] id anObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeValueOfObjCType: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="class_c_p_string.html">CPString</a>)&nbsp;</td>
          <td class="paramname"> <em>aType</em></td>
        </tr>
        <tr>
          <td class="paramkey">at:</td>
          <td></td>
          <td class="paramtype">(id)&nbsp;</td>
          <td class="paramname"> <em>anObject</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td><td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes a structure or object of a specified type. Usually this is used for primitives though it can be used for objects as well. Subclasses must override this method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aType</em>&nbsp;</td><td>the structure or object type </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>anObject</em>&nbsp;</td><td>the object to be encoded </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_coder_8j_source.html#l00056">56</a> of file <a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Foundation/<a class="el" href="_c_p_coder_8j_source.html">CPCoder.j</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Apr 6 10:33:05 2010 for Cappuccino API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_coder.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:16:59 GMT -->
</html>