A model that represents a catalog. More...

#include <Catalog.h>

Public Member Functions
	Catalog (const Catalog &)=default

	Catalog (Catalog &&)=default

Catalog &	operator= (const Catalog &)=default

Catalog &	operator= (Catalog &&)=default

const std::string &	GetId () const
	Gets the ID that is used to refer to this catalog programmatically. More...

std::string &	GetMutableId ()
	Gets a mutable reference to the ID that is used to refer to this catalog programmatically. More...

void	SetId (const std::string &value)
	Sets the catalog ID. More...

const std::string &	GetHrn () const
	Gets the HERE Resource Name (HRN) of the catalog. More...

std::string &	GetMutableHrn ()
	Gets a mutable reference to the HRN of the catalog. More...

void	SetHrn (const std::string &value)
	Sets the catalog HRN. More...

const std::string &	GetName () const
	Gets the short name of the catalog. More...

std::string &	GetMutableName ()
	Gets a mutable reference to the catalog short name. More...

void	SetName (const std::string &value)
	Sets the catalog short name. More...

const std::string &	GetSummary () const
	Gets the one-sentence summary of the catalog. More...

std::string &	GetMutableSummary ()
	Gets a mutable reference to the one-sentence summary of the catalog. More...

void	SetSummary (const std::string &value)
	Sets the catalog summary. More...

const std::string &	GetDescription () const
	Gets the detailed description of the catalog. More...

std::string &	GetMutableDescription ()
	Gets a mutable reference to the detailed description of the catalog. More...

void	SetDescription (const std::string &value)
	Sets the detailed description of the catalog. More...

const Coverage &	GetCoverage () const
	Gets the `Coverage` instance. More...

Coverage &	GetMutableCoverage ()
	Gets a mutable reference to the `Coverage` instance. More...

void	SetCoverage (const Coverage &value)
	Sets the `Coverage` instance. More...

const Owner &	GetOwner () const
	Gets the `Owner` instance. More...

Owner &	GetMutableOwner ()
	Gets a mutable reference to the `Owner` instance. More...

void	SetOwner (const Owner &value)
	Sets the `Owner` instance. More...

const std::vector< std::string > &	GetTags () const
	Gets the keywords that help to find the catalog on the HERE platform Portal. More...

std::vector< std::string > &	GetMutableTags ()
	Gets a mutable reference to the keywords that help to find the catalog on the HERE platform Portal. More...

void	SetTags (const std::vector< std::string > &value)
	Sets the keywords that help to find the catalog. More...

const std::vector< std::string > &	GetBillingTags () const
	Gets the list of billing tags that are used to group billing records. More...

std::vector< std::string > &	GetMutableBillingTags ()
	Gets a mutable reference to the list of billing tags that are used to group billing records. More...

void	SetBillingTags (const std::vector< std::string > &value)
	Sets the list of billing tags. More...

const std::string &	GetCreated () const
	Gets the catalog creation date and time. More...

std::string &	GetMutableCreated ()
	Gets a mutable reference to the catalog creation date and time. More...

void	SetCreated (const std::string &value)
	Sets the catalog creation date and time. More...

const std::vector< Layer > &	GetLayers () const
	Gets the vector with the `Layer` instance. More...

std::vector< Layer > &	GetMutableLayers ()
	Gets a mutable reference to the vector with the `Layer` instance. More...

void	SetLayers (const std::vector< Layer > &value)
	Sets the vector with the `Layer` instance. More...

const int64_t &	GetVersion () const
	Gets the version of the catalog configuration. More...

int64_t &	GetMutableVersion ()
	Gets a mutable reference to the version of the catalog configuration. More...

void	SetVersion (const int64_t &value)
	Sets the catalog configuration version. More...

const Notifications &	GetNotifications () const
	Gets the `Notifications` instance. More...

Notifications &	GetMutableNotifications ()
	Gets a mutable reference to the `Notifications` instance. More...

void	SetNotifications (const Notifications &value)
	Sets the `Notifications` instance. More...

Detailed Description

A model that represents a catalog.

Member Function Documentation

◆ GetBillingTags()

const std::vector<std::string>& olp::dataservice::read::model::Catalog::GetBillingTags ( ) const

inline

Gets the list of billing tags that are used to group billing records.

The billing tag is an optional free-form tag that is used for grouping billing records. If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].

Returns: The list of billing tags.

◆ GetCoverage()

const Coverage& olp::dataservice::read::model::Catalog::GetCoverage ( ) const

inline

Gets the Coverage instance.

Returns: The Coverage instance.

◆ GetCreated()

const std::string& olp::dataservice::read::model::Catalog::GetCreated ( ) const

inline

Gets the catalog creation date and time.

Returns: The catalog creation date and time.

◆ GetDescription()

const std::string& olp::dataservice::read::model::Catalog::GetDescription ( ) const

