arcs::aubo_scope::Feature Class Reference

This base interface represents all types of features available in AuboScope. More...

#include <feature.h>

Inheritance diagram for arcs::aubo_scope::Feature:

Public Member Functions
	Feature (Feature &f)
	Feature (Feature &&f)
virtual	~Feature ()
std::string	getDisplayName ()
	Note: The feature can be renamed at any time. More...
bool	isDefined ()
	Returns whether the position of the feature has been fully defined/specified. More...
bool	isVariable ()
	Returns whether the feature can be used as a variable in the program. More...
bool	isJoggable ()
bool	isResolvable ()
	A feature cannot be guaranteed to be present in AuboScope. More...
std::vector< double >	getPose ()
	Returns the Cartesian location of the feature. More...
size_t	hashCode ()

Protected Member Functions
	Feature ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

This base interface represents all types of features available in AuboScope.

Definition at line 15 of file feature.h.

Constructor & Destructor Documentation

arcs::aubo_scope::Feature::Feature

(

Feature &

f

)

arcs::aubo_scope::Feature::Feature

(

Feature &&

f

)

virtual arcs::aubo_scope::Feature::~Feature ( )

virtual

arcs::aubo_scope::Feature::Feature ( )

protected

Member Function Documentation

std::string arcs::aubo_scope::Feature::getDisplayName

(

)

Note: The feature can be renamed at any time.

Returns

The name of the feature

std::vector<double> arcs::aubo_scope::Feature::getPose

(

)

Returns the Cartesian location of the feature.

Returns

A pose representing the Cartesian location of the feature

size_t arcs::aubo_scope::Feature::hashCode

(

)

bool arcs::aubo_scope::Feature::isDefined

(

)

Returns whether the position of the feature has been fully defined/specified.

Returns

true if the feature is defined, false otherwise.

bool arcs::aubo_scope::Feature::isJoggable

(

)

bool arcs::aubo_scope::Feature::isResolvable

(

)

A feature cannot be guaranteed to be present in AuboScope.

The end user can load a different installation (not containing the feature) or the feature can be removed by the end user or the AuboCap that added the feature. This method can be used to determine, if the feature is present.

Returns

true if this feature is present in AuboScope, otherwise false.

bool arcs::aubo_scope::Feature::isVariable

(

)

Returns whether the feature can be used as a variable in the program.

Returns

true if the feature is variable, false otherwise.

Friends And Related Function Documentation

friend class DataSwitch

friend

Definition at line 71 of file feature.h.

Member Data Documentation

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

private

Definition at line 72 of file feature.h.

---

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

• include/aubo_caps/domain/feature/feature.h