Public Types | Public Member Functions | Static Public Attributes | List of all members
ARCSSheet Class Reference

Maintains connections between objects. More...

#include <arcssheet.h>

Collaboration diagram for ARCSSheet:
Collaboration graph

Public Types

typedef ARCSInit &(ARCSSheet::* AddInvocationMethod) (QString, QString, QString, QString)
 
typedef void(ARCSSheet::* GetInvocationsMethod) (QStringList &, QStringList &, QStringList &, QStringList &)
 

Public Member Functions

 ARCSSheet (ARCSContext *ctx=0, QString n=QString::null)
 Constructor.
 
 ARCSSheet (const ARCSSheet &sheet)
 Copy constructor. More...
 
ARCSConnectionaddConnection (QString src, QString sgn, QString dst, QString slt, bool q=false, bool head=false)
 Adds a connection to the sheet structure. More...
 
ARCSInitaddPreconnect (QString dst, QString slt, QString t, QString val)
 Adds a pre-connection initialisation to the sheet structure. More...
 
ARCSInitaddPostconnect (QString dst, QString slt, QString t, QString val)
 Adds a post-connection initialisation to the sheet structure. More...
 
ARCSInitaddCleanup (QString dst, QString slt, QString t, QString val)
 Adds a cleanup invocation to the sheet structure. More...
 
void getConnections (QStringList &sources, QStringList &signls, QStringList &destinations, QStringList &slts)
 Allows to retrieve connections. More...
 
ARCSConnectiongetConnection (QString source, QString sgn, QString dst, QString slt)
 returns a reference to a connection in the sheet structure More...
 
int getConnectionIndex (ARCSConnection &connection)
 
int getConnectionIndex (QString source, QString sgn, QString dst, QString slt)
 
int getPreconnectIndex (ARCSInit &init)
 
int getPostconnectIndex (ARCSInit &init)
 
int getCleanupIndex (ARCSInit &init)
 
ARCSInitgetPreConnect (QString dst, QString slt, QString t, QString val)
 
ARCSInitgetPostConnect (QString dst, QString slt, QString t, QString val)
 
ARCSInitgetCleanup (QString dst, QString slt, QString t, QString val)
 
void swapConnections (int x, int y)
 
void getPreconnects (QStringList &destinations, QStringList &slts, QStringList &types, QStringList &values)
 Allows to retrieve preconnection invocations. More...
 
void getPostconnects (QStringList &destinations, QStringList &slts, QStringList &types, QStringList &values)
 Allows to retrieve postconnection invocations. More...
 
void getCleanups (QStringList &destinations, QStringList &slts, QStringList &types, QStringList &values)
 Allows to retrieve cleanup invocations. More...
 
void activate ()
 
void deactivate ()
 
void removeConnection (ARCSConnection c)
 
void removePreconnect (ARCSInit i)
 
void removePostconnect (ARCSInit i)
 
void removeCleanup (ARCSInit i)
 
ARCSContextgetContext ()
 
void setContext (ARCSContext *ctx)
 
void preconnect ()
 
void connect ()
 
void postconnect ()
 
void disconnect ()
 
void cleanup ()
 
void reset ()
 
void resetConnections ()
 
void resetPreconnects ()
 
void resetPostconnects ()
 
void resetCleanups ()
 
void resetProperties ()
 
void setProperty (QString name, QString value)
 
QString getProperty (QString name)
 
void removeProperty (QString name)
 
QStringList getComponentList ()
 Retrieves the list of components that are used in this sheet. More...
 
void removeComponent (QString name)
 
QStringList getPropertyList ()
 
bool isActivated ()
 
void setName (QString s)
 
QString getName ()
 
bool isEmpty ()
 
void swapPreconnects (int x, int y)
 
void swapPostconnects (int x, int y)
 
void swapCleanups (int x, int y)
 
void swapInits (QList< ARCSInit > &lst, int x, int y)
 

Static Public Attributes

static ARCSSheet null
 

Detailed Description

Maintains connections between objects.

Author
Jean-Yves Didier
Date
December, the 5th, 2008.

Definition at line 48 of file arcssheet.h.

Constructor & Destructor Documentation

ARCSSheet::ARCSSheet ( const ARCSSheet sheet)

Copy constructor.

Warning: When a sheet is copied, the context it depends on is still the same !

Definition at line 50 of file arcssheet.cpp.

Member Function Documentation

void ARCSSheet::activate ( )
inline

Activates a sheet i.e. enables preconnections, connections and postconnections

Definition at line 182 of file arcssheet.h.

Here is the caller graph for this function:

ARCSInit& ARCSSheet::addCleanup ( QString  dst,
QString  slt,
QString  t,
QString  val 
)
inline

