File: attribute.rst

package info (click to toggle)
adios2 2.10.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 33,764 kB
  • sloc: cpp: 175,964; ansic: 160,510; f90: 14,630; yacc: 12,668; python: 7,275; perl: 7,126; sh: 2,825; lisp: 1,106; xml: 1,049; makefile: 579; lex: 557
file content (36 lines) | stat: -rw-r--r-- 1,212 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
*********
Attribute
*********

Attributes are extra information associated with a particular IO component.
They can be thought of as a very simplified ``Variable``, but with the goal of adding extra metadata.
The most common use is the addition of human-readable metadata (*e.g.* ``"experiment name"``, ``"date and time"``, ``"04,27,2017"``, or a schema).

Currently, ADIOS2 supports single values and arrays of primitive types (excluding ``complex<T>``) for the template type in the ``IO::DefineAttribute<T>`` and ``IO::InquireAttribute<T>`` function (in C++).

The data types supported for ADIOS2 ``Attributes`` are

.. code-block:: c++

   std::string
   char
   signed char  
   unsigned char  
   short  
   unsigned short  
   int  
   unsigned int  
   long int  
   long long int  
   unsigned long int  
   unsigned long long int  
   float  
   double  
   long double 
   
The returned object (``DefineAttribute`` or ``InquireAttribute``) only serves the purpose to inspect the current ``Attribute<T>`` information within code.

.. note:

   Attributes are not forcibly associated to a particular variable in ADIOS2.
   Developers are free to create associations through their own naming conventions.