#include <StirlingCoolerDevice.h>

Inheritance diagram for Basda::Tempo::StirlingCoolerDevice:

Collaboration diagram for Basda::Tempo::StirlingCoolerDevice:

Public Types
typedef ::Basda::DeviceAsync	DeviceAsync

typedef ::Basda::DeviceAsync	DeviceAsync

Public Member Functions
	StirlingCoolerDevice (const Nice::JointPtr &config)

virtual	~StirlingCoolerDevice ()

virtual void	open (void)
	function to open the connection to the device. More...

virtual void	close (void)
	function to close the connection to the device. More...

virtual void	reset (DeviceAsync &=::Basda::Device::s_async)
	function to reset the device. More...

virtual void	init (DeviceAsync &=Basda::Device::s_async)
	function to init the device. More...

virtual void	deinit (DeviceAsync &=::Basda::Device::s_async)
	function to deinit the device. More...

virtual void	activate (DeviceAsync &=::Basda::Device::s_async)
	activate the device More...

virtual void	deactivate (DeviceAsync &=::Basda::Device::s_async)
	deactivate the device More...

virtual void	version ()
	return the library version More...

virtual void	updateProperties ()
	updates the device's properties cyclicly More...

virtual bool	isReachable ()
	function to check whether the device is reachable or not More...

virtual void	setPIDvaluePC1 (const int loop, const double &valueC1)

virtual void	setPIDvalueIC2 (const int loop, const double &valueC2)

virtual void	setPIDvalueDC3 (const int loop, const double &valueC3)

virtual void	setPIDvalueTsample (const double &valueTsample)

virtual void	setDefrostTemperature (const double &defrost)

virtual void	setDefrostStopTemperature (const double &defroststop)

virtual void	setSetpoint (const int loop, const double &setpoint)

virtual void	setFanRotation (const int &fanrpm)

	StirlingCoolerDevice (const Nice::JointPtr &config)

virtual	~StirlingCoolerDevice ()

virtual void	open (void)
	function to open the connection to the device. More...

virtual void	close (void)
	function to close the connection to the device. More...

virtual void	reset (DeviceAsync &=::Basda::Device::s_async)
	function to reset the device. More...

virtual void	init (DeviceAsync &=Basda::Device::s_async)
	function to init the device. More...

virtual void	deinit (DeviceAsync &=::Basda::Device::s_async)
	function to deinit the device. More...

virtual void	activate (DeviceAsync &=::Basda::Device::s_async)
	activate the device More...

virtual void	deactivate (DeviceAsync &=::Basda::Device::s_async)
	deactivate the device More...

virtual void	version ()
	return the library version More...

virtual void	updateProperties ()
	updates the device's properties cyclicly More...

virtual bool	isReachable ()
	function to check whether the device is reachable or not More...

virtual void	setPIDvaluePC1 (const int loop, const double &valueC1)

virtual void	setPIDvalueIC2 (const int loop, const double &valueC2)

virtual void	setPIDvalueDC3 (const int loop, const double &valueC3)

virtual void	setPIDvalueTsample (const double &valueTsample)

virtual void	setDefrostTemperature (const double &defrost)

virtual void	setDefrostStopTemperature (const double &defroststop)

virtual void	setSetpoint (const int loop, const double &setpoint)

virtual void	setFanRotation (const int &fanrpm)

Public Member Functions inherited from Basda::Tempo::CoolerDevice
	CoolerDevice (const Nice::JointPtr &config)

virtual	~CoolerDevice ()

	CoolerDevice (const Nice::JointPtr &config)

virtual	~CoolerDevice ()

	CoolerDevice (const Nice::JointPtr &config)

virtual	~CoolerDevice ()

Public Member Functions inherited from Basda::Tempo::PidDevice
	PidDevice (const Nice::JointPtr &config)

virtual	~PidDevice ()

	PidDevice (const Nice::JointPtr &config)

virtual	~PidDevice ()

	PidDevice (const Nice::JointPtr &config)

virtual	~PidDevice ()

Public Member Functions inherited from Basda::Tempo::TempoDevice
	TempoDevice (const Nice::JointPtr &config)

virtual	~TempoDevice ()

	TempoDevice (const Nice::JointPtr &config)

virtual	~TempoDevice ()

	TempoDevice (const Nice::JointPtr &config)

virtual	~TempoDevice ()

Public Member Functions inherited from Basda::Device
	Device (const Nice::JointPtr &_config)
	constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...

