Ufe::Connections Class Reference

The class represents a list of existing connections. More...

#include <connections.h>

Public Types
enum	AttributeType { ATTR_IS_SOURCE = 0x01 , ATTR_IS_DESTINATION = 0x02 , ATTR_ANY = 0x03 }
typedef std::shared_ptr< Connections >	Ptr

Public Member Functions
	Connections ()
	Constructor. More...
virtual	~Connections ()
	Destructor. More...
	Connections (const Connections &)=delete
	No copy or move constructor/assignment. More...
Connections &	operator= (const Connections &)=delete
	Connections (Connections &&)=delete
Connections &	operator= (Connections &&)=delete
virtual std::vector< Connection::Ptr >	allConnections () const =0
virtual bool	hasConnection (const Attribute::Ptr &attr, AttributeType attrType) const
virtual std::vector< Connection::Ptr >	connections (const Attribute::Ptr &attr, AttributeType attrType) const

Detailed Description

The class represents a list of existing connections.

Definition at line 27 of file connections.h.

Member Typedef Documentation

Ptr

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

Definition at line 30 of file connections.h.

Member Enumeration Documentation

AttributeType

enum Ufe::Connections::AttributeType

Enumerator
ATTR_IS_SOURCE
ATTR_IS_DESTINATION
ATTR_ANY

Definition at line 32 of file connections.h.

Constructor & Destructor Documentation

Connections() [1/3]

Ufe::Connections::Connections

(

)

Constructor.

~Connections()

virtual Ufe::Connections::~Connections ( )

virtual

Destructor.

Connections() [2/3]

Ufe::Connections::Connections ( const Connections &  )

delete

No copy or move constructor/assignment.

Connections() [3/3]

Ufe::Connections::Connections ( Connections &&  )

delete

Member Function Documentation

allConnections()

virtual std::vector< Connection::Ptr > Ufe::Connections::allConnections ( ) const

pure virtual

Returns

Return all the connections where an attribute is part of the connection.

connections()

virtual std::vector< Connection::Ptr > Ufe::Connections::connections ( const Attribute::Ptr &  attr, AttributeType  attrType  ) const

virtual

Returns all the connections for a specific attribute.

Note

It provides a default implementation which can be overridden by the underlying data model if needed.

Complexity

Amortized O(m) for an attribute in a list of m attributes.

Parameters

attr	Attribute to look for connections.
attrType	AttributeType defines if the attribute is the source or the destination of the connection.

Returns

vector of source connections for a given attribute.

hasConnection()

virtual bool Ufe::Connections::hasConnection ( const Attribute::Ptr &  attr, AttributeType  attrType  ) const

virtual

Queries whether at least one connection exists with the given attribute.

Note

It provides a default implementation which can be overridden by the underlying data model if needed.

Complexity

Amortized O(m) for an attribute in a list of m attributes.

Parameters

attr	The attribute to check.
attrType	AttributeType defines if the attribute is the source or the destination of the connection.

Returns

True if the scene item contains a connection matching the given attribute.

operator=() [1/2]

Connections & Ufe::Connections::operator= ( Connections &&  )

delete

operator=() [2/2]

Connections & Ufe::Connections::operator= ( const Connections &  )

delete

---

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

• common/include/ufe/connections.h