inline

Gets the detailed description of the catalog.

This description appears on the Overview tab when you open a catalog on the HERE platform Portal.

Returns: The detailed description of the catalog.

◆ GetHrn()

const std::string& olp::dataservice::read::model::Catalog::GetHrn ( ) const

inline

Gets the HERE Resource Name (HRN) of the catalog.

Returns: The catalog HRN.

◆ GetId()

const std::string& olp::dataservice::read::model::Catalog::GetId ( ) const

inline

Gets the ID that is used to refer to this catalog programmatically.

All catalog IDs must be unique across all catalogs in the HERE platform. Do not put private information in the catalog ID. The catalog ID forms a portion of the catalog HERE Resource Name (HRN), and HRNs are visible to other users.

Returns: The catalog ID.

◆ GetLayers()

const std::vector<Layer>& olp::dataservice::read::model::Catalog::GetLayers ( ) const

inline

Gets the vector with the Layer instance.

Returns: The vector with the Layer instance.

◆ GetMutableBillingTags()

std::vector<std::string>& olp::dataservice::read::model::Catalog::GetMutableBillingTags ( )

inline

Gets a mutable reference to the list of billing tags that are used to group billing records.

See also: GetBillingTags for information on the billing tags.

Returns: The mutable reference to the list of billing tags.

◆ GetMutableCoverage()

Coverage& olp::dataservice::read::model::Catalog::GetMutableCoverage ( )

inline

Gets a mutable reference to the Coverage instance.

Returns: The mutable reference to the Coverage instance.

◆ GetMutableCreated()

std::string& olp::dataservice::read::model::Catalog::GetMutableCreated ( )

inline

Gets a mutable reference to the catalog creation date and time.

Returns: The mutable reference to the catalog creation date and time.

◆ GetMutableDescription()

std::string& olp::dataservice::read::model::Catalog::GetMutableDescription ( )

inline

Gets a mutable reference to the detailed description of the catalog.

See also: GetDescription for more information on the detailed description of the catalog.

Returns: The mutable reference to the detailed description of the catalog.

◆ GetMutableHrn()

std::string& olp::dataservice::read::model::Catalog::GetMutableHrn ( )

inline

Gets a mutable reference to the HRN of the catalog.

Returns: The mutable reference to the catalog HRN.

◆ GetMutableId()

std::string& olp::dataservice::read::model::Catalog::GetMutableId ( )

inline

Gets a mutable reference to the ID that is used to refer to this catalog programmatically.

See also: GetId for information on the catalog ID.

Returns: The mutable reference to the catalog ID.

◆ GetMutableLayers()

std::vector<Layer>& olp::dataservice::read::model::Catalog::GetMutableLayers ( )

inline

Gets a mutable reference to the vector with the Layer instance.

Returns: The mutable reference to the vector with the Layer instance.

◆ GetMutableName()

std::string& olp::dataservice::read::model::Catalog::GetMutableName ( )

inline

Gets a mutable reference to the catalog short name.

Returns: The mutable reference to the catalog short name.

◆ GetMutableNotifications()

Notifications& olp::dataservice::read::model::Catalog::GetMutableNotifications ( )

inline

Gets a mutable reference to the Notifications instance.

Returns: The mutable reference to the Notifications instance.

◆ GetMutableOwner()

Owner& olp::dataservice::read::model::Catalog::GetMutableOwner ( )

inline

Gets a mutable reference to the Owner instance.

Returns: The mutable reference to the Owner instance.

◆ GetMutableSummary()

std::string& olp::dataservice::read::model::Catalog::GetMutableSummary ( )

inline

Gets a mutable reference to the one-sentence summary of the catalog.

Returns: The mutable reference to the one-sentence summary of the catalog.

◆ GetMutableTags()

std::vector<std::string>& olp::dataservice::read::model::Catalog::GetMutableTags ( )

inline

Gets a mutable reference to the keywords that help to find the catalog on the HERE platform Portal.

Returns: The mutable reference to the keywords that help to find the catalog.

◆ GetMutableVersion()

int64_t& olp::dataservice::read::model::Catalog::GetMutableVersion ( )

inline

Gets a mutable reference to the version of the catalog configuration.

See also: GetVersion for information on the catalog configuration version.

Returns: The mutable reference to the catalog configuration version.

◆ GetName()

const std::string& olp::dataservice::read::model::Catalog::GetName ( ) const

inline

Gets the short name of the catalog.

Returns: The catalog short name.

◆ GetNotifications()

const Notifications& olp::dataservice::read::model::Catalog::GetNotifications ( ) const

inline

Gets the Notifications instance.

Returns: The Notifications instance.

◆ GetOwner()

const Owner& olp::dataservice::read::model::Catalog::GetOwner ( ) const

inline

Gets the Owner instance.

Returns: The Owner instance.

