UniSet 2.44.3
Класс uniset::IOController

#include <IOController.h>

Граф наследования:uniset::IOController:
Граф связей класса uniset::IOController:

Классы

struct  USensorInfo
struct  UThresholdInfo

Открытые типы

typedef std::unordered_map< uniset::ObjectId, std::shared_ptr< USensorInfo > > IOStateList
typedef sigc::signal< void, std::shared_ptr< USensorInfo > &, IOController * > ChangeSignal
typedef sigc::signal< void, std::shared_ptr< USensorInfo > &, IOController * > ChangeUndefinedStateSignal
typedef std::list< std::shared_ptr< UThresholdInfo > > ThresholdExtList

Открытые члены

 IOController (const std::string &name, const std::string &section)
 IOController (const uniset::ObjectId id)
void setDBServer (const std::shared_ptr< uniset::DBServer > &dbserver)
virtual uniset::ObjectType getType () override
virtual uniset::SimpleInfogetInfo (const char *userparam="") override
virtual CORBA::Long getValue (uniset::ObjectId sid, uniset::ObjectId sup_id) override
virtual void setValue (uniset::ObjectId sid, CORBA::Long value, uniset::ObjectId sup_id=uniset::DefaultObjectId) override
virtual void setUndefinedState (uniset::ObjectId sid, CORBA::Boolean undefined, uniset::ObjectId sup_id=uniset::DefaultObjectId) override
virtual void freezeValue (uniset::ObjectId sid, CORBA::Boolean set, CORBA::Long value, uniset::ObjectId sup_id=uniset::DefaultObjectId) override
virtual IOController_i::SensorInfoSeq * getSensorSeq (const uniset::IDSeq &lst, uniset::ObjectId sup_id) override
virtual uniset::IDSeqsetOutputSeq (const IOController_i::OutSeq &lst, uniset::ObjectId sup_id) override
virtual UniversalIO::IOType getIOType (uniset::ObjectId sid) override
virtual IOController_i::SensorInfoSeq * getSensorsMap (uniset::ObjectId sup_id) override
virtual IOController_i::SensorIOInfo getSensorIOInfo (uniset::ObjectId sid, uniset::ObjectId sup_id) override
virtual CORBA::Long getRawValue (uniset::ObjectId sid, uniset::ObjectId sup_id) override
virtual void calibrate (uniset::ObjectId sid, const IOController_i::CalibrateInfo &ci, uniset::ObjectId adminId) override
IOController_i::CalibrateInfo getCalibrateInfo (const uniset::ObjectId sid, const uniset::ObjectId consumer_id) override
IOController_i::SensorInfo SensorInfo (const uniset::ObjectId sid, const uniset::ObjectId node=uniset::uniset_conf() ->getLocalNode())
uniset::Message::Priority getPriority (const uniset::ObjectId id, const uniset::ObjectId consumer_id)
virtual IOController_i::ShortIOInfo getTimeChange (const uniset::ObjectId id, const uniset::ObjectId consumer_id) override
virtual IOController_i::ShortMapSeq * getSensors (const uniset::ObjectId consumer_id) override
virtual Poco::JSON::Object::Ptr httpHelp (const Poco::URI::QueryParameters &p) override
virtual Poco::JSON::Object::Ptr httpRequest (const UHttp::HttpRequestContext &ctx) override
ChangeSignal signal_change_value (uniset::ObjectId sid)
ChangeSignal signal_change_value ()
ChangeUndefinedStateSignal signal_change_undefined_state (uniset::ObjectId sid)
ChangeUndefinedStateSignal signal_change_undefined_state ()
IOStateList::iterator ioBegin ()
IOStateList::iterator ioEnd ()
IOStateList::iterator find (uniset::ObjectId k)
int ioCount () const noexcept
Открытые члены унаследованные от uniset::UniSetManager
 UniSetManager (uniset::ObjectId id)
 UniSetManager (const std::string &name, const std::string &section)
virtual void broadcast (const uniset::TransportMessage &msg) override
virtual uniset::SimpleInfoSeq * getObjectsInfo (CORBA::Long MaxLength=300, const char *userparam=0) override
virtual bool add (const std::shared_ptr< UniSetObject > &obj)
virtual bool remove (const std::shared_ptr< UniSetObject > &obj)
size_t objectsCount () const
PortableServer::POA_ptr getPOA ()
PortableServer::POAManager_ptr getPOAManager ()
std::shared_ptr< UniSetManager > get_mptr ()
Открытые члены унаследованные от uniset::UniSetObject
 UniSetObject (const std::string &name, const std::string &section)
 UniSetObject (uniset::ObjectId id)
