TwiceAsNice  2019-02-18
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Basda::TempoDeviceMSXBOXDelay Class Reference

the class used to implement the device part of the MSXBOX Delay Generator More...

#include <DeviceMSXBOXDelay.h>

Inheritance diagram for Basda::TempoDeviceMSXBOXDelay:
Inheritance graph
Collaboration diagram for Basda::TempoDeviceMSXBOXDelay:
Collaboration graph

Public Member Functions

 TempoDeviceMSXBOXDelay (const Nice::JointPtr &_config)
 constructor More...
 
virtual ~TempoDeviceMSXBOXDelay ()
 virtual destructor More...
 
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 (Basda::DeviceAsync &=Basda::Device::s_async)
 function to reset the device More...
 
virtual void init (Basda::DeviceAsync &=Basda::Device::s_async)
 function to init the device More...
 
virtual void deinit (Basda::DeviceAsync &=Basda::Device::s_async)
 function to deinit the device More...
 
virtual void version (void)
 function to get the version More...
 
virtual Basda::TempoDeviceDataVector read (void)
 function to read out values More...
 
virtual Nice::JointPtrVectordescription (void)
 function to read the description More...
 
- Public Member Functions inherited from Basda::TempoDevice
 TempoDevice (const Nice::JointPtr &_config)
 
virtual Basda::TempoSeqData readTemp ()=0
 read the device More...
 
virtual Nice::JointPtrVectordescriptionTemp ()=0
 read description More...
 
 TempoDevice (const Nice::JointPtr &_config)
 
virtual Basda::TempoSeqData readTemp ()=0
 read the device More...
 
virtual Nice::JointPtrVectordescriptionTemp ()=0
 read description More...
 
 TempoDevice (const Nice::JointPtr &_config)
 
virtual Basda::TempoSeqData readTemp ()=0
 read the device More...
 
virtual Nice::JointPtrVectordescriptionTemp ()=0
 read description More...
 
- 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::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device 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::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device More...
 

Protected Attributes

Nice::JointPtrVector m_partNodes
 vector containing the children More...
 
- 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 set_Parameters_A (double fire, unsigned long mod, unsigned long go, unsigned long offset)
 function to set the Parameters of the delay channels More...
 
void set_Parameters_B (double fire, unsigned long mod, unsigned long go, unsigned long offset)
 
void set_Parameters_T0 (double fire, unsigned long mod, unsigned long go, unsigned long offset)
 
void set_Parameters_CD (unsigned long pulse, unsigned long output_level, bool gate, unsigned long gate_func)
 function to set the control data parameters More...
 
void set_Parameters_TD (unsigned long msbus, bool clock_enable, bool trigger_enable)
 function to set the trigger data parameters More...
 

Private Attributes

std::string m_conAdr
 stores the address (endpoint) of the MSXBOX More...
 
unsigned long m_maxDelayGenerators
 stores the maximum number of delay generators supported More...
 
unsigned long m_numberDelayGenerator
 stores the number of his delay generator More...
 
Basda::MSXBOXDelaym_MSXBOX__DG
 the driver instance More...
 

Additional Inherited Members

- Static Public Attributes inherited from Basda::Device
static DeviceAsyncImpl s_async
 

Detailed Description

the class used to implement the device part of the MSXBOX Delay Generator

Constructor & Destructor Documentation

◆ TempoDeviceMSXBOXDelay()

Basda::TempoDeviceMSXBOXDelay::TempoDeviceMSXBOXDelay ( const Nice::JointPtr _config)

constructor

Parameters
_configconfiguration tree

◆ ~TempoDeviceMSXBOXDelay()

virtual Basda::TempoDeviceMSXBOXDelay::~TempoDeviceMSXBOXDelay ( )
inlinevirtual

virtual destructor

Member Function Documentation

◆ close()

void Basda::TempoDeviceMSXBOXDelay::close ( void  )
virtual

function to close the connection to the device.

Implements Basda::Device.

◆ deinit()

void Basda::TempoDeviceMSXBOXDelay::deinit ( Basda::DeviceAsync _async = Basda::Device::s_async)
virtual

function to deinit the device

Implements Basda::Device.

◆ description()

virtual Nice::JointPtrVector& Basda::TempoDeviceMSXBOXDelay::description ( void  )
inlinevirtual

function to read the description

Returns
vector containing all informations

◆ init()

void Basda::TempoDeviceMSXBOXDelay::init ( Basda::DeviceAsync _async = Basda::Device::s_async)
virtual

function to init the device

Implements Basda::Device.

◆ open()

void Basda::TempoDeviceMSXBOXDelay::open ( void  )
virtual

function to open the connection to the device.

Implements Basda::Device.

◆ read()

Basda::TempoDeviceDataVector Basda::TempoDeviceMSXBOXDelay::read ( void  )
virtual

function to read out values

Returns
data vector containing the readings

◆ reset()

void Basda::TempoDeviceMSXBOXDelay::reset ( Basda::DeviceAsync _async = Basda::Device::s_async)
virtual

function to reset the device

Implements Basda::Device.

◆ set_Parameters_A()

void Basda::TempoDeviceMSXBOXDelay::set_Parameters_A ( double  fire,
unsigned long  mod,
unsigned long  go,
unsigned long  offset 
)
private

function to set the Parameters of the delay channels

Parameters
firethe delay for that channel
modthe output modulo for that channel
gothe go signal for the channel
offsetthe offset to be applied to the channel

◆ set_Parameters_B()

void Basda::TempoDeviceMSXBOXDelay::set_Parameters_B ( double  fire,
unsigned long  mod,
unsigned long  go,
unsigned long  offset 
)
private

◆ set_Parameters_CD()

void Basda::TempoDeviceMSXBOXDelay::set_Parameters_CD ( unsigned long  pulse,
unsigned long  output_level,
bool  gate,
unsigned long  gate_func 
)
private

function to set the control data parameters

Parameters
pulsethe pulse width
output_levelthe output voltage level
gateTrue enables a gate function
gate_functhe gate function to be applied

◆ set_Parameters_T0()

void Basda::TempoDeviceMSXBOXDelay::set_Parameters_T0 ( double  fire,
unsigned long  mod,
unsigned long  go,
unsigned long  offset 
)
private

◆ set_Parameters_TD()

void Basda::TempoDeviceMSXBOXDelay::set_Parameters_TD ( unsigned long  msbus,
bool  clock_enable,
bool  trigger_enable 
)
private

function to set the trigger data parameters

Parameters
msbusthe signal to apply to the master/slave bus
clock_enableTrue enables the clock
trigger_enableTrue enables the triggering

◆ version()

void Basda::TempoDeviceMSXBOXDelay::version ( void  )
virtual

function to get the version

Implements Basda::Device.

Member Data Documentation

◆ m_conAdr

std::string Basda::TempoDeviceMSXBOXDelay::m_conAdr
private

stores the address (endpoint) of the MSXBOX

◆ m_maxDelayGenerators

unsigned long Basda::TempoDeviceMSXBOXDelay::m_maxDelayGenerators
private

stores the maximum number of delay generators supported

◆ m_MSXBOX__DG

Basda::MSXBOXDelay* Basda::TempoDeviceMSXBOXDelay::m_MSXBOX__DG
private

the driver instance

◆ m_numberDelayGenerator

unsigned long Basda::TempoDeviceMSXBOXDelay::m_numberDelayGenerator
private

stores the number of his delay generator

◆ m_partNodes

Nice::JointPtrVector Basda::TempoDeviceMSXBOXDelay::m_partNodes
protected

vector containing the children


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