Alexandria  2.18
Please provide a description of the project.
Public Member Functions | Public Attributes | List of all members
Euclid::Table::ColumnDescription Class Reference

Contains the description of a specific column of a Table. More...

#include <ColumnDescription.h>

Collaboration diagram for Euclid::Table::ColumnDescription:
[legend]

Public Member Functions

 ColumnDescription (std::string name, std::type_index type=typeid(std::string), std::string unit="", std::string description="")
 
 ColumnDescription (const ColumnDescription &)=default
 
 ColumnDescription (ColumnDescription &&)=default
 
ColumnDescriptionoperator= (const ColumnDescription &)=default
 
ColumnDescriptionoperator= (ColumnDescription &&)=default
 
bool operator!= (const ColumnDescription &other) const
 Returns true if the two ColumnDescriptions do not describe the same column. More...
 
bool operator== (const ColumnDescription &other) const
 

Public Attributes

std::string name
 
std::type_index type
 
std::string unit
 
std::string description
 

Detailed Description

Contains the description of a specific column of a Table.

Each table column is described by the following:

The access to the above is done by directly accessing the public members of the ColumnDescription class.

The ColumnDescription implements the comparison operators by checking only the name, type and unit and by ignoring the description text.

Definition at line 55 of file ColumnDescription.h.

Constructor & Destructor Documentation

◆ ColumnDescription() [1/3]

Euclid::Table::ColumnDescription::ColumnDescription ( std::string  name,
std::type_index  type = typeid(std::string),
std::string  unit = "",
std::string  description = "" 
)

Constructs a new ColumnDescription instance

Exceptions
Elements::Exceptionif the name is the empty string or if it contains whitespaces

Definition at line 39 of file ColumnDescription.cpp.

References std::string::empty().

Here is the call graph for this function:

◆ ColumnDescription() [2/3]

Euclid::Table::ColumnDescription::ColumnDescription ( const ColumnDescription )
default

◆ ColumnDescription() [3/3]

Euclid::Table::ColumnDescription::ColumnDescription ( ColumnDescription &&  )
default

Member Function Documentation

◆ operator!=()

bool Euclid::Table::ColumnDescription::operator!= ( const ColumnDescription other) const
inline

Returns true if the two ColumnDescriptions do not describe the same column.

Definition at line 70 of file ColumnDescription.h.

◆ operator=() [1/2]

ColumnDescription& Euclid::Table::ColumnDescription::operator= ( ColumnDescription &&  )
default

◆ operator=() [2/2]

ColumnDescription& Euclid::Table::ColumnDescription::operator= ( const ColumnDescription )
default

◆ operator==()

bool Euclid::Table::ColumnDescription::operator== ( const ColumnDescription other) const
inline

Returns true if the two ColumnDescriptions describe the same column (ignoring the description text)

Definition at line 76 of file ColumnDescription.h.

References name, type, and unit.

Member Data Documentation

◆ description

std::string Euclid::Table::ColumnDescription::description

Definition at line 83 of file ColumnDescription.h.

◆ name

std::string Euclid::Table::ColumnDescription::name

◆ type

std::type_index Euclid::Table::ColumnDescription::type

Definition at line 81 of file ColumnDescription.h.

Referenced by operator==().

◆ unit

std::string Euclid::Table::ColumnDescription::unit

Definition at line 82 of file ColumnDescription.h.

Referenced by operator==().


The documentation for this class was generated from the following files: