Momentum Scripting v1
Loading...
Searching...
No Matches
MOMENTUM_NAMESPACE::ConveyorBelt Class Reference

#include <ConveyorBelt.h>

Public Member Functions

std::shared_ptr< GeometrygetGeometry () const
 
std::string getName () const
 
double getSpeed () const
 
void setSpeed (double speed)
 

Detailed Description

A class that encapsulates the Conveyor Belt objects in the simulation.

Member Function Documentation

◆ getGeometry()

std::shared_ptr< Geometry > MOMENTUM_NAMESPACE::ConveyorBelt::getGeometry ( ) const

Get the Geometry that the Conveyor Belt is based on.

Returns
The geometry that the Conveyor Belt is based on

◆ getName()

std::string MOMENTUM_NAMESPACE::ConveyorBelt::getName ( ) const

Get the name of the ConveyorBelt.

Returns
the name of the ConveyorBelt

◆ getSpeed()

double MOMENTUM_NAMESPACE::ConveyorBelt::getSpeed ( ) const

Get the speed of the Conveyor Belt.

Note
The unit of the speed is in m/s
Returns
The speed of the Conveyor Belt

◆ setSpeed()

void MOMENTUM_NAMESPACE::ConveyorBelt::setSpeed ( double  speed)

Set the speed of the Conveyor Belt.

Note
The unit of the mass flow is m/s
Parameters
speed- The speed of the Conveyor Belt.

Only available in simulation mode