virtual	~Device ()
	destructor Does nothing More...

virtual void	setConfig (const Nice::JointPtr &_config)
	init with config tree ptr More...

Nice::JointPtr &	config ()
	retrieve the property tree More...

std::string &	name ()
	retrieve the name set at ctor time. More...

	Device (const Nice::JointPtr &_config)
	constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...

virtual	~Device ()
	destructor Does nothing More...

virtual void	setConfig (const Nice::JointPtr &_config)
	init with config tree ptr More...

Nice::JointPtr &	config ()
	retrieve the property tree More...

std::string &	name ()
	retrieve the name set at ctor time. More...

Protected Attributes
Basda::Tempo::stirlingData	m_data

Protected Attributes inherited from Basda::Device
Nice::JointPtr	m_config

Nice::JointPtr	m_cfg

Nice::JointPtr	m_var

std::string	m_name

Private Member Functions
void	setReachable (const bool state)
	function to set the reachable flag More...

void	setPropertiesToUnknown ()
	set related properties to "unknown" in case of error case More...

void	handleErrors ()
	method to handle error cases More...

void	queryDataFromStirlingCooler ()
	query from the Stirling cooler the current status and parameters More...

void	initStirlingData ()
	initializes the internally stored data for the cooler More...

void	setReachable (const bool state)
	function to set the reachable flag More...

void	setPropertiesToUnknown ()
	set related properties to "unknown" in case of error case More...

void	handleErrors ()
	method to handle error cases More...

void	queryDataFromStirlingCooler ()
	query from the Stirling cooler the current status and parameters More...

void	initStirlingData ()
	initializes the internally stored data for the cooler More...

Private Attributes
Basda::Tempo::HitachiHighProtocolPtr	m_stirling
	instance of the Stirling (Hitachi H-protocol) driver class More...

std::string	m_connection
	stores the connection address of the device currently connected to More...

IceUtil::RecMutex	m_syncMutex

bool	m_isReachable
	reachable flag More...

Additional Inherited Members
Static Public Attributes inherited from Basda::Device
static DeviceAsyncImpl	s_async

Member Typedef Documentation

◆ DeviceAsync [1/2]

typedef ::Basda::DeviceAsync Basda::Tempo::StirlingCoolerDevice::DeviceAsync

◆ DeviceAsync [2/2]

typedef ::Basda::DeviceAsync Basda::Tempo::StirlingCoolerDevice::DeviceAsync

Constructor & Destructor Documentation

◆ StirlingCoolerDevice() [1/2]

Basda::Tempo::StirlingCoolerDevice::StirlingCoolerDevice ( const Nice::JointPtr & config )

◆ ~StirlingCoolerDevice() [1/2]

Basda::Tempo::StirlingCoolerDevice::~StirlingCoolerDevice ( )

virtual

◆ StirlingCoolerDevice() [2/2]

Basda::Tempo::StirlingCoolerDevice::StirlingCoolerDevice ( const Nice::JointPtr & config )

◆ ~StirlingCoolerDevice() [2/2]

virtual Basda::Tempo::StirlingCoolerDevice::~StirlingCoolerDevice ( )

virtual

Member Function Documentation

◆ activate() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::activate ( DeviceAsync & = ::Basda::Device::s_async )

inlinevirtual

activate the device

Implements Basda::Device.

◆ activate() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::activate ( DeviceAsync & = ::Basda::Device::s_async )

inlinevirtual

activate the device

Implements Basda::Device.

◆ close() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::close ( void )

virtual

function to close the connection to the device.

Implements Basda::Device.

◆ close() [2/2]

void Basda::Tempo::StirlingCoolerDevice::close ( void )

virtual

function to close the connection to the device.

Implements Basda::Device.

◆ deactivate() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::deactivate ( DeviceAsync & = ::Basda::Device::s_async )

inlinevirtual

deactivate the device

Implements Basda::Device.

◆ deactivate() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::deactivate ( DeviceAsync & = ::Basda::Device::s_async )

inlinevirtual

deactivate the device

Implements Basda::Device.

◆ deinit() [1/2]

void Basda::Tempo::StirlingCoolerDevice::deinit ( DeviceAsync & deviceAsync = ::Basda::Device::s_async )

virtual

function to deinit the device.

Implements Basda::Device.

◆ deinit() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::deinit ( DeviceAsync & = ::Basda::Device::s_async )

virtual

