MOMENTUM_NAMESPACE::Sensor Class Reference

#include <Sensor.h>

Public Member Functions
bool	getEnable () const
GeometryPtr	getGeometry () const
std::string	getName () const
unsigned int	getNumRemovedBodies () const
unsigned int	getNumRemovedParticles () const
std::vector< unsigned int >	getParticlesContactingIds () const
std::vector< unsigned int >	getParticlesInsideIds () const
double	getRemovedBodyMass () const
double	getRemovedParticleMass () const
double	getTotalRemovedMass () const
void	setEnable (bool enable)

Detailed Description

A class that encapsulated the Sensor objects in the simulation that manipulates contacting GranularBodies with different operations.

Member Function Documentation

getEnable()

bool MOMENTUM_NAMESPACE::Sensor::getEnable

(

)

const

Returns

the enable flag to set on the Sensor.

getGeometry()

GeometryPtr MOMENTUM_NAMESPACE::Sensor::getGeometry

(

)

const

Returns

the Geometry object coupled to the sensor.

getName()

std::string MOMENTUM_NAMESPACE::Sensor::getName

(

)

const

Get the name of the Sensor.

Returns

the name of the Sensor.

getNumRemovedBodies()

unsigned int MOMENTUM_NAMESPACE::Sensor::getNumRemovedBodies

(

)

const

Returns

the number of removed rigid bodies by the sensor.

getNumRemovedParticles()

unsigned int MOMENTUM_NAMESPACE::Sensor::getNumRemovedParticles

(

)

const

Returns

the number of removed particles by the sensor.

getParticlesContactingIds()

std::vector< unsigned int > MOMENTUM_NAMESPACE::Sensor::getParticlesContactingIds

(

)

const

Returns

vector with ids of particles in contact with sensor.

getParticlesInsideIds()

std::vector< unsigned int > MOMENTUM_NAMESPACE::Sensor::getParticlesInsideIds

(

)

const

Returns

vector with ids of granular bodies that have their middle point inside the sensor.

getRemovedBodyMass()

double MOMENTUM_NAMESPACE::Sensor::getRemovedBodyMass

(

)

const

Returns

the amount of Rigid Body mass removed by the sensor.

getRemovedParticleMass()

double MOMENTUM_NAMESPACE::Sensor::getRemovedParticleMass

(

)

const

Returns

the amount of particle mass removed by the sensor.

getTotalRemovedMass()

double MOMENTUM_NAMESPACE::Sensor::getTotalRemovedMass

(

)

const

Returns

the total amount of mass removed from the sensor.

setEnable()

void MOMENTUM_NAMESPACE::Sensor::setEnable

(

bool

enable

)

Set enable of the Sensor.

Parameters

enable

- the enable flag to set on the Sensor.