virtual CORBA::Boolean exist () override
virtual uniset::ObjectId getId () override
const uniset::ObjectId getId () const
std::string getName () const
const std::string getStrType ()
virtual uniset::SimpleInfoapiRequest (const char *query) override
virtual void push (const uniset::TransportMessage &msg) override
 поместить сообщение в очередь
virtual void pushMessage (const char *msg, ::CORBA::Long mtype, const ::uniset::Timespec &tm, const ::uniset::ProducerInfo &pi, ::CORBA::Long priority, ::CORBA::Long consumer) override
 поместить текстовое сообщение в очередь
uniset::ObjectPtr getRef () const
std::shared_ptr< UniSetObjectget_ptr ()
virtual timeout_t askTimer (uniset::TimerId timerid, timeout_t timeMS, clock_t ticks=-1, uniset::Message::Priority p=uniset::Message::High) override
Открытые члены унаследованные от uniset::LT_Object
timeout_t checkTimers (UniSetObject *obj)
timeout_t getTimeInterval (uniset::TimerId timerid) const
timeout_t getTimeLeft (uniset::TimerId timerid) const

Статические открытые данные

static const long not_specified_value = { std::numeric_limits<long>::max() }

Защищенные типы

typedef sigc::signal< void, std::shared_ptr< USensorInfo > &, IOController * > InitSignal
typedef std::function< void(std::shared_ptr< USensorInfo > &)> UFunction
Защищенные типы унаследованные от uniset::UniSetManager
enum  OManagerCommand { deactiv , activ , initial }
typedef UniSetManagerList::iterator MListIterator
typedef std::function< void(const std::shared_ptr< UniSetObject > &)> OFunction
typedef std::function< void(const std::shared_ptr< UniSetManager > &)> MFunction
Защищенные типы унаследованные от uniset::LT_Object
typedef std::deque< TimerInfoTimersList

Защищенные члены

virtual long localSetValueIt (IOStateList::iterator &it, const uniset::ObjectId sid, CORBA::Long value, uniset::ObjectId sup_id)
virtual long localGetValue (IOStateList::iterator &it, const uniset::ObjectId sid, uniset::ObjectId sup_id)
virtual void localSetUndefinedState (IOStateList::iterator &it, bool undefined, const uniset::ObjectId sid)
virtual void localFreezeValueIt (IOController::IOStateList::iterator &li, uniset::ObjectId sid, CORBA::Boolean set, CORBA::Long value, uniset::ObjectId sup_id)
virtual void localFreezeValue (std::shared_ptr< USensorInfo > &usi, CORBA::Boolean set, CORBA::Long value, uniset::ObjectId sup_id)
virtual long localSetValue (std::shared_ptr< USensorInfo > &usi, CORBA::Long value, uniset::ObjectId sup_id)
long localGetValue (std::shared_ptr< USensorInfo > &usi, const uniset::ObjectId consumer_id)
virtual Poco::JSON::Object::Ptr request_get (const std::string &req, const Poco::URI::QueryParameters &p)
virtual Poco::JSON::Object::Ptr request_set (const std::string &req, const Poco::URI::QueryParameters &p)
virtual Poco::JSON::Object::Ptr request_freeze (const std::string &req, const Poco::URI::QueryParameters &p, bool set)
virtual Poco::JSON::Object::Ptr request_sensors (const std::string &req, const Poco::URI::QueryParameters &p)
void getSensorInfo (Poco::JSON::Array::Ptr &jdata, std::shared_ptr< USensorInfo > &s, uniset::ObjectId consumer_id, bool shortInfo=false)
virtual bool deactivateObject () override
virtual bool activateObject () override
virtual void activateInit ()
virtual void sensorsRegistration ()
virtual void sensorsUnregistration ()
InitSignal signal_init ()
void ioRegistration (std::shared_ptr< USensorInfo > &usi)
void ioUnRegistration (const uniset::ObjectId sid)
void reloadACLConfig (uniset::ACLMap &amap, uniset::ACLInfoMap &iomap)
IOController_i::SensorIOInfo SensorIOInfo (long v, UniversalIO::IOType t, const IOController_i::SensorInfo &si, uniset::Message::Priority p=uniset::Message::Medium, long defval=0, IOController_i::CalibrateInfo *ci=0, uniset::ObjectId sup_id=uniset::DefaultObjectId, uniset::ObjectId depend_sid=uniset::DefaultObjectId)
virtual void logging (uniset::SensorMessage &sm)
 сохранение информации об изменении состояния датчика
