All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATKinMechanismUseItf Interface CATIKinematicsCommand

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIKinematicsCommand

Interface to handle a kinematic command and read its content.
Role: A kinematics command has a type and drives an engineering connection. The methods provided by this interface allow to access this information.

Method Index

o GetEngineeringConnection(CATBaseUnknown_var&): Returns the engineering connection associated to the command.
o GetKinCommandType(CATKinematicsCommandType&): Returns the type of the command.
o GetLimits(double&,double&,CATBoolean&,CATBoolean&): Returns limits information of a kinematics command.
o GetValue(CATICkeParm_var&): Returns the CATICkeParm value of a kinematics command.

Methods

o GetEngineeringConnection

public virtual GetEngineeringConnection( oConnection)

Returns the engineering connection associated to the command.

Parameters:

oConnection: The engineering connection associated to the command. It adheres to the CATIEngConnection public interface. see CATIEngConnection

o GetKinCommandType

public virtual GetKinCommandType( oCmdType)

Returns the type of the command.

Parameters:

oCmdType: The type of the kinematics command.

See also:

o GetLimits

public virtual GetLimits(		`oMinValue`,
		`oMaxValue`,
		`oIsMinSet`,
		`oIsMaxSet`)

Returns limits information of a kinematics command.

Parameters:

oMinValue: The minimal value if it exists
oMaxValue: The maximal value if it exists
oIsMinSet: indicates wheter the minimal value exists or not
oIsMaxSet: indicates wheter the maximal value exists or not
Regarding the units for the command values, an angle is measured with degrees whereas a distance is measured with millimeters.

o GetValue

public virtual GetValue( oCmdParameter)

Returns the CATICkeParm value of a kinematics command. Returns the current value of the command

Parameters:

oCmdParameter: The CATICkeParm value of a kinematics command.

See also:

This object is included in the file: CATIKinematicsCommand.h
If needed, your Imakefile.mk should include the module: CATKinMechanismUseItf