gem::LandmarkBrowseSession Class Reference

LandmarkBrowseSession object. More...

Inheritance diagram for gem::LandmarkBrowseSession:

Collaboration diagram for gem::LandmarkBrowseSession:

Public Member Functions
	LandmarkBrowseSession (const LandmarkBrowseSession &)=delete
	LandmarkBrowseSession (LandmarkBrowseSession &&)=default
	Default move constructor noexcept is deduced.
LandmarkBrowseSession &	operator= (const LandmarkBrowseSession &)=delete
LandmarkBrowseSession &	operator= (LandmarkBrowseSession &&browse)=default
	Default move assignment noexcept is deduced.
int	getId () const noexcept
	Get session id.
int	getLandmarkStoreId () const noexcept
	Get the landmark store id to which this session belongs.
int	getLandmarkCount () const noexcept
	Get the number of all landmarks within the session.
LandmarkList	getLandmarks (unsigned int fromIndex, unsigned int toIndex) const noexcept
	Get the landmarks between the specified indexes: [fromIndex, toIndex).
int	getLandmarkPos (int lmkId) const noexcept
	Get the landmark position in browsing set for the given landmark id.
int	getLandmarkPosition (int landmarkId) const noexcept
	Get the landmark position in browsing set for the given landmark id.
LandmarkBrowseSessionSettings	getSettings () const noexcept
	Get the browse session settings.

Detailed Description

LandmarkBrowseSession object.

Implements share-read / write Api object over ILandmarkBrowseSession.

Facilitates the handling of landmark stores with a very high number of landmarks.

Member Function Documentation

getId()

int gem::LandmarkBrowseSession::getId ( ) const

inlinenoexcept

Get session id.

Returns

The session id

getLandmarkCount()

int gem::LandmarkBrowseSession::getLandmarkCount ( ) const

inlinenoexcept

Get the number of all landmarks within the session.

Returns

The number of landmarks

getLandmarkPos()

int gem::LandmarkBrowseSession::getLandmarkPos ( int lmkId ) const

inlinenoexcept

Get the landmark position in browsing set for the given landmark id.

Deprecated

Use getLandmarkPosition instead.

Returns

The position on success, otherwise the error

Parameters

lmkId

The landmark id

getLandmarkPosition()

int gem::LandmarkBrowseSession::getLandmarkPosition ( int landmarkId ) const

inlinenoexcept

Get the landmark position in browsing set for the given landmark id.

Returns

The position on success, otherwise the error

Parameters

landmarkId

The landmark id

getLandmarks()

LandmarkList gem::LandmarkBrowseSession::getLandmarks ( unsigned int fromIndex, unsigned int toIndex ) const

inlinenoexcept

Get the landmarks between the specified indexes: [fromIndex, toIndex).

Returns

the list of landmarks

Parameters

fromIndex	The start index
toIndex	The end index

If GetBrowseSessionLandmarks returned error, preserve it; LandmarkList creation would set it to 0 otherwise

getLandmarkStoreId()

int gem::LandmarkBrowseSession::getLandmarkStoreId ( ) const

inlinenoexcept

Get the landmark store id to which this session belongs.

Returns

The landmark store id

getSettings()

LandmarkBrowseSessionSettings gem::LandmarkBrowseSession::getSettings ( ) const

inlinenoexcept

Get the browse session settings.

Returns

The settings

operator=()

LandmarkBrowseSession & gem::LandmarkBrowseSession::operator= ( LandmarkBrowseSession && browse )

default

Default move assignment noexcept is deduced.

Parameters

browse

The object to move

Returns

The moved object