IMetadata Class Reference

Metadata class for scenarios. More...

Inheritance diagram for IMetadata:

Public Member Functions
virtual OpenViBE::CIdentifier	getIdentifier (void) const =0
virtual OpenViBE::CIdentifier	getType (void) const =0
virtual OpenViBE::CString	getData (void) const =0
virtual bool	setIdentifier (const OpenViBE::CIdentifier &identifier)=0
	Change the identifier of this metadata. More...
virtual bool	setType (const OpenViBE::CIdentifier &identifier)=0
	Change the identifier of this metadata. More...
virtual bool	setData (const OpenViBE::CString &data)=0
	Change the enclosed data. More...
virtual bool	initializeFromExistingMetadata (const OpenViBE::Kernel::IMetadata &existingMetadata)=0
	Initializes the metadata from an already existing metadata. More...
Public Member Functions inherited from IObject
virtual OpenViBE::CIdentifier	getClassIdentifier (void) const =0
	Returns the final class identifier of the concrete class. More...
virtual OpenViBE::boolean	isDerivedFromClass (const OpenViBE::CIdentifier &rClassIdentifier) const
	Checks if this object is compatible with a class identifier. More...
virtual OpenViBE::boolean	acceptVisitor (OpenViBE::IObjectVisitor &rObjectVisitor)
	Requests this object to accept a visitor. More...

Detailed Description

Metadata class for scenarios.

Author

Jozef Legeny

Date

2016-10-11 Scenario can contain string metadata for the purpose of being used by applications. Each piece of metadata is identified by a (unique) Identifier and a (non-unique) Type. Applications can create metadata in scenarios and should not modify metadata with types they do not understand.

Member Function Documentation

virtual OpenViBE::CIdentifier getIdentifier ( void  ) const

pure virtual

Returns

The identifier of this scenario metadata.

virtual OpenViBE::CIdentifier getType ( void  ) const

pure virtual

Returns

The type of this scenario metadata

virtual OpenViBE::CString getData ( void  ) const

pure virtual

Returns

The enclosed metadata

virtual bool setIdentifier ( const OpenViBE::CIdentifier &  identifier )

pure virtual

Change the identifier of this metadata.

Parameters

[in]

identifier

The new identifier

Return values

true	in case of success.
false	in case of error.

virtual bool setType ( const OpenViBE::CIdentifier &  identifier )

pure virtual

Change the identifier of this metadata.

Parameters

[in]

identifier

The new identifier

Return values

true	in case of success.
false	in case of error.

virtual bool setData ( const OpenViBE::CString &  data )

pure virtual

Change the enclosed data.

Parameters

[in]

sText

The text this comment should contain

Return values

true	in case of success.
false	in case of error.

virtual bool initializeFromExistingMetadata ( const OpenViBE::Kernel::IMetadata &  existingMetadata )

pure virtual

Initializes the metadata from an already existing metadata.

Parameters

[in]

existingMetadata

The existing metadata

Return values

true	in case of success.
false	in case of error.

Resets the metadata and initializes its text/attributes according to the existing object.