| <!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> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>activemq-cpp-3.4.0: activemq::commands::ActiveMQMessage Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.7.3 --> |
| <div id="top"> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">activemq-cpp-3.4.0</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Data Fields</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| initNavTree('classactivemq_1_1commands_1_1_active_m_q_message.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> </div> |
| <div class="headertitle"> |
| <h1>activemq::commands::ActiveMQMessage Class Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| <!-- doxytag: class="activemq::commands::ActiveMQMessage" --><!-- doxytag: inherits="ActiveMQMessageTemplate< cms::Message >" --> |
| <p><code>#include <<a class="el" href="_active_m_q_message_8h_source.html">src/main/activemq/commands/ActiveMQMessage.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for activemq::commands::ActiveMQMessage:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classactivemq_1_1commands_1_1_active_m_q_message__inherit__graph.png" border="0" usemap="#activemq_1_1commands_1_1_active_m_q_message_inherit__map" alt="Inheritance graph"/></div> |
| <map name="activemq_1_1commands_1_1_active_m_q_message_inherit__map" id="activemq_1_1commands_1_1_active_m_q_message_inherit__map"> |
| <area shape="rect" id="node2" href="classactivemq_1_1commands_1_1_active_m_q_message_template.html" title="activemq::commands::ActiveMQMessageTemplate\< cms::Message \>" alt="" coords="5,469,501,499"/><area shape="rect" id="node4" href="classcms_1_1_message.html" title="Root of all messages." alt="" coords="92,392,212,421"/><area shape="rect" id="node6" href="classactivemq_1_1commands_1_1_message.html" title="activemq::commands::Message" alt="" coords="236,392,473,421"/><area shape="rect" id="node8" href="classactivemq_1_1commands_1_1_base_command.html" title="activemq::commands::BaseCommand" alt="" coords="215,315,495,344"/><area shape="rect" id="node10" href="classactivemq_1_1commands_1_1_command.html" title="activemq::commands::Command" alt="" coords="232,237,477,267"/><area shape="rect" id="node12" href="classactivemq_1_1commands_1_1_base_data_structure.html" title="activemq::commands::BaseDataStructure" alt="" coords="199,160,511,189"/><area shape="rect" id="node14" href="classactivemq_1_1commands_1_1_data_structure.html" title="activemq::commands::DataStructure" alt="" coords="216,83,493,112"/><area shape="rect" id="node16" href="classactivemq_1_1wireformat_1_1_marshal_aware.html" title="activemq::wireformat::MarshalAware" alt="" coords="219,5,491,35"/></map> |
| <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> |
| <table class="memberdecls"> |
| <tr><td colspan="2"><h2><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#adf526a14666d4ccb5898fdf310ea2aee">ActiveMQMessage</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#aaede4755a345d02cc55ca282b9d8a971">~ActiveMQMessage</a> () throw ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a976752f2fec3d630acbae59eeea079b1">getDataStructureType</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> Type as defined in CommandTypes.h. <a href="#a976752f2fec3d630acbae59eeea079b1"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#ae74895e81234837bf231057f104dbf11">copyDataStructure</a> (const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> *src)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the contents of the passed object into this objects members, overwriting any existing data. <a href="#ae74895e81234837bf231057f104dbf11"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html">ActiveMQMessage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a7b9695e590edfad9cca1513674e5dd5b">cloneDataStructure</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. <a href="#a7b9695e590edfad9cca1513674e5dd5b"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#aea477f1da0e9469b07e2684a8552bf86">toString</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string containing the information for this <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> such as its type and value of its elements. <a href="#aea477f1da0e9469b07e2684a8552bf86"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a2f4e10e9fdfd5a9db7a3249675e59374">equals</a> (const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> *value) const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Compares the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> passed in to this one, and returns if they are equivalent. <a href="#a2f4e10e9fdfd5a9db7a3249675e59374"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classcms_1_1_message.html">cms::Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a2c32942914dc88a040ad743599d7799e">clone</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this message exactly, returns a new instance that the caller is required to delete. <a href="#a2c32942914dc88a040ad743599d7799e"></a><br/></td></tr> |
| <tr><td colspan="2"><h2><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">static const unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a100f93d43fa9b4a5af86e6b9d39a6afc">ID_ACTIVEMQMESSAGE</a> = 23</td></tr> |
| </table> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="adf526a14666d4ccb5898fdf310ea2aee"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::ActiveMQMessage" ref="adf526a14666d4ccb5898fdf310ea2aee" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">activemq::commands::ActiveMQMessage::ActiveMQMessage </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aaede4755a345d02cc55ca282b9d8a971"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::~ActiveMQMessage" ref="aaede4755a345d02cc55ca282b9d8a971" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual activemq::commands::ActiveMQMessage::~ActiveMQMessage </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> throw ()<code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a2c32942914dc88a040ad743599d7799e"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::clone" ref="a2c32942914dc88a040ad743599d7799e" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classcms_1_1_message.html">cms::Message</a>* activemq::commands::ActiveMQMessage::clone </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Clone this message exactly, returns a new instance that the caller is required to delete. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>new copy of this message </dd></dl> |
| |
| <p>Implements <a class="el" href="classcms_1_1_message.html#a27e056dffbf536d18928d848dca82953">cms::Message</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7b9695e590edfad9cca1513674e5dd5b"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::cloneDataStructure" ref="a7b9695e590edfad9cca1513674e5dd5b" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html">ActiveMQMessage</a>* activemq::commands::ActiveMQMessage::cloneDataStructure </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>new copy of this object. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_message.html#acc67bedd34c73c169e38d860542d0d0f">activemq::commands::Message</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae74895e81234837bf231057f104dbf11"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::copyDataStructure" ref="ae74895e81234837bf231057f104dbf11" args="(const DataStructure *src)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void activemq::commands::ActiveMQMessage::copyDataStructure </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> * </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Copy the contents of the passed object into this objects members, overwriting any existing data. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>src - Source Object </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_message.html#a681bceefa9a583a3f8289d536e71223f">activemq::commands::Message</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2f4e10e9fdfd5a9db7a3249675e59374"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::equals" ref="a2f4e10e9fdfd5a9db7a3249675e59374" args="(const DataStructure *value) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool activemq::commands::ActiveMQMessage::equals </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> * </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Compares the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> passed in to this one, and returns if they are equivalent. </p> |
| <p>Equivalent here means that they are of the same type, and that each element of the objects are the same. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>true if DataStructure's are Equal. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message_template.html#a9af95f8fe95b78e713fe3fe9417e16f6">activemq::commands::ActiveMQMessageTemplate< cms::Message ></a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a976752f2fec3d630acbae59eeea079b1"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::getDataStructureType" ref="a976752f2fec3d630acbae59eeea079b1" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual unsigned char activemq::commands::ActiveMQMessage::getDataStructureType </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Get the <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> Type as defined in CommandTypes.h. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>The type of the data structure </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_message.html#a86424b3d8028a000ff38d26f7e4e9d04">activemq::commands::Message</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aea477f1da0e9469b07e2684a8552bf86"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::toString" ref="aea477f1da0e9469b07e2684a8552bf86" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string activemq::commands::ActiveMQMessage::toString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Returns a string containing the information for this <a class="el" href="classactivemq_1_1commands_1_1_data_structure.html">DataStructure</a> such as its type and value of its elements. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>formatted string useful for debugging. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classactivemq_1_1commands_1_1_message.html#a3db5a8f66aa11df55acc6d919d3cf740">activemq::commands::Message</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Field Documentation</h2> |
| <a class="anchor" id="a100f93d43fa9b4a5af86e6b9d39a6afc"></a><!-- doxytag: member="activemq::commands::ActiveMQMessage::ID_ACTIVEMQMESSAGE" ref="a100f93d43fa9b4a5af86e6b9d39a6afc" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const unsigned char <a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html#a100f93d43fa9b4a5af86e6b9d39a6afc">activemq::commands::ActiveMQMessage::ID_ACTIVEMQMESSAGE</a> = 23<code> [static]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/main/activemq/commands/<a class="el" href="_active_m_q_message_8h_source.html">ActiveMQMessage.h</a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceactivemq.html">activemq</a> </li> |
| <li class="navelem"><a class="el" href="namespaceactivemq_1_1commands.html">commands</a> </li> |
| <li class="navelem"><a class="el" href="classactivemq_1_1commands_1_1_active_m_q_message.html">ActiveMQMessage</a> </li> |
| <li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by  |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> |
| </ul> |
| </div> |
| |
| </body> |
| </html> |