virtual void dumpToDB ()
 сохранение состояния всех датчиков в БД
IOStateList::iterator myioBegin ()
IOStateList::iterator myioEnd ()
IOStateList::iterator myiofind (uniset::ObjectId id)
void initIOList (const IOStateList &&l)
void for_iolist (UFunction f)
void setDefaultAccessMask (uniset::AccessMask m)
Защищенные члены унаследованные от uniset::UniSetManager
virtual bool addManager (const std::shared_ptr< UniSetManager > &mngr)
virtual bool removeManager (const std::shared_ptr< UniSetManager > &mngr)
virtual bool addObject (const std::shared_ptr< UniSetObject > &obj)
virtual bool removeObject (const std::shared_ptr< UniSetObject > &obj)
void objects (OManagerCommand cmd)
void managers (OManagerCommand cmd)
void initPOA (const std::weak_ptr< UniSetManager > &rmngr)
const std::shared_ptr< UniSetObjectfindObject (const std::string &name) const
const std::shared_ptr< UniSetManager > findManager (const std::string &name) const
const std::shared_ptr< UniSetObjectdeepFindObject (const std::string &name) const
void getAllObjectsList (std::vector< std::shared_ptr< UniSetObject > > &vec, size_t lim=1000)
int getObjectsInfo (const std::shared_ptr< UniSetManager > &mngr, uniset::SimpleInfoSeq *seq, int begin, const long uplimit, const char *userparam)
void apply_for_objects (OFunction f)
void apply_for_managers (MFunction f)
Защищенные члены унаследованные от uniset::UniSetObject
virtual void processingMessage (const uniset::VoidMessage *msg)
virtual void sysCommand (const uniset::SystemMessage *sm)
virtual void sensorInfo (const uniset::SensorMessage *sm)
virtual void timerInfo (const uniset::TimerMessage *tm)
virtual void onTextMessage (const uniset::TextMessage *tm)
VoidMessagePtr receiveMessage ()
VoidMessagePtr waitMessage (timeout_t msec=UniSetTimer::WaitUpTime)
void termWaiting ()
size_t countMessages ()
size_t getCountOfLostMessages () const
void uterminate ()
void thread (bool create)
void offThread ()
void onThread ()
virtual void callback ()
void setID (uniset::ObjectId id)
void setThreadPriority (Poco::Thread::Priority p)
void setMaxSizeOfMessageQueue (size_t s)
size_t getMaxSizeOfMessageQueue () const
bool isActive () const
void setActive (bool set)
virtual Poco::JSON::Object::Ptr httpGetMyInfo (Poco::JSON::Object::Ptr root)
Poco::JSON::Object::Ptr request_configure (const std::string &req, const Poco::URI::QueryParameters &p)
Poco::JSON::Object::Ptr request_configure_get (const std::string &req, const Poco::URI::QueryParameters &p)
Poco::JSON::Object::Ptr request_configure_by_name (const std::string &name, const std::string &props)
Poco::JSON::Object::Ptr request_params (const std::string &req, const Poco::URI::QueryParameters &p)
virtual Poco::JSON::Object::Ptr request_params_get (const std::string &req, const Poco::URI::QueryParameters &p)
virtual Poco::JSON::Object::Ptr request_params_set (const std::string &req, const Poco::URI::QueryParameters &p)
Защищенные члены унаследованные от uniset::LT_Object
virtual std::string getTimerName (int id) const
TimersList getTimersList () const

Защищенные данные

bool disabledHttpSetApi = { false }
bool disabledHttpFreezeApi = { false }
bool disableHttpAccessControl = { false }
Защищенные данные унаследованные от uniset::UniSetManager
PortableServer::POA_var poa
PortableServer::POAManager_var pman
Защищенные данные унаследованные от uniset::UniSetObject
std::shared_ptr< UInterfaceui
std::string myname
std::weak_ptr< UniSetManager > mymngr
Защищенные данные унаследованные от uniset::LT_Object
timeout_t sleepTime

Друзья

class NCRestorer
class SMInterface

Подробное описание

Реализация интерфейса IOController-а Важной особенностью данной реализации является то, что список входов/выходов (ioList) формируется один раз во время создания объекта и не меняется (!) в процессе работы. На этом построены некоторые оптимизации! Поэтому неизменность ioList во время всей жизни объекта должна гарантироваться. В частности, очень важной является структура USensorInfo, а также userdata, которые используются для "кэширования" (сохранения) указателей на специальные данные. (см. также IONotifyController).

