asv::WavefieldEntity Class Reference

A class to manage a wave field that can be accessed from the World. More...

#include <WavefieldEntity.hh>

Inheritance diagram for asv::WavefieldEntity:

Public Member Functions
virtual void	Fini ()
	Finialize the object. More...
std::shared_ptr< const WaveParameters >	GetWaveParams () const
	Get a pointer to the wave pararameters. More...
virtual void	Init ()
	Initialize the object. More...
virtual void	Load (sdf::ElementPtr _sdf)
	Load. More...
virtual void	Reset ()
	Reset the object. More...
virtual void	Update ()
	Update the object. More...
	WavefieldEntity (gazebo::physics::BasePtr _parent)
	Constructor. More...
virtual	~WavefieldEntity ()
	Destructor. More...

Static Public Member Functions
static std::string	MakeName (const std::string &_parentName)
	Make a wave field entity name given a parent object name. More...

Private Attributes
std::shared_ptr< WavefieldEntityPrivate >	data

Detailed Description

A class to manage a wave field that can be accessed from the World.

Definition at line 42 of file WavefieldEntity.hh.

Constructor & Destructor Documentation

asv::WavefieldEntity::~WavefieldEntity ( )

virtual

Destructor.

Definition at line 55 of file WavefieldEntity.cc.

asv::WavefieldEntity::WavefieldEntity ( gazebo::physics::BasePtr  _parent )

explicit

Constructor.

Definition at line 60 of file WavefieldEntity.cc.

Member Function Documentation

void asv::WavefieldEntity::Fini ( )

virtual

Finialize the object.

Definition at line 97 of file WavefieldEntity.cc.

std::shared_ptr< const WaveParameters > asv::WavefieldEntity::GetWaveParams

(

)

const

Get a pointer to the wave pararameters.

Definition at line 118 of file WavefieldEntity.cc.

void asv::WavefieldEntity::Init ( )

virtual

Initialize the object.

Definition at line 103 of file WavefieldEntity.cc.

void asv::WavefieldEntity::Load ( sdf::ElementPtr  _sdf )

virtual

Load.

Definition at line 67 of file WavefieldEntity.cc.

std::string asv::WavefieldEntity::MakeName ( const std::string &  _parentName )

static

Make a wave field entity name given a parent object name.

Parameters

[in]

_parentName

The name of the parent object.

Returns

The name of the wave field entity.

Definition at line 124 of file WavefieldEntity.cc.

void asv::WavefieldEntity::Reset ( )

virtual

Reset the object.

Definition at line 108 of file WavefieldEntity.cc.

void asv::WavefieldEntity::Update ( )

virtual

Update the object.

Definition at line 113 of file WavefieldEntity.cc.

Member Data Documentation

std::shared_ptr<WavefieldEntityPrivate> asv::WavefieldEntity::data

private

Definition at line 76 of file WavefieldEntity.hh.

---

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

• WavefieldEntity.hh
• WavefieldEntity.cc