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

#include <set_node.h>

Inheritance diagram for arcs::aubo_scope::SetNode:
Collaboration diagram for arcs::aubo_scope::SetNode:

Public Types

enum  ConfigType {
  NO_TYPE , NO_ACTION , DIGITAL_OUTPUT , ANALOG_OUTPUT_CURRENT ,
  ANALOG_OUTPUT_VOLTAGE , FLOAT_REGISTER_OUTPUT , EXPRESSION_OUTPUT , SINGLE_DIGITAL_PULSE ,
  INCREMENT_VARIABLE
}
 The configuration type used to determine which type of configuration this instance is. More...
enum  OutputSelectionType { NO_OUTPUT , UNRESOLVED_OUTPUT , OUTPUT }

Public Member Functions

 SetNode (SetNode &f)
 SetNode (SetNode &&f)
virtual ~SetNode ()
ConfigType getConfigType ()
 This method returns the type of configuration.
void setConfigType (ConfigType type)
double getPulseTime ()
void setPulseTime (double time)
float getFloatValueToSet ()
void setFloatValueToSet (float value)
double getAnalogOutput ()
void setAnalogOutput (double value)
OutputSelectionType getOutputSelectionType ()
ExpressionPtr getExpression ()
void setExpression (ExpressionPtr expression)
IoPtr getOutput ()
 The output selected can be an analog output, a digital output, a MODBUS output or a register output.
void setOutput (IoPtr io)
bool getBoolValueToSet ()
 Depending on the type of output this is interpreted in different ways.
void setBoolValueToSet (bool value)
double getVoltage ()
void setVoltage (double voltage)
double getCurrent ()
void setCurrent (double curr)
Public Member Functions inherited from arcs::aubo_scope::ProgramNode
 ProgramNode (ProgramNode &f)
 ProgramNode (ProgramNode &&f)
virtual ~ProgramNode ()
ProgramNodeContributionPtr getProgramNodeContribution ()
 Get the program node contribution.

Private Member Functions

 SetNode ()

Private Attributes

void * d_ { nullptr }

Friends

class DataSwitch

Additional Inherited Members

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

Detailed Description

Definition at line 12 of file set_node.h.

Member Enumeration Documentation

◆ ConfigType

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

Enumerator
NO_TYPE 

No selection has been made.

This type has no further information.

NO_ACTION 

No action has been selected.

This type has no further information.

DIGITAL_OUTPUT 

Digital output has been selected.

The config instance can be cast to DigitalOutputSetNodeConfig.

ANALOG_OUTPUT_CURRENT 

Analog output configured for electric current or no output has been selected.

The config instance can be cast to AnalogOutputCurrentSetNodeConfig.

ANALOG_OUTPUT_VOLTAGE 

Analog output configured for voltage has been selected.

The config instance can be cast to AnalogOutputVoltageSetNodeConfig.

FLOAT_REGISTER_OUTPUT 

Register using float type values has been selected.

The config instance can be cast to FloatRegisterOutputSetNodeConfig.

EXPRESSION_OUTPUT 

Expression output has been selected.

The config instance can be cast to ExpressionOutputSetNodeConfig.

SINGLE_DIGITAL_PULSE 

Single digital pulse output has been selected.

The config instance can be cast to SingleDigitalPulseSetNodeConfig.

INCREMENT_VARIABLE 

Increment variable has been selected. This type has no further information.

Setting this type of config will be ignored and will have no effect on the node.

Definition at line 19 of file set_node.h.

◆ OutputSelectionType

Enumerator
NO_OUTPUT 

No output is selected.

UNRESOLVED_OUTPUT 

The selected output is no longer available (e.g.

because the end user has removed the output in the Installation or the needed Installation is not currently loaded).

OUTPUT 

Output is selected.

The Selection instance can be cast to ExpressionOutput.

Definition at line 104 of file set_node.h.

Constructor & Destructor Documentation

◆ SetNode() [1/3]

arcs::aubo_scope::SetNode::SetNode ( SetNode & f)

References SetNode().

Referenced by SetNode(), and SetNode().

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

◆ SetNode() [2/3]

arcs::aubo_scope::SetNode::SetNode ( SetNode && f)

References SetNode().

Here is the call graph for this function:

◆ ~SetNode()

virtual arcs::aubo_scope::SetNode::~SetNode ( )
virtual

◆ SetNode() [3/3]

arcs::aubo_scope::SetNode::SetNode ( )
private

Member Function Documentation

◆ getAnalogOutput()

double arcs::aubo_scope::SetNode::getAnalogOutput ( )
Returns
the analog output value.

◆ getBoolValueToSet()

bool arcs::aubo_scope::SetNode::getBoolValueToSet ( )

Depending on the type of output this is interpreted in different ways.

For digital output and MODBUS output, true means the output will be set to HIGH, false means the output will be set to LOW. For boolean register the value is interpreted literally.

Returns
the output value.

◆ getConfigType()

ConfigType arcs::aubo_scope::SetNode::getConfigType ( )

This method returns the type of configuration.

Cast this instance appropriately to have access to specific getters.

Returns
the type of this config.

◆ getCurrent()

double arcs::aubo_scope::SetNode::getCurrent ( )
Returns
the electric current value/level to be applied to the output.

◆ getExpression()

ExpressionPtr arcs::aubo_scope::SetNode::getExpression ( )
Returns
the expression whose evaluation will be applied to the output.

◆ getFloatValueToSet()

float arcs::aubo_scope::SetNode::getFloatValueToSet ( )
Returns
the float value to be applied to the float register output.

◆ getOutput()

IoPtr arcs::aubo_scope::SetNode::getOutput ( )

The output selected can be an analog output, a digital output, a MODBUS output or a register output.

Returns
the output to which the result of the evaluation of the expression will be applied.

◆ getOutputSelectionType()

OutputSelectionType arcs::aubo_scope::SetNode::getOutputSelectionType ( )

◆ getPulseTime()

double arcs::aubo_scope::SetNode::getPulseTime ( )
Returns
the time for the length of the pulse.

◆ getVoltage()

double arcs::aubo_scope::SetNode::getVoltage ( )
Returns
the voltage value/level to be applied to the output

◆ setAnalogOutput()

void arcs::aubo_scope::SetNode::setAnalogOutput ( double value)

◆ setBoolValueToSet()

void arcs::aubo_scope::SetNode::setBoolValueToSet ( bool value)

◆ setConfigType()

void arcs::aubo_scope::SetNode::setConfigType ( ConfigType type)

◆ setCurrent()

void arcs::aubo_scope::SetNode::setCurrent ( double curr)

◆ setExpression()

void arcs::aubo_scope::SetNode::setExpression ( ExpressionPtr expression)

◆ setFloatValueToSet()

void arcs::aubo_scope::SetNode::setFloatValueToSet ( float value)

◆ setOutput()

void arcs::aubo_scope::SetNode::setOutput ( IoPtr io)

◆ setPulseTime()

void arcs::aubo_scope::SetNode::setPulseTime ( double time)

◆ setVoltage()

void arcs::aubo_scope::SetNode::setVoltage ( double voltage)

◆ DataSwitch

friend class DataSwitch
friend

Definition at line 211 of file set_node.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

◆ d_

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

Definition at line 213 of file set_node.h.


The documentation for this class was generated from the following file:
  • include/aubo_caps/domain/program/nodes/builtin/set_node.h