 | CMDrive |
The CMDriveRemotePipe type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Abort | Causes the ClientBaseTChannel object to transition immediately from its current state into the closed state. (Inherited from ClientBaseICompreDriveWCF) |
| ApplyDistanceSetpoint | Applies a distance setpoint in [m]. |
| ApproachCompreDrive | Starts the approach of the CompreDrive from safe position to contact. |
| CallPluginCommand | Call a command defined by one of the loaded plugins. |
| CallPluginCommandBoolean | Call a command defined by one of the loaded plugins. |
| CallPluginCommandNumber | Call a command defined by one of the loaded plugins. |
| CallPluginCommandText | Call a command defined by one of the loaded plugins. |
| Close | Causes the ClientBaseTChannel object to transition from its current state into the closed state. (Inherited from ClientBaseICompreDriveWCF) |
| Connect | Open the remote channel. |
 | CreateChannel | Returns a new channel to the service. (Inherited from ClientBaseICompreDriveWCF) |
| DisableRamp | Disables the ramp control of the CompreDrive. |
| DisableTemperatureControl | Disables the temperature controller's active regulation. |
| Disconnect | Closes the remote channel. |
| DisplayInitializationUI | Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. (Inherited from ClientBaseICompreDriveWCF) |
| EnableRamp | Enables the ramp control of the CompreDrive with the given ramp speed. |
| EnableTemperatureControl | Enabled the temperature controller's active regulation. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetAllForceUnits | Gets a list of all available force units. |
| GetAllPressureUnits | Gets a list of all available pressure units. |
| GetAllTemperatureUnits | Gets a list of all available temperature units. |
| GetCompreDriveState | Gets the current operational state of the CompreDrive. |
| GetCompreFrameForceGross | Gets the current (gross) force of the CompreFrame if it is connected. |
| GetCompreFrameForceNet | Gets the current (net) force of the CompreFrame if it is connected. |
| GetConstantDistanceSetpoint | Gets the current setpoint value of the constant distance mode. |
| GetCurrentUserPath | Gets the path to the current user folder. |
| GetDataProvider | Reads the last value of an additional data provider. |
| GetDefaultValueForInitializationT | Replicates the behavior of the default keyword in C#. (Inherited from ClientBaseICompreDriveWCF) |
| GetDistanceValue | Gets the current value of the current distance provider plugin. |
| GetForce | Returns the currently applied force |
| GetForceAmpForceGross | Gets the current (gross) force of the rhd Force Amplifier if it is connected. |
| GetForceAmpForceNet | Gets the current (net) force of the rhd Force Amplifier if it is connected. |
| GetForceAmpPressureGross | Gets the current (gross) pressure of the rhd Force Amplifier if it is connected. |
| GetForceAmpPressureNet | Gets the current (net) pressure of the rhd Force Amplifier if it is connected. |
| GetForceAmpPressureUnit | Gets the unit of the pressure values retrieved from GetForceAmpPressureNet and GetForceAmpPressureGross. |
| GetForceControlEnabled | Retrieves a value indicating if force control is currently enabled, e.g. if the CompreDrive has finished its approach |
| GetForceSetpoint | Returns the current force setpoint. |
| GetForceUnit | Gets the unit that the force is given in. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHWInTrigger | Determines if the CompreDrive HW Trigger with the given number has received a signal |
| GetIdentifier | Gets the string CompreDriveControl VERSION from the software. |
| GetIsForceStable | Retrieves a value indicating if the force is currently at a stable value |
| GetIsTemperatureStable | Retrieves a value indicating if the temperature is currently at a stable value |
| GetLastFaultCodes | Gets a collection of fault codes, from most recent to oldest. |
| GetPluginCommands | Gets a list of all plugin commands defined by the given plugin. |
| GetPluginDisplayNames | Gets a list of all plugins that support executing custom commands. |
| GetPosition | Returns the current raw motor position |
| GetPressure | Returns the currently applied pressure |
| GetPressureUnit | Returns the unit that pressures are given in. |
| GetSWOutTrigger | Retrieves the state of the given software OUT trigger, that is set when T and/or f is stable during a procedure step. |
| GetTemperature | Returns the current system temperature |
| GetTemperatureControlEnabled | Retrieves a value indicating if temperature control is currently enabled, e.g. if the controller is actively regulating |
| GetTemperatureSetpoint | Returns the current temperature setpoint. |
| GetTemperatureUnit | Gets the unit that the temperature is given in. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InvokeAsync | Provides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview. (Inherited from ClientBaseICompreDriveWCF) |
| IsCMDriveConnected | Retrieves information, if the hosting application is connected to the CompreDrive system |
| IsTControllerConnected | Retrieves information, if the hosting application is connected to a temperature controller |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Open | Causes the ClientBaseTChannel object to transition from the created state into the opened state. (Inherited from ClientBaseICompreDriveWCF) |
| PauseRegulation | Pauses the active force regulation of the CompreDrive |
| PulseHWOutTrigger | Send a pulse on the given CompreDrive HW Output trigger channel |
| RetractCompreDrive | Retracts the CompreDrive back to safe position. |
| SetForceSetpoint | Sets the current force setpoint, if the system is in manual mode. |
| SetHWInTriggerMode | Sets the pulse type that the given CompreDrive HW Trigger listens to |
| SetHWOutTriggerMode | Sets the options for the given CompreDrive HW Output trigger |
| SetPressureSetpoint | Sets the current pressure setpoint, if the system is in manual mode, and has remote setpoint enabled. |
| SetSWInTrigger | Triggers the given software IN trigger, that is used to tell the running procedure to move to the next step |
| SetTemperatureSetpoint | Sets the current temperature setpoint, if the system is in manual mode, and has remote setpoint enabled |
| StartConstantDistanceMode | Switches the CompreDrive from Control into Constant Distance mode. |
| StopConstantDistanceMode | Switches the CompreDrive from Constant Distance into PID Paused mode. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UnpauseRegulation | Unpauses the active force regulation of the CompreDrive |
| WriteLogMessage | Writes a message into the CompreDriveControl message log. |
See Also