MIRA
Public Member Functions | List of all members
TransformProperty Class Reference

Use this class instead of a string property whenever your module has a transform frame as property. More...

#include <fw/TransformProperty.h>

Public Member Functions

template<typename Reflector >
void reflect (Reflector &r)
 
bool operator== (const TransformProperty &other) const
 
bool operator!= (const TransformProperty &other) const
 
TransformPropertyoperator= (const std::string &s)
 
const std::string & getID () const
 Returns the frame ID of this property. More...
 
 operator std::string () const
 
bool isValid () const
 
bool isEmpty () const
 
bool empty () const
 

Detailed Description

Use this class instead of a string property whenever your module has a transform frame as property.

When the user clicks on that property a dialog will open where he can select a frame out of all existing ones.

template <typename Reflector>
void reflect(Reflector& r) {
r.property("FrameID", myFrame, "The frame id");
}
TransformProperty myFrame;

Member Function Documentation

◆ reflect()

void reflect ( Reflector &  r)
inline

◆ operator==()

bool operator== ( const TransformProperty other) const
inline

◆ operator!=()

bool operator!= ( const TransformProperty other) const
inline

◆ operator=()

TransformProperty& operator= ( const std::string &  s)
inline

◆ getID()

const std::string& getID ( ) const
inline

Returns the frame ID of this property.

◆ operator std::string()

operator std::string ( ) const
inline

◆ isValid()

bool isValid ( ) const

◆ isEmpty()

bool isEmpty ( ) const
inline

◆ empty()

bool empty ( ) const
inline

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