stec-platform
Public Member Functions | List of all members
ResidentSubscription Class Reference
Platform

The ResidentSubscription class This is used by remote executables and makes up for the fact we do not use publishers. Essentually, this is a publisher. When it connects to any peer, it broadcasts the values making it by default the publisher. More...

#include <residentsubscription.h>

Inheritance diagram for ResidentSubscription:
Collaboration diagram for ResidentSubscription:

Public Member Functions

 ResidentSubscription (QString name, QVariant properties="NULL", QObject *parent=0)
 
virtual void PeerConnect ()
 when peer gets a connect signal.
 
virtual bool isResident ()
 returns true if resident subscription
 
- Public Member Functions inherited from GlobalSubscription
 GlobalSubscription (QString name, QVariant properties="NULL", QObject *parent=0, bool PeerMaster=false)
 GlobalSubscription. More...
 
void setPeerMaster (bool PeerMaster)
 
- Public Member Functions inherited from Subscription
 Subscription (QString name, QObject *parent=nullptr)
 Subscription. More...
 
virtual ~Subscription ()
 deconstructor
 
virtual MemoryHeap & getMemoryHeap ()
 where the data is stored More...
 
virtual int getSize ()
 number of elements in the array stored already
 
virtual Publication * getPublication (void)
 this returns a pointer to the cloud publication for this subsciber
 
virtual void setUserData (QVariant UserInfo)
 
virtual QVariant userData ()
 gets the user data, if set, for this subscription
 
virtual void UserResetEventOccured (qint16 count, QVariant src)
 reset event
 
virtual void UserEventOccured (qint16 index, qint16 count, QVariant src)
 user event from src
 
virtual void ResetArray (const VremVArray values, QVariant src="local")
 force complete new data and size for this subscription
 
virtual void Update (const QVariant value, int index=0, QVariant src="local")
 update data
 
virtual void Update (const VremVArray values, int index=0, QVariant src="local")
 update data
 
virtual bool isOwner ()
 return true if owner of data
 
virtual void Update (const VremList values, int index=0, QVariant src="local")
 update data
 
void SetPublisherProperty (QVariant property)
 set the property of the data, if owner is set
 
QVariant GetPublisherPropery (void)
 get the publisher of the property
 
void SetPublisherPropertyDescription (QString desc)
 set the description of the publisher if owner is set
 
QString GetPublisherProperyDescription (void)
 gets the description as set by the real owner
 
virtual void Update (const QStringList values, int index=0, QVariant src="local")
 update data
 
virtual VremVArray RequestValues (int index=0, int count=1)
 get the data for this subscription
 
virtual QVariant getSnglValue (int index=0)
 gets just one element of the data
 
virtual VremVArray RequestAllValues (int index=0)
 request all the data the subsciber has
 
virtual void Repeat (QVariant v, int count, int index=0)
 repeat data into subscriber
 
QString const text (void)
 returns the name of the subscription
 
void ForceGlobal (void)
 
void RemoveGlobal (void)
 

Additional Inherited Members

- Public Types inherited from Subscription
enum  StorageType { EventOnly = 0 , CacheData = 1 }
 
- Public Slots inherited from GlobalSubscription
void setProperty (QVariant properties)
 
- Signals inherited from GlobalSubscription
void sigNewProperty (QVariant properties)
 
- Signals inherited from Subscription
void SignalEventDataReset (qint16 count, QVariant src)
 
void SignalEventOccured (qint16 index, qint16 count, QVariant src)
 
void SignalEventIamTheLastSubscription ()
 
void SignalNamedEventOccured (QString name, qint16 index, qint16 count, QVariant src)
 
void SignalUserDataEventOccured (QVariant udata, qint16 index, qint16 count, QVariant src)
 

Detailed Description

The ResidentSubscription class This is used by remote executables and makes up for the fact we do not use publishers. Essentually, this is a publisher. When it connects to any peer, it broadcasts the values making it by default the publisher.

Use this only from a remote executable program.

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