Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::TwoStateTool Class Reference
[Device]

Base class for all tools that support Forward (On) and Off functionality. More...

#include <TwoStateTool.h>

Inheritance diagram for OSCAR::TwoStateTool:

Inheritance graph
[legend]
List of all members.

Public Methods

 TwoStateTool (const String &name=String(), OSCARError &err=DUMMY_ERROR(noError))
 TwoStateTool (const Vector3D &toolPoint, const String &name=String(), OSCARError &err=DUMMY_ERROR(noError))
 TwoStateTool (const Xform &toolFrame, const String &name=String(), OSCARError &err=DUMMY_ERROR(noError))
 TwoStateTool (const TwoStateTool &TwoStateTool)
TwoStateTool & operator= (const TwoStateTool &)
virtual ~TwoStateTool ()
virtual bool Forward ()
virtual bool Off ()=0

Detailed Description

Author:
Chetan Kapoor

Constructor & Destructor Documentation

OSCAR::TwoStateTool::TwoStateTool (  const String &    name = String(),
OSCARError &    err = DUMMY_ERROR(noError)
) 
 

Constructor for TwoStateTool Use this to construct a TwoStateTool object in which no tool frame is specified. The default call mode specified here is Block.

Parameters:
name Name you want to assign to object. Default is " ".
err An OSCARError object that on return will hold the value of the error code that was generated when the constructor was called. If this error was not 'noError' you can call GetError() to get the details of the error code.
See also:
TwoStateTool(const Vector3D& toolPoint, const String& name, OSCARError& err)

TwoStateTool(const Xform& toolFrame, const String& name, OSCARError& err)

OSCAR::TwoStateTool::TwoStateTool (  const Vector3D &    toolPoint,
const String &    name = String(),
OSCARError &    err = DUMMY_ERROR(noError)
) 
 

Constructor for TwoStateTool Use this to construct a TwoStateTool object by specifying a tool frame for the tool.

Parameters:
toolPoint A three long vector that specifies the X, Y, and Z coordinates of the tool point for the tool with respect to the base plate of the tool. This tool point can then be used by the kinematics objects.
name Name you want to assign to object. Default is " ".
err An OSCARError object that on return will hold the value of the error code that was generated when the constructor was called. If this error was not 'noError' you can call GetError() to get the details of the error code.
See also:
TwoStateTool(const String& name, OSCARError& err)

TwoStateTool(const Xform& toolFrame, const String& name, OSCARError& err)

OSCAR::TwoStateTool::TwoStateTool (  const Xform &    toolFrame,
const String &    name = String(),
OSCARError &    err = DUMMY_ERROR(noError)
) 
 

Constructor for TwoStateTool Use this to construct a TwoStateTool object by specifying a tool frame for the tool.

Parameters:
toolFrame A 4X4 matrix that specifies the X, Y, and Z coordinates and the orientation of the tool point for the tool with respect to the base plate of the tool. This tool frame can then be used by the kinematics objects.
name Name you want to assign to object. Default is " ".
err An OSCARError object that on return will hold the value of the error code that was generated when the constructor was called. If this error was not 'noError' you can call GetError() to get the details of the error code.
See also:
TwoStateTool(const String& name, OSCARError& err)

TwoStateTool(const Vector3D& toolPoint, const String& name, OSCARError& err)

OSCAR::TwoStateTool::TwoStateTool (  const TwoStateTool &    TwoStateTool ) 
 

virtual OSCAR::TwoStateTool::~TwoStateTool (    )  [inline, virtual]
 

Member Function Documentation

virtual bool OSCAR::TwoStateTool::Forward (    )  [virtual]
 

Method to turn tool on in the forward direction Call to this method should return immediately. Override this method in derived classes. For this class, all this method does is to check whether Initialize() has been called. As such, derived classes should call TwoStateTool::Forward() and check its return value before proceeding.

Returns:
true or false. If false, call GetError() to get detailed error information
See also:
Off()
Exceptions:
notInitialized notInitialized

Reimplemented in OSCAR::Drill, OSCAR::Saw, and OSCAR::SprayGun.

virtual bool OSCAR::TwoStateTool::Off (    )  [pure virtual]
 

Method to turn tool Off() Call to this method should return immediately. Override this method in derived classes. For this class, all this method does is to check whether Initialize() has been called. As such, derived classes should call TwoStateTool::Off() and check its return value before proceeding.

Returns:
true or false. If false, call GetError() to get detailed error information
See also:
Forward()
Exceptions:
notInitialized notInitialized

Implemented in OSCAR::Drill, OSCAR::Saw, and OSCAR::SprayGun.

TwoStateTool& OSCAR::TwoStateTool::operator= (  const TwoStateTool &    ) 
 

The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations