deepstream::UserMetadata Class Reference

Detailed Description

Base class of user defined metadata.

Definition at line 101 of file service-maker/includes/metadata.hpp.

Inheritance diagram for deepstream::UserMetadata:

Collaboration diagram for deepstream::UserMetadata:

Public Types
typedef std::unique_ptr< AbstractIterator< UserMetadata > >	Iterator
typedef std::unique_ptr< AbstractIterator< UserMetadata > >	Iterator

Public Member Functions
	UserMetadata (void *)
	Constructor through opaque data pointer. More...
virtual	~UserMetadata ()
	Destructor. More...
virtual	operator bool () override
	operator to check if a metadata is void More...
int	metaType () const
	Get the meta type. More...
void	setMetaType (int type)
	Set the meta type. More...
void *	userData () const
	Get the user data pointer. More...
void	setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
	Set user data with copy and release functions. More...
	UserMetadata (void *)
	Constructor through opaque data pointer. More...
virtual	~UserMetadata ()
	Destructor. More...
virtual	operator bool () override
	operator to check if a metadata is void More...
int	metaType () const
	Get the meta type. More...
void	setMetaType (int type)
	Set the meta type. More...
void *	userData () const
	Get the user data pointer. More...
void	setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
	Set user data with copy and release functions. More...

Protected Member Functions
void	get_ (void *&)
void	get_ (void *&)

Protected Attributes
void *	data_

Friends
class	BatchMetadata
class	FrameMetadata
class	ObjectMetadata

Member Typedef Documentation

Iterator [1/2]

typedef std::unique_ptr<AbstractIterator<UserMetadata> > deepstream::UserMetadata::Iterator

Definition at line 103 of file service-maker/includes/metadata.hpp.

Iterator [2/2]

typedef std::unique_ptr<AbstractIterator<UserMetadata> > deepstream::UserMetadata::Iterator

Definition at line 103 of file 9.0/service-maker/includes/metadata.hpp.

Constructor & Destructor Documentation

UserMetadata() [1/2]

deepstream::UserMetadata::UserMetadata

(

void *

)

Constructor through opaque data pointer.

By default an empty user metadata object is created.

~UserMetadata() [1/2]

virtual deepstream::UserMetadata::~UserMetadata ( )

virtual

Destructor.

UserMetadata() [2/2]

deepstream::UserMetadata::UserMetadata

(

void *

)

Constructor through opaque data pointer.

By default an empty user metadata object is created.

~UserMetadata() [2/2]

virtual deepstream::UserMetadata::~UserMetadata ( )

virtual

Destructor.

Member Function Documentation

get_() [1/2]

void deepstream::UserMetadata::get_ ( void *&  )

protected

Referenced by deepstream::UserMetadataTemplate< C, N >::copy(), deepstream::UserMetadataTemplate< C, N >::free(), and deepstream::UserMetadataTemplate< C, N >::get().

get_() [2/2]

void deepstream::UserMetadata::get_ ( void *&  )

protected

metaType() [1/2]

int deepstream::UserMetadata::metaType

(

)

const

Get the meta type.

metaType() [2/2]

int deepstream::UserMetadata::metaType

(

)

const

Get the meta type.

operator bool() [1/2]

virtual deepstream::UserMetadata::operator bool ( )

inlineoverridevirtual

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

operator bool() [2/2]

virtual deepstream::UserMetadata::operator bool ( )

inlineoverridevirtual

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file 9.0/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

setMetaType() [1/2]

void deepstream::UserMetadata::setMetaType

(

int

type

)

Set the meta type.

setMetaType() [2/2]

void deepstream::UserMetadata::setMetaType

(

int

type

)

Set the meta type.

setUserData() [1/2]

void deepstream::UserMetadata::setUserData	(	void *	data,
		void *(*)(void *, void *)	copy,
		void(*)(void *, void *)	release
	)

Set user data with copy and release functions.

Parameters

data	Pointer to user data
copy	Copy function for the user data (can be NULL)
release	Release function for the user data (can be NULL)

setUserData() [2/2]

void deepstream::UserMetadata::setUserData	(	void *	data,
		void *(*)(void *, void *)	copy,
		void(*)(void *, void *)	release
	)

Set user data with copy and release functions.

Parameters

data	Pointer to user data
copy	Copy function for the user data (can be NULL)
release	Release function for the user data (can be NULL)

userData() [1/2]

void* deepstream::UserMetadata::userData

(

)

const

Get the user data pointer.

userData() [2/2]

void* deepstream::UserMetadata::userData

(

)

const

Get the user data pointer.

Friends And Related Function Documentation

BatchMetadata

BatchMetadata

friend

Definition at line 134 of file service-maker/includes/metadata.hpp.

FrameMetadata

FrameMetadata

friend

Definition at line 135 of file service-maker/includes/metadata.hpp.

ObjectMetadata

ObjectMetadata

friend

Definition at line 136 of file service-maker/includes/metadata.hpp.

Field Documentation

data_

void * deepstream::Metadata::data_

protectedinherited

Definition at line 54 of file service-maker/includes/metadata.hpp.

Referenced by deepstream::Metadata::operator bool(), and operator bool().

---

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

• service-maker/includes/metadata.hpp