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: APM_Compass_Class 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 > APM_Compass_Class Class Reference< / h1 > < / div >
< / div >
< div class = "contents" >
<!-- doxytag: class="APM_Compass_Class" -->
< p > < code > #include < < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > > < / code > < / p >
< div class = "dynheader" >
Collaboration diagram for APM_Compass_Class:< / div >
< div class = "dyncontent" >
< div class = "center" > < img src = "class_a_p_m___compass___class__coll__graph.png" border = "0" usemap = "#_a_p_m___compass___class_coll__map" alt = "Collaboration graph" / > < / div >
< map name = "_a_p_m___compass___class_coll__map" id = "_a_p_m___compass___class_coll__map" >
< area shape = "rect" id = "node2" href = "class_matrix3.html" title = "Matrix3\< float \>" alt = "" coords = "21,136,147,165" / > < area shape = "rect" id = "node4" href = "class_vector3.html" title = "Vector3\< float \>" alt = "" coords = "20,5,148,35" / > < / map >
< center > < span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< p > < a href = "class_a_p_m___compass___class-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" > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#adb213c4da7657f2bd4bc5c37d5b6b527" > APM_Compass_Class< / a > ()< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#a446066337ce1c532c1817501c42b2456" > Init< / a > (int initialiseWireLib=1)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#a6c779721fece08423886a488a9cae8bb" > Read< / a > ()< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#a32fe3dd3c5d8db60ae0fce1f47f22907" > Calculate< / a > (float roll, float pitch)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#a3487897e6b4f2c1a1846a9c3de31fc2a" > SetOrientation< / a > (const < a class = "el" href = "class_matrix3.html" > Matrix3f< / a > & rotationMatrix)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#ae8d5a085523f5bcd8beb63143205316f" > SetOffsets< / a > (int x, int y, int z)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#a3cd12c69973c69ac290650673edf2f2f" > SetDeclination< / 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_a_p_m___compass___class.html#a566ac385531ffd2bb93626433a03b476" > 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_a_p_m___compass___class.html#a82af4bc9bb9dbfa5e5f1ac176ef9f8bb" > 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_a_p_m___compass___class.html#ad8d3ab14d57c8ff1c3c8b433454f47cf" > 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_a_p_m___compass___class.html#aa77811fb1a3dd20707735b42fdb18582" > Heading< / a > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > float < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_a_p_m___compass___class.html#addc436315fb77d41e33d8665dbac35cc" > 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_a_p_m___compass___class.html#aed367a3918be9fd231c3c5d627c527c9" > 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_a_p_m___compass___class.html#ad50c21bcdb5353ee343267ebfe925dfe" > lastUpdate< / a > < / td > < / tr >
< / table >
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00060" > 60< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< hr / > < h2 > Constructor & Destructor Documentation< / h2 >
< a class = "anchor" id = "adb213c4da7657f2bd4bc5c37d5b6b527" > < / a > <!-- doxytag: member="APM_Compass_Class::APM_Compass_Class" ref="adb213c4da7657f2bd4bc5c37d5b6b527" args="()" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > APM_Compass_Class::APM_Compass_Class < / td >
< td > (< / td >
< td class = "paramname" > < / td >
< td > ) < / td >
< td > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00057" > 57< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "a32fe3dd3c5d8db60ae0fce1f47f22907" > < / a > <!-- doxytag: member="APM_Compass_Class::Calculate" ref="a32fe3dd3c5d8db60ae0fce1f47f22907" args="(float roll, float pitch)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void APM_Compass_Class::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 > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00171" > 171< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a446066337ce1c532c1817501c42b2456" > < / a > <!-- doxytag: member="APM_Compass_Class::Init" ref="a446066337ce1c532c1817501c42b2456" args="(int initialiseWireLib=1)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool APM_Compass_Class::Init < / td >
< td > (< / td >
< td class = "paramtype" > int < / td >
< td class = "paramname" > < em > initialiseWireLib< / em > = < code > 1< / code > < / td >
< td > ) < / td >
< td > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00069" > 69< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a6c779721fece08423886a488a9cae8bb" > < / a > <!-- doxytag: member="APM_Compass_Class::Read" ref="a6c779721fece08423886a488a9cae8bb" args="()" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void APM_Compass_Class::Read < / td >
< td > (< / td >
< td class = "paramname" > < / td >
< td > ) < / td >
< td > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00143" > 143< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a3cd12c69973c69ac290650673edf2f2f" > < / a > <!-- doxytag: member="APM_Compass_Class::SetDeclination" ref="a3cd12c69973c69ac290650673edf2f2f" args="(float radians)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void APM_Compass_Class::SetDeclination < / td >
< td > (< / td >
< td class = "paramtype" > float < / td >
< td class = "paramname" > < em > radians< / em > < / td >
< td > ) < / td >
< td > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00230" > 230< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "ae8d5a085523f5bcd8beb63143205316f" > < / a > <!-- doxytag: member="APM_Compass_Class::SetOffsets" ref="ae8d5a085523f5bcd8beb63143205316f" args="(int x, int y, int z)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void APM_Compass_Class::SetOffsets < / 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 > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00223" > 223< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a3487897e6b4f2c1a1846a9c3de31fc2a" > < / a > <!-- doxytag: member="APM_Compass_Class::SetOrientation" ref="a3487897e6b4f2c1a1846a9c3de31fc2a" args="(const Matrix3f &rotationMatrix)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void APM_Compass_Class::SetOrientation < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "class_matrix3.html" > Matrix3f< / a > & < / td >
< td class = "paramname" > < em > rotationMatrix< / em > < / td >
< td > ) < / td >
< td > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8cpp_source.html#l00214" > 214< / a > of file < a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / a > .< / p >
< / div >
< / div >
< hr / > < h2 > Member Data Documentation< / h2 >
< a class = "anchor" id = "aa77811fb1a3dd20707735b42fdb18582" > < / a > <!-- doxytag: member="APM_Compass_Class::Heading" ref="aa77811fb1a3dd20707735b42fdb18582" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_a_p_m___compass___class.html#aa77811fb1a3dd20707735b42fdb18582" > APM_Compass_Class::Heading< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00072" > 72< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "addc436315fb77d41e33d8665dbac35cc" > < / a > <!-- doxytag: member="APM_Compass_Class::Heading_X" ref="addc436315fb77d41e33d8665dbac35cc" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_a_p_m___compass___class.html#addc436315fb77d41e33d8665dbac35cc" > APM_Compass_Class::Heading_X< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00073" > 73< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "aed367a3918be9fd231c3c5d627c527c9" > < / a > <!-- doxytag: member="APM_Compass_Class::Heading_Y" ref="aed367a3918be9fd231c3c5d627c527c9" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > float < a class = "el" href = "class_a_p_m___compass___class.html#aed367a3918be9fd231c3c5d627c527c9" > APM_Compass_Class::Heading_Y< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00074" > 74< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "ad50c21bcdb5353ee343267ebfe925dfe" > < / a > <!-- doxytag: member="APM_Compass_Class::lastUpdate" ref="ad50c21bcdb5353ee343267ebfe925dfe" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > unsigned long < a class = "el" href = "class_a_p_m___compass___class.html#ad50c21bcdb5353ee343267ebfe925dfe" > APM_Compass_Class::lastUpdate< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00075" > 75< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a566ac385531ffd2bb93626433a03b476" > < / a > <!-- doxytag: member="APM_Compass_Class::Mag_X" ref="a566ac385531ffd2bb93626433a03b476" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_a_p_m___compass___class.html#a566ac385531ffd2bb93626433a03b476" > APM_Compass_Class::Mag_X< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00069" > 69< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a82af4bc9bb9dbfa5e5f1ac176ef9f8bb" > < / a > <!-- doxytag: member="APM_Compass_Class::Mag_Y" ref="a82af4bc9bb9dbfa5e5f1ac176ef9f8bb" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_a_p_m___compass___class.html#a82af4bc9bb9dbfa5e5f1ac176ef9f8bb" > APM_Compass_Class::Mag_Y< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00070" > 70< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "ad8d3ab14d57c8ff1c3c8b433454f47cf" > < / a > <!-- doxytag: member="APM_Compass_Class::Mag_Z" ref="ad8d3ab14d57c8ff1c3c8b433454f47cf" args="" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int < a class = "el" href = "class_a_p_m___compass___class.html#ad8d3ab14d57c8ff1c3c8b433454f47cf" > APM_Compass_Class::Mag_Z< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Definition at line < a class = "el" href = "_a_p_m___compass_8h_source.html#l00071" > 71< / a > of file < a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > /home/jgoppert/Projects/ap/libraries/APM_Compass/< a class = "el" href = "_a_p_m___compass_8h_source.html" > APM_Compass.h< / a > < / li >
< li > /home/jgoppert/Projects/ap/libraries/APM_Compass/< a class = "el" href = "_a_p_m___compass_8cpp_source.html" > APM_Compass.cpp< / 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 >
