AuboCaps  0.6.0
arcs::aubo_scope::TCP Class Reference

This interface represents a TCP in AuboScope. More...

#include <tcp.h>

Public Member Functions

 TCP (TCP &f)
 
 TCP (TCP &&f)
 
 ~TCP ()
 
std::vector< double > getOffset ()
 
std::string getDisplayName ()
 Note: The TCP can be renamed at any time. More...
 
bool isResolvable ()
 A TCP cannot be guaranteed to be present in AuboScope. More...
 
size_t hashCode ()
 

Private Member Functions

 TCP ()
 

Private Attributes

void * d_ { nullptr }
 

Friends

class DataSwitch
 

Detailed Description

This interface represents a TCP in AuboScope.

This can either be a user-defined TCP or a TCP added by a AuboCap.

Definition at line 16 of file tcp.h.

Constructor & Destructor Documentation

arcs::aubo_scope::TCP::TCP ( TCP f)
arcs::aubo_scope::TCP::TCP ( TCP &&  f)
arcs::aubo_scope::TCP::~TCP ( )
arcs::aubo_scope::TCP::TCP ( )
private

Member Function Documentation

std::string arcs::aubo_scope::TCP::getDisplayName ( )

Note: The TCP can be renamed at any time.

Returns
The name of the TCP
std::vector<double> arcs::aubo_scope::TCP::getOffset ( )
Returns
The offset of the TCP with respect to the tool output flange, if the TCP is resolvable, otherwise null.
size_t arcs::aubo_scope::TCP::hashCode ( )
bool arcs::aubo_scope::TCP::isResolvable ( )

A TCP cannot be guaranteed to be present in AuboScope.

The end user can load a different installation (not containing the TCP) or the TCP was removed by the end user or the AuboCap that added the tcp/ This method can be used to determine, if the TCP is present.

Returns
true if this TCP is present in AuboScope, otherwise false.

Friends And Related Function Documentation

friend class DataSwitch
friend

Definition at line 50 of file tcp.h.

Member Data Documentation

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

Definition at line 52 of file tcp.h.


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