Spreadsheet column information. More...
#include <column_info.hpp>
Public Member Functions | |
| column_info () | |
| default constructor More... | |
| column_info (const column_info &ci) | |
| copy constructor More... | |
| column_info (column_info &&ci) | |
| move constructor More... | |
| column_info (const pni::core::string &n, pni::core::type_id_t tid, const std::vector< size_t > &s) | |
| constructor More... | |
| ~column_info () | |
| destructor More... | |
| column_info & | operator= (const column_info &ci) |
| copy assignment operator More... | |
| column_info & | operator= (column_info &&ci) |
| move assignment operator More... | |
| const std::vector< size_t > & | shape () const |
| get cell shape More... | |
| pni::core::type_id_t | type_id () const |
| get cells type ID More... | |
| pni::core::string | name () const |
| get name More... | |
Private Attributes | |
| pni::core::string | _name |
| name of the columne More... | |
| pni::core::type_id_t | _tid |
| type ID of column type More... | |
| std::vector< size_t > | _shape |
| shape of column data More... | |
Detailed Description
This class holds the basic information about a column stored in a spreadsheet. This includes the following parameters: the name of the column, its TypeID and the shape of each cell. The latter parameter allows even the storage of multidimensional data in such a structure.
Constructor & Destructor Documentation
| pni::io::column_info::column_info | ( | ) |
| pni::io::column_info::column_info | ( | const column_info & | ci | ) |
| pni::io::column_info::column_info | ( | column_info && | ci | ) |
| pni::io::column_info::column_info | ( | const pni::core::string & | n, |
| pni::core::type_id_t | tid, | ||
| const std::vector< size_t > & | s | ||
| ) |
A column can hold a scalar or a multidimensional data entry. In the former case the type id is that of the element stored in the latter case it is the id of a single element in the array stored in each column element.
- Parameters
-
n name of the column tid ID of the type stored in the column s shape of the column
| pni::io::column_info::~column_info | ( | ) |
Member Function Documentation
|
inline |
Return the name of the column.
- Returns
- name
| column_info & pni::io::column_info::operator= | ( | const column_info & | ci | ) |
| column_info & pni::io::column_info::operator= | ( | column_info && | ci | ) |
|
inline |
Returns the shape object from a column.
- Returns
- shape object.
|
inline |
Return the TypeID of the column if available. This is only valid for systems where type information is stored in the file (like for FIO).
- Returns
- type id of the column data
Field Documentation
|
private |
|
private |
|
private |
The documentation for this class was generated from the following files:
