From 3910c6da3c62232e6593e5fcfe53f5ece933a294 Mon Sep 17 00:00:00 2001
From: Tom Rondeau <trondeau@vt.edu>
Date: Fri, 14 Dec 2012 13:57:29 -0500
Subject: core: adding itemsize key to metadata header to allow for vectorized
 items.

This also simplifies some code in the source since we're told exactly what the items size is and don't have to infer.

Also adds an example using vector items.
---
 docs/doxygen/other/metadata.dox | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'docs/doxygen/other')

diff --git a/docs/doxygen/other/metadata.dox b/docs/doxygen/other/metadata.dox
index 5b20b9e730..4bc310531d 100644
--- a/docs/doxygen/other/metadata.dox
+++ b/docs/doxygen/other/metadata.dox
@@ -16,9 +16,9 @@ Metadata files have headers that carry information about a segment of
 data within the file. The header structure is described in detail in
 the next section. A metadata file always starts with a header that
 describes the basic structure of the data. It contains information
-about the data type, if it's complex, the sample rate of the segment,
-the time stamp of the first sample of the segment, and information
-regarding the header size and segment size.
+about the item size, data type, if it's complex, the sample rate of
+the segment, the time stamp of the first sample of the segment, and
+information regarding the header size and segment size.
 
 Headers have two main tags associated with them:
 
@@ -190,10 +190,11 @@ must be the same length and structure. As of now, we only have version
 - version: (char) version number (usually set to METADATA_VERSION)
 - rx_rate: (double) Stream's sample rate
 - rx_time: (pmt_t pair - (uint64_t, double)) Time stamp (format from UHD)
+- size: (int) item size in bytes - reflects vector length if any.
 - type: (int) data type (enum below)
 - cplx: (bool) true if data is complex
 - strt: (uint64_t) start of data relative to current header
-- size: (uint64_t) size of following data segment
+- bytes: (uint64_t) size of following data segment in bytes
 
 The data types are indicated by an integer value from the following
 enumeration type:
-- 
cgit v1.2.3