The RamsesFrameworkConfig holds a set of parameters to be used to initialize ramses. More...

#include <RamsesFrameworkConfig.h>

Inheritance diagram for ramses::RamsesFrameworkConfig:

Collaboration diagram for ramses::RamsesFrameworkConfig:

Public Member Functions
	RamsesFrameworkConfig ()
	Default constructor of RamsesFrameworkConfig. More...

	RamsesFrameworkConfig (int32_t argc, char const const argv)
	Constructor of RamsesFrameworkConfig using command line parameters. More...

	~RamsesFrameworkConfig () override
	Destructor of RamsesFrameworkConfig. More...

status_t	setRequestedRamsesShellType (ERamsesShellType requestedShellType)
	Request a certain type of ramses shell. More...

status_t	setWatchdogNotificationInterval (ERamsesThreadIdentifier thread, uint32_t interval)
	Set watchdog notification interval of ramses threads. More...

status_t	setWatchdogNotificationCallBack (IThreadWatchdogNotification *callback)
	Set watchdog callback. More...

status_t	disableDLTApplicationRegistration ()
	Disable DLT application registration. More...

void	setDLTApplicationID (const char *id)
	Set the application ID name for DLT (4 chars) More...

const char *	getDLTApplicationID () const
	Return the DLT application id value set in configuration object. More...

void	setDLTApplicationDescription (const char *description)
	Set the application description for DLT. More...

const char *	getDLTApplicationDescription () const
	Return the DLT application description set in configuration object. More...

void	setPeriodicLogsEnabled (bool enabled)
	Enables or disables the periodic log messages provided by the Ramses framework. More...

void	setInterfaceSelectionIPForTCPCommunication (const char *ip)
	Sets the IP address that is used to select the local network interface The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only. More...

void	setDaemonIPForTCPCommunication (const char *ip)
	Sets the IP address of the communication daemon The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only. More...

void	setDaemonPortForTCPCommunication (uint16_t port)
	Sets the port of the communication daemon The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only. More...

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

