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

#include <physics/physics.hh>

Inherits State.

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...

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...

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...

State	operator- (const State &_state) const
	Subtraction 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...

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...

Protected Attributes
uint64_t	iterations = 0
	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...

Friends
std::ostream &	operator<< (std::ostream &_out, const gazebo::physics::LightState &_state)
	Stream insertion operator. 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

◆ LightState() [1/3]

LightState ( )

default

Default constructor.

◆ LightState() [2/3]

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.

◆ LightState() [3/3]

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

◆ FillSDF()

void FillSDF ( sdf::ElementPtr _sdf )

Populate a state SDF element with data from the object.

Parameters

[out] _sdf SDF element to populate.

◆ GetIterations()

uint64_t GetIterations ( ) const

inherited

Get the iterations when this state was generated.

Returns: Iterations when the data was recorded

◆ GetName()

std::string GetName ( ) const

inherited

Get the name associated with this State.

Returns: Name associated with this state information. Typically a name of an Entity.

◆ GetRealTime()

common::Time GetRealTime ( ) const

inherited

Get the real time when this state was generated.

Returns: Clock time since simulation was stated.

◆ GetSimTime()

common::Time GetSimTime ( ) const

inherited

Get the sim time when this state was generated.

Returns: Simulation time when the data was recorded.

◆ GetWallTime()

common::Time GetWallTime ( ) const

inherited

Get the wall time when this state was generated.

Returns: The absolute clock time when the State data was recorded.

◆ IsZero()

bool IsZero ( ) const

Return true if the values in the state are zero.

Returns: True if the values in the state are zero.

◆ Load() [1/2]

virtual void 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 State.

◆ Load() [2/2]

void 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.

◆ operator+()

LightState operator+ ( const LightState & _state ) const

Addition operator.

Parameters

[in] _pt A state to substract.

Returns: The resulting state.

◆ operator-() [1/2]

State operator- ( const State & _state ) const

inherited

Subtraction operator.

Parameters

[in] _pt A state to substract.

Returns: The resulting state.

◆ operator-() [2/2]

LightState operator- ( const LightState & _state ) const

Subtraction operator.

Parameters

[in] _pt A state to substract.

Returns: The resulting state.

◆ operator=()

LightState& operator= ( const LightState & _state )

Assignment operator.

Parameters

[in] _state State value

Returns: this

◆ Pose()

const ignition::math::Pose3d Pose ( ) const

Get the stored light pose.

Returns: Pose of the Light.

◆ SetIterations()

virtual void SetIterations ( const uint64_t _iterations )

virtualinherited

Set the iterations when this state was generated.

Parameters

[in] _iterations Iterations when the data was recorded.

Reimplemented in ModelState, WorldState, and LinkState.

◆ SetName()

void SetName ( const std::string & _name )

inherited

Set the name associated with this State.

Parameters

[in] _name Name associated with this state information. Typically the name of an Entity.

◆ SetRealTime()

virtual void SetRealTime ( const common::Time & _time )

virtualinherited

Set the real time when this state was generated.

Parameters

[in] _time Clock time since simulation was stated.

Reimplemented in ModelState, WorldState, and LinkState.

◆ SetSimTime()

virtual void SetSimTime ( const common::Time & _time )

virtualinherited

Set the sim time when this state was generated.

Parameters

[in] _time Simulation time when the data was recorded.

Reimplemented in ModelState, WorldState, and LinkState.

◆ SetWallTime()

virtual void SetWallTime ( const common::Time & _time )

virtualinherited

Set the wall time when this state was generated.

Parameters

[in] _time The absolute clock time when the State data was recorded.

Reimplemented in ModelState, WorldState, and LinkState.

Friends And Related Function Documentation

◆ operator<<

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.

Member Data Documentation

◆ iterations

uint64_t iterations = 0

protectedinherited

The number of simulation iterations when this state was generated.

◆ name

std::string name

protectedinherited

Name associated with this State.

◆ realTime

common::Time realTime

protectedinherited

◆ simTime

common::Time simTime

protectedinherited

◆ wallTime

common::Time wallTime

protectedinherited

Times for the state data.

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

LightState.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LightState() [1/3]

◆ LightState() [2/3]

◆ LightState() [3/3]

Member Function Documentation

◆ FillSDF()

◆ GetIterations()

◆ GetName()

◆ GetRealTime()

◆ GetSimTime()

◆ GetWallTime()

◆ IsZero()

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator=()

◆ Pose()

◆ SetIterations()

◆ SetName()

◆ SetRealTime()

◆ SetSimTime()

◆ SetWallTime()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ iterations

◆ name

◆ realTime

◆ simTime

◆ wallTime