Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
O
OBITools3
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
21
Issues
21
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Incidents
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
OBITools
OBITools3
Commits
b0c9b295
Commit
b0c9b295
authored
May 12, 2015
by
Eric Coissac
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
An OBIDMS is also contitued by views
parent
0b6c1f9f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
14 deletions
+14
-14
doc/source/formats.rst
doc/source/formats.rst
+14
-14
No files found.
doc/source/formats.rst
View file @
b0c9b295
...
...
@@ -7,26 +7,27 @@ Formats
The OBItools3 Data Management System (OBIDMS)
*********************************************
An OBIDMS directory consists of :
An OBIDMS directory consists of :
* OBIDMS column files
* OBIDMS view descriptions
* an OBIDMS history file
OBIDMS column files
===================
Each OBIDMS column file contains :
* a header of a size equal to a multiple of PAGESIZE (PAGESIZE being equal to 4096 bytes
* a header of a size equal to a multiple of PAGESIZE (PAGESIZE being equal to 4096 bytes
on most systems) containing metadata
* one column of data of the same type
OBIDMS column files are read-only.
File name
---------
Each file is named with the attribute associated to the data it contains, and the number of
Each file is named with the attribute associated to the data it contains, and the number of
its version, separated by an underscore.
Example : ``count_0003``
...
...
@@ -39,10 +40,10 @@ Header
------
The header of an OBIDMS column contains :
* Endian byte order
* PAGESIZE value / Size of the header
* Number of lines (total or without the header?)
* Data type (int, str...)
* Date of creation
...
...
@@ -59,10 +60,10 @@ A column of data of the same type.
Versioning
----------
Since OBIDMS column files are read-only, any modification leads to the creation of a new version
Since OBIDMS column files are read-only, any modification leads to the creation of a new version
of the column file.
The first version of a column file is numbered 0001, and each new version increments that
The first version of a column file is numbered 0001, and each new version increments that
number by 1.
...
...
@@ -72,19 +73,19 @@ Mandatory columns
Some columns must exist in an OBIDMS directory :
* sequence identifiers column
OBIDMS history file
===================
An OBIDMS history file consists of data that can be represented in the form of a directed acyclic
An OBIDMS history file consists of data that can be represented in the form of a directed acyclic
graph presenting the history of all the operations ever done in the OBIDMS directory.
OBIDMS views
============
An OBIDMS view corresponds to a list of OBIDMS columns and lines. A view includes one version
of each mandatory column. Only one version of each column is included. All the columns of
An OBIDMS view corresponds to a list of OBIDMS columns and lines. A view includes one version
of each mandatory column. Only one version of each column is included. All the columns of
one view contain the same number of lines in the same order.
...
...
@@ -99,4 +100,3 @@ OBIIntColumn header file
========================
.. doxygenfile:: obiintcolumn.h
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment