From OpenSCADAWiki
Jump to: navigation, search

Table 4.11. VCA classes

Class Responsibility Links
TSecurity Provides the information about the users, and also implements their authentication in OpenSCADA. It is used by the widgets and frames of the VCA to verify the access rights.
TFunction Used to access the user programming mechanism when describing the logic of derived widgets, as well as to include the API functions of the object model in the derived widgets. Stores the structure of parameters that bind by logic in the derivative widgets. Passed to the module, which provides the user programming language implementation in order to connect the mechanism of processing the program's logic.
TUI Root object of the module of the subsystem "User interfaces" which is used for integration into the OpenSCADA core. Inherited by the root objects of the module of the VCA concept and by modules of implementation of the VCA interface.
VCA::Engine Root object of the module of the VCA concept/engine. Contains the objects containers of the engine, as well as general methods and data. Used by the visualization interfaces to access the data of the sessions and the conception in general. Integrates the concept's code of the VCA in OpenSCADA.
VCA::WidgetLib Object of the library of widgets/frames, contains the objects of library widgets (VCA::LWidget). Content of the widget libraries can be freely formed by the user. Contains the objects of library widgets (VCA::LWidget).
VCA::Widget Abstract object of the widget. Inherited by the objects of library widget (VCA::LWidget), of the container widget (VCA::CWidget), of the project page (VCA::Page) and by the session objects (VCA::SessPage,VCA::SessWdg). The widget-container contains the function associated with the implementation of the user programming language. Uses the object OpenSCADA API TSecurity for managing the access rights. Uses events from the event manager. Contact the theme manager in order to obtain the immediate values of the colors, fonts in accordance with the current theme.
VCA::LWidget Object of the library widget/frame. Stored in the library (VCA::WidgetLib). Can contain the included widgets, represented by the objects of the container widgets (VCA::CWidget).
VCA::CWidget Object of the container widget of the library widget/frame (VCA::LWidget). In fact, it serves as link to the library widget. Stored in the library frame/widget (VCA::LWidget).
VCA::Project Object of the project of the user interface. Contains pages (VCA::Page) with the hierarchical name. Stored in the container of the object of the concept (VCA::Engine). Contains the page objects (VCA::Page) of the project.
VCA::Page Object of the VC interface page. Closely related to the frame from the widgets library, the frame itself has the elements of the interface. The page object itself, in additionally to the frame, resolves the links to the dynamics and provides the mechanism for the dynamics interleaving of the frame on the pages, with the possibility of forming the template of the dynamics. Stored in the container of the project. Inherited from the abstract widget (VCA::Widget). Connected with frame of the interface (VCA::LWidget) in the library of widgets.
VCA::Theme Object of the theme of the visualization interface. Contains the elements of the theme (VCA::ThemeEl). Stored in the container of the engine object (VCA::Engine). Stores elements of the theme (VCA::ThemeEl).
VCA::ThemeEl Object of the theme's element. Contains an association of the element with the code of the color and font. Contained in the container of the theme (VCA::Theme). Used by the widget's object (VCA::Widget) for obtaining the color and font values by the name of the theme's element.
VCA::EventMap Object of the events' card. Contains the events' objects (VCA::Event). Contained in the container of the engine object (VCA::Engine). Stores the descriptions of events (VCA::Event).
VCA::Event Event's object, contains the association of the object (event) name with the real event. Contained in the container of the events' map (VCA::EventMap).
VCA::Session Object of the execution session of the visualization project. Is opened by the module of the visualization interface and uses in the future the session data for the visualization by its own method. All calculations of the visualization interfaces are made in the session. Contained in the visualization interface project. Contains the page objects of the session with the execution data. Used by the modules of the visualization interfaces to display the data of the session.
VCA::SessPage Object of the session's page. Contains the dynamic data of the project page on which it makes the required calculations. Contained in the object of the session of the project (VCA::Session). Inherited from the abstract widget (VCA::Widget). Uses the object of the project's page (VCA::Page) as a source of initial parameters.
VCA::SessWdg Object of the session's widget. Contains the dynamic data of the separate element of the frame over which it makes the required calculations. May be enclosed in one another in accordance with the hierarchy of widgets of the frame. Contained in the object of the session's page (VCA::SessPage) or in the higher on the hierarchy object of this type. Inherited from the abstract widget (VCA::Widget). Uses the object of library (VCA::LWidget) and/or container (VCA::CWidget) widget as the source of initial parameters. Used by the visualization interface module as the source of dynamic data for the visualization.
Vision, WebGUI Root objects of the visualization interface module, built on the basis of Qt-library and Web-based technologies. Provide access to the means of execution and development of the visualization interfaces in the environment of used technology. Provide an access to runtime and development modes. Integrate the visualization interface code into OpenSCADA.
VRunTime, WebRunTime Objects of runtime of the visualization interface based on Qt-library and Web-based technologies. Directly provides the user visualization and control interface. Contained in the root objects of the visualization modules. Are connected and used the data of the session object (VCA::Session) of the VCA concept. In accordance with the structure of the session they contain the great number of specialized objects of the direct visualization.
VDevelop, WebDevelop Objects of the development of the visualization interface based on Qt-library and Web-based technologies. Provide an interface of the tool over the conception data for the development of VC interfaces. Are contained in the root objects of the visualization modules. Are connected to the object of the root of the VCA conception (VCA::Engine) and provide the graphical interface for managing it. In accordance with the structure of the conception they include the great number of specialized control objects.