 | CAEXPath |
Static class supporting the generation and analysis of CAEXPath's
Inheritance HierarchyNamespace: Aml.Engine.CAEX.Extensions
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
SyntaxThe CAEXPathBuilder type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AliasFromReference | Gets the alias name from a reference. If the reference is not a reference with an alias, the return value is string.Empty. |
| CAEXPath(IEnumerableCAEXObject) | Builds the Reference-Path which includes all Names of CAEXObjects in the given list of CAEX objects. |
| CAEXPath(IEnumerableXElement) | Builds the Reference-Path which includes all Names of CAEXObjects in the given list of elements. |
| CAEXPath(String, CAEXDocumentCAEXSchema) | Builds the Reference-Path which includes all names of CAEX objects in the given name array. |
| CanNormalize | Determines whether the specified path can be normalized because it contains path part delimiters |
| ChangeAlias | Changes the alias name in a path reference |
| ChangePathStart | Changes the first occurrence of the provided oldPathStart to the newPathStart |
| ContainsPathSeparatorChars | Determines whether the specified name contains path separator chars. |
| ExternalInterfaceIDInAttributeReference | Check, if the provided reference is a reference to an attribute of an ExternalInterface, using the ID of an ExternalInterface. |
| InstanceIDInAttributeReference | Gets the ID of the master parent instance from a reference defined in an Attribute mirror object in the specified CAEX document. |
| InternalElementIDInInternalLinkReference | Gets the InternalElement ID from a reference defined in an InternalLink object. |
| InternalLinkReferencePath(SystemUnitClassType, InterfaceClassType) | Builds the reference Path for an Interface-Reference in an InternalLink |
| InternalLinkReferencePath(XElement, XElement) | gets the reference path for an Interface-Reference in an InternalLink |
| IsAlias | Determines whether the specified part of a path is an alias. |
| IsAttributeReference | Determines, if the path is an Attribute reference. This method is able to distinguish if an UUID is combined with a CAEX path |
| IsIDReferenceWithAlias | Determines whether the specified object reference is an alias reference to an ID in the specified document |
| IsInterfaceReference | Determines, if the path is build using an interface separator. This method is able to distinguish if an interface separator char is used in an interface name and is escaped |
| IsObjectReferenceWithAlias | Determines whether the specified classReference is an alias reference to the provided AutomationML class path. |
| IsReferenceWithAlias | Determines whether the specified reference is defined with an alias separator. |
| IsValidAttributeReferenceID | Determines whether the ID is valid to be used in an attribute mirror reference. |
| IsValidID | Determines whether the specified string can represent an ID |
| NormalizePath | Normalization of a CAEXPath. A normalized path is freed of all path part delimiters '[' and ']' in case that there is no path part name containing a path separator character like '/'. |
| PathNameArray | 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 behaviour). If keepPathPartBrackets is set to true, square brackets are not removed. |
| PathNameArrayWithSeparator | Returns the Path Part object names of a CAEX Path with the Separator Char at the Names End as an array of strings. |
| PathNameListWithSeparator | Returns the Path Part object names of a CAEX Path with the Separator Char at the Names End as an array of strings. |
| PathPart(CAEXObject, Boolean) | 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 '\'. |
| PathPart(XElement, Boolean) | transforms the name of the defined element to a path Part (special characters are escaped). |
| PathPartName | Transforms a name to a path Part (special characters are escaped). |
| 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 behaviour). If keepPathPartBrackets is set to true, square brackets are not removed. |
| PathPartObjectNamesWithSeparator | Returns the Path Part object names of a CAEX Path with the Separator Char at the Names End |
| PathPartSeparator(CAEXObject) | Returns the Path part separator for an element, which should be put before that element in a Path |
| PathPartSeparator(XElement) | Returns the Path part separator for an element, which should be put before that element in a Path |
| RemoveAlias | Removes the alias from the provided path if the path is IsReferenceWithAlias(String, CAEXDocumentCAEXSchema). |
| SeparatorChars | Gets the defined Separator characters according to the provided schema version. |
Fields| Name | Description | |
|---|---|---|
 | AliasSeparator | The alias separator used after Alias |
| AttributeSeparator | The attribute separator used before attribute hierarchies. |
| InterfaceSeparator | The interface separator used before an interface |
| ObjectSeparator | The object separator used between object hierarchies |
| PathPartBegin | The begin of a path part, used if the object name contains a Path Separator |
| PathPartBeginInName | The escaped PathPartBegin, used in an object name, if it contains this character |
| PathPartEnd | The end of a path part, used if the object name contains a Path Separator |
| PathPartEndInName | The escaped PathPartEnd, used in an object name, if it contains this character |
See Also