ILink Class Reference

Link information between OpenViBE boxThis class collects informations between OpenViBE boxes : box identifiers and input / output indices. More...

Inheritance diagram for ILink:

Public Member Functions
Identification
virtual OpenViBE::boolean	setIdentifier (const OpenViBE::CIdentifier &rIdentifier)=0
	Changes this link's identifier. More...
virtual OpenViBE::CIdentifier	getIdentifier (void) const =0
	Gets the identifier of this link. More...
Source / Target management
virtual OpenViBE::boolean	setSource (const OpenViBE::CIdentifier &rBoxIdentifier, const OpenViBE::uint32 ui32BoxOutputIndex)=0
	Sets the source of this link. More...
virtual OpenViBE::boolean	setTarget (const OpenViBE::CIdentifier &rBoxIdentifier, const OpenViBE::uint32 ui32BoxInputIndex)=0
	Sets the target of this link. More...
virtual OpenViBE::boolean	getSource (OpenViBE::CIdentifier &rBoxIdentifier, OpenViBE::uint32 &ui32BoxOutputIndex) const =0
	Gets the source information for this link. More...
virtual OpenViBE::CIdentifier	getSourceBoxIdentifier (void) const =0
	Gets the source box identifier for this link. More...
virtual OpenViBE::uint32	getSourceBoxOutputIndex (void) const =0
	Gets the source box output index for this link. More...
virtual OpenViBE::boolean	getTarget (OpenViBE::CIdentifier &rTargetBoxIdentifier, OpenViBE::uint32 &ui32BoxInputIndex) const =0
	Gets the target information for this link. More...
virtual OpenViBE::CIdentifier	getTargetBoxIdentifier (void) const =0
	Gets the target box identifier for this link. More...
virtual OpenViBE::uint32	getTargetBoxInputIndex (void) const =0
	Gets the target box input index for this link. 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

Link information between OpenViBE box

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

Author

Yann Renard (IRISA/INRIA)

Date

2006-08-16

Member Function Documentation

virtual OpenViBE::boolean setIdentifier ( const OpenViBE::CIdentifier &  rIdentifier )

pure virtual

Changes this link's identifier.

Parameters

rIdentifier

[in] : The new identifier this link should have

Returns

true in case of success.

false in case of error.

virtual OpenViBE::CIdentifier getIdentifier ( void  ) const

pure virtual

Gets the identifier of this link.

Returns

The identifier of this link.

virtual OpenViBE::boolean setSource ( const OpenViBE::CIdentifier &  rBoxIdentifier, const OpenViBE::uint32  ui32BoxOutputIndex  )

pure virtual

Sets the source of this link.

Parameters

rBoxIdentifier	[in] : The identifier of the source box
ui32BoxOutputIndex	[in] : The index of the output to use on the source box

Returns

true in case of success.

false in case of error.

virtual OpenViBE::boolean setTarget ( const OpenViBE::CIdentifier &  rBoxIdentifier, const OpenViBE::uint32  ui32BoxInputIndex  )

pure virtual

Sets the target of this link.

Parameters

rBoxIdentifier	[in] : The identifier of the target box
ui32BoxInputIndex	[in] : The index of the input to use on the target box

Returns

true in case of success.

false in case of error.

virtual OpenViBE::boolean getSource ( OpenViBE::CIdentifier &  rBoxIdentifier, OpenViBE::uint32 &  ui32BoxOutputIndex  ) const

pure virtual

Gets the source information for this link.

Parameters

rBoxIdentifier	[out] : The identifier of of the source box
ui32BoxOutputIndex	[out] : The output index of the source box

Returns

true in case of success.

false in case of error.

virtual OpenViBE::CIdentifier getSourceBoxIdentifier ( void  ) const

pure virtual

Gets the source box identifier for this link.

Returns

the source box identifier for thit link

virtual OpenViBE::uint32 getSourceBoxOutputIndex ( void  ) const

pure virtual

Gets the source box output index for this link.

Returns

the source box output index for this link

virtual OpenViBE::boolean getTarget ( OpenViBE::CIdentifier &  rTargetBoxIdentifier, OpenViBE::uint32 &  ui32BoxInputIndex  ) const

pure virtual

Gets the target information for this link.

Parameters

rTargetBoxIdentifier	[out] : The identifier of the target box
ui32BoxInputIndex	[out] : The input index of the target box

Returns

true in case of success.

false in case of error.

virtual OpenViBE::CIdentifier getTargetBoxIdentifier ( void  ) const

pure virtual

Gets the target box identifier for this link.

Returns

the target box identifier for this link

virtual OpenViBE::uint32 getTargetBoxInputIndex ( void  ) const

pure virtual

Gets the target box input index for this link.

Returns

the target box input index for this link