ethercat_hardware::MotorHeatingModelCommon Class Reference

#include <motor_heating_model.h>

List of all members.

Public Member Functions
void	attach (boost::shared_ptr< MotorHeatingModel > model)
	Append model to list of models that need to have temperature data saved.
bool	initialize ()
	MotorHeatingModelCommon (ros::NodeHandle nh)
	Constructor will read motor heating mode settings from node handle namespace.
	MotorHeatingModelCommon ()
	Constructor will use default settings for all parameters.
Public Attributes
bool	disable_halt_
	Disables halting caused by a motor being overtemperature.
bool	enable_model_
	If true, enables motor heating model. If false, motor heating model is run for any devices.
bool	load_save_files_
	If true, then class instances will attempt to load data from a saved temperature file.
bool	publish_temperature_
	If true, each motor heating model with publish state information every 1 second.
std::string	save_directory_
	Directory where temperature save files should be put.
bool	update_save_files_
Protected Member Functions
bool	createSaveDirectory ()
	Creates directory for saved motor heating information.
void	saveThreadFunc ()
	Continuously saves motor heating model state.
Protected Attributes
std::vector< boost::shared_ptr < MotorHeatingModel > >	models_
	List of MotorHeatingModels that need to have file data saved.
boost::mutex	mutex_
	Lock around models list.
boost::thread	save_thread_
	thread that will periodically save temperature data

---

Detailed Description

Definition at line 105 of file motor_heating_model.h.

---

Constructor & Destructor Documentation

ethercat_hardware::MotorHeatingModelCommon::MotorHeatingModelCommon

(

ros::NodeHandle

nh

)

Constructor will read motor heating mode settings from node handle namespace.

Definition at line 76 of file motor_heating_model.cpp.

ethercat_hardware::MotorHeatingModelCommon::MotorHeatingModelCommon

(

)

Constructor will use default settings for all parameters.

Definition at line 119 of file motor_heating_model.cpp.

---

Member Function Documentation

void ethercat_hardware::MotorHeatingModelCommon::attach

(

boost::shared_ptr< MotorHeatingModel >

model

)

Append model to list of models that need to have temperature data saved.

!

Definition at line 131 of file motor_heating_model.cpp.

bool ethercat_hardware::MotorHeatingModelCommon::createSaveDirectory

(

)

[protected]

Creates directory for saved motor heating information.

Definition at line 184 of file motor_heating_model.cpp.

bool ethercat_hardware::MotorHeatingModelCommon::initialize

(

)

Definition at line 140 of file motor_heating_model.cpp.

void ethercat_hardware::MotorHeatingModelCommon::saveThreadFunc

(

)

[protected]

Continuously saves motor heating model state.

Continuously saved motor state information so state of all registered motor heating model objects. This function is run in its own thread so the saveTemperatureState() funcion of each MotorHeatingModel object should perform appropriate locking.

Definition at line 158 of file motor_heating_model.cpp.

---

Member Data Documentation

bool ethercat_hardware::MotorHeatingModelCommon::disable_halt_

Disables halting caused by a motor being overtemperature.

Definition at line 131 of file motor_heating_model.h.

bool ethercat_hardware::MotorHeatingModelCommon::enable_model_

If true, enables motor heating model. If false, motor heating model is run for any devices.

Definition at line 133 of file motor_heating_model.h.

bool ethercat_hardware::MotorHeatingModelCommon::load_save_files_

If true, then class instances will attempt to load data from a saved temperature file.

Definition at line 129 of file motor_heating_model.h.

std::vector< boost::shared_ptr<MotorHeatingModel> > ethercat_hardware::MotorHeatingModelCommon::models_ [protected]

List of MotorHeatingModels that need to have file data saved.

Definition at line 145 of file motor_heating_model.h.

boost::mutex ethercat_hardware::MotorHeatingModelCommon::mutex_ [protected]

Lock around models list.

Definition at line 148 of file motor_heating_model.h.

bool ethercat_hardware::MotorHeatingModelCommon::publish_temperature_

If true, each motor heating model with publish state information every 1 second.

Definition at line 135 of file motor_heating_model.h.

std::string ethercat_hardware::MotorHeatingModelCommon::save_directory_

Directory where temperature save files should be put.

Definition at line 127 of file motor_heating_model.h.

boost::thread ethercat_hardware::MotorHeatingModelCommon::save_thread_ [protected]

thread that will periodically save temperature data

Definition at line 141 of file motor_heating_model.h.

bool ethercat_hardware::MotorHeatingModelCommon::update_save_files_

Directory where motor model haeting data will be saved. Defaults to /var/lib/motor_heating_model If true, then temeperature data to will be periodically saved to file

Definition at line 125 of file motor_heating_model.h.

---

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

• motor_heating_model.h
• motor_heating_model.cpp