T4EA  AIG_19.2 C8891 A24697
Teamcenter Gateway for Enterprise Applications API Reference
PIPELINE Namespace Reference

Namespaces

 PIPELINE_CLASS
 
 PIPELINE_RUN_SUMMARY_CLASS
 

Classes

class  PIPELINE_CLASS
 
class  PIPELINE_RUN_SUMMARY_CLASS
 

Functions

 create name
 This procedure creates a pipeline object and stores it into the pipeline container. More...
 
 createMonitor
 
 delete name
 This procedure destroys an existing pipeline object and deletes it from the pipeline container. More...
 
 exists name
 This procedure checks whether a pipeline exists. More...
 
 get name
 This procedure retrieves an existing pipeline object from cache. More...
 
 getAll
 This procedure returns the names of all existing pipelines. More...
 

Function Documentation

◆ create()

PIPELINE::create   name  

This procedure creates a pipeline object and stores it into the pipeline container.

Parameters
nameName of the pipeline
Warning
The given name must be unique. Neither an existing pipeline nor a predefined TCL command nor may have the same name. Otherwise an error will be thrown!
Returns
New instance of PIPELINE::PIPELINE_CLASS

◆ createMonitor()

PIPELINE::createMonitor

◆ delete()

PIPELINE::delete   name  

This procedure destroys an existing pipeline object and deletes it from the pipeline container.

Parameters
nameName of the pipeline
Warning
The target pipeline must exist. Otherwise an error will be thrown!

◆ exists()

PIPELINE::exists   name  

This procedure checks whether a pipeline exists.

Parameters
nameName of the pipeline
Returns
1 if exists. Otherwise 0

◆ get()

PIPELINE::get   name  

This procedure retrieves an existing pipeline object from cache.

Parameters
nameName of the pipeline
Warning
The pipeline must exist in cache. Otherwise an error will be thrown!
Returns
the requested pipeline object

◆ getAll()

PIPELINE::getAll

This procedure returns the names of all existing pipelines.

Warning
The pipeline name is not the pipeline object
Returns
names of pipelines