<!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">
<head>
<title>Parrot - Capture PMC</title>
<link rel="stylesheet" type="text/css"
href="../../../resources/parrot.css"
media="all">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body>
<div id="wrapper">
<div id="header">
<a href="http://www.parrot.org">
<img border=0 src="../../../resources/parrot_logo.png" id="logo" alt="parrot">
</a>
</div> <!-- "header" -->
<div id="divider"></div>
<div id="mainbody">
<div id="breadcrumb">
<a href="../../../html/index.html">Home</a> » <a href="../../../html/pmc.html">PMCs</a> » Capture PMC
</div>
<h1><a name="NAME"
>NAME</a></h1>
<p>src/pmc/capture.pmc - Capture PMC</p>
<h1><a name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>These are the vtable functions for the Capture PMC.</p>
<h2><a name="Functions"
>Functions</a></h2>
<dl>
<dt><a name="PMC_*clone()"
><b><code>PMC *clone()</b></code></a></dt>
Creates an identical copy of the Capture.
<dt><a name="void_set_number_keyed_int(INTVAL_key,_FLOATVAL_value)"
><b><code>void set_number_keyed_int(INTVAL key, FLOATVAL value)</b></code></a></dt>
<dt><a name="void_set_integer_keyed_int(INTVAL_key,_INTVAL_value)"
><b><code>void set_integer_keyed_int(INTVAL key, INTVAL value)</b></code></a></dt>
<dt><a name="void_set_pmc_keyed_int(INTVAL_key,_PMC_*value)"
><b><code>void set_pmc_keyed_int(INTVAL key, PMC *value)</b></code></a></dt>
<dt><a name="void_set_string_keyed_int(INTVAL_key,_STRING_*value)"
><b><code>void set_string_keyed_int(INTVAL key, STRING *value)</b></code></a></dt>
Sets a value in the array component of the Capture.
<dt><a name="FLOATVAL_get_number_keyed_int(INTVAL_key)"
><b><code>FLOATVAL get_number_keyed_int(INTVAL key)</b></code></a></dt>
<dt><a name="INTVAL_get_integer_keyed_int(INTVAL_key)"
><b><code>INTVAL get_integer_keyed_int(INTVAL key)</b></code></a></dt>
<dt><a name="PMC_*get_pmc_keyed_int(INTVAL_key)"
><b><code>PMC *get_pmc_keyed_int(INTVAL key)</b></code></a></dt>
<dt><a name="STRING_*get_string_keyed_int(INTVAL_key)"
><b><code>STRING *get_string_keyed_int(INTVAL key)</b></code></a></dt>
Retrieves a value in the array component of the Capture.
<dt><a name="void_push_float(FLOATVAL_value)"
><b><code>void push_float(FLOATVAL value)</b></code></a></dt>
<dt><a name="void_push_integer(INTVAL_value)"
><b><code>void push_integer(INTVAL value)</b></code></a></dt>
<dt><a name="void_push_pmc(PMC_*value)"
><b><code>void push_pmc(PMC *value)</b></code></a></dt>
<dt><a name="void_push_string(STRING_*value)"
><b><code>void push_string(STRING *value)</b></code></a></dt>
Push a value onto the array component of the Capture.
<dt><a name="void_unshift_float(FLOATVAL_value)"
><b><code>void unshift_float(FLOATVAL value)</b></code></a></dt>
<dt><a name="void_unshift_integer(INTVAL_value)"
><b><code>void unshift_integer(INTVAL value)</b></code></a></dt>
<dt><a name="void_unshift_pmc(PMC_*value)"
><b><code>void unshift_pmc(PMC *value)</b></code></a></dt>
<dt><a name="void_unshift_string(STRING_*value)"
><b><code>void unshift_string(STRING *value)</b></code></a></dt>
Unshift a value onto the array component of the Capture.
<dt><a name="FLOATVAL_pop_float()"
><b><code>FLOATVAL pop_float()</b></code></a></dt>
<dt><a name="INTVAL_pop_integer()"
><b><code>INTVAL pop_integer()</b></code></a></dt>
<dt><a name="PMC_*pop_pmc()"
><b><code>PMC *pop_pmc()</b></code></a></dt>
<dt><a name="STRING_*pop_string()"
><b><code>STRING *pop_string()</b></code></a></dt>
Pop a value from the array component of the Capture.
<dt><a name="FLOATVAL_shift_float()"
><b><code>FLOATVAL shift_float()</b></code></a></dt>
<dt><a name="INTVAL_shift_integer()"
><b><code>INTVAL shift_integer()</b></code></a></dt>
<dt><a name="PMC_*shift_pmc()"
><b><code>PMC *shift_pmc()</b></code></a></dt>
<dt><a name="STRING_*shift_string()"
><b><code>STRING *shift_string()</b></code></a></dt>
Shift a value from the array component of the Capture.
<dt><a name="INTVAL_elements()"
><b><code>INTVAL elements()</b></code></a></dt>
Return the number of elements in the array component of the Capture.
<dt><a name="INTVAL_defined_keyed_int(INTVAL_key)"
><b><code>INTVAL defined_keyed_int(INTVAL key)</b></code></a></dt>
Return true if element <code>key</code> of the array component is defined.
<dt><a name="INTVAL_exists_keyed_int(INTVAL_key)"
><b><code>INTVAL exists_keyed_int(INTVAL key)</b></code></a></dt>
Return true if element <code>key</code> of the array component exists.
<dt><a name="void_delete_keyed_int(INTVAL_key)"
><b><code>void delete_keyed_int(INTVAL key)</b></code></a></dt>
Delete the element corresponding to <code>key</code> in the array component.
<dt><a name="void_set_number_keyed(PMC_*key,_FLOATVAL_value)"
><b><code>void set_number_keyed(PMC *key, FLOATVAL value)</b></code></a></dt>
<dt><a name="void_set_integer_keyed(PMC_*key,_INTVAL_value)"
><b><code>void set_integer_keyed(PMC *key, INTVAL value)</b></code></a></dt>
<dt><a name="void_set_pmc_keyed(PMC_*key,_PMC_*value)"
><b><code>void set_pmc_keyed(PMC *key, PMC *value)</b></code></a></dt>
<dt><a name="void_set_string_keyed(PMC_*key,_STRING_*value)"
><b><code>void set_string_keyed(PMC *key, STRING *value)</b></code></a></dt>
Sets a value in the hash component of the Capture.
<dt><a name="FLOATVAL_get_number_keyed(PMC_*key)"
><b><code>FLOATVAL get_number_keyed(PMC *key)</b></code></a></dt>
<dt><a name="INTVAL_get_integer_keyed(PMC_*key)"
><b><code>INTVAL get_integer_keyed(PMC *key)</b></code></a></dt>
<dt><a name="PMC_*get_pmc_keyed(PMC_*key)"
><b><code>PMC *get_pmc_keyed(PMC *key)</b></code></a></dt>
<dt><a name="STRING_*get_string_keyed(PMC_*key)"
><b><code>STRING *get_string_keyed(PMC *key)</b></code></a></dt>
Retrieves a value from the hash component of the Capture.
<dt><a name="void_set_number_keyed_str(STRING_*key,_FLOATVAL_value)"
><b><code>void set_number_keyed_str(STRING *key, FLOATVAL value)</b></code></a></dt>
<dt><a name="void_set_integer_keyed_str(STRING_*key,_INTVAL_value)"
><b><code>void set_integer_keyed_str(STRING *key, INTVAL value)</b></code></a></dt>
<dt><a name="void_set_pmc_keyed_str(STRING_*key,_PMC_*value)"
><b><code>void set_pmc_keyed_str(STRING *key, PMC *value)</b></code></a></dt>
<dt><a name="void_set_string_keyed_str(STRING_*key,_STRING_*value)"
><b><code>void set_string_keyed_str(STRING *key, STRING *value)</b></code></a></dt>
Sets a value in the hash component of the Capture.
<dt><a name="FLOATVAL_get_number_keyed_str(STRING_*key)"
><b><code>FLOATVAL get_number_keyed_str(STRING *key)</b></code></a></dt>
<dt><a name="INTVAL_get_integer_keyed_str(STRING_*key)"
><b><code>INTVAL get_integer_keyed_str(STRING *key)</b></code></a></dt>
<dt><a name="PMC_*get_pmc_keyed_str(STRING_*key)"
><b><code>PMC *get_pmc_keyed_str(STRING *key)</b></code></a></dt>
<dt><a name="STRING_*get_string_keyed_str(STRING_*key)"
><b><code>STRING *get_string_keyed_str(STRING *key)</b></code></a></dt>
Retrieves a value in the hash component of the Capture.
<dt><a name="INTVAL_defined_keyed(PMC_*key)"
><b><code>INTVAL defined_keyed(PMC *key)</b></code></a></dt>
Return true if element <code>key</code> of the hash component is defined.
<dt><a name="INTVAL_exists_keyed(PMC_*key)"
><b><code>INTVAL exists_keyed(PMC *key)</b></code></a></dt>
Return true if element <code>key</code> of the hash component exists.
<dt><a name="void_delete_keyed(PMC_*key)"
><b><code>void delete_keyed(PMC *key)</b></code></a></dt>
Delete the element corresponding to <code>key</code> in the hash component.
<dt><a name="INTVAL_defined_keyed_str(STRING_*key)"
><b><code>INTVAL defined_keyed_str(STRING *key)</b></code></a></dt>
Return true if element <code>key</code> of the hash component is defined.
<dt><a name="INTVAL_exists_keyed_str(STRING_*key)"
><b><code>INTVAL exists_keyed_str(STRING *key)</b></code></a></dt>
Return true if element <code>key</code> of the hash component exists.
<dt><a name="void_delete_keyed_str(STRING_*key)"
><b><code>void delete_keyed_str(STRING *key)</b></code></a></dt>
Delete the element corresponding to <code>key</code> in the hash component.
<dt><a name="void_set_pmc(PMC_*capture)"
><b><code>void set_pmc(PMC *capture)</b></code></a></dt>
Set this capture to hold the value of another.
If set to PMCNULL,
erase the contents of the array and hash components.
<dt><a name="STRING_get_string()"
><b><code>STRING get_string()</b></code></a></dt>
Return a string representation of the hash,
showing class and memory address.
<dt><a name="void_mark(void)"
><b><code>void mark(void)</b></code></a></dt>
Mark the array.
<dt><a name="void_freeze()"
><b><code>void freeze()</b></code></a></dt>
<dt><a name="void_thaw()"
><b><code>void thaw()</b></code></a></dt>
Freeze/thaw Capture</dl>
<h2><a name="Methods"
>Methods</a></h2>
</div> <!-- "mainbody" -->
<div id="divider"></div>
<div id="footer">
Copyright © 2002-2011, Parrot Foundation.
</div>
</div> <!-- "wrapper" -->
</body>
</html>
