gazebo::GazeboTaskboardSlot1::Led Struct Reference

The Led structrure describes the LED in the simulator and holds current led state. More...

List of all members.

Public Member Functions
void	CreateModel (physics::WorldPtr world)
	Create led model in the physics world.
	Led ()
	Led default contructor.
	Led (int index_, bool numPadLed_, LedColor color_, math::Pose pose_)
	Led constructor that initializes led instance with the given parameters.
void	SetupModel (physics::WorldPtr world)
	Setup led model in the physics world.
Public Attributes
LedColor	color
	the color of this led
int	index
	the led index
bool	isOn
	whether this LED is on/off
bool	numPadLed
	if the led is numpad button led
std::string	offLinkName
	link name for OFF state
physics::ModelPtr	offModel
	model for OFF state
std::string	offModelName
	model name for OFF state
std::string	onLinkName
	link name for ON state
physics::ModelPtr	onModel
	model for ON state
std::string	onModelName
	model name for ON state
math::Pose	pose
	the pose of this led

---

Detailed Description

The Led structrure describes the LED in the simulator and holds current led state.

The structure also holds some led configuration parameters since leds configuration is a multi-step process (due to physics engine peculiarities).

Author:

KennyAlive

Version:

1.0

Definition at line 77 of file GazeboTaskboard.cpp.

---

Constructor & Destructor Documentation

gazebo::GazeboTaskboardSlot1::Led::Led

(

)

Led default contructor.

Led structure default constructor.

Definition at line 1425 of file GazeboTaskboard.cpp.

gazebo::GazeboTaskboardSlot1::Led::Led	(	int	index_,
		bool	numPadLed_,
		LedColor	color_,
		math::Pose	pose_
	)

Led constructor that initializes led instance with the given parameters.

Led structure constructor that initializes led instance with provided values.

Parameters:

index_	the led index
numPadLed_	whether it's the led for numpad button or not
color_	the led color in ON state
pose_	the led position

Definition at line 1439 of file GazeboTaskboard.cpp.

---

Member Function Documentation

void gazebo::GazeboTaskboardSlot1::Led::CreateModel

(

physics::WorldPtr

world

)

Create led model in the physics world.

Creates led's model in the physics world.

Parameters:

world

the physics world instance

Definition at line 1452 of file GazeboTaskboard.cpp.

void gazebo::GazeboTaskboardSlot1::Led::SetupModel

(

physics::WorldPtr

world

)

Setup led model in the physics world.

Initializes model references and position the led in the world.

Parameters:

world

the physics world instance

Definition at line 1555 of file GazeboTaskboard.cpp.

---

Member Data Documentation

LedColor gazebo::GazeboTaskboardSlot1::Led::color

the color of this led

Definition at line 106 of file GazeboTaskboard.cpp.

int gazebo::GazeboTaskboardSlot1::Led::index

the led index

Definition at line 102 of file GazeboTaskboard.cpp.

bool gazebo::GazeboTaskboardSlot1::Led::isOn

whether this LED is on/off

Definition at line 80 of file GazeboTaskboard.cpp.

bool gazebo::GazeboTaskboardSlot1::Led::numPadLed

if the led is numpad button led

Definition at line 104 of file GazeboTaskboard.cpp.

std::string gazebo::GazeboTaskboardSlot1::Led::offLinkName

link name for OFF state

Definition at line 97 of file GazeboTaskboard.cpp.

physics::ModelPtr gazebo::GazeboTaskboardSlot1::Led::offModel

model for OFF state

Definition at line 87 of file GazeboTaskboard.cpp.

std::string gazebo::GazeboTaskboardSlot1::Led::offModelName

model name for OFF state

Definition at line 93 of file GazeboTaskboard.cpp.

std::string gazebo::GazeboTaskboardSlot1::Led::onLinkName

link name for ON state

Definition at line 95 of file GazeboTaskboard.cpp.

physics::ModelPtr gazebo::GazeboTaskboardSlot1::Led::onModel

model for ON state

Definition at line 85 of file GazeboTaskboard.cpp.

std::string gazebo::GazeboTaskboardSlot1::Led::onModelName

model name for ON state

Definition at line 91 of file GazeboTaskboard.cpp.

math::Pose gazebo::GazeboTaskboardSlot1::Led::pose

the pose of this led

Definition at line 108 of file GazeboTaskboard.cpp.

---

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

• GazeboTaskboard.cpp