Torc  0.1
Public Slots | Public Member Functions | List of all members
TorcSystemInput Class Referencefinal

#include <torcsysteminput.h>

Inheritance diagram for TorcSystemInput:
[legend]

Public Slots

bool event (QEvent *Event) override
 
- Public Slots inherited from TorcInput
void SubscriberDeleted (QObject *Subscriber)
 
void SetValue (double Value) override
 Update the inputs value. More...
 
void SetValid (bool Valid) final
 
double GetOperatingRangeMin (void)
 
double GetOperatingRangeMax (void)
 
bool GetOutOfRangeLow (void)
 
bool GetOutOfRangeHigh (void)
 
- Public Slots inherited from TorcDevice
virtual void SetValue (double Value)
 
virtual void SetValid (bool Valid)
 
bool GetValid (void)
 
double GetValue (void)
 
double GetDefaultValue (void)
 
QString GetModelId (void)
 
QString GetUniqueId (void)
 
QString GetUserName (void)
 
QString GetUserDescription (void)
 

Public Member Functions

 TorcSystemInput (double Value, const QVariantMap &Details)
 
 ~TorcSystemInput ()
 
TorcInput::Type GetType (void) override
 
QStringList GetDescription (void) override
 
- Public Member Functions inherited from TorcInput
 TorcInput (TorcInput::Type Type, double Value, double RangeMinimum, double RangeMaximum, const QString &ModelId, const QVariantMap &Details)
 
virtual void Start (void) override
 
QString GetUIName (void) override
 
- Public Member Functions inherited from TorcReferenceCounter
 TorcReferenceCounter (void)
 
virtual ~TorcReferenceCounter (void)=default
 
void UpRef (void)
 
virtual bool DownRef (void)
 
bool IsShared (void)
 
- Public Member Functions inherited from TorcHTTPService
 TorcHTTPService (QObject *Parent, const QString &Signature, const QString &Name, const QMetaObject &MetaObject, const QString &Blacklist=QStringLiteral(""))
 
virtual ~TorcHTTPService ()
 
void ProcessHTTPRequest (const QString &PeerAddress, int PeerPort, const QString &LocalAddress, int LocalPort, TorcHTTPRequest &Request) override
 
QVariantMap ProcessRequest (const QString &Method, const QVariant &Parameters, QObject *Connection, bool Authenticated) override
 
QString GetMethod (int Index)
 
QVariant GetProperty (int Index)
 Get the value of a given property. More...
 
QVariantMap GetServiceDetails (void)
 Return a QVariantMap describing the services methods and properties. More...
 
virtual QString GetPresentationURL (void)
 
- Public Member Functions inherited from TorcHTTPHandler
 TorcHTTPHandler (const QString &Signature, const QString &Name)
 
virtual ~TorcHTTPHandler ()
 
QString Signature (void) const
 
bool GetRecursive (void) const
 
QString Name (void) const
 

Additional Inherited Members

- Public Types inherited from TorcInput
enum  Type {
  Unknown = 0, Temperature, pH, Switch,
  PWM, Button, Started, Integer,
  MaxType
}
 
- Signals inherited from TorcInput
void OutOfRangeLowChanged (bool Value)
 
void OutOfRangeHighChanged (bool Value)
 
- Signals inherited from TorcDevice
void ValidChanged (bool Valid)
 
void ValueChanged (double Value)
 
- Static Public Member Functions inherited from TorcReferenceCounter
static void EventLoopEnding (bool Ending)
 
- Protected Member Functions inherited from TorcInput
virtual ~TorcInput ()=default
 
- Protected Member Functions inherited from TorcDevice
virtual ~TorcDevice ()
 
- Protected Member Functions inherited from TorcHTTPService
void HandleSubscriberDeleted (QObject *Subscriber)
 
- Static Protected Member Functions inherited from TorcHTTPHandler
static bool MethodIsAuthorised (TorcHTTPRequest &Request, int Allowed)
 Check the current request is authorised and set the authentication header if not. More...
 
static void HandleOptions (TorcHTTPRequest &Request, int Allowed)
 
static void HandleFile (TorcHTTPRequest &Request, const QString &Filename, int Cache)
 
- Protected Attributes inherited from TorcDevice
double value
 
double defaultValue
 
QString modelId
 
QString uniqueId
 
QString userName
 
QString userDescription
 
QMutex lock
 
bool wasInvalid
 
- Protected Attributes inherited from TorcReferenceCounter
QAtomicInt m_refCount
 
- Protected Attributes inherited from TorcHTTPService
QReadWriteLock m_httpServiceLock
 
- Protected Attributes inherited from TorcHTTPHandler
QString m_signature
 
bool m_recursive
 
QString m_name
 
- Static Protected Attributes inherited from TorcDevice
static QHash< QString, TorcDevice * > * gDeviceList = new QHash<QString,TorcDevice*>()
 
static QMutex * gDeviceListLock = new QMutex(QMutex::Recursive)
 
- Static Protected Attributes inherited from TorcReferenceCounter
static bool m_eventLoopEnding = false
 
- Properties inherited from TorcInput
double operatingRangeMin
 
double operatingRangeMax
 
bool outOfRangeLow
 
bool outOfRangeHigh
 
- Properties inherited from TorcDevice
bool valid
 

Detailed Description

This device listens for Torc events in order to trigger changes in state based on the current Torc status. Currently limited to listening for Start and Stop events to enable, for example, a soft start and finish for dimmed lights.

An optional delay parameter will delay stopping the application by the given number of seconds to allow for dimming etc.

Definition at line 7 of file torcsysteminput.h.

Constructor & Destructor Documentation

TorcSystemInput::TorcSystemInput ( double  Value,
const QVariantMap &  Details 
)

Definition at line 38 of file torcsysteminput.cpp.

TorcSystemInput::~TorcSystemInput ( void  )

Definition at line 61 of file torcsysteminput.cpp.

Member Function Documentation

bool TorcSystemInput::event ( QEvent *  Event)
overrideslot

Definition at line 76 of file torcsysteminput.cpp.

QStringList TorcSystemInput::GetDescription ( void  )
overridevirtual

Reimplemented from TorcDevice.

Definition at line 71 of file torcsysteminput.cpp.

TorcInput::Type TorcSystemInput::GetType ( void  )
overridevirtual

Implements TorcInput.

Definition at line 66 of file torcsysteminput.cpp.


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