Index
All Classes and Interfaces|All Packages
A
- AbsolutePathBuilder - Class in research.ch.cern.unicos.utilities
-
Class to build absolute paths from the UnicosApplication.xml parameters.
If the parameter contains to a relative path, the class will build the absolute path using the path of the UnicosApplication.xml file. - AbsolutePathBuilder() - Constructor for class research.ch.cern.unicos.utilities.AbsolutePathBuilder
- addSpecChange(ISpecChange) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Add a new change to the specs.
C
- computeAddress(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.ISCADAPlugin
-
Get the address of a device element (e.g.
- ConvertToString - Class in research.ch.cern.unicos.utilities
-
Utility class to get a String from different sources
- createSectionText(List<IDeviceInstance>, int, int, int, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to generate text for a program/section.
- createSectionText(List<IDeviceInstance>, int, int, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to generate text for a program/section.
D
- Dcount(String, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Count the number of elements found by the
ISpecFileTemplate.Dlookup(String, String, String)method.
Iterates through all the instances of the device type specified. - DependentLoop(String, String, int, int, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Create a String vector with the 'textRepeated' for each device instance matching the specified conditions.
- DependentLoop(String, String, int, int, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Create a String vector with the 'textRepeated' for each device instance matching the specified conditions.
- DependentLoopString(String, String, int, int, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
- DependentLoopString(String, String, int, int, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Similar to
ISpecFileTemplate.DependentLoop(String, String, int, int, String, String)
This method returns only one String where the different lines are separated by end-of-line char ("\n"). - Dlookup(String, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Dependent look up method.
- DlookupString(String, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Dependent look up String method.
- doesSpecificationAttributeExist(String) - Method in interface research.ch.cern.unicos.utilities.IDeviceInstanceTemplate
-
Check if an specification attribute exists.
- doesSpecificationAttributeExist(String) - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Check if an specification attribute exists.
F
- findAllDescendingInstances(String, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to get all the descendant instances of a specified device type with a specified master object, where the specified condition is true.
- findInstanceByName(String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Find a device instance by name.
- findInstanceByName(String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Find a device instance by name.
- findInstanceByNameIgnoreCase(String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Find a device instance by name, case insensitive.
- findInstanceByNameOrExpertName(String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Find a device instance by name or expert name.
- findMatchingInstances(String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to get all the instances of the specified device type(s) where the specified condition is true.
- findMatchingInstances(String, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to get all the instances of an specified device type with an specified master object, where the specified condition is true.
- findMatchingInstances(String, String, String, List<Integer>) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This method is used to get all the instances of an specified device type with an specified master object, where the specified condition is true.
- formatNumberPLC(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Method used to get the correct number format for the PLC.
G
- GenericDepLoop(String, String, String, int, int, int, String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
This function detects link between an object name in another object table (targetDevice) in a particular field (LinkedField).
If a link is detected then it will replace in the string FTextWithLink the fields between # with the correspondent value in the target device and returns the string to the function.
If several links are found, there are three different options: optionDuplicate=0 then it will concatenate the several strings; optionDuplicate=1 then it will keep the first replaced string; optionDuplicate=2 then it will keep the last replaced string; If no link is detected then, it will return the string FTextNoLink. - get_instances_FI(String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
Function for getting the Fast Interlock HashSet of objects of the DeviceType specified
- getAbsolutePath(String) - Static method in class research.ch.cern.unicos.utilities.AbsolutePathBuilder
-
Build an absolute path from the relative path provided as parameter.
- getAllDeviceTypeInstances() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Method used to get a vector containing all the instances of the device type.
- getAllDeviceTypes() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get all the device types available in the specs file.
- getAllDeviceTypesString() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get a String containing all the device type names separated by the character ','.
- getAllowedValues(String, String, IDeviceTypeFactory) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Return the array of allowed values for determined device type attribute.
- getApplicationName() - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Get the application name from the UnicosApplication.
- getApplicationName() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the application name.
- getApplicationPathParameter(String) - Static method in class research.ch.cern.unicos.utilities.AbsolutePathBuilder
-
Method used to get the absolute path of a UnicosApplication.xml application PathParameter.
- getAttributeData(String) - Method in interface research.ch.cern.unicos.utilities.IDeviceInstanceTemplate
-
Returns the data associated with the instance attribute.
- getComments() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the change comments.
- getDate() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the date when the change was made.
- getDescription() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Get the device type description as specified in the device type sheet.
- getDeviceType() - Method in interface research.ch.cern.unicos.utilities.IDeviceInstanceTemplate
-
Method used to get the device type of the current instance.
- getDeviceType(String) - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get a device type from the specs file.
- getDeviceTypeInstance(int) - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Method used to get a device type instance by its instance number.
- getDeviceTypeName() - Method in interface research.ch.cern.unicos.utilities.IDeviceInstanceTemplate
-
Method used to get the device type name of the current instance.
- getDeviceTypeName() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Method used to get the device type name.
- getFaqLink() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the FAQ URL.
- getHtmlLabel() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the Jira ticket ID.
- getHtmlLink() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the Jira link.
- getInstanceNumber() - Method in interface research.ch.cern.unicos.utilities.IDeviceInstanceTemplate
-
Get the number of the current instance as defined in the specifications file.
- getLinkedExpertName(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Function.
- getObjectDescriptionsLink() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the object descriptions URL.
- getObjectType() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Method used to get the ObjectTypeFamily from the device type definition.
- getPackageName() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Method used to get the name of the package which the device belongs to (CPC, CRYO, ...).
- getPlcManufacturer() - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Get the PLC manufacturer from the PLC declarations
- getPLCMemoryMapper() - Method in interface research.ch.cern.unicos.cpc.interfaces.ISCADAPlugin
-
Get the PLC memory mapper instance.
- getPlcName() - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Get the PLC name as defined in the UnicosApplication.xml
- getProjectDescription() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the project description.
- getProjectDocumentation() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get the project documentation data from the specs file.
- getProjectName() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the project name.
- getProjectOwner() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the project owner alias.
- getResourceAddress(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.ISCADAPlugin
-
For Siemens only: get the DB number for a given resource name.
- getResourcesName() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get the name of the resources package used to build the specs file.
- getResourcesVersion() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Get the version of the resources package used to build the specs file.
- getSpecChanges() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the list of changes in the specs.
- getSpecificationAttributes() - Method in interface research.ch.cern.unicos.utilities.IDeviceTypeTemplate
-
Get the list of specification attributes (e.g.: DeviceIdentification:Name, DeviceIdentification:Expert Name, ...)
- getSpecsPath() - Method in interface research.ch.cern.unicos.utilities.ISpecFileTemplate
-
Return the path to the specs file.
- getSpecsVersion() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Get the specs version.
- getString(File) - Static method in class research.ch.cern.unicos.utilities.ConvertToString
-
Get the content of a File as a String.
- getString(InputStream) - Static method in class research.ch.cern.unicos.utilities.ConvertToString
-
Get the content of an InputStream as a String.
- getString(String) - Static method in class research.ch.cern.unicos.utilities.ConvertToString
-
Get the content of a file as a String.
- getTargetDeviceInformationParam(String, String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
Get the value of an attribute defined in the TargetDeviceInformation family from the Device type definition.
- getTechnicalPathParameter(String) - Static method in class research.ch.cern.unicos.utilities.AbsolutePathBuilder
-
Method used to get the absolute path of a UnicosApplication.xml technical PathParameter.
- getTechnicalPathParameter(String, String...) - Static method in class research.ch.cern.unicos.utilities.AbsolutePathBuilder
-
Method used to get the absolute concatenated path of UnicosApplication.xml technical PathParameters.
- getUnicosProject() - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Provide access to the root of the input XML data (specs file instance)
- getUser() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the alias of the user who made the change.
- getVersion() - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Get the specs version after the change.
I
- IDeviceInstanceTemplate - Interface in research.ch.cern.unicos.utilities
-
Interface used to handle the device type instances available in the specifications file.
- IDeviceTypeTemplate - Interface in research.ch.cern.unicos.utilities
-
Interface used to handle the device types available in the specifications file.
- IGenerationPluginTemplate - Interface in research.ch.cern.unicos.plugins.interfaces
-
This interface provides the common methods used in the Jython templates to interact with the generation plug-ins.
- ILogWriterTemplate - Interface in research.ch.cern.unicos.plugins.interfaces
-
Interface containing the methods that can be used from the Jython templates to write in the user report window.
- initialize() - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
Initialize the value of the internal member
isLargeApplication. - IS7SymbolTemplate - Interface in research.ch.cern.unicos.cpc.interfaces
-
Interface to provide methods to access the Step 7 symbols.
- ISCADAPlugin - Interface in research.ch.cern.unicos.cpc.interfaces
-
Interface to be implemented by all the CPC SCADA plug-ins.
- isFastInterlock(IDeviceInstance) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
Function for checkin if a particular instance is fast interlock
- isLargeApplication() - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
Get the value of the class member isLargeApplication @see
initialize() - ISpecChange - Interface in research.ch.cern.unicos.utilities
-
Interface to read/write the specs change data.
- ISpecDocumentation - Interface in research.ch.cern.unicos.utilities
-
Interface to read/write from the Specs' ProjectDocumentation sheet.
- ISpecFileTemplate - Interface in research.ch.cern.unicos.utilities
-
Interface used to get data from the specifications file.
- isString(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Method used from the templates to know if the specified parameter is a String or a Float
- IUnityLogicTemplateFunctions - Interface in research.ch.cern.unicos.cpc.interfaces
-
Interface containing the methods that can be used in the user logic templates for the UnityLogicGenerator.
N
- newSpecChange() - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Create a new specs change.
R
- research.ch.cern.unicos.cpc.interfaces - package research.ch.cern.unicos.cpc.interfaces
- research.ch.cern.unicos.cpc.utilities.siemens - package research.ch.cern.unicos.cpc.utilities.siemens
- research.ch.cern.unicos.plugins.interfaces - package research.ch.cern.unicos.plugins.interfaces
- research.ch.cern.unicos.utilities - package research.ch.cern.unicos.utilities
S
- s7db_id(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.IS7SymbolTemplate
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, boolean) - Method in interface research.ch.cern.unicos.cpc.interfaces.IS7SymbolTemplate
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, boolean) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, String) - Method in interface research.ch.cern.unicos.cpc.interfaces.IS7SymbolTemplate
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, String, boolean) - Method in interface research.ch.cern.unicos.cpc.interfaces.IS7SymbolTemplate
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(String, String, boolean) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IDeviceInstance, boolean) - Method in interface research.ch.cern.unicos.cpc.interfaces.IS7SymbolTemplate
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IDeviceInstance, boolean) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IInstancesFacade, String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IInstancesFacade, String, boolean) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IInstancesFacade, String, String) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- s7db_id(IInstancesFacade, String, String, boolean) - Static method in class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
-
This function provides the symbol name of the DB for a given instance name (e.g.
- S7Functions - Class in research.ch.cern.unicos.cpc.utilities.siemens
-
Class containing functions for Siemens Step 7
- S7Functions() - Constructor for class research.ch.cern.unicos.cpc.utilities.siemens.S7Functions
- setApplicationName(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set the application name.
- setComments(String) - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Set the change comments.
- setCoreManager(CoreManager) - Method in class research.ch.cern.unicos.utilities.AbsolutePathBuilder
- setDate(String) - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Set the date of the change.
- setFaqLink(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set FAQ URL
- setHtmlLink(String, String) - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Set the Jira link.
- setObjectDescriptionsLink(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set object descriptions URL.
- setProjectDescription(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set the project description.
- setProjectName(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set the project name.
- setProjectOwner(String) - Method in interface research.ch.cern.unicos.utilities.ISpecDocumentation
-
Set the project owner alias.
- setUser(String) - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Set the alias of the user who made the change.
- setVersion(String) - Method in interface research.ch.cern.unicos.utilities.ISpecChange
-
Set the specs version after the change.
W
- writeConfigInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Write a CONFIG message in UAB Log window.
- writeDebugInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Write a DEBUG message in UAB Log window.
- writeErrorInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Write a SEVERE message in UAB Log window.
- writeErrorWithStackTrace(String, Throwable) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Used to write an ERROR message in UAB Log window and the stack trace that caused the error.
- writeFile(String, String) - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Write a file in the plug-in output folder.
- writeFineInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Write a FINE message in UAB Log window.
- writeInfoInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Used to write an INFO message in UAB Log window.
- writeInstanceInfo(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.ISCADAPlugin
-
Used to write an instance declaration in the WinCC O.A.
- writeInUABLog(Level, String, UserReportGenerator.type) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Used to write a message in UAB Log window
- writeProgram(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.IUnityLogicTemplateFunctions
-
Used to write a part of the user logic application.
- writeVariable(String) - Method in interface research.ch.cern.unicos.cpc.interfaces.IUnityLogicTemplateFunctions
-
Used to write a variable in the dedicated buffer.
- writeWarningInUABLog(String) - Method in interface research.ch.cern.unicos.plugins.interfaces.ILogWriterTemplate
-
Used to write a WARNING message in UAB Log window.
- writeXmlFile(String, String) - Method in interface research.ch.cern.unicos.plugins.interfaces.IGenerationPluginTemplate
-
Write an XML file in the plug-in output folder.
All Classes and Interfaces|All Packages