MatrixCollection Class Reference

#include <matrix_collection.h>

Inheritance diagram for MatrixCollection:

Public Member Functions
	MatrixCollection ()=default
	Construct a new Matrix Collection object.
	MatrixCollection (std::vector< std::string > names)
	Construct a new Matrix Collection object.
void	check_has_at_least_as_many_matrices_as (MatrixCollection &other)
	Check we have as many or more matrices than another MatrixCollection.

Public Attributes
int	n_matrices = 0
std::vector< std::string >	matrix_names

Detailed Description

A collection of matlab matrices with names

Constructor & Destructor Documentation

MatrixCollection()

MatrixCollection::MatrixCollection ( std::vector< std::string >  names )

explicit

Construct a new Matrix Collection object.

Parameters

names	of the matrices
number	of matrices in the collection

Member Function Documentation

check_has_at_least_as_many_matrices_as()

void MatrixCollection::check_has_at_least_as_many_matrices_as

(

MatrixCollection &

other

)

Check we have as many or more matrices than another MatrixCollection.

Throws a runtime error if there are fewer matrices in the other MatrixCollection

Parameters

other

the other MatrixCollection

---

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

• tdms/include/matrix_collection.h
• tdms/src/matrix_collection.cpp