Basic Image AlgorithmS Library  2.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
BIAS::IselLinearControlTwoAxis Class Reference

This class controls the Isel iMC-S8 Linear Unit (two axis controll) More...

#include <PanTilt/IselLinearControlTwoAxis.hh>

+ Inheritance diagram for BIAS::IselLinearControlTwoAxis:
+ Collaboration diagram for BIAS::IselLinearControlTwoAxis:

Public Member Functions

void AddDebugLevel (const long int lv)
 
void AddDebugLevel (const std::string &name)
 
void Close ()
 closes the comport stream More...
 
bool DebugLevelIsSet (const long int lv) const
 
bool DebugLevelIsSet (const std::string &name) const
 
void GetAcceleration (int &accel)
 
void GetCurrentPosition (float &millimetersX, float &millimetersY)
 
int GetDebugLevel () const
 
std::ostream & GetDebugStream () const
 
void GetDebugStream (std::ostream &os) const
 
void GetSpeed (float &speedX, float &speedY)
 
int Init (const int nCOMportNumber)
 opens the serial port and initialises unit More...
 
int Init (const char *COMportName)
 opens the given port and initialises unit More...
 
 IselLinearControlTwoAxis ()
 standard constructor, steps_per_mm set to default values More...
 
 IselLinearControlTwoAxis (const int steps_per_mm_x, const int steps_per_mm_y)
 constructor More...
 
int Move (const float millimetersX, const float millimetersY)
 move millimeters in directions More...
 
long int Name2DebugLevel (const std::string &name) const
 looks up a debuglevel in the internal map, returns 0 if not found More...
 
long int NewDebugLevel (const std::string &name)
 creates a new debuglevel More...
 
void PrintDebugLevel (std::ostream &os=std::cout) const
 
int ReadRawLine (std::string &cmd)
 Read a line from the serial port, returns length of read string, zero on nothing to read. More...
 
void RemoveDebugLevel (const long int lv)
 
void RemoveDebugLevel (const std::string &name)
 
int Reset (const int axis=3)
 Start Reference Tour on given axis (1-x, 2-y, or 3 x+y) More...
 
void SendRawCommand (const std::string cmd)
 Send a command string, terminated by <cr> character. More...
 
int SetAcceleration (const int accel)
 
void SetDebugLevel (const long int lv)
 
void SetDebugLevel (const std::string &name)
 
void SetDebugStream (const std::ostream &os)
 
int SetPosition (const float millimetersX, const float millimetersY, const bool bWaitComplete=true)
 
int SetSpeed (const float speedX, const float speedY)
 sets the maximum/desired speed for all movements in millimeter per second More...
 
void ShowDebugLevel (std::ostream &os=std::cout) const
 prints all internally known debuglevels More...
 
 ~IselLinearControlTwoAxis ()
 standard destructor More...
 

Static Public Member Functions

static long int GetGlobalDebugLevel ()
 
static void SetGlobalDebugLevel (long int lev)
 

Protected Member Functions

int CheckStatus ()
 
long ConsumeNextFreeDebuglevel_ ()
 returns the next available debuglevel More...
 

Protected Attributes

long int _liDebugLevel
 
long int _liNextDebugLevel
 new concept, debuglevel are managed here in the debug class More...
 
std::map< std::string, long int > _String2Debuglevel
 
portstream_fd COMstream_
 
int steps_per_mm_x_
 
int steps_per_mm_y_
 
int steps_per_second_x_
 
int steps_per_second_y_
 

Static Protected Attributes

static std::ostream _zDebugStream
 
static long int GlobalDebugLevel = 0
 

Detailed Description

This class controls the Isel iMC-S8 Linear Unit (two axis controll)

Author
tboer, 02/12
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 29 of file IselLinearControlTwoAxis.hh.

Constructor & Destructor Documentation

IselLinearControlTwoAxis::IselLinearControlTwoAxis ( )

standard constructor, steps_per_mm set to default values

Definition at line 14 of file IselLinearControlTwoAxis.cpp.

IselLinearControlTwoAxis::IselLinearControlTwoAxis ( const int  steps_per_mm_x,
const int  steps_per_mm_y 
)

constructor

Parameters
intthe steps per mm of the first axis
intthe steps per mm of the second axis

Definition at line 23 of file IselLinearControlTwoAxis.cpp.

IselLinearControlTwoAxis::~IselLinearControlTwoAxis ( )

standard destructor

Definition at line 29 of file IselLinearControlTwoAxis.cpp.

Member Function Documentation

void BIAS::Debug::AddDebugLevel ( const long int  lv)
inlineinherited
void BIAS::Debug::AddDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 362 of file Debug.hh.

int IselLinearControlTwoAxis::CheckStatus ( )
protected

Definition at line 225 of file IselLinearControlTwoAxis.cpp.

void IselLinearControlTwoAxis::Close ( )

closes the comport stream

Definition at line 83 of file IselLinearControlTwoAxis.cpp.

long BIAS::Debug::ConsumeNextFreeDebuglevel_ ( )
inlineprotectedinherited

returns the next available debuglevel

Author
woelk 09/2006

Definition at line 521 of file Debug.hh.

bool BIAS::Debug::DebugLevelIsSet ( const long int  lv) const
inlineinherited
bool BIAS::Debug::DebugLevelIsSet ( const std::string &  name) const
inlineinherited

Definition at line 350 of file Debug.hh.

void IselLinearControlTwoAxis::GetAcceleration ( int &  accel)
Returns
the current Acceleration

Definition at line 125 of file IselLinearControlTwoAxis.cpp.

void IselLinearControlTwoAxis::GetCurrentPosition ( float &  millimetersX,
float &  millimetersY 
)
Returns
the current position of the Unit
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 154 of file IselLinearControlTwoAxis.cpp.

