axom::sina::Curve Class Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sina/core/Curve.hpp>

Public Member Functions
	Curve (std::string name, std::vector< double > values)
	Create a Curve with the given name and values. More...
	Curve (std::string name, double const *values, std::size_t numValues)
	Create a Curve with the given name and values. More...
	Curve (std::string name, conduit::Node const &curveAsNode)
	Create a Curve by deserializing a conduit node. More...
std::string const &	getName () const
	Get the curve's name. More...
std::vector< double > const &	getValues () const
	Get the values of the curve. More...
void	setUnits (std::string units)
	Set the units of the values. More...
std::string const &	getUnits () const
	Get the units of the values. More...
void	setTags (std::vector< std::string > tags)
	Set the tags for this curve. More...
std::vector< std::string > const &	getTags () const
	Get the tags for this curve. More...
conduit::Node	toNode () const
	Convert this curve to a Conduit node. More...

Detailed Description

A Curve represents a 1-dimensional curve inside a CurveSet.

Constructor & Destructor Documentation

Curve() [1/3]

axom::sina::Curve::Curve	(	std::string	name,
		std::vector< double >	values
	)

Create a Curve with the given name and values.

Parameters

name	the name of the curve
values	the curve's values

Curve() [2/3]

axom::sina::Curve::Curve	(	std::string	name,
		double const *	values,
		std::size_t	numValues
	)

Create a Curve with the given name and values.

Parameters

name	the name of the curve
values	the curve's values
numValues	the number of values.

Curve() [3/3]

axom::sina::Curve::Curve	(	std::string	name,
		conduit::Node const &	curveAsNode
	)

Create a Curve by deserializing a conduit node.

Parameters

name	the name of the curve
curveAsNode	the serialized version of a curve

Member Function Documentation

getName()

std::string const& axom::sina::Curve::getName ( ) const

inline

Get the curve's name.

Returns

the curve's name

getValues()

std::vector<double> const& axom::sina::Curve::getValues ( ) const

inline

Get the values of the curve.

Returns

the curve's values

setUnits()

void axom::sina::Curve::setUnits

(

std::string

units

)

Set the units of the values.

Parameters

units

the value's units

getUnits()

std::string const& axom::sina::Curve::getUnits ( ) const

inline

Get the units of the values.

Returns

the value's units

setTags()

void axom::sina::Curve::setTags

(

std::vector< std::string >

tags

)

Set the tags for this curve.

Parameters

tags	the curve's tags

getTags()

std::vector<std::string> const& axom::sina::Curve::getTags ( ) const

inline

Get the tags for this curve.

Returns

the curve's tags

toNode()

conduit::Node axom::sina::Curve::toNode

(

)

const

Convert this curve to a Conduit node.

Returns

a Conduit representation of this curve

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sina/core/Curve.hpp