function to deinit the device.

Implements Basda::Device.

◆ handleErrors() [1/2]

void Basda::Tempo::StirlingCoolerDevice::handleErrors ( )

private

method to handle error cases

◆ handleErrors() [2/2]

void Basda::Tempo::StirlingCoolerDevice::handleErrors ( )

private

method to handle error cases

◆ init() [1/2]

void Basda::Tempo::StirlingCoolerDevice::init ( DeviceAsync & deviceAsync = Basda::Device::s_async )

virtual

function to init the device.

Implements Basda::Device.

◆ init() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::init ( DeviceAsync & = Basda::Device::s_async )

virtual

function to init the device.

Implements Basda::Device.

◆ initStirlingData() [1/2]

void Basda::Tempo::StirlingCoolerDevice::initStirlingData ( )

private

initializes the internally stored data for the cooler

◆ initStirlingData() [2/2]

void Basda::Tempo::StirlingCoolerDevice::initStirlingData ( )

private

initializes the internally stored data for the cooler

◆ isReachable() [1/2]

virtual bool Basda::Tempo::StirlingCoolerDevice::isReachable ( )

virtual

function to check whether the device is reachable or not

Returns: true if reachable, false otherwise

Implements Basda::Tempo::TempoDevice.

◆ isReachable() [2/2]

bool Basda::Tempo::StirlingCoolerDevice::isReachable ( )

virtual

function to check whether the device is reachable or not

Returns: true if reachable, false otherwise

Implements Basda::Tempo::TempoDevice.

◆ open() [1/2]

void Basda::Tempo::StirlingCoolerDevice::open ( void )

virtual

function to open the connection to the device.

Implements Basda::Device.

◆ open() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::open ( void )

virtual

function to open the connection to the device.

Implements Basda::Device.

◆ queryDataFromStirlingCooler() [1/2]

void Basda::Tempo::StirlingCoolerDevice::queryDataFromStirlingCooler ( )

private

query from the Stirling cooler the current status and parameters

◆ queryDataFromStirlingCooler() [2/2]

void Basda::Tempo::StirlingCoolerDevice::queryDataFromStirlingCooler ( )

private

query from the Stirling cooler the current status and parameters

◆ reset() [1/2]

void Basda::Tempo::StirlingCoolerDevice::reset ( DeviceAsync & deviceAsync = ::Basda::Device::s_async )

virtual

function to reset the device.

Implements Basda::Device.

◆ reset() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::reset ( DeviceAsync & = ::Basda::Device::s_async )

virtual

function to reset the device.

Implements Basda::Device.

◆ setDefrostStopTemperature() [1/2]

