The ClientObject is a base class for all client API objects owned by a RamsesClient. More...

Inheritance diagram for ramses::ClientObject:

Collaboration diagram for ramses::ClientObject:

Public Attributes
class ClientObjectImpl &	impl

Public Attributes inherited from ramses::RamsesObject
class RamsesObjectImpl &	impl

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

Protected Member Functions
	ClientObject (ClientObjectImpl &pimpl)
	Constructor for ClientObject. More...

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

Protected Member Functions inherited from ramses::RamsesObject
	RamsesObject (RamsesObjectImpl &pimpl)
	Constructor for RamsesObject. More...

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

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

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

Friends
class	RamsesClientImpl
	RamsesClientImpl is the factory for creating client objects. More...

Additional Inherited Members
Public Member Functions inherited from ramses::RamsesObject
const char *	getName () const
	Returns the name of the object. More...

status_t	setName (const char *name)
	Changes the name of the object. More...

ERamsesObjectType	getType () const
	Gets type of the object. More...

bool	isOfType (ERamsesObjectType type) const
	Checks if the object is of given type. 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...

Detailed Description

The ClientObject is a base class for all client API objects owned by a RamsesClient.

Constructor & Destructor Documentation

ramses::ClientObject::ClientObject ( ClientObjectImpl & pimpl )

explicitprotected

Constructor for ClientObject.

Parameters

[in] pimpl Internal data for implementation specifics of ClientObject (sink - instance becomes owner)

virtual ramses::ClientObject::~ClientObject ( )

protectedvirtual

Destructor of the ClientObject.

friend class RamsesClientImpl

friend

RamsesClientImpl is the factory for creating client objects.

class ClientObjectImpl& ramses::ClientObject::impl

Stores internal data for implementation specifics of ClientObject.

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

/home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/ClientObject.h