RamsesFrameworkConfig &	operator= (const RamsesFrameworkConfig &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 RamsesFrameworkConfigImpl &	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

The RamsesFrameworkConfig holds a set of parameters to be used to initialize ramses.

Examples: ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-client/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, ramses-example-local-pick-handling/src/main.cpp, ramses-example-local-scene-referencing/src/main.cpp, and ramses-example-local-viewport-link/src/main.cpp.

Constructor & Destructor Documentation

◆ RamsesFrameworkConfig() [1/3]

ramses::RamsesFrameworkConfig::RamsesFrameworkConfig ( )

Default constructor of RamsesFrameworkConfig.

◆ RamsesFrameworkConfig() [2/3]

ramses::RamsesFrameworkConfig::RamsesFrameworkConfig	(	int32_t	argc,
		char const const	argv
	)

Constructor of RamsesFrameworkConfig using command line parameters.

Parameters

[in]	argc	Number of strings in argv array
[in]	argv	Command line parameters as array of string

◆ ~RamsesFrameworkConfig()

ramses::RamsesFrameworkConfig::~RamsesFrameworkConfig ( )

override

Destructor of RamsesFrameworkConfig.

◆ RamsesFrameworkConfig() [3/3]

ramses::RamsesFrameworkConfig::RamsesFrameworkConfig ( const RamsesFrameworkConfig & other )

delete

Deleted copy constructor.

Parameters

other unused

Member Function Documentation

◆ disableDLTApplicationRegistration()

status_t ramses::RamsesFrameworkConfig::disableDLTApplicationRegistration ( )

Disable DLT application registration.

When set and DLT is enabled ramses expects DLT_REGISTER_APP beeing called before RamsesFramework construction and DLT_UNREGISTER_APP after RamsesFramework destruction. Ramses will add its context to the existing application.

When not disabled, ramses will manage DLT application registration itself.

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

◆ getDLTApplicationDescription()

const char* ramses::RamsesFrameworkConfig::getDLTApplicationDescription ( ) const

Return the DLT application description set in configuration object.

Returns: dlt application description set in this configuration object

◆ getDLTApplicationID()

const char* ramses::RamsesFrameworkConfig::getDLTApplicationID ( ) const

Return the DLT application id value set in configuration object.

Returns: dlt application id value set in this configuration object

◆ operator=()

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

delete

Deleted copy assignment.

Parameters

other unused

Returns: unused

◆ setDaemonIPForTCPCommunication()

void ramses::RamsesFrameworkConfig::setDaemonIPForTCPCommunication ( const char * ip )

Sets the IP address of the communication daemon The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only.

Parameters

[in] ip IP to use

◆ setDaemonPortForTCPCommunication()

void ramses::RamsesFrameworkConfig::setDaemonPortForTCPCommunication ( uint16_t port )

Sets the port of the communication daemon The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only.

Parameters

[in] port Port to use

◆ setDLTApplicationDescription()

void ramses::RamsesFrameworkConfig::setDLTApplicationDescription ( const char * description )

Set the application description for DLT.

Parameters

[in] description to use as DLT application description

◆ setDLTApplicationID()

void ramses::RamsesFrameworkConfig::setDLTApplicationID ( const char * id )

Set the application ID name for DLT (4 chars)

Parameters

[in] id to use as DLT application id

◆ setInterfaceSelectionIPForTCPCommunication()

void ramses::RamsesFrameworkConfig::setInterfaceSelectionIPForTCPCommunication ( const char * ip )

Sets the IP address that is used to select the local network interface The value is only evaluated if SOME/IP is not used. This communication type is intended for prototype use-cases only.

Parameters

[in] ip IP to use

◆ setPeriodicLogsEnabled()

void ramses::RamsesFrameworkConfig::setPeriodicLogsEnabled ( bool enabled )

Enables or disables the periodic log messages provided by the Ramses framework.

If enabled the Ramses framework periodically logs information about the Ramses version, connected participants, scene states etc. Please leave enabled in a production environment as the provided information is important for error analysis.

The default value is enabled.

Parameters

[in] enabled If true the periodic logs are enabled

◆ setRequestedRamsesShellType()

status_t ramses::RamsesFrameworkConfig::setRequestedRamsesShellType ( ERamsesShellType requestedShellType )

Request a certain type of ramses shell.

Parameters

[in] requestedShellType type of ramses shell

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

◆ setWatchdogNotificationCallBack()

status_t ramses::RamsesFrameworkConfig::setWatchdogNotificationCallBack ( IThreadWatchdogNotification * callback )

Set watchdog callback.

notifyThread Method will be called in the interval specified registerThread and unregisterThread are called to signal which threads will be calling the callback, and should be 'monitored' by user code in an appropriate way.

Parameters

[in] callback callback class to use for watchdog reporting

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

◆ setWatchdogNotificationInterval()

status_t ramses::RamsesFrameworkConfig::setWatchdogNotificationInterval	(	ERamsesThreadIdentifier	thread,
		uint32_t	interval
	)

Set watchdog notification interval of ramses threads.

Parameters

[in]	thread	which thread identifier to set the interval for
[in]	interval	interval in ms which is used to call given callback

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

Member Data Documentation

◆ impl

class RamsesFrameworkConfigImpl& ramses::RamsesFrameworkConfig::impl

Stores internal data for implementation specifics of RamsesFrameworkConfig

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RamsesFrameworkConfig() [1/3]

◆ RamsesFrameworkConfig() [2/3]

◆ ~RamsesFrameworkConfig()

◆ RamsesFrameworkConfig() [3/3]

Member Function Documentation

◆ disableDLTApplicationRegistration()

◆ getDLTApplicationDescription()

◆ getDLTApplicationID()

◆ operator=()

◆ setDaemonIPForTCPCommunication()

◆ setDaemonPortForTCPCommunication()

◆ setDLTApplicationDescription()

◆ setDLTApplicationID()

◆ setInterfaceSelectionIPForTCPCommunication()

◆ setPeriodicLogsEnabled()

◆ setRequestedRamsesShellType()

◆ setWatchdogNotificationCallBack()

◆ setWatchdogNotificationInterval()

Member Data Documentation

◆ impl