Link information between OpenViBE box. More...

#include <ovILink.h>

Inheritance diagram for OpenViBE::Kernel::ILink:

Public Member Functions
Identification
virtual bool	initializeFromExistingLink (const ILink &link)=0
	Initialize link from existing link by copying members. More...

virtual bool	setIdentifier (const CIdentifier &id)=0
	Changes this link's id. More...

virtual CIdentifier	getIdentifier () const =0
	Gets the identifier of this link. More...

Source / Target management
virtual bool	setSource (const CIdentifier &boxID, size_t boxOutputIdx, CIdentifier boxOutputID)=0
	Sets the source of this link. More...

virtual bool	setTarget (const CIdentifier &boxID, size_t boxInputIdx, CIdentifier boxInputID)=0
	Sets the target of this link. More...

virtual bool	getSource (CIdentifier &boxID, size_t &boxOutputIdx, CIdentifier &boxOutputID) const =0
	Gets the source information for this link. More...

virtual CIdentifier	getSourceBoxIdentifier () const =0
	Gets the source box identifier for this link. More...

virtual size_t	getSourceBoxOutputIndex () const =0
	Gets the source box output index for this link. More...

virtual CIdentifier	getSourceBoxOutputIdentifier () const =0
	Gets the source box output index for this link. More...

virtual bool	getTarget (CIdentifier &boxID, size_t &boxInputIdx, CIdentifier &boxInputID) const =0
	Gets the target information for this link. More...

virtual CIdentifier	getTargetBoxIdentifier () const =0
	Gets the target box identifier for this link. More...

virtual size_t	getTargetBoxInputIndex () const =0
	Gets the target box input index for this link. More...

virtual CIdentifier	getTargetBoxInputIdentifier () const =0
	Gets the target box input identifier for this link. More...

Public Member Functions inherited from OpenViBE::Kernel::IAttributable
virtual bool	addAttribute (const CIdentifier &id, const CString &value)=0

virtual bool	removeAttribute (const CIdentifier &id)=0

virtual bool	removeAllAttributes ()=0

virtual CString	getAttributeValue (const CIdentifier &id) const =0

virtual bool	setAttributeValue (const CIdentifier &id, const CString &value)=0

virtual bool	hasAttribute (const CIdentifier &id) const =0

virtual bool	hasAttributes () const =0

virtual CIdentifier	getNextAttributeIdentifier (const CIdentifier &previousID) const =0

Public Member Functions inherited from OpenViBE::IObject
virtual CIdentifier	getClassIdentifier () const =0
	Returns the final class identifier of the concrete class. More...

virtual bool	isDerivedFromClass (const CIdentifier &classId) const
	Checks if this object is compatible with a class identifier. More...

virtual bool	acceptVisitor (IObjectVisitor &visitor)
	Requests this object to accept a visitor. More...

Additional Inherited Members
Protected Member Functions inherited from OpenViBE::IObject
virtual	~IObject ()

Detailed Description

Link information between OpenViBE box.

Author: Yann Renard (IRISA/INRIA)

Date: 2006-08-16

This class collects informations between OpenViBE boxes : box identifiers and input / output indices.

Member Function Documentation

◆ initializeFromExistingLink()

virtual bool OpenViBE::Kernel::ILink::initializeFromExistingLink ( const ILink & link )

pure virtual

Initialize link from existing link by copying members.

Parameters

link	the existing link

Returns: true

◆ setIdentifier()

virtual bool OpenViBE::Kernel::ILink::setIdentifier ( const CIdentifier & id )

pure virtual

Changes this link's id.

Parameters

id	[in] : The new id this link should have

Returns: true in case of success.; false in case of error.

◆ getIdentifier()

virtual CIdentifier OpenViBE::Kernel::ILink::getIdentifier ( ) const

pure virtual

Gets the identifier of this link.

Returns: The identifier of this link.

◆ setSource()

virtual bool OpenViBE::Kernel::ILink::setSource	(	const CIdentifier &	boxID,
		size_t	boxOutputIdx,
		CIdentifier	boxOutputID
	)

pure virtual

Sets the source of this link.

Parameters

boxID	[in] : The identifier of the source box
boxOutputIdx	[in] : The index of the output to use on the source box
boxOutputID	[in] : The identifier of the output to use on the source box

Returns: true in case of success.; false in case of error.

◆ setTarget()

virtual bool OpenViBE::Kernel::ILink::setTarget	(	const CIdentifier &	boxID,
		size_t	boxInputIdx,
		CIdentifier	boxInputID
	)

pure virtual

Sets the target of this link.

Parameters

boxID	[in] : The identifier of the target box
boxInputIdx	[in] : The index of the input to use on the target box
boxInputID	[in] : The identifier of the input to use on the target box

Returns: true in case of success.; false in case of error.

◆ getSource()

virtual bool OpenViBE::Kernel::ILink::getSource	(	CIdentifier &	boxID,
		size_t &	boxOutputIdx,
		CIdentifier &	boxOutputID
	)		const

pure virtual

Gets the source information for this link.

Parameters

boxID	[out] : The identifier of the source box
boxOutputIdx	[out] : The output index of the source box
boxOutputID	[out] : The output identifier of the target box

Returns: true in case of success.; false in case of error.

◆ getSourceBoxIdentifier()

virtual CIdentifier OpenViBE::Kernel::ILink::getSourceBoxIdentifier ( ) const

pure virtual

Gets the source box identifier for this link.

Returns: the source box identifier for thit link

◆ getSourceBoxOutputIndex()

virtual size_t OpenViBE::Kernel::ILink::getSourceBoxOutputIndex ( ) const

pure virtual

Gets the source box output index for this link.

Returns: the source box output index for this link

◆ getSourceBoxOutputIdentifier()

virtual CIdentifier OpenViBE::Kernel::ILink::getSourceBoxOutputIdentifier ( ) const

pure virtual

Gets the source box output index for this link.

Returns: the source box output index for this link

◆ getTarget()

virtual bool OpenViBE::Kernel::ILink::getTarget	(	CIdentifier &	boxID,
		size_t &	boxInputIdx,
		CIdentifier &	boxInputID
	)		const

pure virtual

Gets the target information for this link.

Parameters

boxID	[out] : The identifier of the target box
boxInputIdx	[out] : The input index of the target box
boxInputID	[out] : The input identifier of the target box

Returns: true in case of success.; false in case of error.

◆ getTargetBoxIdentifier()

virtual CIdentifier OpenViBE::Kernel::ILink::getTargetBoxIdentifier ( ) const

pure virtual

Gets the target box identifier for this link.

Returns: the target box identifier for this link

◆ getTargetBoxInputIndex()

virtual size_t OpenViBE::Kernel::ILink::getTargetBoxInputIndex ( ) const

pure virtual

Gets the target box input index for this link.

Returns: the target box input index for this link

◆ getTargetBoxInputIdentifier()

virtual CIdentifier OpenViBE::Kernel::ILink::getTargetBoxInputIdentifier ( ) const

pure virtual

Gets the target box input identifier for this link.

Returns: the target box input identifier for this link

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ initializeFromExistingLink()

◆ setIdentifier()

◆ getIdentifier()

◆ setSource()

◆ setTarget()

◆ getSource()

◆ getSourceBoxIdentifier()

◆ getSourceBoxOutputIndex()

◆ getSourceBoxOutputIdentifier()

◆ getTarget()

◆ getTargetBoxIdentifier()

◆ getTargetBoxInputIndex()

◆ getTargetBoxInputIdentifier()