<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>steghide: BmpSampleValue Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">steghide  <span id="projectnumber">0.5.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classBmpSampleValue-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">BmpSampleValue Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>an (abstract) sample value in a bmp file </p> <p><code>#include <<a class="el" href="BmpSampleValue_8h_source.html">BmpSampleValue.h</a>></code></p> <div class="dynheader"> Inheritance diagram for BmpSampleValue:</div> <div class="dyncontent"> <div class="center"> <img src="classBmpSampleValue.png" usemap="#BmpSampleValue_map" alt=""/> <map id="BmpSampleValue_map" name="BmpSampleValue_map"> <area href="classSampleValue.html" title="the value of a sample in a CvrStgFile " alt="SampleValue" shape="rect" coords="79,0,227,24"/> <area href="classBmpPaletteSampleValue.html" title="a sample in a bmp palette (i.e. in a 1-,4- or 8-bit) file " alt="BmpPaletteSampleValue" shape="rect" coords="0,112,148,136"/> <area href="classBmpRGBSampleValue.html" title="a sample in a bmp rgb (i.e. 24-bit) file " alt="BmpRGBSampleValue" shape="rect" coords="158,112,306,136"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a088339541abf3b4511e71778633b6b12"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBmpSampleValue.html#a088339541abf3b4511e71778633b6b12">BmpSampleValue</a> (void)</td></tr> <tr class="separator:a088339541abf3b4511e71778633b6b12"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a591a3a5d7dcc61fde3fd1e37906e1781"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBmpSampleValue.html#a591a3a5d7dcc61fde3fd1e37906e1781">calcDistance</a> (const <a class="el" href="classSampleValue.html">SampleValue</a> *s) const </td></tr> <tr class="separator:a591a3a5d7dcc61fde3fd1e37906e1781"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8665a4c4db9ac910abf4ec0738cfde68"><td class="memItemLeft" align="right" valign="top">virtual unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classBmpSampleValue.html#a8665a4c4db9ac910abf4ec0738cfde68">getRed</a> (void) const =0</td></tr> <tr class="separator:a8665a4c4db9ac910abf4ec0738cfde68"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5d646a4082648a5b63323167553066ab"><td class="memItemLeft" align="right" valign="top">virtual unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classBmpSampleValue.html#a5d646a4082648a5b63323167553066ab">getGreen</a> (void) const =0</td></tr> <tr class="separator:a5d646a4082648a5b63323167553066ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0c31d4428158c7c6017935ac03254b26"><td class="memItemLeft" align="right" valign="top">virtual unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classBmpSampleValue.html#a0c31d4428158c7c6017935ac03254b26">getBlue</a> (void) const =0</td></tr> <tr class="separator:a0c31d4428158c7c6017935ac03254b26"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classSampleValue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSampleValue')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSampleValue.html">SampleValue</a></td></tr> <tr class="memitem:a74c75452d43690d940d9ca5d8b64da27 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a74c75452d43690d940d9ca5d8b64da27">SampleValue</a> (void)</td></tr> <tr class="separator:a74c75452d43690d940d9ca5d8b64da27 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7e51c7f758b83d354bdb6d3e9502934e inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a7e51c7f758b83d354bdb6d3e9502934e">~SampleValue</a> (void)</td></tr> <tr class="separator:a7e51c7f758b83d354bdb6d3e9502934e inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeca3fc1fd34c09d2244706b010935c2c inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSampleValue.html">SampleValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#aeca3fc1fd34c09d2244706b010935c2c">getNearestTargetSampleValue</a> (<a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> t) const =0</td></tr> <tr class="separator:aeca3fc1fd34c09d2244706b010935c2c inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeaf5c46ec6d023840e9773604b20d25c inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#aeaf5c46ec6d023840e9773604b20d25c">getName</a> (void) const =0</td></tr> <tr class="separator:aeaf5c46ec6d023840e9773604b20d25c inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80e6ab34112c3829385b4bf4b14d0401 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a80e6ab34112c3829385b4bf4b14d0401">isNeighbour</a> (const <a class="el" href="classSampleValue.html">SampleValue</a> *s) const </td></tr> <tr class="separator:a80e6ab34112c3829385b4bf4b14d0401 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace091469343754f11af43be63202ab79 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#ace091469343754f11af43be63202ab79">getEmbeddedValue</a> (void) const </td></tr> <tr class="separator:ace091469343754f11af43be63202ab79 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3961e8e390a5bd2cafa64171b78f5698 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a3961e8e390a5bd2cafa64171b78f5698">getKey</a> (void) const </td></tr> <tr class="separator:a3961e8e390a5bd2cafa64171b78f5698 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af0505a36a5072d8fea8b92fe97d7029a inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#af0505a36a5072d8fea8b92fe97d7029a">operator==</a> (const <a class="el" href="classSampleValue.html">SampleValue</a> &sv) const </td></tr> <tr class="separator:af0505a36a5072d8fea8b92fe97d7029a inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a268b910b1c16916363549180fa3a6648 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a268b910b1c16916363549180fa3a6648">operator!=</a> (const <a class="el" href="classSampleValue.html">SampleValue</a> &sv) const </td></tr> <tr class="separator:a268b910b1c16916363549180fa3a6648 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3a4fc17df81bfb17a16ca3a06c6f12c8 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a3a4fc17df81bfb17a16ca3a06c6f12c8">operator<</a> (const <a class="el" href="classSampleValue.html">SampleValue</a> &sv) const </td></tr> <tr class="separator:a3a4fc17df81bfb17a16ca3a06c6f12c8 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a53c3804f4551d19046c0b113387bc518 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a53c3804f4551d19046c0b113387bc518">getNumEdges</a> (<a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> t) const </td></tr> <tr class="separator:a53c3804f4551d19046c0b113387bc518 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a576da5dade60d82b0d00373fac218b8f inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a576da5dade60d82b0d00373fac218b8f">setNumEdges</a> (<a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> t, <a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> ne)</td></tr> <tr class="separator:a576da5dade60d82b0d00373fac218b8f inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7cda8c5bb0b8689764c80582dcbd145f inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a7cda8c5bb0b8689764c80582dcbd145f">incNumEdges</a> (<a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> t)</td></tr> <tr class="separator:a7cda8c5bb0b8689764c80582dcbd145f inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a469706163142f053d9e10585a72c9322 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a469706163142f053d9e10585a72c9322">decNumEdges</a> (<a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> t)</td></tr> <tr class="separator:a469706163142f053d9e10585a72c9322 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa05c5d32ce2e4c9f27e894d9df51bf19 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#aa05c5d32ce2e4c9f27e894d9df51bf19">setLabel</a> (unsigned long l)</td></tr> <tr class="separator:aa05c5d32ce2e4c9f27e894d9df51bf19 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abb1332fa92702da1d32eac1a6bb1fc94 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#abb1332fa92702da1d32eac1a6bb1fc94">getLabel</a> (void) const </td></tr> <tr class="separator:abb1332fa92702da1d32eac1a6bb1fc94 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abce524205204b1bf08df60585354b216 inherit pub_methods_classSampleValue"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#abce524205204b1bf08df60585354b216">print</a> (unsigned short spc=0) const </td></tr> <tr class="separator:abce524205204b1bf08df60585354b216 inherit pub_methods_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_attribs_classSampleValue"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classSampleValue')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classSampleValue.html">SampleValue</a></td></tr> <tr class="memitem:a0dcaf6e226df96e9caab87aa933f9f19 inherit pro_attribs_classSampleValue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#acf820202f81f25eb00734eac0d7aed2d">EmbValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a0dcaf6e226df96e9caab87aa933f9f19">EValue</a></td></tr> <tr class="memdesc:a0dcaf6e226df96e9caab87aa933f9f19 inherit pro_attribs_classSampleValue"><td class="mdescLeft"> </td><td class="mdescRight">the bit that is embedded in this sample value - must be set in constructor of derived class <a href="#a0dcaf6e226df96e9caab87aa933f9f19">More...</a><br/></td></tr> <tr class="separator:a0dcaf6e226df96e9caab87aa933f9f19 inherit pro_attribs_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a10e075aea7ba428d0c76549423d8efe2 inherit pro_attribs_classSampleValue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleValue.html#a10e075aea7ba428d0c76549423d8efe2">Key</a></td></tr> <tr class="memdesc:a10e075aea7ba428d0c76549423d8efe2 inherit pro_attribs_classSampleValue"><td class="mdescLeft"> </td><td class="mdescRight">the key of this sample value - must be different for two different sample values - must be set in constructor of derived class <a href="#a10e075aea7ba428d0c76549423d8efe2">More...</a><br/></td></tr> <tr class="separator:a10e075aea7ba428d0c76549423d8efe2 inherit pro_attribs_classSampleValue"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a088339541abf3b4511e71778633b6b12"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">BmpSampleValue::BmpSampleValue </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a591a3a5d7dcc61fde3fd1e37906e1781"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="common_8h.html#a6b8592979b076e06aa233e3f586ac999">UWORD32</a> BmpSampleValue::calcDistance </td> <td>(</td> <td class="paramtype">const <a class="el" href="classSampleValue.html">SampleValue</a> * </td> <td class="paramname"><em>s</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>calculate the distance between the sample value s and this sample value </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">s</td><td>a sample value of the same type as this </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the distance </dd></dl> <p>Implements <a class="el" href="classSampleValue.html#aa7e5d9b69203f6f6edf97c79319232dd">SampleValue</a>.</p> <p>Reimplemented in <a class="el" href="classBmpRGBSampleValue.html#a558ea1a6a1cc8fe882daef7b1d75be4b">BmpRGBSampleValue</a>.</p> </div> </div> <a class="anchor" id="a0c31d4428158c7c6017935ac03254b26"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual unsigned char BmpSampleValue::getBlue </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the blue color component </p> <p>Implemented in <a class="el" href="classBmpPaletteSampleValue.html#a514232cea9e9dae4eba836f635987b4c">BmpPaletteSampleValue</a>, and <a class="el" href="classBmpRGBSampleValue.html#a3503f564c0a1d56bf91ad2f129f2948c">BmpRGBSampleValue</a>.</p> </div> </div> <a class="anchor" id="a5d646a4082648a5b63323167553066ab"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual unsigned char BmpSampleValue::getGreen </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the green color component </p> <p>Implemented in <a class="el" href="classBmpPaletteSampleValue.html#a57118ccdeeacf5cdc6a734f05818f6e7">BmpPaletteSampleValue</a>, and <a class="el" href="classBmpRGBSampleValue.html#a4a9db68fe15d0b3fa761d3dd7bae900a">BmpRGBSampleValue</a>.</p> </div> </div> <a class="anchor" id="a8665a4c4db9ac910abf4ec0738cfde68"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual unsigned char BmpSampleValue::getRed </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>get the red color component </p> <p>Implemented in <a class="el" href="classBmpPaletteSampleValue.html#a6d6b04295ba5894e021d94a82247c8c9">BmpPaletteSampleValue</a>, and <a class="el" href="classBmpRGBSampleValue.html#a0d0b4acb960d7024e8560605260bd488">BmpRGBSampleValue</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="BmpSampleValue_8h_source.html">BmpSampleValue.h</a></li> <li><a class="el" href="BmpSampleValue_8cc.html">BmpSampleValue.cc</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 18 2013 17:59:37 for steghide by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>