Skip to content
This repository has been archived by the owner on Jun 22, 2019. It is now read-only.

T_CAEX_ClassModel_CAEXPathBuilder

AutomationML edited this page Feb 23, 2017 · 2 revisions

CAEXPathBuilder Class

The Class PathSeparator contains Path Analysis and Path Building Methods as they are defined in chapter 2.8 of the CAEX Guide

Inheritance Hierarchy

System.Object
  CAEX_ClassModel.CAEXPathBuilder
Namespace: CAEX_ClassModel
Assembly: AMLEngine (in AMLEngine.dll) Version: 3.5

Syntax

C#

public static class CAEXPathBuilder

C++

public ref class CAEXPathBuilder abstract sealed

The CAEXPathBuilder type exposes the following members.

Methods

 

Name Description
Public methodStatic member AliasFromReference gets the Alias Name from a reference. If the Reference is not a reference with an alias, the return value is string.Empty.
Public methodStatic member CAEXPath(IEnumerable(XmlElement)) Builds the Reference-Path which includes all Names of CAEXObjects in the given list of elements.
Public methodStatic member CAEXPath(IEnumerable(CAEXObject)) Builds the Reference-Path which includes all Names of CAEXObjects in the given list of elements
Public methodStatic member InternalLinkReferencePath Builds the reference Path for an Interface-Reference in an InternalLink
Public methodStatic member IsObjectReferenceWithAlias Determines whether the specified AutomationML class path is
Public methodStatic member IsReferenceWithAlias Determines whether the specified reference is defined with an alias separator.
Public methodStatic member PathPart Builds the Path Part for any CAEXObject, which may be part of a CAEX Path. The Path Part is build from the object Names and the Part - Syntax, according to chapter 2.8 of the CAEX guide: If defined separators are potentially a valid part of object names, the following syntax shall be used: all path elements shall be separated by square brackets “[“ name “]”. This allows for using the original names and the defined separators at the same time. If the conflict case arises that the described brackets are part of object names, the brackets in the object name shall be escaped by means of common XML escape-sequences. If a name contains any Path part - Separator like '[' or ]' this character will be escaped with ''.
Public methodStatic member PathPartObjectNames Returns the Path Part object names of a caex Path. If any object name contains a path separator character the path part is enclosed in square brackets '[', ']'. The square brackets are removed from the object name in the returned result (default behavior). If keepPathPartBrackets is set to true, square brackets are not removed.
Public methodStatic member PathPartObjectNamesWithSeparator Returns the Path Part object names of a caex Path with the Separator Char at the Names End
Public methodStatic member PathPartSeparator(XmlNode) Returns th Path part separator for an element, which should be put before that element in a Path
Public methodStatic member PathPartSeparator(CAEXObject) Returns th Path part separator for an element, which should be put before that element in a Path
  Back to Top

Fields

 

Name Description
Public fieldStatic member AliasSeparator The alias separator used after Alias
Public fieldStatic member AttributeSeparator The attribute separator used before attribute hierarchies
Public fieldStatic member InterfaceSeparator The interface separator used before an interface
Public fieldStatic member ObjectSeparator The object separator used between object hierarchies
Public fieldStatic member PathPartBegin The begin of a path part, used if the object name contains a Path Separator
Public fieldStatic member PathPartBeginInName The escaped PathPartBegin, used in an object name, if it contains this character
Public fieldStatic member PathPartEnd The end of a path part, used if the object name contains a Path Separator
Public fieldStatic member PathPartEndInName The escaped PathPartEnd, used in an object name, if it contains this character
  Back to Top

See Also

Reference

CAEX_ClassModel Namespace

  • Introduction
  • [Version History](Version history)
    • [Version 3.5](Version 3.4)
    • [Version 3.1](Version 3.0)
    • [Version 2.1](Version 2.1)
    • [Version 2.0](Version 2.0)
  • [Getting Started](Getting started)
  • Examples
  • AMLEngine API
BEST Practice Content

Extensions

CAEX Elements

AutomationML

Utilities

Interfaceclasses

Exceptions

Objecttables and Document validation

Clone this wiki locally