Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
radial_menu_model::Model Class Reference

#include <model.hpp>

Public Member Functions

void ascend ()
 
bool canAscend () const
 
bool canDescend (const ItemConstPtr &item) const
 
bool canDeselect (const ItemConstPtr &item) const
 
bool canPoint (const ItemConstPtr &item) const
 
bool canSelect (const ItemConstPtr &item) const
 
bool canUnpoint (const ItemConstPtr &item) const
 
ItemConstPtr currentLevel () const
 
void descend (const ItemConstPtr &item, const bool allow_multi_selection)
 
void deselect (const ItemConstPtr &item)
 
radial_menu_msgs::StatePtr exportState (const ros::Time stamp=ros::Time::now()) const
 
bool isEnabled () const
 
bool isPointed (const ItemConstPtr &item) const
 
bool isPointed (const std::string &path, const char separator='.') const
 
bool isSelected (const ItemConstPtr &item) const
 
bool isSelected (const std::string &path, const char separator='.') const
 
 Model ()
 
void point (const ItemConstPtr &item)
 
ItemConstPtr pointed () const
 
bool resetDescription ()
 
bool resetState ()
 
ItemConstPtr root () const
 
void select (const ItemConstPtr &item, const bool allow_multi_selection)
 
std::vector< ItemConstPtr > selected () const
 
bool setDescription (const std::string &desc)
 
bool setDescriptionFromParam (const std::string &param_name)
 
void setEnabled (const bool is_enabled)
 
bool setState (const radial_menu_msgs::State &new_state)
 
ItemConstPtr sibilingByAngle (double angle) const
 
std::string toString () const
 
void unpoint (const ItemConstPtr &item)
 
virtual ~Model ()
 

Static Public Member Functions

static std::string defaultDescription ()
 
static radial_menu_msgs::State defaultState ()
 

Protected Member Functions

void forceDeselect (const ItemConstPtr &item)
 
void forceSelect (const ItemConstPtr &item)
 

Protected Attributes

ItemConstPtr current_level_
 
std::vector< ItemConstPtr > items_
 
radial_menu_msgs::State state_
 

Detailed Description

Definition at line 23 of file model.hpp.

Constructor & Destructor Documentation

◆ Model()

radial_menu_model::Model::Model ( )
inline

Definition at line 25 of file model.hpp.

◆ ~Model()

virtual radial_menu_model::Model::~Model ( )
inlinevirtual

Definition at line 30 of file model.hpp.

Member Function Documentation

◆ ascend()

void radial_menu_model::Model::ascend ( )
inline

Definition at line 294 of file model.hpp.

◆ canAscend()

bool radial_menu_model::Model::canAscend ( ) const
inline

Definition at line 291 of file model.hpp.

◆ canDescend()

bool radial_menu_model::Model::canDescend ( const ItemConstPtr &  item) const
inline

Definition at line 268 of file model.hpp.

◆ canDeselect()

bool radial_menu_model::Model::canDeselect ( const ItemConstPtr &  item) const
inline

Definition at line 249 of file model.hpp.

◆ canPoint()

bool radial_menu_model::Model::canPoint ( const ItemConstPtr &  item) const
inline

Definition at line 196 of file model.hpp.

◆ canSelect()

bool radial_menu_model::Model::canSelect ( const ItemConstPtr &  item) const
inline

Definition at line 228 of file model.hpp.

◆ canUnpoint()

bool radial_menu_model::Model::canUnpoint ( const ItemConstPtr &  item) const
inline

Definition at line 210 of file model.hpp.

◆ currentLevel()

ItemConstPtr radial_menu_model::Model::currentLevel ( ) const
inline

Definition at line 38 of file model.hpp.

◆ defaultDescription()

static std::string radial_menu_model::Model::defaultDescription ( )
inlinestatic

Definition at line 135 of file model.hpp.

◆ defaultState()

static radial_menu_msgs::State radial_menu_model::Model::defaultState ( )
inlinestatic

Definition at line 176 of file model.hpp.

◆ descend()

void radial_menu_model::Model::descend ( const ItemConstPtr &  item,
const bool  allow_multi_selection 
)
inline

Definition at line 275 of file model.hpp.

◆ deselect()

void radial_menu_model::Model::deselect ( const ItemConstPtr &  item)
inline

Definition at line 255 of file model.hpp.

◆ exportState()

radial_menu_msgs::StatePtr radial_menu_model::Model::exportState ( const ros::Time  stamp = ros::Time::now()) const
inline

Definition at line 146 of file model.hpp.

◆ forceDeselect()

void radial_menu_model::Model::forceDeselect ( const ItemConstPtr &  item)
inlineprotected

Definition at line 361 of file model.hpp.

◆ forceSelect()

void radial_menu_model::Model::forceSelect ( const ItemConstPtr &  item)
inlineprotected

Definition at line 352 of file model.hpp.

◆ isEnabled()

bool radial_menu_model::Model::isEnabled ( ) const
inline

Definition at line 187 of file model.hpp.

◆ isPointed() [1/2]

bool radial_menu_model::Model::isPointed ( const ItemConstPtr &  item) const
inline

Definition at line 45 of file model.hpp.

◆ isPointed() [2/2]

bool radial_menu_model::Model::isPointed ( const std::string &  path,
const char  separator = '.' 
) const
inline

Definition at line 47 of file model.hpp.

◆ isSelected() [1/2]

bool radial_menu_model::Model::isSelected ( const ItemConstPtr &  item) const
inline

Definition at line 62 of file model.hpp.

◆ isSelected() [2/2]

bool radial_menu_model::Model::isSelected ( const std::string &  path,
const char  separator = '.' 
) const
inline

Definition at line 74 of file model.hpp.

◆ point()

void radial_menu_model::Model::point ( const ItemConstPtr &  item)
inline

Definition at line 201 of file model.hpp.

◆ pointed()

ItemConstPtr radial_menu_model::Model::pointed ( ) const
inline

Definition at line 40 of file model.hpp.

◆ resetDescription()

bool radial_menu_model::Model::resetDescription ( )
inline

Definition at line 133 of file model.hpp.

◆ resetState()

bool radial_menu_model::Model::resetState ( )
inline

Definition at line 174 of file model.hpp.

◆ root()

ItemConstPtr radial_menu_model::Model::root ( ) const
inline

Definition at line 36 of file model.hpp.

◆ select()

void radial_menu_model::Model::select ( const ItemConstPtr &  item,
const bool  allow_multi_selection 
)
inline

Definition at line 235 of file model.hpp.

◆ selected()

std::vector< ItemConstPtr > radial_menu_model::Model::selected ( ) const
inline

Definition at line 52 of file model.hpp.

◆ setDescription()

bool radial_menu_model::Model::setDescription ( const std::string &  desc)
inline

Definition at line 99 of file model.hpp.

◆ setDescriptionFromParam()

bool radial_menu_model::Model::setDescriptionFromParam ( const std::string &  param_name)
inline

Definition at line 122 of file model.hpp.

◆ setEnabled()

void radial_menu_model::Model::setEnabled ( const bool  is_enabled)
inline

Definition at line 189 of file model.hpp.

◆ setState()

bool radial_menu_model::Model::setState ( const radial_menu_msgs::State &  new_state)
inline

Definition at line 153 of file model.hpp.

◆ sibilingByAngle()

ItemConstPtr radial_menu_model::Model::sibilingByAngle ( double  angle) const
inline

Definition at line 83 of file model.hpp.

◆ toString()

std::string radial_menu_model::Model::toString ( ) const
inline

Definition at line 311 of file model.hpp.

◆ unpoint()

void radial_menu_model::Model::unpoint ( const ItemConstPtr &  item)
inline

Definition at line 215 of file model.hpp.

Member Data Documentation

◆ current_level_

ItemConstPtr radial_menu_model::Model::current_level_
protected

Definition at line 370 of file model.hpp.

◆ items_

std::vector< ItemConstPtr > radial_menu_model::Model::items_
protected

Definition at line 369 of file model.hpp.

◆ state_

radial_menu_msgs::State radial_menu_model::Model::state_
protected

Definition at line 371 of file model.hpp.

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

radial_menu_model
Author(s):
autogenerated on Mon Feb 28 2022 23:22:00