adtf::streaming::ant::named_graph_object< INTERFACE > Class Template Reference

#include <named_graph_object.h>

Inherits adtf::ucom::catwo::object< INamedGraphObject, INamedGraphObject >.

Public Member Functions
	named_graph_object ()
	CTOR.
virtual	~named_graph_object ()=default
	DTOR.
	named_graph_object (const char *strName)
tResult	SetName (const char *strName) override
tResult	GetName (base::ant::IString &&strName) const override
tResult	SetParent (const ucom::ant::IObject *poParentObject) override
tResult	GetParent (const ucom::ant::IObject *&poParentObject) const override
Public Member Functions inherited from adtf::ucom::catwo::object< INamedGraphObject, INamedGraphObject >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	named_graph_object (const named_graph_object &)=delete
	delete copy CTOR
	named_graph_object (named_graph_object &&)=delete
	delete move CTOR
named_graph_object &	operator= (const named_graph_object &)=delete
	delete copy operator
named_graph_object &	operator= (named_graph_object &&)=delete
	delete move operator
void	LogNamedMessage (const char *strMessage)
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

template<typename INTERFACE = INamedGraphObject>
class adtf::streaming::ant::named_graph_object< INTERFACE >

Default convenient implementation for INamedGraphObject. If your own type is derived from INamedGraphObject and you want to use this default implementation use the derived type as parameter Interface to prevent multiple inheritance.

Template Parameters

Interface

type that derives from INamedGraphObject.

Constructor & Destructor Documentation

named_graph_object()

template<typename INTERFACE = INamedGraphObject>

adtf::streaming::ant::named_graph_object< INTERFACE >::named_graph_object ( const char * strName )

inline

CTOR with name

Parameters

[in]

strName

Name of object

Member Function Documentation

GetName()

template<typename INTERFACE = INamedGraphObject>

tResult adtf::streaming::ant::named_graph_object< INTERFACE >::GetName ( base::ant::IString && strName ) const

inlineoverride

Gets the Name of the object

Parameters

[in,out]

strName

Name of object

Returns

Standard Result Code of adtf::base::IString::Set

GetParent()

template<typename INTERFACE = INamedGraphObject>

tResult adtf::streaming::ant::named_graph_object< INTERFACE >::GetParent ( const ucom::ant::IObject *& poParentObject ) const

inlineoverride

Gets the Parent of the object.

Parameters

[out]

poParentObject

Parent of object returned

Returns

Standard Result Code

Return values

ERR_NOT_INITIALIZED

No Parent set.

LogNamedMessage()

template<typename INTERFACE = INamedGraphObject>

void adtf::streaming::ant::named_graph_object< INTERFACE >::LogNamedMessage ( const char * strMessage )

inlineprotected

Helper to log a message with the full name of the object

Parameters

[in]

strMessage

Message to log

Returns

void

SetName()

template<typename INTERFACE = INamedGraphObject>

tResult adtf::streaming::ant::named_graph_object< INTERFACE >::SetName ( const char * strName )

inlineoverride

Sets the Name of the object

Parameters

[in]

strName

Name of object

Returns

Standard Result Code

SetParent()

template<typename INTERFACE = INamedGraphObject>

tResult adtf::streaming::ant::named_graph_object< INTERFACE >::SetParent ( const ucom::ant::IObject * poParentObject )

inlineoverride

Sets Parent of the object

Parameters

[in]

poParentObject

Parent of object

Remarks

Make sure the parent lives longer then the child.

Returns

Standard Result Code

---

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

• src/libraries/streaming3/include/adtfstreaming3/named_graph_object.h