Documentation

NodesetProjectService
in package
uses ApiServiceTrait

Table of Contents

Properties

$apiService  : BaseApiServiceFactory
$cloudLibrary  : string
$opcWebApiService  : OPCWebApiService
$projectId  : string
$projectNodesets  : array<string|int, mixed>

Methods

__construct()  : mixed
NodesetProjectService constructor.
addNodeSetToProject()  : void
Add nodeset to project
downloadInfoModel()  : array<string|int, mixed>|string
Download the infomodel
getInfomodelNamespaces()  : array<string|int, mixed>|string
Get the infomodel namespaces
getInfoModels()  : array<string|int, mixed>|string
Get the infomodels from the API service
getProjectId()  : string
Get the project ID
getProjectNodesets()  : array<string|int, mixed>
Get the project nodesets
loadUaNodes()  : array<string|int, mixed>
Creates a dictionary of UA nodes from the given project name space keys and project ID
processNodesetIntoProject()  : void
Process nodeset into project
uploadInfomodel()  : int
Upload an infomodel to the API service

Properties

$projectId

private string $projectId
  • This is the unique identifier for the project. It is used to manage and reference the project within the OPC Web API.

$projectNodesets

private array<string|int, mixed> $projectNodesets = ['project_name_spaces' => [], 'project_name_space_keys' => []]

  • This array holds the nodesets for the project. It contains two keys:

  • 'project_name_spaces': An array of namespace URIs for the nodesets in the project.

  • 'project_name_space_keys': An array of keys corresponding to the namespaces in the project.

Methods

addNodeSetToProject()

Add nodeset to project

public addNodeSetToProject(array<string|int, mixed> $nodeset, array<string|int, mixed> $localNamespaces, array<string|int, mixed> $localNodesetFileNames) : void
Parameters
$nodeset : array<string|int, mixed>
  • The nodeset
$localNamespaces : array<string|int, mixed>
  • The local namespaces
$localNodesetFileNames : array<string|int, mixed>
  • The local nodeset file names

downloadInfoModel()

Download the infomodel

public downloadInfoModel(ApiServiceFactory $apiService, int $nodesetId[, bool $nodesetXMLOnly = false ][, bool $metadataOnly = false ]) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
$nodesetId : int
  • The nodeset ID
$nodesetXMLOnly : bool = false
  • Whether to download only the nodeset XML
$metadataOnly : bool = false
Return values
array<string|int, mixed>|string —
  • The response from the request

getInfomodelNamespaces()

Get the infomodel namespaces

public getInfomodelNamespaces(ApiServiceFactory $apiService) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
Return values
array<string|int, mixed>|string —
  • The infomodel namespaces

getInfoModels()

Get the infomodels from the API service

public getInfoModels(ApiServiceFactory $apiService) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
Return values
array<string|int, mixed>|string

getProjectNodesets()

Get the project nodesets

public getProjectNodesets() : array<string|int, mixed>
Return values
array<string|int, mixed>

loadUaNodes()

Creates a dictionary of UA nodes from the given project name space keys and project ID

public loadUaNodes(array<string|int, mixed> $projectNameSpaceKeys, string $projectId, OPCWebApiService $OPCWebApiService, OpcType $projectTypes) : array<string|int, mixed>
Parameters
$projectNameSpaceKeys : array<string|int, mixed>
  • The project name space keys
$projectId : string
  • The project ID
$OPCWebApiService : OPCWebApiService
  • The OPC Web API service
$projectTypes : OpcType
  • The project types
Return values
array<string|int, mixed> —

$results - The results of the loaded nodes

processNodesetIntoProject()

Process nodeset into project

public processNodesetIntoProject(array<string|int, mixed> $infoModel) : void
Parameters
$infoModel : array<string|int, mixed>
  • The info model containing nodeset information
Tags
throws
Exception

uploadInfomodel()

Upload an infomodel to the API service

public uploadInfomodel(ApiServiceFactory $apiService, array<string|int, mixed> $body[, bool $overwrite = false ]) : int
Parameters
$apiService : ApiServiceFactory
  • The API service
$body : array<string|int, mixed>
  • The body of the request containing the infomodel data
$overwrite : bool = false
  • Whether to overwrite an existing infomodel with the same name
Return values
int —
  • The ID of the uploaded infomodel

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results