ramses::StatusObject Class Reference

The StatusObject provides status message handling. More...

#include <StatusObject.h>

Inheritance diagram for ramses::StatusObject:

Public Member Functions
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 StatusObjectImpl &	impl

Protected Member Functions
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...
virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Detailed Description

The StatusObject provides status message handling.

Constructor & Destructor Documentation

StatusObject() [1/2]

ramses::StatusObject::StatusObject ( const StatusObject &  other )

delete

Deleted copy constructor.

Parameters

other

unused

StatusObject() [2/2]

ramses::StatusObject::StatusObject ( StatusObjectImpl &  pimpl )

explicitprotected

Constructor for StatusObject.

Parameters

[in]

pimpl

Internal data for implementation specifics of StatusObject (sink - instance becomes owner)

~StatusObject()

virtual ramses::StatusObject::~StatusObject ( )

protectedvirtual

Destructor of the StatusObject.

Member Function Documentation

getStatusMessage()

const char* ramses::StatusObject::getStatusMessage

(

status_t

status

)

const

Get the string description for a status provided by a RAMSES API function.

Parameters

status

Status returned by a RAMSES API function call

Returns

If value refers to an existing status message, the string with text description for status is returned. If no status message for value is available, unknown status message is returned.

getValidationReport()

const char* ramses::StatusObject::getValidationReport

(

EValidationSeverity

minSeverity = EValidationSeverity_Info

)

const

Provides verbose report in human readable form generated by validate.

If minSeverity is set to ramses::EValidationSeverity_Error, only objects with errors and their descriptions are returned, if filtering is set to EValidationSeverity_Warning additionally all objects with warnings and their descriptions are returned. If filtering is set to EValidationSeverity_Info all errors and warnings are printed and additionally some objects will print more information like number of instances or similar.

Parameters

[in]

minSeverity

Optional filter, only messages with greater or equal severity will be added to report

Returns

Validation string containing human readable status of the object, if validate was not called a pointer to an empty string is returned.

operator=()

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

delete

Deleted copy assignment.

Parameters

other

unused

Returns

unused

validate()

status_t ramses::StatusObject::validate

(

)

const

Generates verbose validation of the object.

Checks validity of internal values, references, states and performance warnings. Will validate object it is called on and all its dependencies recursively, e.g. Scene->MeshNode->Appearance->Resource ... Result can be obtained by calling getValidationReport.

Returns

StatusOK if no issues found, otherwise an index to a status message which will be either "Validation warning" or "Validation error" depending on severity of the issues found. The status message can be obtained by calling getStatusMessage.

Member Data Documentation

impl

class StatusObjectImpl& ramses::StatusObject::impl

Stores internal data for implementation specifics of StatusObject.

---

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

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/StatusObject.h