void Basda::Tempo::StirlingCoolerDevice::setDefrostStopTemperature ( const double & defroststop )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setDefrostStopTemperature() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setDefrostStopTemperature ( const double & defroststop )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setDefrostTemperature() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setDefrostTemperature ( const double & defrost )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setDefrostTemperature() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setDefrostTemperature ( const double & defrost )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setFanRotation() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setFanRotation ( const int & fanrpm )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setFanRotation() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setFanRotation ( const int & fanrpm )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setPIDvalueDC3() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setPIDvalueDC3	(	const int	loop,
		const double &	valueC3
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvalueDC3() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setPIDvalueDC3	(	const int	loop,
		const double &	valueC3
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvalueIC2() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setPIDvalueIC2	(	const int	loop,
		const double &	valueC2
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvalueIC2() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setPIDvalueIC2	(	const int	loop,
		const double &	valueC2
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvaluePC1() [1/2]

void Basda::Tempo::StirlingCoolerDevice::setPIDvaluePC1	(	const int	loop,
		const double &	valueC1
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvaluePC1() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setPIDvaluePC1	(	const int	loop,
		const double &	valueC1
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setPIDvalueTsample() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setPIDvalueTsample ( const double & valueTsample )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setPIDvalueTsample() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setPIDvalueTsample ( const double & valueTsample )

virtual

Implements Basda::Tempo::CoolerDevice.

◆ setPropertiesToUnknown() [1/2]

void Basda::Tempo::StirlingCoolerDevice::setPropertiesToUnknown ( )

private

set related properties to "unknown" in case of error case

◆ setPropertiesToUnknown() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setPropertiesToUnknown ( )

private

set related properties to "unknown" in case of error case

◆ setReachable() [1/2]

void Basda::Tempo::StirlingCoolerDevice::setReachable ( const bool state )

private

function to set the reachable flag

◆ setReachable() [2/2]

void Basda::Tempo::StirlingCoolerDevice::setReachable ( const bool state )

private

function to set the reachable flag

◆ setSetpoint() [1/2]

void Basda::Tempo::StirlingCoolerDevice::setSetpoint	(	const int	loop,
		const double &	setpoint
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ setSetpoint() [2/2]

virtual void Basda::Tempo::StirlingCoolerDevice::setSetpoint	(	const int	loop,
		const double &	setpoint
	)

virtual

Implements Basda::Tempo::PidDevice.

◆ updateProperties() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::updateProperties ( )

virtual

updates the device's properties cyclicly

Implements Basda::Tempo::TempoDevice.

◆ updateProperties() [2/2]

void Basda::Tempo::StirlingCoolerDevice::updateProperties ( )

virtual

updates the device's properties cyclicly

Implements Basda::Tempo::TempoDevice.

◆ version() [1/2]

virtual void Basda::Tempo::StirlingCoolerDevice::version ( )

virtual

return the library version

Implements Basda::Device.

◆ version() [2/2]

void Basda::Tempo::StirlingCoolerDevice::version ( void )

virtual

return the library version

Implements Basda::Device.

Member Data Documentation

◆ m_connection

std::string Basda::Tempo::StirlingCoolerDevice::m_connection

private

stores the connection address of the device currently connected to

◆ m_data

Basda::Tempo::stirlingData Basda::Tempo::StirlingCoolerDevice::m_data

protected

◆ m_isReachable

bool Basda::Tempo::StirlingCoolerDevice::m_isReachable

private

reachable flag

◆ m_stirling

Basda::Tempo::HitachiHighProtocolPtr Basda::Tempo::StirlingCoolerDevice::m_stirling

private

instance of the Stirling (Hitachi H-protocol) driver class

◆ m_syncMutex

IceUtil::RecMutex Basda::Tempo::StirlingCoolerDevice::m_syncMutex

private

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

TwiceAsNice/basda-tempo/doc/include/StirlingCoolerDevice.h
TwiceAsNice/basda-tempo/doc/include/StirlingCoolerDevice.cpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ DeviceAsync [1/2]

◆ DeviceAsync [2/2]

Constructor & Destructor Documentation

◆ StirlingCoolerDevice() [1/2]

◆ ~StirlingCoolerDevice() [1/2]

◆ StirlingCoolerDevice() [2/2]

◆ ~StirlingCoolerDevice() [2/2]

Member Function Documentation

◆ activate() [1/2]

◆ activate() [2/2]

◆ close() [1/2]

◆ close() [2/2]

◆ deactivate() [1/2]

◆ deactivate() [2/2]

◆ deinit() [1/2]

◆ deinit() [2/2]

◆ handleErrors() [1/2]

◆ handleErrors() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ initStirlingData() [1/2]

◆ initStirlingData() [2/2]

◆ isReachable() [1/2]

◆ isReachable() [2/2]

◆ open() [1/2]

◆ open() [2/2]

◆ queryDataFromStirlingCooler() [1/2]

◆ queryDataFromStirlingCooler() [2/2]

◆ reset() [1/2]

◆ reset() [2/2]

◆ setDefrostStopTemperature() [1/2]

◆ setDefrostStopTemperature() [2/2]

◆ setDefrostTemperature() [1/2]

◆ setDefrostTemperature() [2/2]

◆ setFanRotation() [1/2]

◆ setFanRotation() [2/2]

◆ setPIDvalueDC3() [1/2]

◆ setPIDvalueDC3() [2/2]

◆ setPIDvalueIC2() [1/2]

◆ setPIDvalueIC2() [2/2]

◆ setPIDvaluePC1() [1/2]

◆ setPIDvaluePC1() [2/2]

◆ setPIDvalueTsample() [1/2]

◆ setPIDvalueTsample() [2/2]

◆ setPropertiesToUnknown() [1/2]

◆ setPropertiesToUnknown() [2/2]

◆ setReachable() [1/2]

◆ setReachable() [2/2]

◆ setSetpoint() [1/2]

◆ setSetpoint() [2/2]

◆ updateProperties() [1/2]

◆ updateProperties() [2/2]

◆ version() [1/2]

◆ version() [2/2]

Member Data Documentation

◆ m_connection

◆ m_data

◆ m_isReachable

◆ m_stirling

◆ m_syncMutex