OpenMPCD
Public Types | Public Member Functions | List of all members
OpenMPCD::Graph4D Class Reference

Represents a 4D graph. More...

#include <Graph4D.hpp>

Public Types

typedef std::deque< boost::tuple< double, double, double, double > > Container
 The type the data points are collected in. More...
 

Public Member Functions

void addPoint (const FP w, const FP x, const FP y, const FP z)
 Adds a data point. More...
 
const ContainergetPoints () const
 Returns the data points. More...
 
void save (const std::string &path) const
 Saves the graph data to the given file path. More...
 

Detailed Description

Represents a 4D graph.

Definition at line 20 of file Graph4D.hpp.

Member Typedef Documentation

◆ Container

typedef std::deque<boost::tuple<double, double, double, double> > OpenMPCD::Graph4D::Container

The type the data points are collected in.

Definition at line 23 of file Graph4D.hpp.

Member Function Documentation

◆ addPoint()

void OpenMPCD::Graph4D::addPoint ( const FP  w,
const FP  x,
const FP  y,
const FP  z 
)
inline

Adds a data point.

Parameters
[in]wThe w coordinate.
[in]xThe x coordinate.
[in]yThe y coordinate.
[in]zThe z coordinate.

Definition at line 34 of file Graph4D.hpp.

◆ getPoints()

const Container& OpenMPCD::Graph4D::getPoints ( ) const
inline

Returns the data points.

Definition at line 42 of file Graph4D.hpp.

◆ save()

void OpenMPCD::Graph4D::save ( const std::string &  path) const

Saves the graph data to the given file path.

Parameters
[in]pathThe file path to save to.

Definition at line 6 of file Graph4D.cpp.


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