Documentation

Application

Table of Contents

Interfaces

DatabaseInterface

HttpResponseFactoryInterface

CostingInterface

Classes that implement this Interface can participate in material flow detection with greater depth

MaterialAwareInterface

Classes that implement this Interface can participate in material flow detection with greater depth

StorageInterface

ProfileApiServiceInterface

Classes

AbstractDatabase

A basic wrapper around php's PDO class.

DatabaseConnectionManager

A class to manage database connections as true singletons across the application.

MySQL

A MySQL Data Object

PgSQL

A Postgres Data Object

BaseProfileResponse

BaseNode

DataType

ObjectNode

ObjectType

Property

OPC UA defines Properties as a special kind of Variable (see Part 3, Section 5.6.3) used to provide metadata about other nodes. Properties are implemented as Variables with additional usage restrictions, such as typically being read-only and having unique BrowseNames within their parent context.

Variable

VariableType

ProfileImporterResponse

SmartCloudLibraryResponse

CloudProviderException

Base Exception for TiqUtilities package

PhpSpreadsheetException

ZipArchiveException

BaseApiServiceFactory

CESMIIApiFactory

OPCApiFactory

THINKIQApiFactory

CESMIIResponseFactory

OPCResponseFactory

THINKIQResponseFactory

CESMIIResponseFactory

OPCResponseFactory

THINKIQResponseFactory

GraphQL

Class for Making, and Authenticating GraphQL requests

Guid

ArrayHelper

DatabaseHelpers

Useful functions for dealing with Database data

Map

Set

MaterialLedgerHelpers

Useful functions for dealing with the Material Ledger

NodePathHelper

Class NodePathHelper

HtmlDropdown

Class that can create an html dropdown for choice/value selection

Logger

This is a Singleton implementation of a Monolog\Logger. This will log to all the 'correct' places for the application, without having to always set up same Handlers.

CostingEvent

This Class is meant to be a permanent representation of the type Generic Object -> Costing. It is used in the Material Flow Detection

LedgerEntry

LedgerEntries are the fundamental unit of the Material Ledger.

Propagation

This class is used to propagate Event Object and Material Attribute data between accounts.

Trace

Transaction

Transactions are used to bind LedgerEntries together and form a movement from one account into another.

Account

Accounts are attached to places, areas, and equipment in the model to indicate that this is where material movements will be tracked

Attribute

Attributes store data that can changes over time, or static data that stays the same. Attributes are similar to what developers call Properties.

Connector

Connectors connect to local data sources and stream the data to a Gateway. These are the first step in how data is injected into the ThinkIQ platform

EnumerationType

Enumeration Types are used to translate codes (digits usually) into meaningful words/descriptions

Equipment

Equipment are a base type in the model.

EquipmentType

Class Equipment Type.

Gateway

Gateways can have 1 or more connectors below them and have the job of sending data to the ThinkIQ platform

GenericObject

Class GenericObject.

Library

Libraries are collections of types, enumeration types, scripts, measurement units and more.

Limit

Limits add HiHi, Hi, Target, Lo, and LoLo threshold to an attribute

MeasurementUnit

The Measurement Unit class allows unit conversion between units of the same quantity kinds

Node

Class Node is the base for all equipment, attributes, and more

NodesWithTags

Class NodeWithTags extends Nodes and is used for nodes that can contain tags, i.e. Gateway, Connector, OpcuaObject

NotificationType

Class NotificationType.

OpcGroup

Class OpcuaObject.

OpcuaObject

Class OpcuaObject.

Organization

Class Organization is a base type in the Model

Place

Class Place is a base type in the ThinkIQ model.

QuantityKind

Quantity Kinds are the base types of Measurement Units.

Relationship

Relationships are between two Nodes, nodes may have many relationships between them.

RelationshipType

Class RelationshipType.

Script

Scripts can be attached to types or instances, used for displaying reports, calculating KPI's, and more

SystemNodeType

These are base types of the system, not the base types within the model.

Tag

Tags are a data source which come directly from the factory floor.

Type

The Model has to main parts, Instances and Types. Types give shape to instances and are used to organize data into usable, repeatable forms

TypeToAttributeType

Class TypeToAttributeType.

TypeToChildType

Class TypeToChildType.

GcpProvider

S3Provider

StorageFacade

AlertLogger

ApiService

GuzzleClientFactory

OPCWebApiService

BaseProfileApiService

NodesetProjectService

OPCApiService

AbstractProfileProcessor

ProfileExportProcessor

ProfileImportProcessor

CsvService

PhpSpreadsheetService

TimeSeriesCsvService

Counters

A set of methods that take a ValueStream and perform different types of totalizations.

Filters

TimeSeries

Fetches and manipulates time series data

TiqBase

Base Abstract Tiq Class

TiqHelper

Traits

DatabaseTrait

This trait attaches a Database singleton to the user of the Trait. The key method is ::getDb() which returns a database object

ActiveRecordTrait

Gives an object the ability to act as a proxy for a record in the database.

ApiServiceTrait

EventObjectTrait

VisionTrait

Enums

AlertType

OpcType

Constants

_JEXEC  = 1

JPATH_BASE  = $_SERVER['DOCUMENT_ROOT']