AuboCaps  0.6.0
arcs::aubo_scope::GripperNode Class Reference

#include <gripper_node.h>

Inheritance diagram for arcs::aubo_scope::GripperNode:
Collaboration diagram for arcs::aubo_scope::GripperNode:

Public Types

enum  ConfigType { UNDEFINED, GRIP_ACTION, RELEASE_ACTION }
 The configuration type used to determine which type of configuration this instance is. More...
 
enum  SettingType { UNDEFINED0, PAYLOAD_SELECTION, CUSTOM_PARAMETERS }
 The setting type used to determine which type of setting this instance is. More...
 

Public Member Functions

 GripperNode (GripperNode &f)
 
 GripperNode (GripperNode &&f)
 
virtual ~GripperNode ()
 
ConfigType getConfigType ()
 This method returns the type of configuration. More...
 
void setConfigType (ConfigType type)
 
GripperDevicePtr getGripperDevice ()
 
SettingType getSettingType ()
 This method returns the type of setting. More...
 
- Public Member Functions inherited from arcs::aubo_scope::ProgramNode
 ProgramNode (ProgramNode &f)
 
 ProgramNode (ProgramNode &&f)
 
virtual ~ProgramNode ()
 
ProgramNodeContributionPtr getProgramNodeContribution ()
 不推荐用户调用 ProgramNodeContribution::generateScript 使用 ScriptWritter::writeChildren More...
 

Private Member Functions

 GripperNode ()
 

Private Attributes

void * d_ { nullptr }
 

Friends

class DataSwitch
 

Additional Inherited Members

- Protected Member Functions inherited from arcs::aubo_scope::ProgramNode
 ProgramNode ()
 

Detailed Description

This interface represents a program node which can be used for programming grip and release actions with a selected gripper device.

An instance of this interface can be built using the GripperNodeFactory interface and is returned as a result when GripperNodeFactory#createGripperNode(GripperDevice) is called.

Definition at line 24 of file gripper_node.h.

Member Enumeration Documentation

The configuration type used to determine which type of configuration this instance is.

Enumerator
UNDEFINED 

A Gripper action (i.e. grip or release) has not been selected

The config instance can be cast to UndefinedActionConfig. This is only relevant if the Gripper node uses a multi-gripper device, i.e. a gripper device supporting the multi-gripper capability (see the MultiGripperSupport interface). The instance will provide access to the individual gripper selection.

GRIP_ACTION 

The gripper is configured for a grip action

The config instance can be cast to GripActionConfig.

RELEASE_ACTION 

The gripper is configured for a release action

The config instance can be cast to ReleaseActionConfig.

Definition at line 31 of file gripper_node.h.

The setting type used to determine which type of setting this instance is.

Enumerator
UNDEFINED0 

No selection has been made.

PAYLOAD_SELECTION 

A payload (from the installation) is selected.

The setting instance can be cast to PayloadSelection.

CUSTOM_PARAMETERS 

Custom payload parameters are specified.

The setting instance can be cast to CustomPayloadParameters.

Definition at line 90 of file gripper_node.h.

Constructor & Destructor Documentation

arcs::aubo_scope::GripperNode::GripperNode ( GripperNode f)
arcs::aubo_scope::GripperNode::GripperNode ( GripperNode &&  f)
virtual arcs::aubo_scope::GripperNode::~GripperNode ( )
virtual
arcs::aubo_scope::GripperNode::GripperNode ( )
private

Member Function Documentation

ConfigType arcs::aubo_scope::GripperNode::getConfigType ( )

This method returns the type of configuration.

Cast this instance appropriately to have access to specific getters.

Returns
The type of this config.
GripperDevicePtr arcs::aubo_scope::GripperNode::getGripperDevice ( )
Returns
The gripper device used by this Gripper node
SettingType arcs::aubo_scope::GripperNode::getSettingType ( )

This method returns the type of setting.

Cast this instance appropriately to have access to specific getters.

Returns
The type of this payload setting.
void arcs::aubo_scope::GripperNode::setConfigType ( ConfigType  type)

Friends And Related Function Documentation

friend class DataSwitch
friend

Definition at line 128 of file gripper_node.h.

Member Data Documentation

void* arcs::aubo_scope::GripperNode::d_ { nullptr }
private

Definition at line 130 of file gripper_node.h.


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