gem::LandmarkCategory Class Reference

LandmarkCategory object. More...

Inheritance diagram for gem::LandmarkCategory:

Collaboration diagram for gem::LandmarkCategory:

Public Member Functions
	LandmarkCategory (const LandmarkCategory &)=default
	Default copy constructor.
	LandmarkCategory (LandmarkCategory &&)=default
	Default move constructor noexcept is deduced.
LandmarkCategory &	operator= (const LandmarkCategory &categ)=default
	Default copy assignment.
LandmarkCategory &	operator= (LandmarkCategory &&categ)=default
	Default move assignment noexcept is deduced.
bool	operator== (const LandmarkCategory &categ) const
	Comparison operator equal.
bool	operator!= (const LandmarkCategory &categ) const
	Comparison operator not equal.
int	getId () const noexcept
	Get the category ID.
const StringRef	getName () const noexcept
	Get the category name.
LandmarkCategory &	setName (const String &name) noexcept
	Set the category name.
const ImageRef	getImage () const noexcept
	Get the category image.
LandmarkCategory &	setImage (const Image &img) noexcept
	Set the category image.
int	getLandmarkStoreId () const noexcept
	Get parent landmark store id If the category doesn't belong to a landmark store the function will return KNotFound.

Detailed Description

LandmarkCategory object.

Implements share-read / copy-on-write Api object over ILandmarkCategory.

Member Function Documentation

getId()

int gem::LandmarkCategory::getId ( ) const

inlinenoexcept

Get the category ID.

Returns

Category ID

getImage()

const ImageRef gem::LandmarkCategory::getImage ( ) const

inlinenoexcept

Get the category image.

The API user is responsible to check if the image is valid.

Returns

ImageRef for the category image

getLandmarkStoreId()

int gem::LandmarkCategory::getLandmarkStoreId ( ) const

inlinenoexcept

Get parent landmark store id If the category doesn't belong to a landmark store the function will return KNotFound.

Returns

Landmark store id

getName()

const StringRef gem::LandmarkCategory::getName ( ) const

inlinenoexcept

Get the category name.

On return the parameter is set to the actual value. The name may be empty.

Returns

StringRef for the category name

operator!=()

bool gem::LandmarkCategory::operator!= ( const LandmarkCategory & categ ) const

inline

Comparison operator not equal.

Parameters

categ

LandmarkCategory object to compare with

Returns

true if the objects are not equal, false otherwise

operator=() [1/2]

LandmarkCategory & gem::LandmarkCategory::operator= ( const LandmarkCategory & categ )

default

Default copy assignment.

Parameters

categ

LandmarkCategory object to copy from

Returns

LandmarkCategory& Reference to this object

operator=() [2/2]

LandmarkCategory & gem::LandmarkCategory::operator= ( LandmarkCategory && categ )

default

Default move assignment noexcept is deduced.

Parameters

categ

LandmarkCategory object to move from

Returns

LandmarkCategory& Reference to this object

operator==()

bool gem::LandmarkCategory::operator== ( const LandmarkCategory & categ ) const

inline

Comparison operator equal.

Parameters

categ

LandmarkCategory object to compare with

Returns

true if the objects are equal, false otherwise

setImage()

LandmarkCategory & gem::LandmarkCategory::setImage ( const Image & img )

inlinenoexcept

Set the category image.

Parameters

img	Image to set

Returns

reference to this object

setName()

LandmarkCategory & gem::LandmarkCategory::setName ( const String & name )

inlinenoexcept

Set the category name.

Parameters

name	Category name

Returns

reference to this object