Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
core::conformation::signals::ConnectionEvent Struct Reference

signal a change in the connection with a Conformation object, e.g. destruction or transfer More...

#include <ConnectionEvent.hh>

Public Types

enum  Tag { EMPTY, DISCONNECT, TRANSFER }
 the type of Conformation lifetime event More...
 
typedef
core::conformation::Conformation 
Conformation
 

Public Member Functions

 ConnectionEvent ()
 default constructor More...
 
 ConnectionEvent (Conformation const *conf, Tag const t)
 constructor More...
 
 ConnectionEvent (ConnectionEvent const &rval)
 copy constructor More...
 
virtual ~ConnectionEvent ()
 default destructor More...
 
ConnectionEventoperator= (ConnectionEvent const &rval)
 copy assignment More...
 

Public Attributes

Conformation const * conformation
 the Conformation firing the signal More...
 
Tag tag
 tag indicating type of connection change More...
 

Detailed Description

signal a change in the connection with a Conformation object, e.g. destruction or transfer

Remarks
SUGGESTION: Try to use the Link management provided by the SignalHub instead of listening to this event, as it typically makes managing connections much easier.

Member Typedef Documentation

Member Enumeration Documentation

the type of Conformation lifetime event

Current tags are as follows:

  • 'EMPTY' - null event for default ConnectionEvent constructor (no point in watching for this non-event)
  • 'DISCONNECT' - force disconnect (e.g. the Conformation is getting destroyed)
  • 'TRANSFER' - the connection is getting transferred to a new Conformation, so if any observers are storing Conformation pointers (e.g. those not using Link management) then they should discard the existing Conformation pointer and swap it with the one provided by the Event.
Enumerator
EMPTY 
DISCONNECT 
TRANSFER 

Constructor & Destructor Documentation

core::conformation::signals::ConnectionEvent::ConnectionEvent ( )
inline

default constructor

core::conformation::signals::ConnectionEvent::ConnectionEvent ( Conformation const *  conf,
Tag const  t 
)
inline

constructor

Parameters
[in]confThe Conformation firing the signal.
[in]tThe tag specifying the type of signal.
core::conformation::signals::ConnectionEvent::ConnectionEvent ( ConnectionEvent const &  rval)
inline

copy constructor

virtual core::conformation::signals::ConnectionEvent::~ConnectionEvent ( )
inlinevirtual

default destructor

Member Function Documentation

ConnectionEvent& core::conformation::signals::ConnectionEvent::operator= ( ConnectionEvent const &  rval)
inline

copy assignment

References conformation, and tag.

Member Data Documentation

Conformation const* core::conformation::signals::ConnectionEvent::conformation
Tag core::conformation::signals::ConnectionEvent::tag

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