PDF
AuboStudio SDK  0.6.3
arcs::aubo_scope::Io Class Reference

Io This is the base interface representing all types of I/Os available in AuboScope. More...

#include <io.h>

Inheritance diagram for arcs::aubo_scope::Io:

Public Types

enum  IoType : int {
  DIGITAL , ANALOG , INTEGER , BOOLEAN ,
  DOUBLE
}
enum  InterfaceType : int {
  STANDARD , TOOL , CONFIGURABLE , LINKIO ,
  MODBUS , GENERAL_PURPOSE , PROFINET , ETHERNET_IP
}

Public Member Functions

 Io (Io &f)
 Io (Io &&f)
virtual ~Io ()
std::string getDisplayName () const
 Returns the user defined name of the IO in the currently selected installation.
std::string getDefaultName () const
 Returns the robot default name of the I/O.
std::string getValueStr () const
 Returns the current reading of the I/O as a string.
IoType getType () const
 Returns the I/O type.
InterfaceType getInterfaceType () const
 Returns the interface type this I/O belongs to.
int getAction () const
 Returns the action number of the I/O.
bool isInput () const
 Returns true if I/O supports reading of values and false otherwise.
bool isResolvable () const
 Some I/Os, such as MODBUS I/Os and analog Tool inputs, are in some situations not present in AuboScope or available for use.
size_t hashCode ()

Protected Member Functions

 Io ()

Private Attributes

void * d_ { nullptr }

Friends

class DataSwitch

Detailed Description

Io This is the base interface representing all types of I/Os available in AuboScope.

Definition at line 22 of file io.h.

Member Enumeration Documentation

◆ InterfaceType

Enumerator
STANDARD 
TOOL 
CONFIGURABLE 
LINKIO 
MODBUS 
GENERAL_PURPOSE 
PROFINET 
ETHERNET_IP 

Definition at line 33 of file io.h.

◆ IoType

Enumerator
DIGITAL 
ANALOG 
INTEGER 
BOOLEAN 
DOUBLE 

Definition at line 25 of file io.h.

Constructor & Destructor Documentation

◆ Io() [1/3]

arcs::aubo_scope::Io::Io ( Io & f)

References Io().

Referenced by Io(), and Io().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Io() [2/3]

arcs::aubo_scope::Io::Io ( Io && f)

References Io().

Here is the call graph for this function:

◆ ~Io()

virtual arcs::aubo_scope::Io::~Io ( )
virtual

◆ Io() [3/3]

arcs::aubo_scope::Io::Io ( )
protected

Member Function Documentation

◆ getAction()

int arcs::aubo_scope::Io::getAction ( ) const

Returns the action number of the I/O.

Returns
the action number of the I/O.

◆ getDefaultName()

std::string arcs::aubo_scope::Io::getDefaultName ( ) const

Returns the robot default name of the I/O.

Returns
the robot default name of the I/O.

◆ getDisplayName()

std::string arcs::aubo_scope::Io::getDisplayName ( ) const

Returns the user defined name of the IO in the currently selected installation.

Returns
the user defined name of the IO.

◆ getInterfaceType()

InterfaceType arcs::aubo_scope::Io::getInterfaceType ( ) const

Returns the interface type this I/O belongs to.

Returns
the interface type this I/O belongs to.

◆ getType()

IoType arcs::aubo_scope::Io::getType ( ) const

Returns the I/O type.

Returns
the I/O type.

◆ getValueStr()

std::string arcs::aubo_scope::Io::getValueStr ( ) const

Returns the current reading of the I/O as a string.

Returns
get current reading of the I/O as a string.

◆ hashCode()

size_t arcs::aubo_scope::Io::hashCode ( )

◆ isInput()

bool arcs::aubo_scope::Io::isInput ( ) const

Returns true if I/O supports reading of values and false otherwise.

Returns
true if I/O supports reading of values.

◆ isResolvable()

bool arcs::aubo_scope::Io::isResolvable ( ) const

Some I/Os, such as MODBUS I/Os and analog Tool inputs, are in some situations not present in AuboScope or available for use.

This method can be used to determine if the I/O is available.

Returns
true, if I/O can be resolved. false otherwise.

◆ DataSwitch

friend class DataSwitch
friend

Definition at line 158 of file io.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

◆ d_

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

Definition at line 159 of file io.h.


The documentation for this class was generated from the following file:
  • include/aubo_caps/domain/io/io.h