Objects and Namespaces

Introduction to Objects and Namespaces

Accessing Objects Directly in Your Solution

In most other systems, custom logic using the status of the modules or extending properties for tags requires the use of APIs and some programming.

However, our platform allows your application to directly access all the objects you created and their properties, using .NET class extensions without any configuration or programming required.

For example, if you create an Alarm Group named ProductionAlerts, it is immediately available to the solution as the property Alarm.Group.ProductionAlerts.TotalCount, which holds the number of active alarms within that group.

Another example: if you need to find the day of the year for a DateTime value, you can use the .NET class directly in the extension for the solution tags, like in Tag.StartDateTime.Value.DayOfYear.

The DayOfYear property wasn't created or programmed by our software platform, but since our tags are .NET objects, their values can naturally utilize all the .NET functionality right away.

Not only are tags .NET objects, but everything created with the solution, including alarms and database connections, are all .NET objects extending the feature.

Modules Namespaces

The platform namespaces are organized following exactly the names and organization of the Designer configuration tools. Those are the op-level objects that correspond to the main modules in the platform:

The top-level hierarchy is implemented as .NET namespaces. Each 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 within an application, and each tag has built-in field properties, such as Quality, Timestamp, 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 features IntelliSense auto-completion for building projects, filling in input fields, and creating scripts. This functionality guides you to any existing properties allowed for the object you are editing and enables you to easily "drill down" to a specific property.

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

Examples:

In Script → Tasks and CodeBehind, you can use:

@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 platform's 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.

Namespaces API Reference

For each module, examples of the properties or methods used by that module may have been already presented, at the section "Runtime Attributes" for that module.

The complete reference of Namespaces, Classes and its Methods and properties, in a documentation environment that follows the typical organization for programming API.

Follow the link to the Namespace API, to access the complete organization of the system objects.

In this section...