Определения типов

◆ ChangeSignal

typedef sigc::signal<void, std::shared_ptr<USensorInfo>&, IOController*> uniset::IOController::ChangeSignal
Предупреждения
В сигнале напрямую передаётся указатель на внутреннюю структуру! Это не очень хорошо, с точки зрения "архитектуры", но оптимальнее по быстродействию! необходимо в обработчике не забывать использовать uniset_rwmutex_wrlock(val_lock) или uniset_rwmutex_rlock(val_lock)

Методы

◆ activateInit()

void IOController::activateInit ( )
protectedvirtual

Начальная инициализация (выставление значений)

◆ activateObject()

bool IOController::activateObject ( )
overrideprotectedvirtual
Заметки
Переопределяя, не забывайте вызвать базовую

Регистрация объекта и всех его подобъектов в репозитории.

Заметки
Только после этого он (и они) становятся доступны другим процессам

Переопределяет метод предка uniset::UniSetManager.

Переопределяется в uniset::IONotifyController и uniset::SharedMemory.

◆ deactivateObject()

bool IOController::deactivateObject ( )
overrideprotectedvirtual
Заметки
Переопределяя, не забывайте вызвать базовую

Удаление объекта и всех его подобъектов из репозитория.

Заметки
Объект становится недоступен другим процессам

Переопределяет метод предка uniset::UniSetManager.

Переопределяется в uniset::SharedMemory и uniset::UniExchange.

◆ dumpToDB()

void IOController::dumpToDB ( )
protectedvirtual

сохранение состояния всех датчиков в БД

Переопределяется в NullController.

◆ getInfo()

uniset::SimpleInfo * IOController::getInfo ( const char * userparam = "")
overridevirtual

Переопределяет метод предка uniset::UniSetObject.

Переопределяется в uniset::IONotifyController.

◆ getType()

virtual uniset::ObjectType uniset::IOController::getType ( )
inlineoverridevirtual

Переопределяет метод предка uniset::UniSetManager.

◆ httpHelp()

Poco::JSON::Object::Ptr IOController::httpHelp ( const Poco::URI::QueryParameters & p)
overridevirtual

Переопределяет метод предка uniset::UniSetObject.

◆ httpRequest()

Poco::JSON::Object::Ptr IOController::httpRequest ( const UHttp::HttpRequestContext & ctx)
overridevirtual

Переопределяет метод предка uniset::UniSetObject.

◆ ioRegistration()

void IOController::ioRegistration ( std::shared_ptr< USensorInfo > & usi)
protected

регистрация датчика в репозитории

◆ ioUnRegistration()

void IOController::ioUnRegistration ( const uniset::ObjectId sid)
protected

разрегистрация датчика

◆ localSetUndefinedState()

void IOController::localSetUndefinedState ( IOStateList::iterator & it,
bool undefined,
const uniset::ObjectId sid )
protectedvirtual

функция выставления признака неопределённого состояния для аналоговых датчиков для дискретных датчиков необходимости для подобной функции нет. см. логику выставления в функции localSaveState

◆ logging()

void IOController::logging ( uniset::SensorMessage & sm)
protectedvirtual

сохранение информации об изменении состояния датчика

Переопределяется в NullSM, NullSM и uniset::SharedMemory.

◆ reloadACLConfig()

void IOController::reloadACLConfig ( uniset::ACLMap & amap,
uniset::ACLInfoMap & iomap )
protected

перезагрузка ACL

◆ sensorsRegistration()

virtual void uniset::IOController::sensorsRegistration ( )
inlineprotectedvirtual

регистрация датчиков, за информацию о которых отвечает данный IOController

Переопределяется в uniset::IONotifyController.

◆ sensorsUnregistration()

void IOController::sensorsUnregistration ( )
protectedvirtual

удаление из репозитория датчиков за информацию о которых отвечает данный IOController

Данные класса

◆ disabledHttpFreezeApi

bool uniset::IOController::disabledHttpFreezeApi = { false }
protected

отключить API "freeze/unfreeze", для невозможности управлять через HTTP API

◆ disabledHttpSetApi

bool uniset::IOController::disabledHttpSetApi = { false }
protected

отключить API "set", для невозможности устанавливать датчики через HTTP API

◆ disableHttpAccessControl

bool uniset::IOController::disableHttpAccessControl = { false }
protected

отключить проверку прав доступа для HTTP API