arcs::aubo_scope::PersistedVariable Class Reference

ingroup ApplicationApi This interface represents variables stored with the installation. More...

#include <persisted_variable.h>

Inheritance diagram for arcs::aubo_scope::PersistedVariable:

Collaboration diagram for arcs::aubo_scope::PersistedVariable:

Public Member Functions
	PersistedVariable (PersistedVariable &f)
	PersistedVariable (PersistedVariable &&f)
virtual	~PersistedVariable ()
bool	isResolvable ()
	A persisted variable can not be guaranteed to be present.
Public Member Functions inherited from arcs::aubo_scope::Variable
	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
	PersistedVariable ()
Protected Member Functions inherited from arcs::aubo_scope::Variable
	Variable ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Additional Inherited Members
Public Types inherited from arcs::aubo_scope::Variable
enum	Type : int { GLOBAL , VALUE_PERSISTED , FEATURE }
	The variable type used to determine which type of variable this instance is. More...

Detailed Description

ingroup ApplicationApi This interface represents variables stored with the installation.

These variables are defined in the installation and will exist even when a robot is turned off and on.

Definition at line 16 of file persisted_variable.h.

Constructor & Destructor Documentation

PersistedVariable() [1/3]

arcs::aubo_scope::PersistedVariable::PersistedVariable

(

PersistedVariable &

f

)

References PersistedVariable().

Referenced by PersistedVariable(), and PersistedVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

PersistedVariable() [2/3]

arcs::aubo_scope::PersistedVariable::PersistedVariable

(

PersistedVariable &&

f

)

References PersistedVariable().

Here is the call graph for this function:

~PersistedVariable()

virtual arcs::aubo_scope::PersistedVariable::~PersistedVariable ( )

virtual

PersistedVariable() [3/3]

arcs::aubo_scope::PersistedVariable::PersistedVariable ( )

protected

Member Function Documentation

isResolvable()

bool arcs::aubo_scope::PersistedVariable::isResolvable

(

)

A persisted variable can not be guaranteed to be present.

This method can be used to determine, if the variable is present.

The persisted variable will not be present, if the end user loads a different installation which does not contain the variable, or if the variable is deleted by the end user.

A program node storing a PersistedVariable in its Data Model will be undefined if the variable cannot be resolved (i.e. the variable is not present).

Returns

true, if this persisted variable is resolvable (i.e. present in the current installation).

Friends And Related Symbol Documentation

DataSwitch

friend class DataSwitch

friend

Definition at line 53 of file persisted_variable.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

d_

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

private

Definition at line 54 of file persisted_variable.h.

---

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

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