chrono::sensor::ChFilterSave Class Reference

Description

A filter that, when applied to a sensor, saves the data as an image.

#include <ChFilterSave.h>

Inheritance diagram for chrono::sensor::ChFilterSave:
Collaboration diagram for chrono::sensor::ChFilterSave:

Public Member Functions

 ChFilterSave (std::string data_path="", std::string name="ChFilterSave")
 Class constructor. More...
 
virtual ~ChFilterSave ()
 Class destructor.
 
virtual void Apply ()
 Apply function. Saves image data.
 
virtual void Initialize (std::shared_ptr< ChSensor > pSensor, std::shared_ptr< SensorBuffer > &bufferInOut)
 Initializes all data needed by the filter access apply function. More...
 
- Public Member Functions inherited from chrono::sensor::ChFilter
virtual ~ChFilter ()
 Virtual class desctructor.
 
std::string & Name ()
 Accesses the name of the filter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from chrono::sensor::ChFilter
 ChFilter (std::string name)
 protected constructor for the filter which requires a name as input. More...
 
void InvalidFilterGraphNullBuffer (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: null buffer found.
 
void InvalidFilterGraphBufferTypeMismatch (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: type mismatch in graph.
 
void InvalidFilterGraphSensorTypeMismatch (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: type mismatch in graph.
 

Constructor & Destructor Documentation

◆ ChFilterSave()

CH_SENSOR_API chrono::sensor::ChFilterSave::ChFilterSave ( std::string  data_path = "",
std::string  name = "ChFilterSave" 
)

Class constructor.

Parameters
data_pathThe path to save the data
namethe name of the filter

Member Function Documentation

◆ Initialize()

CH_SENSOR_API void chrono::sensor::ChFilterSave::Initialize ( std::shared_ptr< ChSensor pSensor,
std::shared_ptr< SensorBuffer > &  bufferInOut 
)
virtual

Initializes all data needed by the filter access apply function.

Parameters
pSensorA pointer to the sensor on which the filter is attached.
bufferInOutA buffer that is passed into the filter.

Implements chrono::sensor::ChFilter.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterSave.h
  • /builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterSave.cpp