Detailed Description

template<typename Coordinate>
class maliput::object::api::Object< Coordinate >

Represents an object in a given Coordinate system.

#include <include/maliput_object/api/object.h>

Public Types
using	Id = maliput::api::TypeSpecificIdentifier< class Object >

Public Member Functions
	Object (const Id &id, const std::map< std::string, std::string > &properties, std::unique_ptr< maliput::math::BoundingRegion< Coordinate >> region)
	Constructs an Object. More...

	~Object ()=default

Id	id () const

const maliput::math::BoundingRegion< Coordinate > &	bounding_region () const

const Coordinate &	position () const

std::optional< std::string >	get_property (const std::string &key) const

const std::map< std::string, std::string > &	get_properties () const

Member Typedef Documentation

◆ Id

using Id = maliput::api::TypeSpecificIdentifier<class Object>

Constructor & Destructor Documentation

◆ Object()

Object	(	const Id &	id,
		const std::map< std::string, std::string > &	properties,
		std::unique_ptr< maliput::math::BoundingRegion< Coordinate >>	region
	)

Constructs an Object.

Parameters

id	Id of the object.
properties	Object's properties.
region	Object's bounding region.

Template Parameters

Coordinate Coordinate of the bounding region instance.

◆ ~Object()

~Object ( )

default

Member Function Documentation

◆ bounding_region()

const maliput::math::BoundingRegion< Coordinate > & bounding_region

Returns: The bounding region of the object.

◆ get_properties()

const std::map< std::string, std::string > & get_properties

Returns: All the properties of the object.

◆ get_property()

std::optional< std::string > get_property ( const std::string & key ) const

Returns: A property of the object.

◆ id()

Object< Coordinate >::Id id

Returns: The id of the Object.

◆ position()

const Coordinate & position

Returns: The position of the object in the Inertial-.

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