axom::klee::Shape Class Reference

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

Public Member Functions
	Shape (std::string name, std::string material, std::vector< std::string > materialsReplaced, std::vector< std::string > materialsNotReplaced, Geometry geometry)
const std::string &	getName () const
const std::string &	getMaterial () const
bool	replaces (const std::string &material) const
const Geometry &	getGeometry () const
const std::vector< std::string > &	getMaterialsReplaced () const
const std::vector< std::string > &	getMaterialsNotReplaced () const

Detailed Description

A Shape describes a region of space, a material it is made of, and a list of materials which it does/doesn't replace.

Constructor & Destructor Documentation

Shape()

axom::klee::Shape::Shape	(	std::string	name,
		std::string	material,
		std::vector< std::string >	materialsReplaced,
		std::vector< std::string >	materialsNotReplaced,
		Geometry	geometry
	)

Create a new Shape.

Parameters

name	the name of the shape
material	the shape's material.
materialsReplaced	the materials which can be replaced. If empty, all materials can be replaced unless materialsNotReplaced is set.
materialsNotReplaced	the materials which cannot be replaced. If empty, all materials can be replaced unless materialsReplaced is set.
geometry	the geometric properties of this shape

Exceptions

std::logic_error

if both materialsReplaced and materialsNotReplaced have entries.

Member Function Documentation

getName()

const std::string& axom::klee::Shape::getName ( ) const

inline

Get the name of this shape.

Returns

the shape's name

getMaterial()

const std::string& axom::klee::Shape::getMaterial ( ) const

inline

Get the material this shape is made of.

Returns

the shape's material.

replaces()

bool axom::klee::Shape::replaces

(

const std::string &

material

)

const

Check whether this shape can replace the given material (within the space defined by this shape).

Parameters

material

the material to check

Returns

whether this shape replaces the given material

getGeometry()

const Geometry& axom::klee::Shape::getGeometry ( ) const

inline

Get the description fo the geometry for this shape.

Returns

the shape's geometry

getMaterialsReplaced()

const std::vector<std::string>& axom::klee::Shape::getMaterialsReplaced ( ) const

inline

Get the vector of materials that this shape can replace.

Returns

A reference to the material name vector.

getMaterialsNotReplaced()

const std::vector<std::string>& axom::klee::Shape::getMaterialsNotReplaced ( ) const

inline

Get the vector of materials that this shape cannot replace.

Returns

A reference to the material name vector.

---

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

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