axom::klee::ShapeSet Class Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/ShapeSet.hpp>

Public Member Functions
void	setShapes (std::vector< Shape > shapes)
std::vector< Shape > const &	getShapes () const
void	setPath (const std::string &path)
const std::string &	getPath () const
std::string	resolvePath (const std::string &filePath) const
void	setDimensions (Dimensions dimensions)
Dimensions	getDimensions () const

Detailed Description

A ShapeSet represents a document in the common shape format.

Member Function Documentation

setShapes()

void axom::klee::ShapeSet::setShapes

(

std::vector< Shape >

shapes

)

Set the shapes in this set.

Parameters

shapes

all the shapes in this set

getShapes()

std::vector<Shape> const& axom::klee::ShapeSet::getShapes ( ) const

inline

Get the shapes in this set.

Returns

the shapes in this set

setPath()

void axom::klee::ShapeSet::setPath

(

const std::string &

path

)

Set the file path from which this ShapeSet was created. This must be set for resolvePath() to work.

Parameters

path	the ShapeSet's path

getPath()

const std::string& axom::klee::ShapeSet::getPath ( ) const

inline

Get the path of the file from which this ShapeSet was created.

Returns

the path of the file. Can be empty.

resolvePath()

std::string axom::klee::ShapeSet::resolvePath

(

const std::string &

filePath

)

const

Resolves a path relative to the path of this ShapeSet.

Parameters

filePath

the path to resolve

Returns

if the given path is absolute, then the given path. Otherwise, the path is interpreted as being relative to the directory containing this ShapeSet, and that is is returned.

setDimensions()

void axom::klee::ShapeSet::setDimensions

(

Dimensions

dimensions

)

Sets the dimensions for all shapes in the ShapeSet.

Parameters

dimensions

the dimension for all the shapes

Note

This function must be called before calling getDimensions()

getDimensions()

Dimensions axom::klee::ShapeSet::getDimensions

(

)

const

Returns the dimension of the ShapeSet.

Precondition

Only valid after setDimensions() has been called on this instance

See also

setDimensions()

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/ShapeSet.hpp