◆ GetSummary()

const std::string& olp::dataservice::read::model::Catalog::GetSummary ( ) const

inline

Gets the one-sentence summary of the catalog.

You can see this summary when you browse a list of catalogs on the HERE platform Portal.

Returns: The one-sentence summary of the catalog.

◆ GetTags()

const std::vector<std::string>& olp::dataservice::read::model::Catalog::GetTags ( ) const

inline

Gets the keywords that help to find the catalog on the HERE platform Portal.

Returns: The keywords that help to find the catalog.

◆ GetVersion()

const int64_t& olp::dataservice::read::model::Catalog::GetVersion ( ) const

inline

Gets the version of the catalog configuration.

Every change in this number indicates a change in catalog configuration. Examples of changes in catalog configuration include changing catalog parameters and adding layers. Note that the catalog configuration version is not the same as the metadata/data version. Configuration and metadata versions are independent of each other and indicate different kinds of changes.

Returns: The catalog configuration version.

◆ SetBillingTags()

void olp::dataservice::read::model::Catalog::SetBillingTags ( const std::vector< std::string > & value )

inline

Sets the list of billing tags.

See also: GetBillingTags for information on the billing tags.

Parameters

value The list of billing tags that are used to group billing records.

◆ SetCoverage()

void olp::dataservice::read::model::Catalog::SetCoverage ( const Coverage & value )

inline

Sets the Coverage instance.

Parameters

value The Coverage instance.

◆ SetCreated()

void olp::dataservice::read::model::Catalog::SetCreated ( const std::string & value )

inline

Sets the catalog creation date and time.

Parameters

value The catalog creation date and time.

◆ SetDescription()

void olp::dataservice::read::model::Catalog::SetDescription ( const std::string & value )

inline

Sets the detailed description of the catalog.

See also: GetDescription for more information on the detailed description of the catalog.

Parameters

value The detailed description of the catalog.

◆ SetHrn()

void olp::dataservice::read::model::Catalog::SetHrn ( const std::string & value )

inline

Sets the catalog HRN.

Parameters

value The catalog HRN.

◆ SetId()

void olp::dataservice::read::model::Catalog::SetId ( const std::string & value )

inline

Sets the catalog ID.

See also: GetId for information on the catalog ID.

Parameters

value The catalog ID.

◆ SetLayers()

void olp::dataservice::read::model::Catalog::SetLayers ( const std::vector< Layer > & value )

inline

Sets the vector with the Layer instance.

Parameters

value The vector with the Layer instance.

◆ SetName()

void olp::dataservice::read::model::Catalog::SetName ( const std::string & value )

inline

Sets the catalog short name.

Parameters

value The catalog short name.

◆ SetNotifications()

void olp::dataservice::read::model::Catalog::SetNotifications ( const Notifications & value )

inline

Sets the Notifications instance.

Parameters

value The Notifications instance.

◆ SetOwner()

void olp::dataservice::read::model::Catalog::SetOwner ( const Owner & value )

inline

Sets the Owner instance.

Parameters

value The Owner instance.

◆ SetSummary()

void olp::dataservice::read::model::Catalog::SetSummary ( const std::string & value )

inline

Sets the catalog summary.

Parameters

value The one-sentence summary of the catalog.

◆ SetTags()

void olp::dataservice::read::model::Catalog::SetTags ( const std::vector< std::string > & value )

inline

Sets the keywords that help to find the catalog.

Parameters

value The keywords that help to find the catalog on the HERE platform Portal.

◆ SetVersion()

void olp::dataservice::read::model::Catalog::SetVersion ( const int64_t & value )

inline

Sets the catalog configuration version.

See also: GetVersion for information on the catalog configuration version.

Parameters

value The catalog configuration version.

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

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/model/Catalog.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBillingTags()

◆ GetCoverage()

◆ GetCreated()

◆ GetDescription()

◆ GetHrn()

◆ GetId()

◆ GetLayers()

◆ GetMutableBillingTags()

◆ GetMutableCoverage()

◆ GetMutableCreated()

◆ GetMutableDescription()

◆ GetMutableHrn()

◆ GetMutableId()

◆ GetMutableLayers()

◆ GetMutableName()

◆ GetMutableNotifications()

◆ GetMutableOwner()

◆ GetMutableSummary()

◆ GetMutableTags()

◆ GetMutableVersion()

◆ GetName()

◆ GetNotifications()

◆ GetOwner()

◆ GetSummary()

◆ GetTags()

◆ GetVersion()

◆ SetBillingTags()

◆ SetCoverage()

◆ SetCreated()

◆ SetDescription()

◆ SetHrn()

◆ SetId()

◆ SetLayers()

◆ SetName()

◆ SetNotifications()

◆ SetOwner()

◆ SetSummary()

◆ SetTags()

◆ SetVersion()