Ufe::ConnectionHandler Class Reference

Factory base class for connection interface. More...

#include <connectionHandler.h>

Public Types
typedef std::shared_ptr< ConnectionHandler >	Ptr

Public Member Functions
	ConnectionHandler ()
	Constructor. More...
	ConnectionHandler (const ConnectionHandler &)=default
	Default copy constructor. More...
virtual	~ConnectionHandler ()
	Destructor. More...
virtual Connections::Ptr	sourceConnections (const SceneItem::Ptr &item) const =0
	Get the source Connections on the given SceneItem. More...
virtual std::shared_ptr< ConnectionResultUndoableCommand >	createConnectionCmd (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const =0
virtual std::shared_ptr< UndoableCommand >	deleteConnectionCmd (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const =0
Connect Methods
Methods to connect source and destination attributes.
Connection::Ptr	connect (const AttributeInfo &srcInfo, const AttributeInfo &dstInfo) const
	Connects a source attribute to a destination attribute. More...
Connection::Ptr	connect (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const
	Connects a source attribute to a destination attribute. More...
Disconnect Methods
Methods to disconnect source and destination attributes.
void	disconnect (const AttributeInfo &srcInfo, const AttributeInfo &dstInfo) const
	Disconnects a source attribute from a destination attribute. More...
void	disconnect (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const
	Disconnects a source attribute from a destination attribute. More...

Detailed Description

Factory base class for connection interface.

This base class defines an interface that runtimes must implement to manage source connections i.e. list, create and delete.

Note

A source connection is a connection where the source attribute is an ouput type attribute and the destination attribute is an input type from the SceneItem.

Definition at line 37 of file connectionHandler.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<ConnectionHandler> Ufe::ConnectionHandler::Ptr

Definition at line 40 of file connectionHandler.h.

Constructor & Destructor Documentation

ConnectionHandler() [1/2]

Ufe::ConnectionHandler::ConnectionHandler

(

)

Constructor.

ConnectionHandler() [2/2]

Ufe::ConnectionHandler::ConnectionHandler ( const ConnectionHandler &  )

default

Default copy constructor.

~ConnectionHandler()

virtual Ufe::ConnectionHandler::~ConnectionHandler ( )

virtual

Destructor.

Member Function Documentation

connect() [1/2]

Connection::Ptr Ufe::ConnectionHandler::connect	(	const Attribute::Ptr &	srcAttr,
		const Attribute::Ptr &	dstAttr
	)		const

Connects a source attribute to a destination attribute.

Parameters

srcAttr	Source attribute to be connected.
dstAttr	Destination attribute to be connected.

Returns

The resulting connection. Note that the original source and target can be remapped by the client, so this will be the actual attributes that ended up being connected.

Note

Throws an exception if the connection cannot be created or if it already exists.

connect() [2/2]

Connection::Ptr Ufe::ConnectionHandler::connect	(	const AttributeInfo &	srcInfo,
		const AttributeInfo &	dstInfo
	)		const

Connects a source attribute to a destination attribute.

Parameters

srcInfo	Source attribute (from AttributeInfo) to be connected.
dstInfo	Destination attribute (from AttributeInfo) to be connected.

Returns

The resulting connection. Note that the original source and target can be remapped by the client, so this will be the actual attributes that ended up being connected.

Note

Throws an exception if the connection cannot be created or if it already exists.

To avoid the performance hit of the conversion from AttributeInfo to Attribute use the method with Attribute arguments when available.

createConnectionCmd()

virtual std::shared_ptr< ConnectionResultUndoableCommand > Ufe::ConnectionHandler::createConnectionCmd ( const Attribute::Ptr &  srcAttr, const Attribute::Ptr &  dstAttr  ) const

pure virtual

Get the command to connect two attributes. The returned command is not executed.

Parameters

srcAttr	source attribute to be connected.
dstAttr	destination attribute to be connected.

Returns

a command that, when executed, will connect the attributes and return the resulting connection. Note that the original source and target can be remapped by the client and the connection returned by the command will be the actual attributes that ended up being connected.

deleteConnectionCmd()

virtual std::shared_ptr< UndoableCommand > Ufe::ConnectionHandler::deleteConnectionCmd ( const Attribute::Ptr &  srcAttr, const Attribute::Ptr &  dstAttr  ) const

pure virtual

Get the command to disconnect two attributes. The returned command is not executed.

Parameters

srcAttr	source attribute to be disconnected.
dstAttr	destination attribute to be disconnected.

Returns

a command that, when executed, will disconnect the attributes.

disconnect() [1/2]

void Ufe::ConnectionHandler::disconnect	(	const Attribute::Ptr &	srcAttr,
		const Attribute::Ptr &	dstAttr
	)		const

Disconnects a source attribute from a destination attribute.

Parameters

srcAttr	Source attribute to be disconnected.
dstAttr	Destination attribute to be disconnected.

Note

Throws an exception if the connection cannot be removed or if it doesn't exist.

disconnect() [2/2]

void Ufe::ConnectionHandler::disconnect	(	const AttributeInfo &	srcInfo,
		const AttributeInfo &	dstInfo
	)		const

Disconnects a source attribute from a destination attribute.

Parameters

srcInfo	Source attribute (from AttributeInfo) to be disconnected.
dstInfo	Destination attribute (from AttributeInfo) to be disconnected.

Note

Throws an exception if the connection cannot be removed or if it doesn't exist.

To avoid the performance hit of the conversion from AttributeInfo to Attribute use the method with Attribute arguments when available.

sourceConnections()

virtual Connections::Ptr Ufe::ConnectionHandler::sourceConnections ( const SceneItem::Ptr &  item ) const

pure virtual

Get the source Connections on the given SceneItem.

Parameters

item	SceneItem to use to retrieve its source Connections.

Returns

all the Connections of given SceneItem and a null pointer if no Connections interface can be created for the item.

---

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

• common/include/ufe/connectionHandler.h