arcs::aubo_scope::Variable Class Reference

Variable Represents a variable in AuboScope. More...

#include <variable.h>

Inheritance diagram for arcs::aubo_scope::Variable:

Public Types
enum	Type : int { GLOBAL , VALUE_PERSISTED , FEATURE }
	The variable type used to determine which type of variable this instance is. More...

Public Member Functions
	Variable (Variable &f)
	Variable (Variable &&f)
virtual	~Variable ()
Type	getType ()
	Returns the type of variable.
std::string	getDisplayName ()
	Note: The variable can be renamed at any time.
bool	equals (VariablePtr object)
	Checks if the object references the same internal Variable.
size_t	hashCode ()
	Returns the hash code for this object.
std::string	toString ()
	Returns a string representation of the variable.

Protected Member Functions
	Variable ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

Variable Represents a variable in AuboScope.

Variables can be used to store and pass data in programs.

Definition at line 24 of file variable.h.

Member Enumeration Documentation

Type

enum arcs::aubo_scope::Variable::Type : int

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

Enumerator
GLOBAL	GLOBAL means that the variable is available everywhere in a program. This variable instance can be cast to GlobalVariable.
VALUE_PERSISTED	VALUE_PERSISTED means that the variable is stored with the installation. These variables are defined in the installation and will retain their values even when a robot is turned off and on. This variable instance can be cast to ValuePersistedVariable.
FEATURE	FEATURE means that a Feature is marked as a variable. The variable is defined in the installation and will exist even when a robot is turned off and on. This variable instance can be cast to FeatureVariable.

Definition at line 35 of file variable.h.

Constructor & Destructor Documentation

Variable() [1/3]

arcs::aubo_scope::Variable::Variable

(

Variable &

f

)

References Variable().

Referenced by Variable(), and Variable().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable() [2/3]

arcs::aubo_scope::Variable::Variable

(

Variable &&

f

)

References Variable().

Here is the call graph for this function:

~Variable()

virtual arcs::aubo_scope::Variable::~Variable ( )

virtual

Variable() [3/3]

arcs::aubo_scope::Variable::Variable ( )

protected

Member Function Documentation

equals()

bool arcs::aubo_scope::Variable::equals

(

VariablePtr

object

)

Checks if the object references the same internal Variable.

Returns

true if object references the same internal Variable.

getDisplayName()

std::string arcs::aubo_scope::Variable::getDisplayName

(

)

Note: The variable can be renamed at any time.

Returns

the display name of the variable.

getType()

Type arcs::aubo_scope::Variable::getType

(

)

Returns the type of variable.

Returns

the type of variable.

hashCode()

size_t arcs::aubo_scope::Variable::hashCode

(

)

Returns the hash code for this object.

Returns

hashCode for this object.

toString()

std::string arcs::aubo_scope::Variable::toString

(

)

Returns a string representation of the variable.

Returns

a string representation of the variable.

Friends And Related Symbol Documentation

DataSwitch

friend class DataSwitch

friend

Definition at line 139 of file variable.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

d_

void* arcs::aubo_scope::Variable::d_ { nullptr }

private

Definition at line 140 of file variable.h.

---

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

• include/aubo_caps/domain/variable/variable.h