2010-12-26 20:59:17 -04:00
<!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 > ArduPilot Libraries: Compass Class Reference< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
2010-12-26 23:23:35 -04:00
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javaScript" src = "search/search.js" > < / script >
2010-12-26 20:59:17 -04:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
2010-12-26 23:23:35 -04:00
< body onload = 'searchBox.OnSelectItem(0);' >
2010-12-26 20:59:17 -04:00
<!-- Generated by Doxygen 1.7.1 -->
< div class = "navigation" id = "top" >
< div class = "tabs" >
< ul class = "tablist" >
< li > < a href = "main.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 > Classes< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< div class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "annotated.html" > < span > Class List< / span > < / a > < / li >
< li > < a href = "classes.html" > < span > Class Index< / 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 >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-attribs" > Public Attributes< / a > < / div >
< div class = "headertitle" >
< h1 > Compass Class Reference< / h1 > < / div >
< / div >
< div class = "contents" >
<!-- doxytag: class="Compass" -->
< p > < code > #include < < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > > < / code > < / p >
< p > Inherited by < a class = "el" href = "class_a_p___compass___h_i_l.html" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html" > AP_Compass_HMC5843< / a > .< / p >
< p > < a href = "class_compass-members.html" > List of all members.< / a > < / p >
< 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" > virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a825f597357f66521819807d68ffc551e" > init< / a > (int initialise_wire_lib=1)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#ab17ec5cc0bb81f2c94046e4ef5150106" > read< / a > ()< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a7503a41b6978e1f1a9edcd2f11fddd01" > calculate< / a > (float roll, float pitch)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a57b71b1f29b91e73f84bcc6860f3cf51" > set_orientation< / a > (const < a class = "el" href = "class_matrix3.html" > Matrix3f< / a > & rotation_matrix)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#af4ae15041479ecb2631ba6c39e84c561" > set_offsets< / a > (int x, int y, int z)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a3b7ea064e17a870a419c8f45a7c1fb5d" > set_declination< / a > (float radians)< / td > < / tr >
< tr > < td colspan = "2" > < h2 > < a name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a8324bcab8618a2a2076a511dec2cc8a0" > mag_x< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a4de5f44fab49fabf8524ea79e9d3f84a" > mag_y< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a6c05eabd47bd8116c4823481c3ea4549" > mag_z< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > float < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#af34cf40b43e957554a48ed27b848a35f" > heading< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > float < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#aafc7608bd711702f519d52afbc06dc7a" > heading_x< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > float < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a2e1554fb76b067f36d011f59e7e8dd58" > heading_y< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > unsigned long < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_compass.html#a66419d0c87ac23bc422db0279486fd31" > last_update< / a > < / td > < / tr >
< / table >
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00007" > 7< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "a7503a41b6978e1f1a9edcd2f11fddd01" > < / a > <!-- doxytag: member="Compass::calculate" ref="a7503a41b6978e1f1a9edcd2f11fddd01" args="(float roll, float pitch)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void Compass::calculate < / td >
< td > (< / td >
< td class = "paramtype" > float < / td >
< td class = "paramname" > < em > roll< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > float < / td >
< td class = "paramname" > < em > pitch< / em > < / td > < td > < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#a755d7409dedf3e903225b36fbf16e622" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#aaef4df8c859b284d17c8a374d13e4e51" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a825f597357f66521819807d68ffc551e" > < / a > <!-- doxytag: member="Compass::init" ref="a825f597357f66521819807d68ffc551e" args="(int initialise_wire_lib=1)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool Compass::init < / td >
< td > (< / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > initialise_wire_lib< / em > = < code > 1< / code > < / td >
< td > ) < / td >
< td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#aefa72efcf8536c3696a25de69f1731c7" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#af32c9430d20a2eb7d1df8413870c99b6" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "ab17ec5cc0bb81f2c94046e4ef5150106" > < / a > <!-- doxytag: member="Compass::read" ref="ab17ec5cc0bb81f2c94046e4ef5150106" args="()" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void Compass::read < / td >
< td > (< / td >
< td class = "paramname" > < / td >
< td > ) < / td >
< td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#ac8d183edcd14cf5ee56895c498ebf02a" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#ab60b932f53493c46e262c1f46a12bdf6" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a3b7ea064e17a870a419c8f45a7c1fb5d" > < / a > <!-- doxytag: member="Compass::set_declination" ref="a3b7ea064e17a870a419c8f45a7c1fb5d" args="(float radians)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void Compass::set_declination < / td >
< td > (< / td >
< td class = "paramtype" > float < / td >
< td class = "paramname" > < em > radians< / em > < / td >
< td > ) < / td >
< td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#a4b4d22637d14bd5585aa8d2d5e32ea43" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#a2ba3fc3b5bd78a28f717c2740948d61e" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "af4ae15041479ecb2631ba6c39e84c561" > < / a > <!-- doxytag: member="Compass::set_offsets" ref="af4ae15041479ecb2631ba6c39e84c561" args="(int x, int y, int z)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void Compass::set_offsets < / td >
< td > (< / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > x< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > y< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > z< / em > < / td > < td > < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#a1fb0fcecfa08549ea1ca9d0cf9f7eb14" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#a90481085e451fe3f64d46ebb401b5aaf" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a57b71b1f29b91e73f84bcc6860f3cf51" > < / a > <!-- doxytag: member="Compass::set_orientation" ref="a57b71b1f29b91e73f84bcc6860f3cf51" args="(const Matrix3f &rotation_matrix)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void Compass::set_orientation < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "class_matrix3.html" > Matrix3f< / a > & < / td >
< td class = "paramname" > < em > rotation_matrix< / em > < / td >
< td > ) < / td >
< td > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Reimplemented in < a class = "el" href = "class_a_p___compass___h_i_l.html#aae23c67a982d566e2f538509799ee277" > AP_Compass_HIL< / a > , and < a class = "el" href = "class_a_p___compass___h_m_c5843.html#a5dafbafd496867d435168c8decc742fa" > AP_Compass_HMC5843< / a > .< / p >
< / div >
< / div >
< hr / > < h2 > Member Data Documentation< / h2 >
< a class = "anchor" id = "af34cf40b43e957554a48ed27b848a35f" > < / a > <!-- doxytag: member="Compass::heading" ref="af34cf40b43e957554a48ed27b848a35f" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_compass.html#af34cf40b43e957554a48ed27b848a35f" > Compass::heading< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00013" > 13< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "aafc7608bd711702f519d52afbc06dc7a" > < / a > <!-- doxytag: member="Compass::heading_x" ref="aafc7608bd711702f519d52afbc06dc7a" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_compass.html#aafc7608bd711702f519d52afbc06dc7a" > Compass::heading_x< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00014" > 14< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a2e1554fb76b067f36d011f59e7e8dd58" > < / a > <!-- doxytag: member="Compass::heading_y" ref="a2e1554fb76b067f36d011f59e7e8dd58" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_compass.html#a2e1554fb76b067f36d011f59e7e8dd58" > Compass::heading_y< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00015" > 15< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a66419d0c87ac23bc422db0279486fd31" > < / a > <!-- doxytag: member="Compass::last_update" ref="a66419d0c87ac23bc422db0279486fd31" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > unsigned long < a class = "el" href = "class_compass.html#a66419d0c87ac23bc422db0279486fd31" > Compass::last_update< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00016" > 16< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a8324bcab8618a2a2076a511dec2cc8a0" > < / a > <!-- doxytag: member="Compass::mag_x" ref="a8324bcab8618a2a2076a511dec2cc8a0" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_compass.html#a8324bcab8618a2a2076a511dec2cc8a0" > Compass::mag_x< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00010" > 10< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a4de5f44fab49fabf8524ea79e9d3f84a" > < / a > <!-- doxytag: member="Compass::mag_y" ref="a4de5f44fab49fabf8524ea79e9d3f84a" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_compass.html#a4de5f44fab49fabf8524ea79e9d3f84a" > Compass::mag_y< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00011" > 11< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a6c05eabd47bd8116c4823481c3ea4549" > < / a > <!-- doxytag: member="Compass::mag_z" ref="a6c05eabd47bd8116c4823481c3ea4549" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_compass.html#a6c05eabd47bd8116c4823481c3ea4549" > Compass::mag_z< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_compass_8h_source.html#l00012" > 12< / a > of file < a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
< li > /home/jgoppert/Projects/ap/libraries/AP_Compass/< a class = "el" href = "_compass_8h_source.html" > Compass.h< / a > < / li >
< / ul >
< / div >
2010-12-26 23:23:35 -04:00
< hr class = "footer" / > < address class = "footer" > < small >
Generated for ArduPilot Libraries by < a href = "http://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > < / small > < / address >
2010-12-26 20:59:17 -04:00
< / body >
< / html >
