This is an old revision of HomePageEn/Doc/API from 2010-09-13 10:00:42..

Ðóññêàÿ âåðñèÿ

Óêðà¿íñüêà âåðñ³ÿ?

API system OpenSCADA

Author: Roman Savochenko
Translated by: Maxim Lysenko

Contents

1. The internal structure, API system OpenSCADA.

2. The overall structure of the system. Modularity (TSubSYS, TModule)

2.1. The root object system (TSYS)

2.2. Object of the messages system (TMess)

2.3. Object subsystem (TSubSYS)

2.4. Object Module (TModule)

3. Subsystem "Database" (TBDS)

3.1. Object of subsystem "Database" (TBDS)

3.2. Modular object of types of databases (TTypeBD)

3.3. The object of the database (TBD)

3.4. The object of the table (TTable)

4. The subsystem "Data acquisition" (TDAQS)

4.1. Object of subsystem "Data acquisition" (TDAQS)

4.2. Modular object of the controller's type (TTypeDAQ)

4.3. Controller's object (TController)

4.4. Parameters' type object (TTypeParam)

4.5. Object of the physical level parameter (TParamContr)

4.6. Object of the value (TValue)

4.7. Attribute's object (TVal).

4.8. Object of the templates library of parameters of the "DAQ" subsystem (TPrmTmplLib)

4.9. The object of the parameter's template of the "DAQ" subsystem (TPrmTempl)

5. Subsystem "Archives" (TArchiveS)

5.1. The object of the subsystem "Archives" (TArchiveS)

5.2. The object of the values' archive (TVArchive)

5.3. Object of the values' buffer (TValBuf)

5.4. The modular object of the archiver's type (TTypeArchivator)

5.5. The object of the messages' archiver (TMArchivator)

5.6. The object of the values' archiver (TVArchivator)

5.7. The object of the archive's element in the archiver (TVArchEl)

6. Subsystem "Transports" (TTransportS)

6.1. The object of the "Transports" subsystem (TTransportS)

6.2. The modular object of the transports' type (TTypeTransport)

6.3. The object of the incoming transports (TTransportIn)

6.4. The object of the outgoing transports (TTransportOut)

7. Subsystem "Communication interfaces' protocols" (TProtocolS)

7.1. The object of the “Communication interfaces' protocols” subsystem (TProtocolS)

7.2. The modular object of the protocol (TProtocol)

7.3. The object of the incoming protocol's session (TProtocolIn)

8. Subsystem "User interfaces" (TUIS)

8.1. The object of the "User interfaces" subsystem (TUIS)

8.2. The modular object of the user interface (TUI)

9. Subsystem “Specials” (TSpecialS)

9.1. The object of the “Specials” subsystem (TSpecialS)

9.2. The modular object of the specials (TSpecial)

10. Subsystem “Security” (TSeñurity)

10.1. The object of the "Security" subsystem. (TSeñurity)

10.2. The user's object (TUser)

10.3. The users' group object (TGroup)

11. Subsystem “Modules' sheduling” (TModSchedul)

11.1. The object of the subsystem “Modules' sheduling” (TModSchedul)

12. Components of the object model of the OpenSCADA system

12.1. The function object (TFunction)

12.2. The object of the function's parameter (IO)

12.3. The object of the function's value (TValFunc).

13. Data in the OpenSCADA system and their storage in the DB (TConfig)

13.1. Data object (TConfig)

13.2. Data cell (TCfg)

13.3. Data structure object (TElem)

13.4. Data structure cell (TFld)

13.5. The object which preacts about changing of the structure (TValElem)

13.6. Data cell (TVariant)

13.7. User object (TVarObj)

14. The control interface of the system and the dynamic tree of the system objects (TCntrNode)

14.1. The syntax of the request and response of the control interface

14.2. Tag of the information structure for describing the groups of child branches of the page

14.3. Tags of the description of the information structure of the control interface

14.3.1. Area tag "area"

14.3.2. Data tags

e) Commands with the parameters. Tag "comm"

f) Branches (child nodes)

14.4 Hierarchical dependences of the information elements of the control language

14.5. Object of the dynamic tree node (TCntrNode)

15. XML in the OpenSCADA system (XMLNode)

15.1. XML-tag (XMLNode)

16. Resources in the OpenSCADA system (Res, ResAlloc, ResMtx, MtxAlloc, AutoHD)

16.1. Resource R/W lock object (ResRW)

16.2. Automatic resource RW unlock object (ResAlloc)

16.3. Template (AutoHD)

16.4. Resources allocation object, by mutex (ResMtx)

16.5. Object of the string with the access shared by the resource (ResString)

16.6. Conditional variable object, by mutex (CondVar)

16.7. Object of automatic unlock POSIX mutex (MtxAlloc)

16.8. Object of the string with the access shared by the global the data resource (mutex) (MtxString)

17. Organization and structure of the database of the system components

17.1. System tables

17.2. Tables of the "Data acquisition" subsystem

17.3. Tables of the "Transports" subsystem

17.4. Tables of the "Archives" subsystem

17.5. Tables of the "Security" subsystem

17.6. The structure of the databases of the modules

18. Service functions of the OpenSCADA control interface

18.1. Group access to the values of the parameter's attributes of the subsystem "Data acquisition", as well as to the detailed information

18.2. Access to archived data of the archives of messages

18.3. Access to archived data of the values' archive

19. API of modules of modular subsystems

20. Debugging and Testing the OpenSCADA project

21. Rules for design and commenting of the sources of OpenSCADA and its modules

22. Ñonventional signs in the text and source code

Introduction

This paper describes an application programming interface (API) of the OpenSCADA system.

OpenSCADA is the project of an open SCADA-system based on the modular principle. The document contains an exhaustive description of the internal system architecture of OpenSCADA. In addition to information on the architecture the background information on methods and attributes of the system is provided.
The document is intended for programmers wishing to understand the architecture of OpenSCADA and develop extensions for it. The document is not intended for users and integrators of OpenSCADA!

For understanding of this document it is necessary for you to know the concept of Object Oriented Programming (OOP) and Universal Modeling Language (UML), and for the possibility of studying the source code of the project it is required the knowledge of programming language C++. In addition, the document contains the mentioning of the following technologies: relational databases, XML.

Action source page doesn't exist yet(/Home Page En / Doc / API / part 1?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 2?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 3?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 4?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 5?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 6?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 7?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 8?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 9?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 10?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 11?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 12?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 13?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 14?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 15?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 16?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 17?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 18?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 19?)
Action source page doesn't exist yet(/Home Page En / Doc / API / part 20?)

Ññûëêè

Referring pages: HomePageEn/Doc
HomePageEn/Doc/ModuleBuild
HomePageEn/Doc/OPCUA
HomePageEn/Doc/OpenSCADA060
HomePageEn/Doc/ProgrammManual/part5
HomePageEn/Doc/SelfSystem
HomePageEn/Doc/VCAEngine
HomePageEn/Doc/VCAconcept
HomePageEn/Doc/VCAconcept/part4
HomePageEn/Doc/VCAconcept/part4/part14
HomePageEn/Doc/VCAconcept/part4/part5
HomePageEn/Doc/VCAconcept/part6/part1
HomePageUk/Doc/SelfSystem

There are no files on this page.[Display files/form]

There is no comment on this page. [Display comments/form]