Adds a cleanup invocation to the sheet structure.

Parameters
dstdestination component id
sltdestination component slot
tinitialisation type
valinitialisation value

Definition at line 98 of file arcssheet.h.

Here is the caller graph for this function:

ARCSConnection & ARCSSheet::addConnection ( QString  src,
QString  sgn,
QString  dst,
QString  slt,
bool  q = false,
bool  head = false 
)

Adds a connection to the sheet structure.

Parameters
srcsource component's Id
sgnsource component's signal
dstdestination component's Id
sltdestination component's slot
qtells wether the connection is queued or not (false by default)
headtells wether the connection should be inserted on top of list or not (false by default)

Definition at line 183 of file arcssheet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ARCSInit& ARCSSheet::addPostconnect ( QString  dst,
QString  slt,
QString  t,
QString  val 
)
inline

Adds a post-connection initialisation to the sheet structure.

Parameters
dstdestination component id
sltdestination component slot
tinitialisation type
valinitialisation value

Definition at line 87 of file arcssheet.h.

Here is the caller graph for this function:

ARCSInit& ARCSSheet::addPreconnect ( QString  dst,
QString  slt,
QString  t,
QString  val 
)
inline

Adds a pre-connection initialisation to the sheet structure.

Parameters
dstdestination component's id
sltdestination component's slot
tinitialisation type
valinitialisation value

Definition at line 76 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::cleanup ( )
inline

Performs some cleanup

Definition at line 203 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::connect ( )

Connects all links

Definition at line 161 of file arcssheet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ARCSSheet::deactivate ( )
inline

Deactivates a sheet i.e. disconnect all and perform cleanups

Definition at line 184 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::disconnect ( )

Disconnect all

Definition at line 172 of file arcssheet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ARCSSheet::getCleanups ( QStringList &  destinations,
QStringList &  slts,
QStringList &  types,
QStringList &  values 
)
inline

Allows to retrieve cleanup invocations.

Parameters
destinationslist of destination component ids to fill
sltslist of slots to fill
typeslist of invocation type
valueslist of values

Definition at line 176 of file arcssheet.h.

Here is the caller graph for this function:

QStringList ARCSSheet::getComponentList ( )

Retrieves the list of components that are used in this sheet.

The list of components is given by inspecting connections and invocations

Definition at line 74 of file arcssheet.cpp.

ARCSConnection & ARCSSheet::getConnection ( QString  source,
QString  sgn,
QString  dst,
QString  slt 
)

returns a reference to a connection in the sheet structure

Parameters
srcsource component's Id
sgnsource component's signal
dstdestination component's Id
sltdestination component's slot

Definition at line 206 of file arcssheet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ARCSSheet::getConnections ( QStringList &  sources,
QStringList &  signls,
QStringList &  destinations,
QStringList &  slts 
)

Allows to retrieve connections.

Parameters
sourceslist of source component ids to fill
signlslist of signals to fill
destinationslist of destination component ids to fill
sltslist of slots to fill

Definition at line 248 of file arcssheet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

QString ARCSSheet::getName ( )
inline

returns the name of the sheet

Definition at line 246 of file arcssheet.h.

void ARCSSheet::getPostconnects ( QStringList &  destinations,
QStringList &  slts,
QStringList &  types,
QStringList &  values 
)
inline

Allows to retrieve postconnection invocations.

Parameters
destinationslist of destination component ids to fill
sltslist of slots to fill
typeslist of invocation type
valueslist of values

Definition at line 165 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::getPreconnects ( QStringList &  destinations,
QStringList &  slts,
QStringList &  types,
QStringList &  values 
)
inline

Allows to retrieve preconnection invocations.

Parameters
destinationslist of destination component ids to fill
sltslist of slots to fill
typeslist of invocation type
valueslist of values

Definition at line 154 of file arcssheet.h.

Here is the caller graph for this function:

QString ARCSSheet::getProperty ( QString  name)
inline

Get a property

Definition at line 216 of file arcssheet.h.

Here is the caller graph for this function:

QStringList ARCSSheet::getPropertyList ( )
inline

Return the list of properties stored in the sheet

Definition at line 237 of file arcssheet.h.

bool ARCSSheet::isActivated ( )
inline

Checks wether the sheet is activated or not

Definition at line 241 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::postconnect ( )
inline

Performs postconnections

Definition at line 199 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::preconnect ( )
inline

Performs preconnections

Definition at line 195 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::setName ( QString  s)
inline

Sets the name of the sheet

Definition at line 244 of file arcssheet.h.

Here is the caller graph for this function:

void ARCSSheet::setProperty ( QString  name,
QString  value 
)
inline

Set a property

Definition at line 214 of file arcssheet.h.

Here is the caller graph for this function:


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