Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

 This page has information about This page provides a comprehensive overview of objects and namespaces, explaining its concepts and listing the namespaces that are defined by the platform. The Reference for all classes, methods and properties of the various namespaces in on the page Namespace APIfundamental concepts crucial for effective development within the software platform. Understanding these concepts is essential for organizing and managing the various elements of your application.

On this page:

Table of Contents
maxLevel3
stylenone


Introduction

to Objects and Namespaces

Accessing Objects Directly in Your Project

In With most systems, you must create custom logic for your projects and create Tags or Variables and the creation of tags or variables for all internal properties are necessary. Our However, our platform allows your application to directly access all the objects that you created create in your project. It This means that user-created temporary tags are not required to manage the status of PLC network nodes, the total number of alarms in a group, or the number of rows in a dataset. You can now access runtime objects, business objects (representing a network node), or an alarm group or dataset directly. Then, This allows you can to display the required information or take action directly through the object's built-in properties.

FactoryStudio has There is an underlying .NET object model with an 100% managed code, specifically targeting the development of Realreal-Time time data management applications. The hierarchical object model includes the following top-level objects that correspond to the main modules in the platform:

Module

Description

Tags

Real-time tags objectsTime Tags Objects

Alarm

Module Alarm runtime objectsRuntime Objects

ClientStation

Client station runtime objectsStation Runtime Objects

Dataset

Module Dataset runtime objectsRuntime Objects

Device

Module Alarm runtime objectsRuntime Objects

Display

Module Display runtime objectsRuntime Objects

Historian

Module Historian runtime objectsRuntime Objects

Info

Module Info runtime objectsRuntime Objects

Report

Module Report runtime objectsRuntime Objects

Script

Module Script runtime objectsRuntime Objects

Security

Module Security runtime objectsRuntime Objects

ServerStation

Server station runtime objectsRuntime Objects

ToolkitToolkit classes

Toolkit Classes

The top-level hierarchy is implemented as .NET Namespacesnamespaces. Each Namespace has namespace includes .NET classes and objects that are created when building projects. These objects have runtime properties, methods, statuses, and configuration settings. 

For instance, the Tag namespace contains every tag that is in within an application, and each tag has built-in field properties, such as Quality, TimeStampTimestamp, Min, Max, Units, etc.

Examples:

Tag.tagname1.bit0, tag.tagname2.timestamp

The same concept of tag fields applies to all namespaces, for instance:

Alarm.TotalCount

Alarm.Group.Warning.Disable

Our platform has features IntelliSense auto-completion for when you build a project, fill building projects, filling in input fields, or create and creating scripts. This functionality guides you to any existing properties that are allowed for the object you are editing and allows enables you to easily "drill down" to a specific property. 

When accessing a project's object in the .NET Script Editor, it is necessary to you must prefix the namespace with an at "@" symbol in order to avoid conflict conflicts with the names of the .NET local variables.

Examples:

In Script → Tasks and CodeBehind, use:

Code Block
languagetext
@Device.Node.Node1.Status


The at "@" symbol is not necessary on Grids and Dialogs. Some input fields may require objects of only one type, such as Tag or Display. For these, IntelliSense will automatically guide you to the required objects. 

These concepts may seem abstract for users that do not have experience in .NET or similar object-oriented systems. However, the power of these concepts will become clearer when users learn the engineering configuration tools and the FactoryStudio modules. When users get used to working with object models and Intellisense, they realize that there is a huge increase in productivity so they no longer want to work with systems that lack these features.

You can see the available Namespaces on the platform here.



In this section...

Page Treeroot@parentspacesV10What's Next?