summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRALOVICH, Kristof <tade60@freemail.hu>2014-01-04 22:21:40 +0100
committerRALOVICH, Kristof <tade60@freemail.hu>2014-01-04 22:21:40 +0100
commit345650cac86dc82982374be2b41ed2ba08cdacc3 (patch)
tree08afb7288a7b6aff374d3359fd7f182e14fe0c2a
parent775892bce133bfeee38d09c03df8572df9c721fd (diff)
improve src documentation
-rw-r--r--src/AntMessage.cpp5
-rw-r--r--src/AntMessage.hpp1
2 files changed, 6 insertions, 0 deletions
diff --git a/src/AntMessage.cpp b/src/AntMessage.cpp
index 9ba8daf..b047e67 100644
--- a/src/AntMessage.cpp
+++ b/src/AntMessage.cpp
@@ -194,6 +194,8 @@ const std::string AntMessage::str() const
}
+// decoded message as string
+// e.g. "MESG_BURST_DATA_ID chan=0x00, seq=1, last=no ANTFS_RESP(0x44) ANTFS_RespDirect fd=0xffff, offset=0x0000, data=0x0017"
const std::string
AntMessage::str2() const
{
@@ -315,7 +317,10 @@ AntMessage::str2() const
}
+// return as a string:
// whether packet was sent or received, and time as string
+// decoded message
+// e.g. "R 23.003 MESG_BURST_DATA_ID chan=0x00, seq=1, last=no ANTFS_RESP(0x44) ANTFS_RespDirect fd=0xffff, offset=0x0000, data=0x0017"
const string AntMessage::strDt(const double &dt) const
{
if(bytes.empty())
diff --git a/src/AntMessage.hpp b/src/AntMessage.hpp
index 15947cf..e3ee0ea 100644
--- a/src/AntMessage.hpp
+++ b/src/AntMessage.hpp
@@ -625,6 +625,7 @@ public:
};
+// encapsualtes the byte stream of a file retrieved through ant-fs
struct AntFsFile
{
std::vector<uchar> bytes;