Defines how to identify a model. More...

#include <Model.hh>

Public Member Functions
	Model ()
	Default constructor. More...

	Model (const Model &_orig)=default
	Copy constructor. More...

Result	Fetch () const
	Make sure this model is in the local cache. More...

ModelIdentifier	Identification () const
	Returns information identifying the model. More...

	operator bool ()
	Returns false if model was constructed via Model(). More...

	operator bool () const
	Returns false if model was constructed via Model() More...

std::string	PathToModel () const
	Returns a path to the model on disk if it is already cached. More...

Protected Member Functions
	Model (std::shared_ptr< ModelPrivate > _dptr)
	Protected constructor. More...

Detailed Description

Defines how to identify a model.

Constructor & Destructor Documentation

◆ Model() [1/3]

Model ( )

Default constructor.

◆ Model() [2/3]

Model ( const Model & _orig )

default

Copy constructor.

Parameters

[in] _orig Model to copy.

◆ Model() [3/3]

Model ( std::shared_ptr< ModelPrivate > _dptr )

explicitprotected

Protected constructor.

Parameters

[in] _dPtr Model private data to copy.

Member Function Documentation

◆ Fetch()

Result Fetch ( ) const

Make sure this model is in the local cache.

Remarks: this downloads the model and saves it locally if necessary

Returns: The result of fetching

◆ Identification()

ModelIdentifier Identification ( ) const

Returns information identifying the model.

Returns: Information that can identify the model.

◆ operator bool() [1/2]

operator bool ( )

Returns false if model was constructed via Model().

Returns: False if model was constructed via Model().

◆ operator bool() [2/2]

operator bool ( ) const

Returns false if model was constructed via Model()

◆ PathToModel()

std::string PathToModel ( ) const

Returns a path to the model on disk if it is already cached.

Returns: path, or empty string if the model is not cached.

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

gz/fuel_tools/Model.hh

Gazebo Fuel_tools

API Reference

Public Member Functions

Protected Member Functions