int BIAS::Debug::GetDebugLevel ( ) const
inlineinherited
std::ostream& BIAS::Debug::GetDebugStream ( ) const
inlineinherited

Definition at line 405 of file Debug.hh.

void BIAS::Debug::GetDebugStream ( std::ostream &  os) const
inlineinherited

Definition at line 414 of file Debug.hh.

static long int BIAS::Debug::GetGlobalDebugLevel ( )
inlinestaticinherited

Definition at line 431 of file Debug.hh.

void IselLinearControlTwoAxis::GetSpeed ( float &  speedX,
float &  speedY 
)
Returns
the current speed

Definition at line 107 of file IselLinearControlTwoAxis.cpp.

int IselLinearControlTwoAxis::Init ( const int  nCOMportNumber)

opens the serial port and initialises unit

Parameters
intthe number of the serial port
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 45 of file IselLinearControlTwoAxis.cpp.

int IselLinearControlTwoAxis::Init ( const char *  COMportName)

opens the given port and initialises unit

Parameters
char[]the name of the port

Definition at line 53 of file IselLinearControlTwoAxis.cpp.

int IselLinearControlTwoAxis::Move ( const float  millimetersX,
const float  millimetersY 
)

move millimeters in directions

Parameters
floatthe millimeters to move on the first axis
floatthe millimeters to move on the second axis
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 131 of file IselLinearControlTwoAxis.cpp.

long int BIAS::Debug::Name2DebugLevel ( const std::string &  name) const
inlineinherited

looks up a debuglevel in the internal map, returns 0 if not found

Author
woelk 09/2006

Definition at line 454 of file Debug.hh.

long int BIAS::Debug::NewDebugLevel ( const std::string &  name)
inlineinherited
void BIAS::Debug::PrintDebugLevel ( std::ostream &  os = std::cout) const
inlineinherited

Definition at line 383 of file Debug.hh.

int IselLinearControlTwoAxis::ReadRawLine ( std::string &  cmd)

Read a line from the serial port, returns length of read string, zero on nothing to read.

Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 217 of file IselLinearControlTwoAxis.cpp.

void BIAS::Debug::RemoveDebugLevel ( const long int  lv)
inlineinherited

Definition at line 369 of file Debug.hh.

void BIAS::Debug::RemoveDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 376 of file Debug.hh.

int IselLinearControlTwoAxis::Reset ( const int  axis = 3)

Start Reference Tour on given axis (1-x, 2-y, or 3 x+y)

Returns
bool indicating success of reset
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 31 of file IselLinearControlTwoAxis.cpp.

void IselLinearControlTwoAxis::SendRawCommand ( const std::string  cmd)

Send a command string, terminated by <cr> character.

Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 212 of file IselLinearControlTwoAxis.cpp.

int IselLinearControlTwoAxis::SetAcceleration ( const int  accel)

Definition at line 113 of file IselLinearControlTwoAxis.cpp.

void BIAS::Debug::SetDebugLevel ( const long int  lv)
inlineinherited
void BIAS::Debug::SetDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 325 of file Debug.hh.

void BIAS::Debug::SetDebugStream ( const std::ostream &  os)
inlineinherited

Definition at line 398 of file Debug.hh.

static void BIAS::Debug::SetGlobalDebugLevel ( long int  lev)
inlinestaticinherited

Definition at line 424 of file Debug.hh.

int IselLinearControlTwoAxis::SetPosition ( const float  millimetersX,
const float  millimetersY,
const bool  bWaitComplete = true 
)
int IselLinearControlTwoAxis::SetSpeed ( const float  speedX,
const float  speedY 
)

sets the maximum/desired speed for all movements in millimeter per second

Parameters
floatthe speed for the first axis
floatthe speed for the second axis
Examples:
ExampleIselLinearControlTwoAxis.cpp.

Definition at line 89 of file IselLinearControlTwoAxis.cpp.

void BIAS::Debug::ShowDebugLevel ( std::ostream &  os = std::cout) const
inlineinherited

prints all internally known debuglevels

Author
woelk 09/2006

Definition at line 496 of file Debug.hh.

Member Data Documentation

long int BIAS::Debug::_liDebugLevel
protectedinherited

Definition at line 510 of file Debug.hh.

Referenced by BIAS::Debug::operator=(), and BIAS::ImageBase::operator=().

long int BIAS::Debug::_liNextDebugLevel
protectedinherited

new concept, debuglevel are managed here in the debug class

Definition at line 516 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

std::map<std::string, long int> BIAS::Debug::_String2Debuglevel
protectedinherited

Definition at line 517 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

std::ostream BIAS::Debug::_zDebugStream
staticprotectedinherited

Definition at line 511 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

portstream_fd BIAS::IselLinearControlTwoAxis::COMstream_
protected

Definition at line 119 of file IselLinearControlTwoAxis.hh.

long int BIAS::Debug::GlobalDebugLevel = 0
staticprotectedinherited

Definition at line 513 of file Debug.hh.

int BIAS::IselLinearControlTwoAxis::steps_per_mm_x_
protected

Definition at line 120 of file IselLinearControlTwoAxis.hh.

int BIAS::IselLinearControlTwoAxis::steps_per_mm_y_
protected

Definition at line 120 of file IselLinearControlTwoAxis.hh.

int BIAS::IselLinearControlTwoAxis::steps_per_second_x_
protected

Definition at line 118 of file IselLinearControlTwoAxis.hh.

int BIAS::IselLinearControlTwoAxis::steps_per_second_y_
protected

Definition at line 118 of file IselLinearControlTwoAxis.hh.


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