OSS_SNMP.MIBS.Entity.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>OSS_SNMP » \OSS_SNMP\MIBS\Entity</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Namespaces</a></li>
  23. <li><a href="../namespaces/OSS_SNMP.html"><i class="icon-th"></i> OSS_SNMP</a></li>
  24. </ul>
  25. </li>
  26. <li class="dropdown" id="charts-menu">
  27. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  28. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  29. </li>
  30. <li class="dropdown" id="reports-menu">
  31. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  32. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  33. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  34. <span class="label label-info">39</span></a></li>
  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  36. <ul><li>todo 
  37. <span class="label label-info">1</span>
  38. </li></ul></a></li>
  39. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  40. <span class="label label-info">0</span></a></li>
  41. </ul>
  42. </li>
  43. </ul></div>
  44. </div></div>
  45. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  46. </div>
  47. <div id="___" class="container">
  48. <noscript><div class="alert alert-warning">
  49. Javascript is disabled; several features are only available
  50. if Javascript is enabled.
  51. </div></noscript>
  52. <div class="row">
  53. <div class="span4">
  54. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  55. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  56. </div>
  57. <ul class="side-nav nav nav-list">
  58. <li class="nav-header">
  59. <i class="icon-custom icon-method"></i> Methods</li>
  60. <li class="method public "><a href="#physicalAlias" title="physicalAlias :: Returns an associate array of physical aliases"><span class="description">Returns an associate array of physical aliases</span><pre>physicalAlias()</pre></a></li>
  61. <li class="method public "><a href="#physicalClass" title="physicalClass :: Returns an associate array of entPhysicalClass"><span class="description">Returns an associate array of entPhysicalClass</span><pre>physicalClass()</pre></a></li>
  62. <li class="method public "><a href="#physicalParentRelPos" title="physicalParentRelPos :: Returns an associate array of entPhysicalParentRelPos"><span class="description">Returns an associate array of entPhysicalParentRelPos</span><pre>physicalParentRelPos()</pre></a></li>
  63. <li class="method public "><a href="#relPosToAlias" title="relPosToAlias :: Utility function for MIBS\Cisco\RSTP::rstpPortRole() to try and translate a port index
  64. into a port ID"><span class="description">Utility function for MIBS\Cisco\RSTP::rstpPortRole() to try and translate a port index
  65. into a port ID</span><pre>relPosToAlias()</pre></a></li>
  66. <li class="nav-header">
  67. <i class="icon-custom icon-property"></i> Properties</li>
  68. <li class="property public "><a href="#%24ENTITY_PHSYICAL_CLASS" title="$ENTITY_PHSYICAL_CLASS :: "><span class="description">$ENTITY_PHSYICAL_CLASS</span><pre>$ENTITY_PHSYICAL_CLASS</pre></a></li>
  69. <li class="nav-header">
  70. <i class="icon-custom icon-constant"></i> Constants</li>
  71. <li class="constant "><a href="#OID_ENTITY_PHYSICAL_ALIAS" title="OID_ENTITY_PHYSICAL_ALIAS :: "><span class="description">OID_ENTITY_PHYSICAL_ALIAS</span><pre>OID_ENTITY_PHYSICAL_ALIAS</pre></a></li>
  72. <li class="constant "><a href="#OID_ENTITY_PHYSICAL_CLASS" title="OID_ENTITY_PHYSICAL_CLASS :: "><span class="description">OID_ENTITY_PHYSICAL_CLASS</span><pre>OID_ENTITY_PHYSICAL_CLASS</pre></a></li>
  73. <li class="constant "><a href="#OID_ENTITY_PHYSICAL_PARENT_REL_POS" title="OID_ENTITY_PHYSICAL_PARENT_REL_POS :: "><span class="description">OID_ENTITY_PHYSICAL_PARENT_REL_POS</span><pre>OID_ENTITY_PHYSICAL_PARENT_REL_POS</pre></a></li>
  74. <li class="constant "><a href="#PHYSICAL_CLASS_CHASSIS" title="PHYSICAL_CLASS_CHASSIS :: "><span class="description">PHYSICAL_CLASS_CHASSIS</span><pre>PHYSICAL_CLASS_CHASSIS</pre></a></li>
  75. <li class="constant "><a href="#PHYSICAL_CLASS_CONTAINER" title="PHYSICAL_CLASS_CONTAINER :: "><span class="description">PHYSICAL_CLASS_CONTAINER</span><pre>PHYSICAL_CLASS_CONTAINER</pre></a></li>
  76. <li class="constant "><a href="#PHYSICAL_CLASS_FAN" title="PHYSICAL_CLASS_FAN :: "><span class="description">PHYSICAL_CLASS_FAN</span><pre>PHYSICAL_CLASS_FAN</pre></a></li>
  77. <li class="constant "><a href="#PHYSICAL_CLASS_MODULE" title="PHYSICAL_CLASS_MODULE :: "><span class="description">PHYSICAL_CLASS_MODULE</span><pre>PHYSICAL_CLASS_MODULE</pre></a></li>
  78. <li class="constant "><a href="#PHYSICAL_CLASS_PORT" title="PHYSICAL_CLASS_PORT :: "><span class="description">PHYSICAL_CLASS_PORT</span><pre>PHYSICAL_CLASS_PORT</pre></a></li>
  79. <li class="constant "><a href="#PHYSICAL_CLASS_POWER_SUPPLY" title="PHYSICAL_CLASS_POWER_SUPPLY :: "><span class="description">PHYSICAL_CLASS_POWER_SUPPLY</span><pre>PHYSICAL_CLASS_POWER_SUPPLY</pre></a></li>
  80. <li class="constant "><a href="#PHYSICAL_CLASS_SENSOR" title="PHYSICAL_CLASS_SENSOR :: "><span class="description">PHYSICAL_CLASS_SENSOR</span><pre>PHYSICAL_CLASS_SENSOR</pre></a></li>
  81. </ul>
  82. </div>
  83. <div class="span8">
  84. <a name="%5COSS_SNMP%5CMIBS%5CEntity" id="\OSS_SNMP\MIBS\Entity"></a><ul class="breadcrumb">
  85. <li>
  86. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  87. </li>
  88. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  89. <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.MIBS.html">MIBS</a></li>
  90. <li class="active">
  91. <span class="divider">\</span><a href="../classes/OSS_SNMP.MIBS.Entity.html">Entity</a>
  92. </li>
  93. </ul>
  94. <div href="../classes/OSS_SNMP.MIBS.Entity.html" class="element class">
  95. <p class="short_description">A class for performing SNMP V2 queries on generic devices</p>
  96. <div class="details">
  97. <p class="long_description"></p>
  98. <table class="table table-bordered">
  99. <tr>
  100. <th>copyright</th>
  101. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  102. </tr>
  103. <tr>
  104. <th>author</th>
  105. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  106. </tr>
  107. </table>
  108. <h3>
  109. <i class="icon-custom icon-method"></i> Methods</h3>
  110. <a name="physicalAlias" id="physicalAlias"></a><div class="element clickable method public physicalAlias" data-toggle="collapse" data-target=".physicalAlias .collapse">
  111. <h2>Returns an associate array of physical aliases</h2>
  112. <pre>physicalAlias() : array</pre>
  113. <div class="labels"></div>
  114. <div class="row collapse"><div class="detail-description">
  115. <p class="long_description"><p>e.g. [1005] => 10001</p></p>
  116. <h3>Returns</h3>
  117. <div class="subelement response">
  118. <code>array</code>Associate array of physical aliases</div>
  119. </div></div>
  120. </div>
  121. <a name="physicalClass" id="physicalClass"></a><div class="element clickable method public physicalClass" data-toggle="collapse" data-target=".physicalClass .collapse">
  122. <h2>Returns an associate array of entPhysicalClass</h2>
  123. <pre>physicalClass(boolean $translate) : array</pre>
  124. <div class="labels"></div>
  125. <div class="row collapse"><div class="detail-description">
  126. <p class="long_description"><p>e.g. [1005] => 10 / port</p></p>
  127. <h3>Parameters</h3>
  128. <div class="subelement argument">
  129. <h4>$translate</h4>
  130. <code>boolean</code><p>If true, return the string representation via self::$ENTITY_PHSYICAL_CLASS</p>
  131. </div>
  132. <h3>Returns</h3>
  133. <div class="subelement response">
  134. <code>array</code>Associate array of entPhysicalClass</div>
  135. </div></div>
  136. </div>
  137. <a name="physicalParentRelPos" id="physicalParentRelPos"></a><div class="element clickable method public physicalParentRelPos" data-toggle="collapse" data-target=".physicalParentRelPos .collapse">
  138. <h2>Returns an associate array of entPhysicalParentRelPos</h2>
  139. <pre>physicalParentRelPos() : array</pre>
  140. <div class="labels"></div>
  141. <div class="row collapse"><div class="detail-description">
  142. <p class="long_description"><p>e.g. [1005] => 1</p></p>
  143. <h3>Returns</h3>
  144. <div class="subelement response">
  145. <code>array</code>Associate array of entPhysicalParentRelPos</div>
  146. </div></div>
  147. </div>
  148. <a name="relPosToAlias" id="relPosToAlias"></a><div class="element clickable method public relPosToAlias" data-toggle="collapse" data-target=".relPosToAlias .collapse">
  149. <h2>Utility function for MIBS\Cisco\RSTP::rstpPortRole() to try and translate a port index
  150. into a port ID</h2>
  151. <pre>relPosToAlias() : Array</pre>
  152. <div class="labels"></div>
  153. <div class="row collapse"><div class="detail-description">
  154. <p class="long_description"><p>Makes a number of assumptions including that it has to be of type port, that the ID must be >10000,
  155. etc.</p></p>
  156. <h3>Returns</h3>
  157. <div class="subelement response">
  158. <code>Array</code>of relative positions to port IDs</div>
  159. </div></div>
  160. </div>
  161. <h3>
  162. <i class="icon-custom icon-property"></i> Properties</h3>
  163. <a name="%24ENTITY_PHSYICAL_CLASS" id="$ENTITY_PHSYICAL_CLASS"> </a><div class="element clickable property public $ENTITY_PHSYICAL_CLASS" data-toggle="collapse" data-target=".$ENTITY_PHSYICAL_CLASS .collapse">
  164. <h2>$ENTITY_PHSYICAL_CLASS</h2>
  165. <pre>$ENTITY_PHSYICAL_CLASS </pre>
  166. <div class="labels"></div>
  167. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  168. </div>
  169. <h3>
  170. <i class="icon-custom icon-constant"></i> Constants</h3>
  171. <a name="OID_ENTITY_PHYSICAL_ALIAS" id="OID_ENTITY_PHYSICAL_ALIAS"> </a><div class="element clickable constant OID_ENTITY_PHYSICAL_ALIAS" data-toggle="collapse" data-target=".OID_ENTITY_PHYSICAL_ALIAS .collapse">
  172. <h2>OID_ENTITY_PHYSICAL_ALIAS</h2>
  173. <pre>OID_ENTITY_PHYSICAL_ALIAS </pre>
  174. <div class="labels"></div>
  175. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  176. </div>
  177. <a name="OID_ENTITY_PHYSICAL_CLASS" id="OID_ENTITY_PHYSICAL_CLASS"> </a><div class="element clickable constant OID_ENTITY_PHYSICAL_CLASS" data-toggle="collapse" data-target=".OID_ENTITY_PHYSICAL_CLASS .collapse">
  178. <h2>OID_ENTITY_PHYSICAL_CLASS</h2>
  179. <pre>OID_ENTITY_PHYSICAL_CLASS </pre>
  180. <div class="labels"></div>
  181. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  182. </div>
  183. <a name="OID_ENTITY_PHYSICAL_PARENT_REL_POS" id="OID_ENTITY_PHYSICAL_PARENT_REL_POS"> </a><div class="element clickable constant OID_ENTITY_PHYSICAL_PARENT_REL_POS" data-toggle="collapse" data-target=".OID_ENTITY_PHYSICAL_PARENT_REL_POS .collapse">
  184. <h2>OID_ENTITY_PHYSICAL_PARENT_REL_POS</h2>
  185. <pre>OID_ENTITY_PHYSICAL_PARENT_REL_POS </pre>
  186. <div class="labels"></div>
  187. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  188. </div>
  189. <a name="PHYSICAL_CLASS_CHASSIS" id="PHYSICAL_CLASS_CHASSIS"> </a><div class="element clickable constant PHYSICAL_CLASS_CHASSIS" data-toggle="collapse" data-target=".PHYSICAL_CLASS_CHASSIS .collapse">
  190. <h2>PHYSICAL_CLASS_CHASSIS</h2>
  191. <pre>PHYSICAL_CLASS_CHASSIS </pre>
  192. <div class="labels"></div>
  193. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  194. </div>
  195. <a name="PHYSICAL_CLASS_CONTAINER" id="PHYSICAL_CLASS_CONTAINER"> </a><div class="element clickable constant PHYSICAL_CLASS_CONTAINER" data-toggle="collapse" data-target=".PHYSICAL_CLASS_CONTAINER .collapse">
  196. <h2>PHYSICAL_CLASS_CONTAINER</h2>
  197. <pre>PHYSICAL_CLASS_CONTAINER </pre>
  198. <div class="labels"></div>
  199. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  200. </div>
  201. <a name="PHYSICAL_CLASS_FAN" id="PHYSICAL_CLASS_FAN"> </a><div class="element clickable constant PHYSICAL_CLASS_FAN" data-toggle="collapse" data-target=".PHYSICAL_CLASS_FAN .collapse">
  202. <h2>PHYSICAL_CLASS_FAN</h2>
  203. <pre>PHYSICAL_CLASS_FAN </pre>
  204. <div class="labels"></div>
  205. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  206. </div>
  207. <a name="PHYSICAL_CLASS_MODULE" id="PHYSICAL_CLASS_MODULE"> </a><div class="element clickable constant PHYSICAL_CLASS_MODULE" data-toggle="collapse" data-target=".PHYSICAL_CLASS_MODULE .collapse">
  208. <h2>PHYSICAL_CLASS_MODULE</h2>
  209. <pre>PHYSICAL_CLASS_MODULE </pre>
  210. <div class="labels"></div>
  211. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  212. </div>
  213. <a name="PHYSICAL_CLASS_PORT" id="PHYSICAL_CLASS_PORT"> </a><div class="element clickable constant PHYSICAL_CLASS_PORT" data-toggle="collapse" data-target=".PHYSICAL_CLASS_PORT .collapse">
  214. <h2>PHYSICAL_CLASS_PORT</h2>
  215. <pre>PHYSICAL_CLASS_PORT </pre>
  216. <div class="labels"></div>
  217. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  218. </div>
  219. <a name="PHYSICAL_CLASS_POWER_SUPPLY" id="PHYSICAL_CLASS_POWER_SUPPLY"> </a><div class="element clickable constant PHYSICAL_CLASS_POWER_SUPPLY" data-toggle="collapse" data-target=".PHYSICAL_CLASS_POWER_SUPPLY .collapse">
  220. <h2>PHYSICAL_CLASS_POWER_SUPPLY</h2>
  221. <pre>PHYSICAL_CLASS_POWER_SUPPLY </pre>
  222. <div class="labels"></div>
  223. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  224. </div>
  225. <a name="PHYSICAL_CLASS_SENSOR" id="PHYSICAL_CLASS_SENSOR"> </a><div class="element clickable constant PHYSICAL_CLASS_SENSOR" data-toggle="collapse" data-target=".PHYSICAL_CLASS_SENSOR .collapse">
  226. <h2>PHYSICAL_CLASS_SENSOR</h2>
  227. <pre>PHYSICAL_CLASS_SENSOR </pre>
  228. <div class="labels"></div>
  229. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  230. </div>
  231. </div>
  232. </div>
  233. </div>
  234. </div>
  235. <div class="row"><footer class="span12">
  236. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  237. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  238. generated on 2012-06-22T10:05:27+01:00.<br></footer></div>
  239. </div>
  240. </body>
  241. </html>