Misc Relacs Plugins  0.9.8
Public Member Functions | Friends | List of all members
Kleindiek Class Reference

#include <kleindiek.h>

Inheritance diagram for Kleindiek:
Inheritance graph
[legend]
Collaboration diagram for Kleindiek:
Collaboration graph
[legend]

Public Member Functions

 Kleindiek (const string &device)
 
 Kleindiek (void)
 
 ~Kleindiek (void)
 
virtual int open (const string &device) override
 
virtual bool isOpen (void) const
 
virtual void close (void)
 
virtual int reset (void)
 
virtual int stepX (double x)
 
virtual int stepY (double y)
 
virtual int stepZ (double z)
 
virtual double posX (void) const
 
virtual double posY (void) const
 
virtual double posZ (void) const
 
virtual int clearX (void)
 
virtual int clearY (void)
 
virtual int clearZ (void)
 
virtual int clear (void)
 
virtual int homeX (void)
 
virtual int homeY (void)
 
virtual int homeZ (void)
 
virtual int home (void)
 
virtual int setAmplX (double posampl, double negampl=-1.0)
 
virtual int setAmplY (double posampl, double negampl=-1.0)
 
virtual int setAmplZ (double posampl, double negampl=-1.0)
 
virtual double minAmplX (void) const
 
virtual double maxAmplX (void) const
 
int coarse (int channel, int steps)
 
int pause (int ms)
 
int speed (int channel, int speed)
 
int amplitudepos (int channel, int ampl)
 
int amplitudeneg (int channel, int ampl)
 
int countermode (int channel, long mode)
 
int counterread (void)
 
int counterreset (void)
 
- Public Member Functions inherited from Manipulator
 Manipulator (void)
 
 Manipulator (const string &deviceclass)
 
virtual ~Manipulator (void)
 
virtual double minAmplY (void) const
 
virtual double maxAmplY (void) const
 
virtual double minAmplZ (void) const
 
virtual double maxAmplZ (void) const
 

Friends

ostream & operator<< (ostream &str, const Kleindiek &k)
 

Detailed Description

[Manipulator] The Kleindiek nanotechnik MM3A micromanipulator

Author
Jan Benda
Version
1.0

Constructor & Destructor Documentation

Kleindiek ( const string &  device)

References Kleindiek::open().

Kleindiek ( void  )
~Kleindiek ( void  )

References Kleindiek::close().

Member Function Documentation

int open ( const string &  device)
overridevirtual

Referenced by Kleindiek::Kleindiek().

virtual bool isOpen ( void  ) const
inlinevirtual
void close ( void  )
virtual

References Kleindiek::clear().

Referenced by Kleindiek::~Kleindiek().

int reset ( void  )
virtual
int stepX ( double  x)
virtual

Move x-axis by x. Depending on the implementation x can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

References Kleindiek::coarse().

Referenced by Kleindiek::homeX().

int stepY ( double  y)
virtual

Move y-axis by y. Depending on the implementation y can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

References Kleindiek::coarse().

Referenced by Kleindiek::homeY().

int stepZ ( double  z)
virtual

Move z-axis by z. Depending on the implementation z can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

References Kleindiek::coarse().

Referenced by Kleindiek::homeZ().

double posX ( void  ) const
virtual

Return the position of the z-axis. Depending on the implementation this can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

double posY ( void  ) const
virtual

Return the position of the z-axis. Depending on the implementation this can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

double posZ ( void  ) const
virtual

Return the position of the z-axis. Depending on the implementation this can be raw steps or a specific distance or angle.

Reimplemented from Manipulator.

int clearX ( void  )
virtual

Defines the current position of the x axis as the home position.

Reimplemented from Manipulator.

Referenced by Kleindiek::clear().

int clearY ( void  )
virtual

Defines the current position of the y axis as the home position.

Reimplemented from Manipulator.

Referenced by Kleindiek::clear().

int clearZ ( void  )
virtual

Defines the current position of the z axis as the home position.

Reimplemented from Manipulator.

Referenced by Kleindiek::clear().

int clear ( void  )
virtual

Defines the current position of all axis as the home position.

Reimplemented from Manipulator.

References Kleindiek::clearX(), Kleindiek::clearY(), and Kleindiek::clearZ().

Referenced by Kleindiek::close().

int homeX ( void  )
virtual

Move x axis back to its home position.

Reimplemented from Manipulator.

References Kleindiek::stepX().

Referenced by Kleindiek::home().

int homeY ( void  )
virtual

Move y axis back to its home position.

Reimplemented from Manipulator.

References Kleindiek::stepY().

Referenced by Kleindiek::home().

int homeZ ( void  )
virtual

Move z axis back to its home position.

Reimplemented from Manipulator.

References Kleindiek::stepZ().

Referenced by Kleindiek::home().

int home ( void  )
virtual

Move back to the home position.

Reimplemented from Manipulator.

References Kleindiek::homeX(), Kleindiek::homeY(), and Kleindiek::homeZ().

int setAmplX ( double  posampl,
double  negampl = -1.0 
)
virtual

Set the amplitude of a step of the x-axis to posampl. If negampl >= 0.0 set the negative amplitude to negampl, otherwise set it equal to posampl.

Reimplemented from Manipulator.

References Kleindiek::amplitudeneg(), and Kleindiek::amplitudepos().

int setAmplY ( double  posampl,
double  negampl = -1.0 
)
virtual

Set the amplitude of a step of the y-axis to posampl. If negampl >= 0.0 set the negative amplitude to negampl, otherwise set it equal to posampl.

Reimplemented from Manipulator.

References Kleindiek::amplitudeneg(), and Kleindiek::amplitudepos().

int setAmplZ ( double  posampl,
double  negampl = -1.0 
)
virtual

Set the amplitude of a step of the z-axis to posampl. If negampl >= 0.0 set the negative amplitude to negampl, otherwise set it equal to posampl.

Reimplemented from Manipulator.

References Kleindiek::amplitudeneg(), and Kleindiek::amplitudepos().

double minAmplX ( void  ) const
virtual

The minimum possible amplitude for the x-axis.

Reimplemented from Manipulator.

double maxAmplX ( void  ) const
virtual

The maximum possible amplitude for the x-axis.

Reimplemented from Manipulator.

int coarse ( int  channel,
int  steps 
)
int pause ( int  ms)
int speed ( int  channel,
int  speed 
)
int amplitudepos ( int  channel,
int  ampl 
)
int amplitudeneg ( int  channel,
int  ampl 
)
int countermode ( int  channel,
long  mode 
)
int counterread ( void  )
int counterreset ( void  )

Friends And Related Function Documentation

ostream& operator<< ( ostream &  str,
const Kleindiek k 
)
friend

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