MagicSmoke  $VERSION$
MTGetEntranceEvents Class Reference

This is a convenience transaction: it returns all events that are likely to be chosen at an entrance barcode scanner; this includes all events starting at max. within the next 24 hours that and that have not ended yet. More...

#include <srcMTGetEntranceEvents.h>

Inheritance diagram for MTGetEntranceEvents:
MTransaction

Public Member Functions

 MTGetEntranceEvents ()
 default constructor: generates an invalid transaction More...
 
 MTGetEntranceEvents (const MTGetEntranceEvents &)
 copy constructor: the two copies share their state More...
 
virtual ~MTGetEntranceEvents ()
 deletes this instance More...
 
Q_SLOT QList< MOEventgetevents () const
 
MTGetEntranceEventsoperator= (const MTGetEntranceEvents &)
 copy assignment: the copy shares the state of the original object More...
 

Static Public Member Functions

static MTGetEntranceEvents asyncQuery (const qint64 &amaxbeforestart, const qint64 &amaxafterend, QString iface="MagicSmoke")
 emits the query over the network and returns the transaction object, use isFinished() to check for the transaction's state More...
 
static MTGetEntranceEvents query (const qint64 &amaxbeforestart, const qint64 &amaxafterend, QString iface="MagicSmoke")
 emits the query over the network and returns the finished transaction object More...
 
- Static Public Member Functions inherited from MTransaction
static void setStartStopActions (const MTStartStop &start, const MTStartStop &stop)
 set actions to be executed at start/stop More...
 

Protected Member Functions

 MTGetEntranceEvents (const qint64 &amaxbeforestart, const qint64 &amaxafterend, QString iface)
 generates an instance from its properties More...
 
virtual void endQuery ()
 
- Protected Member Functions inherited from MTransaction
 MTransaction (QString iface=QString())
 internal: construct the transaction More...
 
 MTransaction (const WTransaction &)
 internal: copy the transaction More...
 
 MTransaction (const MTransaction &)
 internal: copy the transaction More...
 
QByteArray executeQuery (QString, QByteArray)
 internal: extend executeQuery to show a wait cursor More...
 

Friends

class MTGetEntranceEvents_Private
 

Detailed Description

This is a convenience transaction: it returns all events that are likely to be chosen at an entrance barcode scanner; this includes all events starting at max. within the next 24 hours that and that have not ended yet.

Constructor & Destructor Documentation

MTGetEntranceEvents::MTGetEntranceEvents ( const qint64 &  amaxbeforestart,
const qint64 &  amaxafterend,
QString  iface 
)
explicitprotected

generates an instance from its properties

Parameters
amaxbeforestartthe clients definition of "soon": time in seconds to look into the future for events that will start "soon"; recommended is 24 hours
amaxafterendthe clients definition of "yet": time in seconds to look into the past for events that have not ended "yet"; recommended is 1 or 2 hours
ifaceID of the interface that the transaction will be sent on

References MTGetEntranceEvents_Private::in_maxafterend, MTGetEntranceEvents_Private::in_maxbeforestart, and MTGetEntranceEvents_Private.

MTGetEntranceEvents::MTGetEntranceEvents ( )

default constructor: generates an invalid transaction

References MTGetEntranceEvents_Private.

MTGetEntranceEvents::MTGetEntranceEvents ( const MTGetEntranceEvents t)

copy constructor: the two copies share their state

References MTGetEntranceEvents_Private::attach().

MTGetEntranceEvents::~MTGetEntranceEvents ( )
virtual

deletes this instance

References MTGetEntranceEvents_Private::detach().

Member Function Documentation

MTGetEntranceEvents MTGetEntranceEvents::asyncQuery ( const qint64 &  amaxbeforestart,
const qint64 &  amaxafterend,
QString  iface = "MagicSmoke" 
)
static

emits the query over the network and returns the transaction object, use isFinished() to check for the transaction's state

Parameters
amaxbeforestartthe clients definition of "soon": time in seconds to look into the future for events that will start "soon"; recommended is 24 hours
amaxafterendthe clients definition of "yet": time in seconds to look into the past for events that have not ended "yet"; recommended is 1 or 2 hours
ifaceID of the interface that the transaction will be sent on
void MTGetEntranceEvents::endQuery ( )
protectedvirtual
QList< MOEvent > MTGetEntranceEvents::getevents ( ) const
MTGetEntranceEvents & MTGetEntranceEvents::operator= ( const MTGetEntranceEvents t)

copy assignment: the copy shares the state of the original object

References MTGetEntranceEvents_Private::attach(), and MTGetEntranceEvents_Private::detach().

MTGetEntranceEvents MTGetEntranceEvents::query ( const qint64 &  amaxbeforestart,
const qint64 &  amaxafterend,
QString  iface = "MagicSmoke" 
)
static

emits the query over the network and returns the finished transaction object

Parameters
amaxbeforestartthe clients definition of "soon": time in seconds to look into the future for events that will start "soon"; recommended is 24 hours
amaxafterendthe clients definition of "yet": time in seconds to look into the past for events that have not ended "yet"; recommended is 1 or 2 hours
ifaceID of the interface that the transaction will be sent on

Referenced by MEntranceTab::initialize(), and MInterface::queryGetEntranceEvents().

Friends And Related Function Documentation

friend class MTGetEntranceEvents_Private
friend

Referenced by MTGetEntranceEvents().


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