arcs::aubo_scope::Variable Class Reference

#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 ()
std::string	getDisplayName ()
	Note: The variable can be renamed at any time. More...
bool	equals (VariablePtr object)
size_t	hashCode ()
std::string	toString ()

Protected Member Functions
	Variable ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

Definition at line 11 of file variable.h.

Member Enumeration Documentation

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 22 of file variable.h.

Constructor & Destructor Documentation

arcs::aubo_scope::Variable::Variable

(

Variable &

f

)

arcs::aubo_scope::Variable::Variable

(

Variable &&

f

)

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

virtual

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

protected

Member Function Documentation

bool arcs::aubo_scope::Variable::equals

(

VariablePtr

object

)

Returns

true if object references the same internal Variable.

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

(

)

Note: The variable can be renamed at any time.

Returns

the display name of the variable.

Type arcs::aubo_scope::Variable::getType

(

)

Returns

the type of variable.

Referenced by arcs::aubo_scope::FeatureVariableFilter::operator()(), arcs::aubo_scope::GlobalVariableFilter::operator()(), and arcs::aubo_scope::PersistedVariableFilter::operator()().

Here is the caller graph for this function:

size_t arcs::aubo_scope::Variable::hashCode

(

)

Returns

hashCode for this object.

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

(

)

Returns

a string representation of the variable.

Friends And Related Function Documentation

friend class DataSwitch

friend

Definition at line 88 of file variable.h.

Member Data Documentation

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

private

Definition at line 89 of file variable.h.

---

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

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