bitrl & cuberl Documentation
Simulation engine for reinforcement learning agents
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
kernel::CSVMeshWriter Class Reference

The CSVWriter class. Handles writing into CSV file format. More...

#include <csv_mesh_writer.h>

Public Member Functions

 CSVMeshWriter (const std::string &filename, char delim=kernel::utilities::CSVWriter::default_delimiter(), bool open_file=false, const std::ios_base::openmode mode=std::ios_base::out)
 Constructor.
 
void write_column_names (const std::vector< std::string > &col_names, bool write_header=true)
 Write the column names.
 
void write_column_names (const std::vector< std::string_view > &col_names, bool write_header=true)
 Write the column names.
 
void write_column_names (const std::initializer_list< std::string_view > &col_names, bool write_header=true)
 Write the column names.
 
template<typename T >
void write_row (const std::vector< T > &vals)
 Write a row of the file.
 
template<typename T >
void write_row (const DynVec< T > &vals)
 Write the given Vec as a row.
 
template<typename... T>
void write_row (const std::tuple< T... > &row)
 Write the given tuple as a row.
 
void set_delimiter (char delim) noexcept
 Set the delimiter.
 
char get_delimiter () const noexcept
 Returns the column delimiter.
 
bool is_open () const
 Returns true if the file is open.
 
void write_mesh (const numerics::LineMesh< 2 > &mesh)
 Write the given LineMesh into csv format.
 
template<typename MeshTp >
void write_mesh_nodes (const MeshTp &mesh)
 Write the nodes of the given Mesh.
 

Static Public Member Functions

static char default_delimiter ()
 The default column delimiter.
 

Detailed Description

The CSVWriter class. Handles writing into CSV file format.

Constructor & Destructor Documentation

◆ CSVMeshWriter()

kernel::CSVMeshWriter::CSVMeshWriter ( const std::string &  filename,
char  delim = kernel::utilities::CSVWriter::default_delimiter(),
bool  open_file = false,
const std::ios_base::openmode  mode = std::ios_base::out 
)

Constructor.

Member Function Documentation

◆ default_delimiter()

static char kernel::CSVMeshWriter::default_delimiter ( )
inlinestatic

The default column delimiter.

◆ get_delimiter()

char kernel::CSVMeshWriter::get_delimiter ( ) const
inlinenoexcept

Returns the column delimiter.

◆ is_open()

bool kernel::CSVMeshWriter::is_open ( ) const
inline

Returns true if the file is open.

◆ set_delimiter()

void kernel::CSVMeshWriter::set_delimiter ( char  delim)
inlinenoexcept

Set the delimiter.

◆ write_column_names() [1/3]

void kernel::CSVMeshWriter::write_column_names ( const std::initializer_list< std::string_view > &  col_names,
bool  write_header = true 
)
inline

Write the column names.

◆ write_column_names() [2/3]

void kernel::CSVMeshWriter::write_column_names ( const std::vector< std::string > &  col_names,
bool  write_header = true 
)
inline

Write the column names.

◆ write_column_names() [3/3]

void kernel::CSVMeshWriter::write_column_names ( const std::vector< std::string_view > &  col_names,
bool  write_header = true 
)
inline

Write the column names.

◆ write_mesh()

void kernel::CSVMeshWriter::write_mesh ( const numerics::LineMesh< 2 > &  mesh)

Write the given LineMesh into csv format.

if the file is not open throw

◆ write_mesh_nodes()

template<typename MeshTp >
void kernel::CSVMeshWriter::write_mesh_nodes ( const MeshTp &  mesh)

Write the nodes of the given Mesh.

if the file is not open throw

◆ write_row() [1/3]

template<typename T >
void kernel::CSVMeshWriter::write_row ( const DynVec< T > &  vals)

Write the given Vec as a row.

◆ write_row() [2/3]

template<typename... T>
void kernel::CSVMeshWriter::write_row ( const std::tuple< T... > &  row)

Write the given tuple as a row.

◆ write_row() [3/3]

template<typename T >
void kernel::CSVMeshWriter::write_row ( const std::vector< T > &  vals)

Write a row of the file.

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