Class to create DCSM metadata object to be used in DcsmProvider. More...

#include <DcsmMetadataCreator.h>

Inheritance diagram for ramses::DcsmMetadataCreator:

Collaboration diagram for ramses::DcsmMetadataCreator:

Public Member Functions
	DcsmMetadataCreator ()
	Constructor. More...

	~DcsmMetadataCreator ()
	Destructor. More...

status_t	setPreviewImagePng (const void *data, size_t dataLength)
	Set preview image metadata entry. Data must point to a valid in memory representation of a PNG file for the time of calling this method. More...

status_t	setPreviewDescription (std::u32string previewDescription)
	Set preview description metadata entry. Must be a valid utf32 string. More...

status_t	setWidgetOrder (int32_t widgetOrder)
	Set widget order metadata entry. Used to determine order within a dcsm category. More...

status_t	setWidgetBackgroundID (int32_t backgroundID)
	Set widget background ID metadata entry. Requests specific background at consumer side. More...

status_t	setWidgetHUDLineID (int32_t hudLineID)
	Set widget hud line ID metadata entry. Requests specific HUD line style at consumer side. More...

status_t	setCarModel (int32_t carModel)
	Set car model metadata entry. Requests car model to be put into widget at consumer side. More...

status_t	setCarModelView (const CarModelViewMetadata &viewMetadata, const AnimationInformation &timingInfo)
	Set car model view metadata entry. Requests car model view parameters at consumer side. More...

status_t	setCarModelViewExtended (const CarModelViewMetadataExtended &viewMetadata)
	Set car model view extended metadata entry. Provides additional values for setCarModelView() More...

status_t	setCarModelVisibility (bool visibility)
	Set car model visibility metadata entry. Requests car model visibility at consumer side. More...

status_t	setExclusiveBackground (bool state)
	Set the exclusive background metadata entry. Requests to show widget exclusively without other overlapping content in background. More...

status_t	setStreamID (int32_t streamID)
	Set the streamID metadata entry. Requests to start/show specified stream. More...

status_t	setContentFlippedVertically (bool state)
	Set the contentFlippedVertically metadata entry. Requests to show widget mirrored on Y-axis. More...

status_t	setDisplayedDataFlags (uint32_t flags)
	Set displayed data flags metadata entry. More...

status_t	setLayoutAvailability (uint8_t flags)
	Set widget layout dependency to the given M Modes. More...

status_t	setConfiguratorPriority (uint8_t priority)
	Set the widget configurator priority for this dcsm content. More...

	DcsmMetadataCreator (DcsmMetadataCreator &&other)=delete
	Deleted move constructor. More...

DcsmMetadataCreator &	operator= (DcsmMetadataCreator &&other)=delete
	Deleted move assignment. More...

	DcsmMetadataCreator (const DcsmMetadataCreator &other)=delete
	Deleted copy constructor. More...

DcsmMetadataCreator &	operator= (const DcsmMetadataCreator &other)=delete
	Deleted copy assignment. More...

Public Member Functions inherited from ramses::StatusObject
status_t	validate () const
	Generates verbose validation of the object. More...

const char *	getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
	Provides verbose report in human readable form generated by validate. More...

const char *	getStatusMessage (status_t status) const
	Get the string description for a status provided by a RAMSES API function. More...

	StatusObject (const StatusObject &other)=delete
	Deleted copy constructor. More...

StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
class DcsmMetadataCreatorImpl &	impl

Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Additional Inherited Members
Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...

virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Detailed Description

Class to create DCSM metadata object to be used in DcsmProvider.

It is not required or expected to set all metadata entries before handing the DcsmMetadataCreator to DcsmProvider. Only the set entries will be transferred to consumer side. It is not required to always provide all values on update but only provide a delta to the last update for a given content.

A new DcsmMetadataCreator object shall be used for each DcsmProvider call.

Examples: ramses-example-dcsm-provider/src/main.cpp.

Constructor & Destructor Documentation

◆ DcsmMetadataCreator() [1/3]

ramses::DcsmMetadataCreator::DcsmMetadataCreator ( )

Constructor.

◆ ~DcsmMetadataCreator()

ramses::DcsmMetadataCreator::~DcsmMetadataCreator ( )

Destructor.

◆ DcsmMetadataCreator() [2/3]

ramses::DcsmMetadataCreator::DcsmMetadataCreator ( DcsmMetadataCreator && other )

delete

Deleted move constructor.

Parameters

other unused

◆ DcsmMetadataCreator() [3/3]

ramses::DcsmMetadataCreator::DcsmMetadataCreator ( const DcsmMetadataCreator & other )

delete

Deleted copy constructor.

Parameters

other unused

Member Function Documentation

◆ operator=() [1/2]

DcsmMetadataCreator& ramses::DcsmMetadataCreator::operator= ( const DcsmMetadataCreator & other )

delete

Deleted copy assignment.

Parameters

other unused

Returns: unused

◆ operator=() [2/2]

DcsmMetadataCreator& ramses::DcsmMetadataCreator::operator= ( DcsmMetadataCreator && other )

delete

Deleted move assignment.

Parameters

other unused

Returns: unused

◆ setCarModel()

status_t ramses::DcsmMetadataCreator::setCarModel ( int32_t carModel )

Set car model metadata entry. Requests car model to be put into widget at consumer side.

Parameters

carModel identifier of requested car model

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setCarModelView()

status_t ramses::DcsmMetadataCreator::setCarModelView	(	const CarModelViewMetadata &	viewMetadata,
		const AnimationInformation &	timingInfo
	)

Set car model view metadata entry. Requests car model view parameters at consumer side.

Parameters

viewMetadata	view metadata for the car model
timingInfo	hint to receiver when to start/finish animation to given values

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setCarModelViewExtended()

status_t ramses::DcsmMetadataCreator::setCarModelViewExtended ( const CarModelViewMetadataExtended & viewMetadata )

Set car model view extended metadata entry. Provides additional values for setCarModelView()

Note: Should only be used in combination with setCarModelView()

Parameters

viewMetadata extended view metadata for the car model

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setCarModelVisibility()

status_t ramses::DcsmMetadataCreator::setCarModelVisibility ( bool visibility )

Set car model visibility metadata entry. Requests car model visibility at consumer side.

Parameters

visibility visibility of car model

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setConfiguratorPriority()

status_t ramses::DcsmMetadataCreator::setConfiguratorPriority ( uint8_t priority )

Set the widget configurator priority for this dcsm content.

Defines the widget configurator behaviour when it gets opened and this dcsm content is in shown state

Parameters

priority the widget configurator priority

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setContentFlippedVertically()

status_t ramses::DcsmMetadataCreator::setContentFlippedVertically ( bool state )

Set the contentFlippedVertically metadata entry. Requests to show widget mirrored on Y-axis.

Parameters

state true to request consumer to flip content vertically, false to not flip.

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setDisplayedDataFlags()

status_t ramses::DcsmMetadataCreator::setDisplayedDataFlags ( uint32_t flags )

Set displayed data flags metadata entry.

Used to determine what type(s) of data is currently displayed to avoid showing redundant content in some use cases.

Parameters

flags Bitmask of types of data, concrete values must be defined on application level between provider and consumer.

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setExclusiveBackground()

status_t ramses::DcsmMetadataCreator::setExclusiveBackground ( bool state )

Set the exclusive background metadata entry. Requests to show widget exclusively without other overlapping content in background.

Parameters

state true to request exclusive state, false to allow background content.

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setLayoutAvailability()

status_t ramses::DcsmMetadataCreator::setLayoutAvailability ( uint8_t flags )

Set widget layout dependency to the given M Modes.

Used to restrict the widget availability in the WidgetConfigurator for certain M modes

Parameters

flags Bitmask of displaycluster::M_Modes

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setPreviewDescription()

status_t ramses::DcsmMetadataCreator::setPreviewDescription ( std::u32string previewDescription )

Set preview description metadata entry. Must be a valid utf32 string.

Parameters

previewDescription

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ setPreviewImagePng()

status_t ramses::DcsmMetadataCreator::setPreviewImagePng	(	const void *	data,
		size_t	dataLength
	)

Set preview image metadata entry. Data must point to a valid in memory representation of a PNG file for the time of calling this method.

Parameters

data	pointer to memory buffer with PNG content
dataLength	length in bytes of data

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ setStreamID()

status_t ramses::DcsmMetadataCreator::setStreamID ( int32_t streamID )

Set the streamID metadata entry. Requests to start/show specified stream.

Parameters

streamID identifier of stream to start/show

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setWidgetBackgroundID()

status_t ramses::DcsmMetadataCreator::setWidgetBackgroundID ( int32_t backgroundID )

Set widget background ID metadata entry. Requests specific background at consumer side.

Parameters

backgroundID identifier of requested background

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setWidgetHUDLineID()

status_t ramses::DcsmMetadataCreator::setWidgetHUDLineID ( int32_t hudLineID )

Set widget hud line ID metadata entry. Requests specific HUD line style at consumer side.

Parameters

hudLineID identifier of requested hud line style

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

◆ setWidgetOrder()

status_t ramses::DcsmMetadataCreator::setWidgetOrder ( int32_t widgetOrder )

Set widget order metadata entry. Used to determine order within a dcsm category.

Parameters

widgetOrder

Returns: StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

Member Data Documentation

◆ impl

class DcsmMetadataCreatorImpl& ramses::DcsmMetadataCreator::impl

Stores internal data for implementation specifics of DcsmMetadataCreator

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

/home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/DcsmMetadataCreator.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DcsmMetadataCreator() [1/3]

◆ ~DcsmMetadataCreator()

◆ DcsmMetadataCreator() [2/3]

◆ DcsmMetadataCreator() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setCarModel()

◆ setCarModelView()

◆ setCarModelViewExtended()

◆ setCarModelVisibility()

◆ setConfiguratorPriority()

◆ setContentFlippedVertically()

◆ setDisplayedDataFlags()

◆ setExclusiveBackground()

◆ setLayoutAvailability()

◆ setPreviewDescription()

◆ setPreviewImagePng()

◆ setStreamID()

◆ setWidgetBackgroundID()

◆ setWidgetHUDLineID()

◆ setWidgetOrder()

Member Data Documentation

◆ impl