Adding doxydocs
This commit is contained in:
Srivats P
commit
a47e80f930
110
doxydocs/class_abstract_protocol-members.html
Normal file
110
doxydocs/class_abstract_protocol-members.html
Normal file
@ -0,0 +1,110 @@
|
||||
<!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>Member List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">AbstractProtocol Member List</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
This is the complete list of members for <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>, including all inherited members.<table>
|
||||
<tr bgcolor="#f0f0f0"><td><b>_cacheFlags</b> (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a01ec7a50fc120622da25ef754ef9051d">_hasPayload</a></td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a8ef6adaa06c7fc87b5b029f685030848">AbstractProtocol</a>(StreamBase *stream, AbstractProtocol *parent=0)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a020c049c35328d847606a571455cc298">appendVariableField</a>(const OstProto::VariableField &vf)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ad845fce434d744158360470faf446071">CacheFlag</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a71a018a1a39da3fd0b22f348e21c85e8ac5407d0629943e055651b900df2b8cfa">CksumField</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a54c7dc4c12d9fc9032641166551f2b65ae9c2c223559327eda034dc7e3499948f">CksumIp</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a54c7dc4c12d9fc9032641166551f2b65a69e3f4f4e9a5b5ae357380b8e0cb2d4f">CksumIpPseudo</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a54c7dc4c12d9fc9032641166551f2b65a4d5ab2c30b009fbac93c3b1e4e36f8c9">CksumMax</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a3fa9027a98c6e78c97ea2b21d278a1ce">CksumScope</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a3fa9027a98c6e78c97ea2b21d278a1ceaf73a5e1ed72ff2afbd51aadf636f2c4b">CksumScopeAdjacentProtocol</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a3fa9027a98c6e78c97ea2b21d278a1ceaaa680c3020e9d6ec42e3283cd326d6b2">CksumScopeAllProtocols</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a54c7dc4c12d9fc9032641166551f2b65a1db5d75b3ca5342d57c78668de8b2c07">CksumTcpUdp</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a54c7dc4c12d9fc9032641166551f2b65">CksumType</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>ComboProtocol</b> (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [friend]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#aa4654b842f274e0daee280684adef2c1">commonProtoDataCopyFrom</a>(const OstProto::Protocol &protocol)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a818b999e0fe20710b62e100ecad124f3">commonProtoDataCopyInto</a>(OstProto::Protocol &protocol) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a5f4b770b062f0cfd90ec9f93f8d737f8">createInstance</a>(StreamBase *stream, AbstractProtocol *parent=0)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [static]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2c">FieldAttrib</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2cabf037461e1abed7603d311f701a560d8">FieldBitSize</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a5c26dc650b8480265ceaa8bfb6f30357">fieldCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a63aa72e9a3d7c666f75a5442a36b894b">fieldData</a>(int index, FieldAttrib attrib, int streamIndex=0) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a71a018a1a39da3fd0b22f348e21c85e8">FieldFlag</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#aa9dea7d27d100f8886f3abcad5220e0b">fieldFlags</a>(int index) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a1a7491fe014db3307b7e443fcb23d3f8">fieldFrameBitOffset</a>(int index, int streamIndex=0) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>FieldFrameBitOffsetCache</b> enum value (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2cabb3fc3111e7d887281728ccd95c0e876">FieldFrameValue</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2ca6a6eabda81c9937845258bd6a87197af">FieldName</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2ca39c3a7bfe08b218a6dd0b0c93752cf57">FieldTextValue</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a264223e35af983ba7016700b17f24b2ca6f6cbe2c8b4bb7ba90f77bb71ab148df">FieldValue</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a71a018a1a39da3fd0b22f348e21c85e8a975bb1cfe826bcf6044b7432f8b4dee4">FrameField</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#acac964c423928703a0da8c21fa6dfe50">frameFieldCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>gcd</b>(quint64 u, quint64 v) (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [static]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#adb3d714eae41034500c70663a8792790">isProtocolFramePayloadSizeVariable</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a507683641d443b62e36998b1bd4d3533">isProtocolFramePayloadValueVariable</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#acf6eeb9f4db0848295b125906c92eea4">isProtocolFrameSizeVariable</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#aec6223a44cff630869ae4535c00ae11f">isProtocolFrameValueVariable</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>lcm</b>(quint64 u, quint64 v) (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [static]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a71a018a1a39da3fd0b22f348e21c85e8a4674267e0b1ca900b107823a094c44f2">MetaField</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a1720f5fae0e7c90ba52d0d4cb04c80fe">metaFieldCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a64a39e56273fea09038b4f4e2e9288bb">mpStream</a></td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a8afe28a07915431c59c57769ef037cf3">mutableVariableField</a>(int index)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a88bb4dec958836f9ec65f32f797253d1">name</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ab7ecfd75e44450db380fc24694a478c6">next</a></td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a0461f1cdeb9bb4bc85ad7e26daf0d600">parent</a></td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a8115d60319fe23b71b6d4de46d800bef">payloadProtocolId</a>(ProtocolIdType type) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94cb5005a93c5318a99234f36c9259e5">prev</a></td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#af5f206edd6050e10321756889086cc19">protocolFrameCksum</a>(int streamIndex=0, CksumType cksumType=CksumIp) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ac0f92f797429fa74deb4a451ccd18f01">protocolFrameHeaderCksum</a>(int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAdjacentProtocol) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#aff15d2fdc6df8db5bc5b13fbacb57675">protocolFrameOffset</a>(int streamIndex=0) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#aa3294a383d53b9d963d885eb53558d62">protocolFramePayloadCksum</a>(int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAllProtocols) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#af0826fd6957b30bdc1b0af5e9ac6987d">protocolFramePayloadSize</a>(int streamIndex=0) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ad3cd83ac4774ef40e90a3db4eea44bcd">protocolFramePayloadVariableCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a62f842e0d07c382e20d70b78ed39c21c">protocolFrameSize</a>(int streamIndex=0) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a71c64ddfb9797d2e567013f3dcf93c73">protocolFrameValue</a>(int streamIndex=0, bool forCksum=false) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a527b6ca531b3489ef29d47bc4f38f361">protocolFrameVariableCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#acb1603f1b707cc28b7fb2ad4642eab01">protocolHasPayload</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a09724ee80fa35bad5e00bf8581084bb7">protocolId</a>(ProtocolIdType type) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600fab4be19b14834dbc2106d2f69daad8156">ProtocolIdEth</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600fac232e06fa03ade8b73b6f805fbf4e594">ProtocolIdIp</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600fa018f343eea81889b34ce37be982a0949">ProtocolIdLlc</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600fa7caf04230689c991aea6ea98dd6cb44f">ProtocolIdNone</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600fa6ccc40767925f33be3c4ba94503d4819">ProtocolIdTcpUdp</a> enum value</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a94af7be261834da225cdda75223a600f">ProtocolIdType</a> enum name</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#abd1dad7fee4194e4da537f82f1a2a162">protocolIdType</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>ProtocolListIterator</b> (defined in <a class="el" href="class_abstract_protocol.html">AbstractProtocol</a>)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [friend]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a11d85e6249098392eb2c29212613b880">protocolNumber</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a124e67926605177d7787ae649ba57a99">protoDataCopyFrom</a>(const OstProto::Protocol &protocol)=0</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [pure virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ad632e0fc6fcd86a0fecefd6fa3cf2724">protoDataCopyInto</a>(OstProto::Protocol &protocol) const =0</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [pure virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a47c19d80bfeb03af263fd9b5db3bd56a">removeVariableField</a>(int index)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ab0c6da690a523a49134944fb1d56b6ac">setFieldData</a>(int index, const QVariant &value, FieldAttrib attrib=FieldValue)</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#add629f97f1e6633fc8ec6b936e06ca77">shortName</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ae38a631ad22df35e3fcb8093d58dc0fa">variableField</a>(int index) const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#ae91b83c11b74182365a51e8736066aaa">variableFieldCount</a>() const </td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol.html#a7ccbf35c6141e0d6aa136e4100c4d39b">~AbstractProtocol</a>()</td><td><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
</table></div>
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue Jun 2 2015 18:40:09 by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1369
doxydocs/class_abstract_protocol.html
Normal file
1369
doxydocs/class_abstract_protocol.html
Normal file
File diff suppressed because it is too large
Load Diff
42
doxydocs/class_abstract_protocol_config_form-members.html
Normal file
42
doxydocs/class_abstract_protocol_config_form-members.html
Normal file
@ -0,0 +1,42 @@
|
||||
<!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>Member List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">AbstractProtocolConfigForm Member List</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
This is the complete list of members for <a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a>, including all inherited members.<table>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a4ffb524289d0693f34f574320b6947e7">AbstractProtocolConfigForm</a>(QWidget *parent=0)</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a7fc940d0a24ab32d0ce7f940125831ae">createInstance</a>()</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline, static]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#af146c51184f181b25761512ccb6383c8">hexStrToUInt</a>(QString text, bool *ok=NULL)</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a2b875ffb5ef73914bada207043272232">hexStrToUInt64</a>(QString text, bool *ok=NULL)</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a39410b5c5e4fc0fcf0b848d472868da3">loadWidget</a>(AbstractProtocol *)</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline, virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90">storeWidget</a>(AbstractProtocol *)</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline, virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_abstract_protocol_config_form.html#a7fab8a8781cb39ea8c0aee0728512f38">~AbstractProtocolConfigForm</a>()</td><td><a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a></td><td><code> [inline, virtual]</code></td></tr>
|
||||
</table></div>
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue Jun 2 2015 18:40:09 by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
220
doxydocs/class_abstract_protocol_config_form.html
Normal file
220
doxydocs/class_abstract_protocol_config_form.html
Normal file
@ -0,0 +1,220 @@
|
||||
<!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>AbstractProtocolConfigForm Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">AbstractProtocolConfigForm Class Reference</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<!-- doxytag: class="AbstractProtocolConfigForm" -->
|
||||
<p><a href="class_abstract_protocol_config_form-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_abstract_protocol_config_form.html#a4ffb524289d0693f34f574320b6947e7">AbstractProtocolConfigForm</a> (QWidget *parent=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the widget. <a href="#a4ffb524289d0693f34f574320b6947e7"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a7fab8a8781cb39ea8c0aee0728512f38">~AbstractProtocolConfigForm</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the widget. <a href="#a7fab8a8781cb39ea8c0aee0728512f38"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a39410b5c5e4fc0fcf0b848d472868da3">loadWidget</a> (<a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads data from the protocol using it's fieldData() method into this widget. <a href="#a39410b5c5e4fc0fcf0b848d472868da3"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90">storeWidget</a> (<a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores data from this widget into the protocol using the protocol's setFieldData() method. <a href="#a77a25bddb0310fee7ad4cd437fe95d90"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#af146c51184f181b25761512ccb6383c8">hexStrToUInt</a> (QString text, bool *ok=NULL)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol's setFieldData() method...">storeWidget()</a> implementations. <a href="#af146c51184f181b25761512ccb6383c8"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">quint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a2b875ffb5ef73914bada207043272232">hexStrToUInt64</a> (QString text, bool *ok=NULL)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol's setFieldData() method...">storeWidget()</a> implementations. <a href="#a2b875ffb5ef73914bada207043272232"></a><br/></td></tr>
|
||||
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
|
||||
Static Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a7fc940d0a24ab32d0ce7f940125831ae">createInstance</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates and returns a new instance of the widget. <a href="#a7fc940d0a24ab32d0ce7f940125831ae"></a><br/></td></tr>
|
||||
</table>
|
||||
<hr/><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a4ffb524289d0693f34f574320b6947e7"></a><!-- doxytag: member="AbstractProtocolConfigForm::AbstractProtocolConfigForm" ref="a4ffb524289d0693f34f574320b6947e7" args="(QWidget *parent=0)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AbstractProtocolConfigForm::AbstractProtocolConfigForm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QWidget * </td>
|
||||
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Constructs the widget. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a7fab8a8781cb39ea8c0aee0728512f38"></a><!-- doxytag: member="AbstractProtocolConfigForm::~AbstractProtocolConfigForm" ref="a7fab8a8781cb39ea8c0aee0728512f38" args="()" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual AbstractProtocolConfigForm::~AbstractProtocolConfigForm </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Destroys the widget. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="a7fc940d0a24ab32d0ce7f940125831ae"></a><!-- doxytag: member="AbstractProtocolConfigForm::createInstance" ref="a7fc940d0a24ab32d0ce7f940125831ae" args="()" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static <a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a>* AbstractProtocolConfigForm::createInstance </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [inline, static]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Allocates and returns a new instance of the widget. </p>
|
||||
<p>Caller is responsible for freeing up after use. Subclasses MUST implement this function </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="af146c51184f181b25761512ccb6383c8"></a><!-- doxytag: member="AbstractProtocolConfigForm::hexStrToUInt" ref="af146c51184f181b25761512ccb6383c8" args="(QString text, bool *ok=NULL)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint AbstractProtocolConfigForm::hexStrToUInt </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>text</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool * </td>
|
||||
<td class="paramname"><em>ok</em> = <code>NULL</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [inline]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol's setFieldData() method...">storeWidget()</a> implementations. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a2b875ffb5ef73914bada207043272232"></a><!-- doxytag: member="AbstractProtocolConfigForm::hexStrToUInt64" ref="a2b875ffb5ef73914bada207043272232" args="(QString text, bool *ok=NULL)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">quint64 AbstractProtocolConfigForm::hexStrToUInt64 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>text</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool * </td>
|
||||
<td class="paramname"><em>ok</em> = <code>NULL</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [inline]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol's setFieldData() method...">storeWidget()</a> implementations. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a39410b5c5e4fc0fcf0b848d472868da3"></a><!-- doxytag: member="AbstractProtocolConfigForm::loadWidget" ref="a39410b5c5e4fc0fcf0b848d472868da3" args="(AbstractProtocol *)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual void AbstractProtocolConfigForm::loadWidget </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> * </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Loads data from the protocol using it's fieldData() method into this widget. </p>
|
||||
<p>Any conversion to user friendly display/editing formats (e.g. hex format) SHOULD be done by this method.</p>
|
||||
<p>Subclasses MUST implement this function. See the SampleProtocol for an example </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a77a25bddb0310fee7ad4cd437fe95d90"></a><!-- doxytag: member="AbstractProtocolConfigForm::storeWidget" ref="a77a25bddb0310fee7ad4cd437fe95d90" args="(AbstractProtocol *)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual void AbstractProtocolConfigForm::storeWidget </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> * </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Stores data from this widget into the protocol using the protocol's setFieldData() method. </p>
|
||||
<p>Field values MUST be converted from any user friendly display/editing formats (e.g. hex format) to simple Qt-style integers/strings before passing to setFieldData()</p>
|
||||
<p>Subclasses MUST implement this function. See the SampleProtocol for an example </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li>common/abstractprotocolconfig.h</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue Jun 2 2015 18:40:09 by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
49
doxydocs/class_pdml_protocol-members.html
Normal file
49
doxydocs/class_pdml_protocol-members.html
Normal file
@ -0,0 +1,49 @@
|
||||
<!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>Member List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">PdmlProtocol Member List</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
This is the complete list of members for <a class="el" href="class_pdml_protocol.html">PdmlProtocol</a>, including all inherited members.<table>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#adf3f80063f50998797c2cfa6a9d3edc9">createInstance</a>()</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [static]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a921264e3c5f916db2533d4c2bc5141c6">fieldHandler</a>(QString name, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a29fd0e4f5e2e12a7a84948d6f86dbf7a">fieldId</a>(QString name) const </td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>fieldMap_</b> (defined in <a class="el" href="class_pdml_protocol.html">PdmlProtocol</a>)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a0c82b3d98442e19852d3b3738c023aec">hasField</a>(QString name) const </td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a2d7462a9b7c8ff58c1277902d0bee9e3">knownFieldHandler</a>(QString name, QString valueHexStr, OstProto::Protocol *pbProto)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#aef66d163a7f2a541c1d4dc273354ca29">ostProtoId</a>() const </td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a4b58c8f079f60986126d084fb9167dd8">ostProtoId_</a></td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a60b82661c6b59a052c320a13cae6462a">PdmlProtocol</a>()</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [protected]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a0f6f93c259def7ad5f59958d3b077d5c">postProtocolHandler</a>(OstProto::Protocol *pbProto, OstProto::Stream *stream)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#a996a0f5f40076b87435cdb3b306e9148">prematureEndHandler</a>(int pos, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#ae6996ae7dc9e81b096ad53046b757d02">preProtocolHandler</a>(QString name, const QXmlStreamAttributes &attributes, int expectedPos, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#aa4e42812f7259649cce1663f6ffed034">unknownFieldHandler</a>(QString name, int pos, int size, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="class_pdml_protocol.html#ae4b3443fea68ea738f27f124803bbb5d">~PdmlProtocol</a>()</td><td><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a></td><td><code> [virtual]</code></td></tr>
|
||||
</table></div>
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue Jun 2 2015 18:40:09 by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
484
doxydocs/class_pdml_protocol.html
Normal file
484
doxydocs/class_pdml_protocol.html
Normal file
@ -0,0 +1,484 @@
|
||||
<!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>PdmlProtocol Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||||
<a href="#pro-methods">Protected Member Functions</a> |
|
||||
<a href="#pro-attribs">Protected Attributes</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">PdmlProtocol Class Reference</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<!-- doxytag: class="PdmlProtocol" -->
|
||||
<p><a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a> is the base class which provides the interface for all PDML decode helper protocols.
|
||||
<a href="class_pdml_protocol.html#details">More...</a></p>
|
||||
|
||||
<p><a href="class_pdml_protocol-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#ae4b3443fea68ea738f27f124803bbb5d">~PdmlProtocol</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the <a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a>. <a href="#ae4b3443fea68ea738f27f124803bbb5d"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#aef66d163a7f2a541c1d4dc273354ca29">ostProtoId</a> () const </td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the protocol's field number as defined in message 'Protocol', enum 'k' (<a href="file:">file:</a> protocol.proto) <a href="#aef66d163a7f2a541c1d4dc273354ca29"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a0c82b3d98442e19852d3b3738c023aec">hasField</a> (QString name) const </td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if name is a 'known' field that can be directly mapped to the protobuf field. <a href="#a0c82b3d98442e19852d3b3738c023aec"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a29fd0e4f5e2e12a7a84948d6f86dbf7a">fieldId</a> (QString name) const </td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the protocol's protobuf field number corresponding to name. <a href="#a29fd0e4f5e2e12a7a84948d6f86dbf7a"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#ae6996ae7dc9e81b096ad53046b757d02">preProtocolHandler</a> (QString name, const QXmlStreamAttributes &attributes, int expectedPos, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called by PdmlReader before any fields within the protocol are processed. <a href="#ae6996ae7dc9e81b096ad53046b757d02"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a996a0f5f40076b87435cdb3b306e9148">prematureEndHandler</a> (int pos, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called by PdmlReader when it encounters a nested protocol in the PDML i.e. <a href="#a996a0f5f40076b87435cdb3b306e9148"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a0f6f93c259def7ad5f59958d3b077d5c">postProtocolHandler</a> (OstProto::Protocol *pbProto, OstProto::Stream *stream)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called by PdmlReader after all fields within the protocol are processed. <a href="#a0f6f93c259def7ad5f59958d3b077d5c"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a921264e3c5f916db2533d4c2bc5141c6">fieldHandler</a> (QString name, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called by PdmlReader for each field in the protocol. <a href="#a921264e3c5f916db2533d4c2bc5141c6"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a2d7462a9b7c8ff58c1277902d0bee9e3">knownFieldHandler</a> (QString name, QString valueHexStr, OstProto::Protocol *pbProto)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a 'known' field. <a href="#a2d7462a9b7c8ff58c1277902d0bee9e3"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#aa4e42812f7259649cce1663f6ffed034">unknownFieldHandler</a> (QString name, int pos, int size, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a 'unknown' field. <a href="#aa4e42812f7259649cce1663f6ffed034"></a><br/></td></tr>
|
||||
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
|
||||
Static Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_pdml_protocol.html">PdmlProtocol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#adf3f80063f50998797c2cfa6a9d3edc9">createInstance</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates and returns a new instance of the class. <a href="#adf3f80063f50998797c2cfa6a9d3edc9"></a><br/></td></tr>
|
||||
<tr><td colspan="2"><h2><a name="pro-methods"></a>
|
||||
Protected Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a60b82661c6b59a052c320a13cae6462a">PdmlProtocol</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protocol's field number as defined in message 'Protocol', enum 'k'. <a href="#a60b82661c6b59a052c320a13cae6462a"></a><br/></td></tr>
|
||||
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
|
||||
Protected Attributes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pdml_protocol.html#a4b58c8f079f60986126d084fb9167dd8">ostProtoId_</a></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map of PDML field names to protobuf field numbers for 'known' fields. <a href="#a4b58c8f079f60986126d084fb9167dd8"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60335e08d777de3ece01a992140503be"></a><!-- doxytag: member="PdmlProtocol::fieldMap_" ref="a60335e08d777de3ece01a992140503be" args="" -->
|
||||
QMap< QString, int > </td><td class="memItemRight" valign="bottom"><b>fieldMap_</b></td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<div class="textblock"><p><a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a> is the base class which provides the interface for all PDML decode helper protocols. </p>
|
||||
<p>All Pdml helper classes derived from <a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a> MUST register themselves with PdmlReader. When PdmlReader encounters a 'proto' tag in the PDML during parsing, it instantiates the corresponding helper <a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a> class and calls its methods to decode the protocol.</p>
|
||||
<p>A subclass MUST initialize the following inherited protected variables in its constructor -</p>
|
||||
<ul>
|
||||
<li>ostProtoId_</li>
|
||||
<li>fieldMap_</li>
|
||||
</ul>
|
||||
<p>A subclass typically needs to reimplement the following methods -</p>
|
||||
<ul>
|
||||
<li><a class="el" href="class_pdml_protocol.html#adf3f80063f50998797c2cfa6a9d3edc9" title="Allocates and returns a new instance of the class.">createInstance()</a></li>
|
||||
</ul>
|
||||
<p>Depending on certain conditions, subclasses may need to reimplement the following additional methods -</p>
|
||||
<ul>
|
||||
<li><a class="el" href="class_pdml_protocol.html#aa4e42812f7259649cce1663f6ffed034" title="Handles a 'unknown' field.">unknownFieldHandler()</a></li>
|
||||
<li><a class="el" href="class_pdml_protocol.html#ae6996ae7dc9e81b096ad53046b757d02" title="This method is called by PdmlReader before any fields within the protocol are processed.">preProtocolHandler()</a></li>
|
||||
<li><a class="el" href="class_pdml_protocol.html#a0f6f93c259def7ad5f59958d3b077d5c" title="This method is called by PdmlReader after all fields within the protocol are processed.">postProtocolHandler()</a></li>
|
||||
</ul>
|
||||
<p>See the description of the methods for more information.</p>
|
||||
<p>Use the SamplePdmlProtocol implementation as boilerplate code and for guidelines and tips </p>
|
||||
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="ae4b3443fea68ea738f27f124803bbb5d"></a><!-- doxytag: member="PdmlProtocol::~PdmlProtocol" ref="ae4b3443fea68ea738f27f124803bbb5d" args="()" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">PdmlProtocol::~PdmlProtocol </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Destroys the <a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a>. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a60b82661c6b59a052c320a13cae6462a"></a><!-- doxytag: member="PdmlProtocol::PdmlProtocol" ref="a60b82661c6b59a052c320a13cae6462a" args="()" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">PdmlProtocol::PdmlProtocol </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [protected]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Protocol's field number as defined in message 'Protocol', enum 'k'. </p>
|
||||
<p>Constructs the <a class="el" href="class_pdml_protocol.html" title="PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols...">PdmlProtocol</a>. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="adf3f80063f50998797c2cfa6a9d3edc9"></a><!-- doxytag: member="PdmlProtocol::createInstance" ref="adf3f80063f50998797c2cfa6a9d3edc9" args="()" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="class_pdml_protocol.html">PdmlProtocol</a> * PdmlProtocol::createInstance </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td><code> [static]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Allocates and returns a new instance of the class. </p>
|
||||
<p>Caller is responsible for freeing up after use. Subclasses MUST implement this function and register it with PdmlReader </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a921264e3c5f916db2533d4c2bc5141c6"></a><!-- doxytag: member="PdmlProtocol::fieldHandler" ref="a921264e3c5f916db2533d4c2bc5141c6" args="(QString name, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::fieldHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const QXmlStreamAttributes & </td>
|
||||
<td class="paramname"><em>attributes</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Stream * </td>
|
||||
<td class="paramname"><em>stream</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>This method is called by PdmlReader for each field in the protocol. </p>
|
||||
<p>Depending on whether it is a known or unknown field, the virtual methods <a class="el" href="class_pdml_protocol.html#a2d7462a9b7c8ff58c1277902d0bee9e3" title="Handles a 'known' field.">knownFieldHandler()</a> and <a class="el" href="class_pdml_protocol.html#aa4e42812f7259649cce1663f6ffed034" title="Handles a 'unknown' field.">unknownFieldHandler()</a> are invoked </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a29fd0e4f5e2e12a7a84948d6f86dbf7a"></a><!-- doxytag: member="PdmlProtocol::fieldId" ref="a29fd0e4f5e2e12a7a84948d6f86dbf7a" args="(QString name) const " -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int PdmlProtocol::fieldId </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Returns the protocol's protobuf field number corresponding to name. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a0c82b3d98442e19852d3b3738c023aec"></a><!-- doxytag: member="PdmlProtocol::hasField" ref="a0c82b3d98442e19852d3b3738c023aec" args="(QString name) const " -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool PdmlProtocol::hasField </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Returns true if name is a 'known' field that can be directly mapped to the protobuf field. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a2d7462a9b7c8ff58c1277902d0bee9e3"></a><!-- doxytag: member="PdmlProtocol::knownFieldHandler" ref="a2d7462a9b7c8ff58c1277902d0bee9e3" args="(QString name, QString valueHexStr, OstProto::Protocol *pbProto)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::knownFieldHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>valueHexStr</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Handles a 'known' field. </p>
|
||||
<p>Uses protobuf reflection interface to set the protobuf field name to valueHexStr as per the field's datatype </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aef66d163a7f2a541c1d4dc273354ca29"></a><!-- doxytag: member="PdmlProtocol::ostProtoId" ref="aef66d163a7f2a541c1d4dc273354ca29" args="() const " -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int PdmlProtocol::ostProtoId </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Returns the protocol's field number as defined in message 'Protocol', enum 'k' (<a href="file:">file:</a> protocol.proto) </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a0f6f93c259def7ad5f59958d3b077d5c"></a><!-- doxytag: member="PdmlProtocol::postProtocolHandler" ref="a0f6f93c259def7ad5f59958d3b077d5c" args="(OstProto::Protocol *pbProto, OstProto::Stream *stream)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::postProtocolHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Stream * </td>
|
||||
<td class="paramname"><em>stream</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>This method is called by PdmlReader after all fields within the protocol are processed. </p>
|
||||
<p>Use this method to do any special handling that may be required for postprocessing </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a996a0f5f40076b87435cdb3b306e9148"></a><!-- doxytag: member="PdmlProtocol::prematureEndHandler" ref="a996a0f5f40076b87435cdb3b306e9148" args="(int pos, OstProto::Protocol *pbProto, OstProto::Stream *stream)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::prematureEndHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>pos</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Stream * </td>
|
||||
<td class="paramname"><em>stream</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>This method is called by PdmlReader when it encounters a nested protocol in the PDML i.e. </p>
|
||||
<p>a protocol within a protocol or a protocol within a field</p>
|
||||
<p>This is a notification to the protocol that protocol processing will be ending prematurely. <a class="el" href="class_pdml_protocol.html#a0f6f93c259def7ad5f59958d3b077d5c" title="This method is called by PdmlReader after all fields within the protocol are processed.">postProtocolHandler()</a> will still be called in such cases. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ae6996ae7dc9e81b096ad53046b757d02"></a><!-- doxytag: member="PdmlProtocol::preProtocolHandler" ref="ae6996ae7dc9e81b096ad53046b757d02" args="(QString name, const QXmlStreamAttributes &attributes, int expectedPos, OstProto::Protocol *pbProto, OstProto::Stream *stream)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::preProtocolHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const QXmlStreamAttributes & </td>
|
||||
<td class="paramname"><em>attributes</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>expectedPos</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Stream * </td>
|
||||
<td class="paramname"><em>stream</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>This method is called by PdmlReader before any fields within the protocol are processed. </p>
|
||||
<p>All attributes associated with the 'proto' tag in the PDML are passed to this method</p>
|
||||
<p>Use this method to do any special handling that may be required for preprocessing </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa4e42812f7259649cce1663f6ffed034"></a><!-- doxytag: member="PdmlProtocol::unknownFieldHandler" ref="aa4e42812f7259649cce1663f6ffed034" args="(QString name, int pos, int size, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void PdmlProtocol::unknownFieldHandler </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">QString </td>
|
||||
<td class="paramname"><em>name</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>pos</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>size</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const QXmlStreamAttributes & </td>
|
||||
<td class="paramname"><em>attributes</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Protocol * </td>
|
||||
<td class="paramname"><em>pbProto</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">OstProto::Stream * </td>
|
||||
<td class="paramname"><em>stream</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td><code> [virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Handles a 'unknown' field. </p>
|
||||
<p>The default implementation does nothing. Subclasses may need to implement this if the protocol contains 'unknown' fields. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/><h2>Member Data Documentation</h2>
|
||||
<a class="anchor" id="a4b58c8f079f60986126d084fb9167dd8"></a><!-- doxytag: member="PdmlProtocol::ostProtoId_" ref="a4b58c8f079f60986126d084fb9167dd8" args="" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int <a class="el" href="class_pdml_protocol.html#a4b58c8f079f60986126d084fb9167dd8">PdmlProtocol::ostProtoId_</a><code> [protected]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Map of PDML field names to protobuf field numbers for 'known' fields. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>common/pdmlprotocol.h</li>
|
||||
<li>common/pdmlprotocol.cpp</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue Jun 2 2015 18:40:09 by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
946
doxydocs/doxygen.css
Normal file
946
doxydocs/doxygen.css
Normal file
@ -0,0 +1,946 @@
|
||||
/* The standard CSS for doxygen */
|
||||
|
||||
body, table, div, p, dl {
|
||||
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
/* @group Heading Levels */
|
||||
|
||||
h1 {
|
||||
font-size: 150%;
|
||||
}
|
||||
|
||||
.title {
|
||||
font-size: 150%;
|
||||
font-weight: bold;
|
||||
margin: 10px 2px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.multicol {
|
||||
-moz-column-gap: 1em;
|
||||
-webkit-column-gap: 1em;
|
||||
-moz-column-count: 3;
|
||||
-webkit-column-count: 3;
|
||||
}
|
||||
|
||||
p.startli, p.startdd, p.starttd {
|
||||
margin-top: 2px;
|
||||
}
|
||||
|
||||
p.endli {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
p.enddd {
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
|
||||
p.endtd {
|
||||
margin-bottom: 2px;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
caption {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
span.legend {
|
||||
font-size: 70%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
h3.version {
|
||||
font-size: 90%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.qindex, div.navtab{
|
||||
background-color: #EBEFF6;
|
||||
border: 1px solid #A3B4D7;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.qindex, div.navpath {
|
||||
width: 100%;
|
||||
line-height: 140%;
|
||||
}
|
||||
|
||||
div.navtab {
|
||||
margin-right: 15px;
|
||||
}
|
||||
|
||||
/* @group Link Styling */
|
||||
|
||||
a {
|
||||
color: #3D578C;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.contents a:visited {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a.qindex {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a.qindexHL {
|
||||
font-weight: bold;
|
||||
background-color: #9CAFD4;
|
||||
color: #ffffff;
|
||||
border: 1px double #869DCA;
|
||||
}
|
||||
|
||||
.contents a.qindexHL:visited {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
a.el {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a.elRef {
|
||||
}
|
||||
|
||||
a.code {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
a.codeRef {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
dl.el {
|
||||
margin-left: -1cm;
|
||||
}
|
||||
|
||||
.fragment {
|
||||
font-family: monospace, fixed;
|
||||
font-size: 105%;
|
||||
}
|
||||
|
||||
pre.fragment {
|
||||
border: 1px solid #C4CFE5;
|
||||
background-color: #FBFCFD;
|
||||
padding: 4px 6px;
|
||||
margin: 4px 8px 4px 2px;
|
||||
overflow: auto;
|
||||
word-wrap: break-word;
|
||||
font-size: 9pt;
|
||||
line-height: 125%;
|
||||
}
|
||||
|
||||
div.ah {
|
||||
background-color: black;
|
||||
font-weight: bold;
|
||||
color: #ffffff;
|
||||
margin-bottom: 3px;
|
||||
margin-top: 3px;
|
||||
padding: 0.2em;
|
||||
border: solid thin #333;
|
||||
border-radius: 0.5em;
|
||||
-webkit-border-radius: .5em;
|
||||
-moz-border-radius: .5em;
|
||||
box-shadow: 2px 2px 3px #999;
|
||||
-webkit-box-shadow: 2px 2px 3px #999;
|
||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
|
||||
background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
|
||||
background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
|
||||
}
|
||||
|
||||
div.groupHeader {
|
||||
margin-left: 16px;
|
||||
margin-top: 12px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.groupText {
|
||||
margin-left: 16px;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
body {
|
||||
background-color: white;
|
||||
color: black;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.contents {
|
||||
margin-top: 10px;
|
||||
margin-left: 8px;
|
||||
margin-right: 8px;
|
||||
}
|
||||
|
||||
td.indexkey {
|
||||
background-color: #EBEFF6;
|
||||
font-weight: bold;
|
||||
border: 1px solid #C4CFE5;
|
||||
margin: 2px 0px 2px 0;
|
||||
padding: 2px 10px;
|
||||
}
|
||||
|
||||
td.indexvalue {
|
||||
background-color: #EBEFF6;
|
||||
border: 1px solid #C4CFE5;
|
||||
padding: 2px 10px;
|
||||
margin: 2px 0px;
|
||||
}
|
||||
|
||||
tr.memlist {
|
||||
background-color: #EEF1F7;
|
||||
}
|
||||
|
||||
p.formulaDsp {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
img.formulaDsp {
|
||||
|
||||
}
|
||||
|
||||
img.formulaInl {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.center {
|
||||
text-align: center;
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
div.center img {
|
||||
border: 0px;
|
||||
}
|
||||
|
||||
address.footer {
|
||||
text-align: right;
|
||||
padding-right: 12px;
|
||||
}
|
||||
|
||||
img.footer {
|
||||
border: 0px;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
/* @group Code Colorization */
|
||||
|
||||
span.keyword {
|
||||
color: #008000
|
||||
}
|
||||
|
||||
span.keywordtype {
|
||||
color: #604020
|
||||
}
|
||||
|
||||
span.keywordflow {
|
||||
color: #e08000
|
||||
}
|
||||
|
||||
span.comment {
|
||||
color: #800000
|
||||
}
|
||||
|
||||
span.preprocessor {
|
||||
color: #806020
|
||||
}
|
||||
|
||||
span.stringliteral {
|
||||
color: #002080
|
||||
}
|
||||
|
||||
span.charliteral {
|
||||
color: #008080
|
||||
}
|
||||
|
||||
span.vhdldigit {
|
||||
color: #ff00ff
|
||||
}
|
||||
|
||||
span.vhdlchar {
|
||||
color: #000000
|
||||
}
|
||||
|
||||
span.vhdlkeyword {
|
||||
color: #700070
|
||||
}
|
||||
|
||||
span.vhdllogic {
|
||||
color: #ff0000
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
/*
|
||||
.search {
|
||||
color: #003399;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
form.search {
|
||||
margin-bottom: 0px;
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
input.search {
|
||||
font-size: 75%;
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
background-color: #e8eef2;
|
||||
}
|
||||
*/
|
||||
|
||||
td.tiny {
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
.dirtab {
|
||||
padding: 4px;
|
||||
border-collapse: collapse;
|
||||
border: 1px solid #A3B4D7;
|
||||
}
|
||||
|
||||
th.dirtab {
|
||||
background: #EBEFF6;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
hr {
|
||||
height: 0px;
|
||||
border: none;
|
||||
border-top: 1px solid #4A6AAA;
|
||||
}
|
||||
|
||||
hr.footer {
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
/* @group Member Descriptions */
|
||||
|
||||
table.memberdecls {
|
||||
border-spacing: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
.mdescLeft, .mdescRight,
|
||||
.memItemLeft, .memItemRight,
|
||||
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
|
||||
background-color: #F9FAFC;
|
||||
border: none;
|
||||
margin: 4px;
|
||||
padding: 1px 0 0 8px;
|
||||
}
|
||||
|
||||
.mdescLeft, .mdescRight {
|
||||
padding: 0px 8px 4px 8px;
|
||||
color: #555;
|
||||
}
|
||||
|
||||
.memItemLeft, .memItemRight, .memTemplParams {
|
||||
border-top: 1px solid #C4CFE5;
|
||||
}
|
||||
|
||||
.memItemLeft, .memTemplItemLeft {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.memItemRight {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.memTemplParams {
|
||||
color: #4665A2;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Member Details */
|
||||
|
||||
/* Styles for detailed member documentation */
|
||||
|
||||
.memtemplate {
|
||||
font-size: 80%;
|
||||
color: #4665A2;
|
||||
font-weight: normal;
|
||||
margin-left: 9px;
|
||||
}
|
||||
|
||||
.memnav {
|
||||
background-color: #EBEFF6;
|
||||
border: 1px solid #A3B4D7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
|
||||
.mempage {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.memitem {
|
||||
padding: 0;
|
||||
margin-bottom: 10px;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
.memname {
|
||||
white-space: nowrap;
|
||||
font-weight: bold;
|
||||
margin-left: 6px;
|
||||
}
|
||||
|
||||
.memproto, dl.reflist dt {
|
||||
border-top: 1px solid #A8B8D9;
|
||||
border-left: 1px solid #A8B8D9;
|
||||
border-right: 1px solid #A8B8D9;
|
||||
padding: 6px 0px 6px 0px;
|
||||
color: #253555;
|
||||
font-weight: bold;
|
||||
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
|
||||
/* opera specific markup */
|
||||
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||
border-top-right-radius: 8px;
|
||||
border-top-left-radius: 8px;
|
||||
/* firefox specific markup */
|
||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
||||
-moz-border-radius-topright: 8px;
|
||||
-moz-border-radius-topleft: 8px;
|
||||
/* webkit specific markup */
|
||||
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||
-webkit-border-top-right-radius: 8px;
|
||||
-webkit-border-top-left-radius: 8px;
|
||||
background-image:url('nav_f.png');
|
||||
background-repeat:repeat-x;
|
||||
background-color: #E2E8F2;
|
||||
|
||||
}
|
||||
|
||||
.memdoc, dl.reflist dd {
|
||||
border-bottom: 1px solid #A8B8D9;
|
||||
border-left: 1px solid #A8B8D9;
|
||||
border-right: 1px solid #A8B8D9;
|
||||
padding: 2px 5px;
|
||||
background-color: #FBFCFD;
|
||||
border-top-width: 0;
|
||||
/* opera specific markup */
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||
/* firefox specific markup */
|
||||
-moz-border-radius-bottomleft: 8px;
|
||||
-moz-border-radius-bottomright: 8px;
|
||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
|
||||
background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7);
|
||||
/* webkit specific markup */
|
||||
-webkit-border-bottom-left-radius: 8px;
|
||||
-webkit-border-bottom-right-radius: 8px;
|
||||
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||
background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
|
||||
}
|
||||
|
||||
dl.reflist dt {
|
||||
padding: 5px;
|
||||
}
|
||||
|
||||
dl.reflist dd {
|
||||
margin: 0px 0px 10px 0px;
|
||||
padding: 5px;
|
||||
}
|
||||
|
||||
.paramkey {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.paramtype {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.paramname {
|
||||
color: #602020;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.paramname em {
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
.params, .retval, .exception, .tparams {
|
||||
border-spacing: 6px 2px;
|
||||
}
|
||||
|
||||
.params .paramname, .retval .paramname {
|
||||
font-weight: bold;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.params .paramtype {
|
||||
font-style: italic;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.params .paramdir {
|
||||
font-family: "courier new",courier,monospace;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Directory (tree) */
|
||||
|
||||
/* for the tree view */
|
||||
|
||||
.ftvtree {
|
||||
font-family: sans-serif;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
/* these are for tree view when used as main index */
|
||||
|
||||
.directory {
|
||||
font-size: 9pt;
|
||||
font-weight: bold;
|
||||
margin: 5px;
|
||||
}
|
||||
|
||||
.directory h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
/*
|
||||
The following two styles can be used to replace the root node title
|
||||
with an image of your choice. Simply uncomment the next two styles,
|
||||
specify the name of your image and be sure to set 'height' to the
|
||||
proper pixel height of your image.
|
||||
*/
|
||||
|
||||
/*
|
||||
.directory h3.swap {
|
||||
height: 61px;
|
||||
background-repeat: no-repeat;
|
||||
background-image: url("yourimage.gif");
|
||||
}
|
||||
.directory h3.swap span {
|
||||
display: none;
|
||||
}
|
||||
*/
|
||||
|
||||
.directory > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.directory p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.directory div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
.directory img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
/* these are for tree view when not used as main index */
|
||||
|
||||
.directory-alt {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.directory-alt h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
.directory-alt > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.directory-alt p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.directory-alt div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
.directory-alt img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
div.dynheader {
|
||||
margin-top: 8px;
|
||||
}
|
||||
|
||||
address {
|
||||
font-style: normal;
|
||||
color: #2A3D61;
|
||||
}
|
||||
|
||||
table.doxtable {
|
||||
border-collapse:collapse;
|
||||
}
|
||||
|
||||
table.doxtable td, table.doxtable th {
|
||||
border: 1px solid #2D4068;
|
||||
padding: 3px 7px 2px;
|
||||
}
|
||||
|
||||
table.doxtable th {
|
||||
background-color: #374F7F;
|
||||
color: #FFFFFF;
|
||||
font-size: 110%;
|
||||
padding-bottom: 4px;
|
||||
padding-top: 5px;
|
||||
text-align:left;
|
||||
}
|
||||
|
||||
table.fieldtable {
|
||||
width: 100%;
|
||||
margin-bottom: 10px;
|
||||
border: 1px solid #A8B8D9;
|
||||
border-spacing: 0px;
|
||||
-moz-border-radius: 4px;
|
||||
-webkit-border-radius: 4px;
|
||||
border-radius: 4px;
|
||||
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
|
||||
-webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
|
||||
box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
|
||||
}
|
||||
|
||||
.fieldtable td, .fieldtable th {
|
||||
padding: 3px 7px 2px;
|
||||
}
|
||||
|
||||
.fieldtable td.fieldtype, .fieldtable td.fieldname {
|
||||
white-space: nowrap;
|
||||
border-right: 1px solid #A8B8D9;
|
||||
border-bottom: 1px solid #A8B8D9;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.fieldtable td.fielddoc {
|
||||
border-bottom: 1px solid #A8B8D9;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.fieldtable tr:last-child td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.fieldtable th {
|
||||
background-image:url('nav_f.png');
|
||||
background-repeat:repeat-x;
|
||||
background-color: #E2E8F2;
|
||||
font-size: 90%;
|
||||
color: #253555;
|
||||
padding-bottom: 4px;
|
||||
padding-top: 5px;
|
||||
text-align:left;
|
||||
-moz-border-radius-topleft: 4px;
|
||||
-moz-border-radius-topright: 4px;
|
||||
-webkit-border-top-left-radius: 4px;
|
||||
-webkit-border-top-right-radius: 4px;
|
||||
border-top-left-radius: 4px;
|
||||
border-top-right-radius: 4px;
|
||||
border-bottom: 1px solid #A8B8D9;
|
||||
}
|
||||
|
||||
|
||||
.tabsearch {
|
||||
top: 0px;
|
||||
left: 10px;
|
||||
height: 36px;
|
||||
background-image: url('tab_b.png');
|
||||
z-index: 101;
|
||||
overflow: hidden;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.navpath ul
|
||||
{
|
||||
font-size: 11px;
|
||||
background-image:url('tab_b.png');
|
||||
background-repeat:repeat-x;
|
||||
height:30px;
|
||||
line-height:30px;
|
||||
color:#8AA0CC;
|
||||
border:solid 1px #C2CDE4;
|
||||
overflow:hidden;
|
||||
margin:0px;
|
||||
padding:0px;
|
||||
}
|
||||
|
||||
.navpath li
|
||||
{
|
||||
list-style-type:none;
|
||||
float:left;
|
||||
padding-left:10px;
|
||||
padding-right:15px;
|
||||
background-image:url('bc_s.png');
|
||||
background-repeat:no-repeat;
|
||||
background-position:right;
|
||||
color:#364D7C;
|
||||
}
|
||||
|
||||
.navpath li.navelem a
|
||||
{
|
||||
height:32px;
|
||||
display:block;
|
||||
text-decoration: none;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.navpath li.navelem a:hover
|
||||
{
|
||||
color:#6884BD;
|
||||
}
|
||||
|
||||
.navpath li.footer
|
||||
{
|
||||
list-style-type:none;
|
||||
float:right;
|
||||
padding-left:10px;
|
||||
padding-right:15px;
|
||||
background-image:none;
|
||||
background-repeat:no-repeat;
|
||||
background-position:right;
|
||||
color:#364D7C;
|
||||
font-size: 8pt;
|
||||
}
|
||||
|
||||
|
||||
div.summary
|
||||
{
|
||||
float: right;
|
||||
font-size: 8pt;
|
||||
padding-right: 5px;
|
||||
width: 50%;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.summary a
|
||||
{
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
div.ingroups
|
||||
{
|
||||
margin-left: 5px;
|
||||
font-size: 8pt;
|
||||
padding-left: 5px;
|
||||
width: 50%;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.ingroups a
|
||||
{
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
div.header
|
||||
{
|
||||
background-image:url('nav_h.png');
|
||||
background-repeat:repeat-x;
|
||||
background-color: #F9FAFC;
|
||||
margin: 0px;
|
||||
border-bottom: 1px solid #C4CFE5;
|
||||
}
|
||||
|
||||
div.headertitle
|
||||
{
|
||||
padding: 5px 5px 5px 7px;
|
||||
}
|
||||
|
||||
dl
|
||||
{
|
||||
padding: 0 0 0 10px;
|
||||
}
|
||||
|
||||
dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug
|
||||
{
|
||||
border-left:4px solid;
|
||||
padding: 0 0 0 6px;
|
||||
}
|
||||
|
||||
dl.note
|
||||
{
|
||||
border-color: #D0C000;
|
||||
}
|
||||
|
||||
dl.warning, dl.attention
|
||||
{
|
||||
border-color: #FF0000;
|
||||
}
|
||||
|
||||
dl.pre, dl.post, dl.invariant
|
||||
{
|
||||
border-color: #00D000;
|
||||
}
|
||||
|
||||
dl.deprecated
|
||||
{
|
||||
border-color: #505050;
|
||||
}
|
||||
|
||||
dl.todo
|
||||
{
|
||||
border-color: #00C0E0;
|
||||
}
|
||||
|
||||
dl.test
|
||||
{
|
||||
border-color: #3030E0;
|
||||
}
|
||||
|
||||
dl.bug
|
||||
{
|
||||
border-color: #C08050;
|
||||
}
|
||||
|
||||
#projectlogo
|
||||
{
|
||||
text-align: center;
|
||||
vertical-align: bottom;
|
||||
border-collapse: separate;
|
||||
}
|
||||
|
||||
#projectlogo img
|
||||
{
|
||||
border: 0px none;
|
||||
}
|
||||
|
||||
#projectname
|
||||
{
|
||||
font: 300% Tahoma, Arial,sans-serif;
|
||||
margin: 0px;
|
||||
padding: 2px 0px;
|
||||
}
|
||||
|
||||
#projectbrief
|
||||
{
|
||||
font: 120% Tahoma, Arial,sans-serif;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
#projectnumber
|
||||
{
|
||||
font: 50% Tahoma, Arial,sans-serif;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
#titlearea
|
||||
{
|
||||
padding: 0px;
|
||||
margin: 0px;
|
||||
width: 100%;
|
||||
border-bottom: 1px solid #5373B4;
|
||||
}
|
||||
|
||||
.image
|
||||
{
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.dotgraph
|
||||
{
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.mscgraph
|
||||
{
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.caption
|
||||
{
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.zoom
|
||||
{
|
||||
border: 1px solid #90A5CE;
|
||||
}
|
||||
|
||||
dl.citelist {
|
||||
margin-bottom:50px;
|
||||
}
|
||||
|
||||
dl.citelist dt {
|
||||
color:#334975;
|
||||
float:left;
|
||||
font-weight:bold;
|
||||
margin-right:10px;
|
||||
padding:5px;
|
||||
}
|
||||
|
||||
dl.citelist dd {
|
||||
margin:2px 0;
|
||||
padding:5px 0;
|
||||
}
|
||||
|
||||
@media print
|
||||
{
|
||||
#top { display: none; }
|
||||
#side-nav { display: none; }
|
||||
#nav-path { display: none; }
|
||||
body { overflow:visible; }
|
||||
h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
|
||||
.summary { display: none; }
|
||||
.memitem { page-break-inside: avoid; }
|
||||
#doc-content
|
||||
{
|
||||
margin-left:0 !important;
|
||||
height:auto !important;
|
||||
width:auto !important;
|
||||
overflow:inherit;
|
||||
display:inline;
|
||||
}
|
||||
pre.fragment
|
||||
{
|
||||
overflow: visible;
|
||||
text-wrap: unrestricted;
|
||||
white-space: -moz-pre-wrap; /* Moz */
|
||||
white-space: -pre-wrap; /* Opera 4-6 */
|
||||
white-space: -o-pre-wrap; /* Opera 7 */
|
||||
white-space: pre-wrap; /* CSS3 */
|
||||
word-wrap: break-word; /* IE 5.5+ */
|
||||
}
|
||||
}
|
||||
|
||||
BIN
doxydocs/doxygen.png
Normal file
BIN
doxydocs/doxygen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
102
doxydocs/tabs.css
Normal file
102
doxydocs/tabs.css
Normal file
@ -0,0 +1,102 @@
|
||||
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */
|
||||
|
||||
DIV.tabs
|
||||
{
|
||||
float : left;
|
||||
width : 100%;
|
||||
background : url("tab_b.gif") repeat-x bottom;
|
||||
margin-bottom : 4px;
|
||||
}
|
||||
|
||||
DIV.tabs UL
|
||||
{
|
||||
margin : 0px;
|
||||
padding-left : 10px;
|
||||
list-style : none;
|
||||
}
|
||||
|
||||
DIV.tabs LI, DIV.tabs FORM
|
||||
{
|
||||
display : inline;
|
||||
margin : 0px;
|
||||
padding : 0px;
|
||||
}
|
||||
|
||||
DIV.tabs FORM
|
||||
{
|
||||
float : right;
|
||||
}
|
||||
|
||||
DIV.tabs A
|
||||
{
|
||||
float : left;
|
||||
background : url("tab_r.gif") no-repeat right top;
|
||||
border-bottom : 1px solid #84B0C7;
|
||||
font-size : x-small;
|
||||
font-weight : bold;
|
||||
text-decoration : none;
|
||||
}
|
||||
|
||||
DIV.tabs A:hover
|
||||
{
|
||||
background-position: 100% -150px;
|
||||
}
|
||||
|
||||
DIV.tabs A:link, DIV.tabs A:visited,
|
||||
DIV.tabs A:active, DIV.tabs A:hover
|
||||
{
|
||||
color: #1A419D;
|
||||
}
|
||||
|
||||
DIV.tabs SPAN
|
||||
{
|
||||
float : left;
|
||||
display : block;
|
||||
background : url("tab_l.gif") no-repeat left top;
|
||||
padding : 5px 9px;
|
||||
white-space : nowrap;
|
||||
}
|
||||
|
||||
DIV.tabs INPUT
|
||||
{
|
||||
float : right;
|
||||
display : inline;
|
||||
font-size : 1em;
|
||||
}
|
||||
|
||||
DIV.tabs TD
|
||||
{
|
||||
font-size : x-small;
|
||||
font-weight : bold;
|
||||
text-decoration : none;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* Commented Backslash Hack hides rule from IE5-Mac \*/
|
||||
DIV.tabs SPAN {float : none;}
|
||||
/* End IE5-Mac hack */
|
||||
|
||||
DIV.tabs A:hover SPAN
|
||||
{
|
||||
background-position: 0% -150px;
|
||||
}
|
||||
|
||||
DIV.tabs LI.current A
|
||||
{
|
||||
background-position: 100% -150px;
|
||||
border-width : 0px;
|
||||
}
|
||||
|
||||
DIV.tabs LI.current SPAN
|
||||
{
|
||||
background-position: 0% -150px;
|
||||
padding-bottom : 6px;
|
||||
}
|
||||
|
||||
DIV.navpath
|
||||
{
|
||||
background : none;
|
||||
border : none;
|
||||
border-bottom : 1px solid #84B0C7;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user