Commit 2a851e40 authored by Pavel Vainerman's avatar Pavel Vainerman

add new docs, clean obsolete docs

parent 5bec5101
/*! \page page_Concept
\b uniset ()
. .
\ref sec_Cnpt_Object
\ref sec_Cnpt_ObjectTypes
\ref sec_Cnpt_Message
\ref sec_Cnpt_ObjectId
\ref sec_Cnpt_Repository
\ref sec_Cnpt_Sensor
\ref sec_Cnpt_Process
\ref sec_Cnpt_Service
\section sec_Cnpt_Object
, ,
""
UniSetObject,
.
\section sec_Cnpt_ObjectTypes
:
# () - UniSetObject
# - IOController
# -
# - , ,
.
\section sec_Cnpt_Message
. ,
MessageType.h.
(enum).
. UniSetTypes::Message::TypeOfMessage.
libuniset,
,
\b
UniSetTypes::Message::TheLastFieldOfTypeOfMessage.
\code
enum MyMessageTypes
{
myBegin = UniSetTypes::Message::TheLastFieldOfTypeOfMessage,
myMessgeType1,
myMessgeType2,
myMessgeType3,
...
};
\endcode
\section sec_Cnpt_ObjectId
,
( . \ref sec_Cnpt_Sensor)
. \b long.
UniSetTypes::DefaultObjectId.
- .
\b <id,node>
\b node - , .
. ..
node.
.
\par .
\b <nodes>,\b <sensors>,\b <objects>,\b <controllers>,\b <services>
( \a name).
\b <ObjectsMap> \b idfromfile="0".
\code
<Configurations>
...
<ObjectsMap idfromfile="0">
<nodes port="2809">
<item name="LocalhostNode" alias="" textname=" " ip="127.0.0.1" infserver="InfoServer" dbserver=""/>
<item name="Node2" alias="" textname=" " ip="127.0.0.1" infserver="InfoServer" dbserver=""/>
</nodes>
<sensors>
<item name="Input1_S" textname=" 1" node="" iotype="DI" priority="Medium" default="1" />
<item name="Input2_S" textname=" 2" node="" iotype="DI" priority="Medium" mbtype="rtu" mbaddr="0x01" mbfunc="0x04" mbreg="0x02" rs="2" />
</sensors>
<controllers name="Controllers">
<item name="SharedMemory"/>
<item name="UniExchange"/>
<item name="UniExchange2"/>
</controllers>
<!-- ******************* ***************** -->
<services name="Services">
<item name="InfoServer"/>
<item name="DBServer"/>
<item name="PrintServer"/>
<item name="TimeService"/>
</services>
<!-- ******************* ***************** -->
<objects name="UniObjects">
<item name="TestProc1"/>
<item name="TestProc2"/>
</objects>
</ObjectsMap>
...
</Configurations>
\endcode
, ,
( ). . \ref ObjectIndex_XML
\note , ,
\b \b \b .
<item> , ,
( ). .. ,
.
\note - ģ .
\par
()
. , ,
-
.
, ,
"" (
̣ ).
,
\b <nodes>,\b <sensors>,\b <objects>,\b <controllers>,\b <services>
\b id.
\b <ObjectsMap> \b idfromfile="1".
\code
<Configurations>
...
<ObjectsMap idfromfile="1">
<nodes port="2809">
<item id="1000" name="LocalhostNode" alias="" textname=" " ip="127.0.0.1" infserver="InfoServer" dbserver=""/>
<item id="1001" name="Node2" alias="" textname=" " ip="127.0.0.1" infserver="InfoServer" dbserver=""/>
</nodes>
<sensors>
<item id="1" name="Input1_S" textname=" 1" node="" iotype="DI" priority="Medium" default="1" />
<item id="10" name="Input2_S" textname=" 2" node="" iotype="DI" priority="Medium" mbtype="rtu" mbaddr="0x01" mbfunc="0x04" mbreg="0x02" rs="2" />
</sensors>
<controllers name="Controllers">
<item id="100" name="SharedMemory"/>
<item id="101" name="UniExchange"/>
<item id="102" name="UniExchange2"/>
</controllers>
<!-- ******************* ***************** -->
<services name="Services">
<item id="500" name="InfoServer"/>
<item id="501" name="DBServer"/>
<item id="502" name="PrintServer"/>
<item id="503" name="TimeService"/>
</services>
<!-- ******************* ***************** -->
<objects name="UniObjects">
<item id="200" name="TestProc1"/>
<item id="201" name="TestProc2"/>
</objects>
</ObjectsMap>
...
</Configurations>
\note ( )
(
).
\section sec_Cnpt_Repository
\section sec_Cnpt_Sensor
\section sec_Cnpt_Process
\section sec_Cnpt_Service
*/
/*! /* OBSOLETE DOC!!!
\page ControlProcessPage \page ControlProcessPage
- \ref pgCP_secDeclareIDL - \ref pgCP_secDeclareIDL
......
/*! /* OBSOLETE DOC!!!
\page IOConfigurePage / \page IOConfigurePage /
- \ref pgIOC_secCommon - \ref pgIOC_secCommon
......
/*! /* OBSOLETE DOC!!!
\page IONotifyControllerPage IONotifyController ( /) \page IONotifyControllerPage IONotifyController ( /)
- \ref pgIONC_secDeclareIDL - \ref pgIONC_secDeclareIDL
......
/*! /* OBSOLETE DOC!!!
\page ObjectRepositoryPage \page ObjectRepositoryPage
, ,
......
...@@ -260,4 +260,3 @@ const UniSetTypes::ObjectInfo ObjectsMap[MAX_NUMOBJECTS] = ...@@ -260,4 +260,3 @@ const UniSetTypes::ObjectInfo ObjectsMap[MAX_NUMOBJECTS] =
\subsection OMAP_subDynamic_Create \subsection OMAP_subDynamic_Create
\subsection OMAP_subDynamic_Example \subsection OMAP_subDynamic_Example
*/ */
...@@ -3,6 +3,6 @@ ...@@ -3,6 +3,6 @@
\page ServicesPage \page ServicesPage
- \ref secDBServer - \ref secDBServer
- \ref secInfoServer - \ref secInfoService
- \ref secTimerService - \ref secTimerService
*/ */
/*! /* OBSOLETE DOC!!!
\page UniversalInterfacePage \page UniversalInterfacePage
( ), , .. ( ), , ..
......
...@@ -142,4 +142,3 @@ ...@@ -142,4 +142,3 @@
- \b /Utilities - UniSet - \b /Utilities - UniSet
*/ */
...@@ -19,4 +19,3 @@ ...@@ -19,4 +19,3 @@
.. <depend> . .. <depend> .
*/ */
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
\section MainSection \section MainSection
- \ref CommitPage - \ref CommitPage
- \ref ObjectRepositoryPage - \ref page_Concept
- \ref UniSetLibStylePage - \ref UniSetLibStylePage
- \ref DebugPage - \ref DebugPage
*/ */
......
...@@ -27,4 +27,3 @@ ...@@ -27,4 +27,3 @@
-# , .. ( ) -# , .. ( )
-# NotifyController- calibrate ( ) -# NotifyController- calibrate ( )
*/ */
...@@ -16,9 +16,11 @@ ...@@ -16,9 +16,11 @@
\section sec_SM_Common SharedMemory \section sec_SM_Common SharedMemory
SharedMemory IONotifyController.
. \ref page_IONotifyController
: SM:
- \ref sec_SM_Save
- \ref sec_SM_Conf - \ref sec_SM_Conf
- \ref sec_SM_Event - \ref sec_SM_Event
- \ref sec_SM_HeartBeat - \ref sec_SM_HeartBeat
...@@ -26,10 +28,8 @@ ...@@ -26,10 +28,8 @@
- \ref sec_SM_Pulsar - \ref sec_SM_Pulsar
- \ref sec_SM_DBLog - \ref sec_SM_DBLog
\section sec_SM_Save
\section sec_SM_Conf \section sec_SM_Conf
SM , SM SM ,
. .
""(consumer) , ""(consumer) ,
(depends) . (depends) .
......
...@@ -38,6 +38,65 @@ ...@@ -38,6 +38,65 @@
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
class NCRestorer; class NCRestorer;
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
/*!
\page page_IONotifyController
IONotifyController IOController.
. \ref page_IOController
IONotifyController- (\b IONC):
- \ref sec_NC_AskSensors
- \ref sec_NC_Consumers
- \ref sec_NC_Thresholds
- \ref sec_NC_Depends
\section sec_NC_AskSensors
IONotifyController
() ( ).
:
"" \b IONC ,
.
, ϣ ,
UniSetTypes::SensorMessage () ,
.. .
.
IONotifyController::askSensor. askState askValue
.
... ...
\section sec_NC_Consumers
"" UniSet- (UniSetObject),
" " (),
. ,
(. IONotifyController::askSensor).
"" ,
("" ).
, \b <sensors>
\b <consumers>.
\code
<sensors>
...
<item name="Sensors1" textname="sensor N1" iotype="AI" ...>
<consumers>
<consumer name="TestProc1" type="objects"/>
<consumer name="TestProc2" type="managers" node="RemoteNode"/>
...
</consumers>
</item>
...
</sensors>
\endcode
"" ,
\b IONC .
\section sec_NC_Thresholds
\section sec_NC_Depends
*/
/*! \class IONotifyController /*! \class IONotifyController
* \todo * \todo
...@@ -45,7 +104,7 @@ class NCRestorer; ...@@ -45,7 +104,7 @@ class NCRestorer;
.... ....
ConsumerMaxAttempts - ConsumerMaxAttempts -
"". "".
. = 5. . = 5.
*/ */
class IONotifyController: class IONotifyController:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment