gazebo::physics::LightState Class Reference

Store state information of a Light object. More...

#include <physics/physics.hh>

Inheritance diagram for gazebo::physics::LightState:

Public Member Functions
	LightState ()=default
	Default constructor. More...
	LightState (const LightPtr _light, const common::Time &_realTime, const common::Time &_simTime, const uint64_t _iterations)
	Constructor. More...
	LightState (const sdf::ElementPtr _sdf)
	Constructor. More...
void	FillSDF (sdf::ElementPtr _sdf)
	Populate a state SDF element with data from the object. More...
bool	IsZero () const
	Return true if the values in the state are zero. More...
virtual void	Load (const sdf::ElementPtr _elem)
	Load state from SDF element. More...
void	Load (const LightPtr _light, const common::Time &_realTime, const common::Time &_simTime, const uint64_t _iterations)
	Load state from Light pointer. More...
LightState	operator+ (const LightState &_state) const
	Addition operator. More...
LightState	operator- (const LightState &_state) const
	Subtraction operator. More...
LightState &	operator= (const LightState &_state)
	Assignment operator. More...
const ignition::math::Pose3d	Pose () const
	Get the stored light pose. More...
Public Member Functions inherited from gazebo::physics::State
	State ()
	Default constructor. More...
	State (const std::string &_name, const common::Time &_realTime, const common::Time &_simTime, const uint64_t _iterations)
	Constructor. More...
virtual	~State ()
	Destructor. More...
uint64_t	GetIterations () const
	Get the iterations when this state was generated. More...
std::string	GetName () const
	Get the name associated with this State. More...
common::Time	GetRealTime () const
	Get the real time when this state was generated. More...
common::Time	GetSimTime () const
	Get the sim time when this state was generated. More...
common::Time	GetWallTime () const
	Get the wall time when this state was generated. More...
State	operator- (const State &_state) const
	Subtraction operator. More...
State &	operator= (const State &_state)
	Assignment operator. More...
virtual void	SetIterations (const uint64_t _iterations)
	Set the iterations when this state was generated. More...
void	SetName (const std::string &_name)
	Set the name associated with this State. More...
virtual void	SetRealTime (const common::Time &_time)
	Set the real time when this state was generated. More...
virtual void	SetSimTime (const common::Time &_time)
	Set the sim time when this state was generated. More...
virtual void	SetWallTime (const common::Time &_time)
	Set the wall time when this state was generated. More...

Friends
std::ostream &	operator<< (std::ostream &_out, const gazebo::physics::LightState &_state)
	Stream insertion operator. More...

Additional Inherited Members
Protected Attributes inherited from gazebo::physics::State
uint64_t	iterations
	The number of simulation iterations when this state was generated. More...
std::string	name
	Name associated with this State. More...
common::Time	realTime
common::Time	simTime
common::Time	wallTime
	Times for the state data. More...

Detailed Description

Store state information of a Light object.

This class captures the entire state of a Light at one specific time during a simulation run.

Constructor & Destructor Documentation

gazebo::physics::LightState::LightState ( )

default

Default constructor.

gazebo::physics::LightState::LightState	(	const LightPtr	_light,
		const common::Time &	_realTime,
		const common::Time &	_simTime,
		const uint64_t	_iterations
	)

Constructor.

Build a LightState from an existing Light.

Parameters

[in]	_light	Pointer to the light from which to gather state info.
[in]	_realTime	Real time stamp.
[in]	_simTime	Sim time stamp.
[in]	_iterations	Simulation iterations.

gazebo::physics::LightState::LightState ( const sdf::ElementPtr  _sdf )

explicit

Constructor.

Build a LightState from SDF data

Parameters

[in]

_sdf

SDF data to load a light state from.

Member Function Documentation

void gazebo::physics::LightState::FillSDF

(

sdf::ElementPtr

_sdf

)

Populate a state SDF element with data from the object.

Parameters

[out]

_sdf

SDF element to populate.

bool gazebo::physics::LightState::IsZero

(

)

const

Return true if the values in the state are zero.

Returns

True if the values in the state are zero.

virtual void gazebo::physics::LightState::Load ( const sdf::ElementPtr  _elem )

virtual

Load state from SDF element.

Load LightState information from stored data in and SDF::Element

Parameters

[in]

_elem

Pointer to the SDF::Element containing state info.

Reimplemented from gazebo::physics::State.

void gazebo::physics::LightState::Load	(	const LightPtr	_light,
		const common::Time &	_realTime,
		const common::Time &	_simTime,
		const uint64_t	_iterations
	)

Load state from Light pointer.

Build a LightState from an existing Light.

Parameters

[in]	_light	Pointer to the light from which to gather state info.
[in]	_realTime	Real time stamp.
[in]	_simTime	Sim time stamp.
[in]	_iterations	Simulation iterations.

LightState gazebo::physics::LightState::operator+

(

const LightState &

_state

)

const

Addition operator.

Parameters

[in]

_pt

A state to substract.

Returns

The resulting state.

LightState gazebo::physics::LightState::operator-

(

const LightState &

_state

)

const

Subtraction operator.

Parameters

[in]

_pt

A state to substract.

Returns

The resulting state.

LightState& gazebo::physics::LightState::operator=

(

const LightState &

_state

)

Assignment operator.

Parameters

[in]

_state

State value

Returns

this

const ignition::math::Pose3d gazebo::physics::LightState::Pose

(

)

const

Get the stored light pose.

Returns

Pose of the Light.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _out, const gazebo::physics::LightState &  _state  )

friend

Stream insertion operator.

Parameters

[in]	_out	output stream.
[in]	_state	Light state to output.

Returns

The stream.

---

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

• LightState.hh