CLASS PUBLIC MyClass
+{S7.extern=ReadWrite}
+CLASS PUBLIC MyClass
VAR PUBLIC
{#ix-attr:[CompilerOmits()]}
MyStringIgnoredForAllOutputs : STRING;
@@ -160,6 +162,17 @@ CompilerOmits attribute
END_VAR
END_CLASS
Ignoring Communication with the Controller for POCO Operations
+To minimize the communication overhead between the application and the controller during POCO operations, you can annotate specific members of a type to bypass data exchange. This attribute should be applied when the compiler omits the compilation of particular members in the POCO object.
+{S7.extern=ReadWrite}
+CLASS PUBLIC MyClass
+ VAR PUBLIC
+ {#ix-attr:[CompilerOmits("POCO")]}
+ {#ix-attr:[IgnoreOnPocoOperation()]}
+ MyStringIgnoredInPocos : STRING;
+ END_VAR
+END_CLASS
+Generic extension attributes
ixc allows to declare generic attributes in ST that will add a genetic notation to transpiled types.
The use of generics is an advanced scenario aimed at simplifying some tasks where templating is needed.
diff --git a/docs/articles/compiler/README.html b/docs/articles/compiler/README.html
index 338f088c..e2d4b011 100644
--- a/docs/articles/compiler/README.html
+++ b/docs/articles/compiler/README.html
@@ -80,10 +80,14 @@
AXSharp Compiler
AXSharp Compiler (ixc) translates PLC data structures into C# (PLC .NET Twin), which makes the PLC data available in a structured way for any .NET application.
+Adding types and members to the communication over WebAPI
+Starting from the version v2.0.0+ of sld, to make member or type accessible over the communication there is a need to add pragma {S7.extern=ReadWrite} or {S7.extern=ReadOnly} in the appropriate place in the code.
+For details see here
Write PLC code
{#ix-attr:[Container(Layout.Stack)]}
{#ix-attr:[Group(Layout.GroupBox)]}
{#ix-set:AttributeName = "Location"}
+{S7.extern=ReadWrite}
CLASS GeoLocation
VAR PUBLIC
{#ix-set:AttributeName = "Latitude [°]"}
@@ -145,15 +149,15 @@ Use in any .NET application
Config file Packaging and dependency management AXSharp compiles transpiles following project blocks:
+AXSharp compiles transpiles the following project blocks:
diff --git a/docs/articles/connectors/README.html b/docs/articles/connectors/README.html
index b17dca91..c486624a 100644
--- a/docs/articles/connectors/README.html
+++ b/docs/articles/connectors/README.html
@@ -321,6 +321,15 @@ Localizable string
Example
ix_plc.PlcTranslator.Instance.SetLocalizationResource(typeof(myproject.ResourcesOverride.OverridePlcStringResources));
Localization in a client in server-side application
+In order to get translation in given culture for a client in a server side application you should use methods Get{ProperyName}(CultureInfo culture) to get translation for client current culture. The properties will returned original string where localization tokens are removed.
+var notTranlsated = obj.AttributeName;
+var translated = obj.GetAttribute(new CultureInfo("sk-SK"));
+Setting connector's culture
+In some instances it might be necessary to set the culture for the threads handling connectors. In that case use the following method to impose a specific culture.
+AXSharp.Connector.Connector.SetCulture(new CultureInfo("en-US"));
+See also
Dummy Connector
WebAPI Connector
diff --git a/docs/articles/connectors/WebAPI.html b/docs/articles/connectors/WebAPI.html
index 285ddd8e..8f6096b9 100644
--- a/docs/articles/connectors/WebAPI.html
+++ b/docs/articles/connectors/WebAPI.html
@@ -81,6 +81,7 @@ S71500 WebAPI Connector Documenta
This connector offers an interface to interact with S7-15XX PLC systems through the WebAPI.
+For details how to make the data available see extern accessibility .
Here is an example of how to create an instance of this connector:
public static <PLC_TWIN_TYPE> Plc { get; } = new (ConnectorAdapterBuilder.Build().CreateWebApi(Environment.GetEnvironmentVariable("AXTARGET") ?? "10.10.101.1", "Everybody", "", true));
Special characters
Ixr support all these special characters:!"#$'()*+,-.:;<=>?@[\]^_`{|}~€
+See also
Notes
Ixr is still in early development, so some features may be missing and bugs may occur.
diff --git a/docs/index.json b/docs/index.json
index 2afd3fdb..c95e35e0 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -2,12 +2,12 @@
"api/AXSharp.Abstractions.Presentation.EmptyGroupProvider.html": {
"href": "api/AXSharp.Abstractions.Presentation.EmptyGroupProvider.html",
"title": "Class EmptyGroupProvider | System.Dynamic.ExpandoObject",
- "keywords": "Class EmptyGroupProvider Inheritance object EmptyGroupProvider Implements IGroupLayoutProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public class EmptyGroupProvider : IGroupLayoutProvider Methods | Improve this Doc View Source GetControl(GroupLayout) Declaration public (string assembly, string fullTypeName) GetControl(GroupLayout layoutType) Parameters Type Name Description GroupLayout layoutType Returns Type Description (string assembly, string fullTypeName) Implements IGroupLayoutProvider"
+ "keywords": "Class EmptyGroupProvider Inheritance object EmptyGroupProvider Implements IGroupLayoutProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public class EmptyGroupProvider : IGroupLayoutProvider Methods | Improve this Doc View Source GetControl(GroupLayout) Declaration public (string assembly, string fullTypeName) GetControl(GroupLayout layoutType) Parameters Type Name Description GroupLayout layoutType Returns Type Description (string assembly, string fullTypeName) Implements IGroupLayoutProvider"
},
"api/AXSharp.Abstractions.Presentation.EmptyPresentationProvider.html": {
"href": "api/AXSharp.Abstractions.Presentation.EmptyPresentationProvider.html",
"title": "Class EmptyPresentationProvider | System.Dynamic.ExpandoObject",
- "keywords": "Class EmptyPresentationProvider Inheritance object EmptyPresentationProvider Implements ILayoutProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public class EmptyPresentationProvider : ILayoutProvider Methods | Improve this Doc View Source GetControl(Layout) Declaration public (string assembly, string fullTypeName) GetControl(Layout layoutType) Parameters Type Name Description Layout layoutType Returns Type Description (string assembly, string fullTypeName) Implements ILayoutProvider"
+ "keywords": "Class EmptyPresentationProvider Inheritance object EmptyPresentationProvider Implements ILayoutProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public class EmptyPresentationProvider : ILayoutProvider Methods | Improve this Doc View Source GetControl(Layout) Declaration public (string assembly, string fullTypeName) GetControl(Layout layoutType) Parameters Type Name Description Layout layoutType Returns Type Description (string assembly, string fullTypeName) Implements ILayoutProvider"
},
"api/AXSharp.Abstractions.Presentation.html": {
"href": "api/AXSharp.Abstractions.Presentation.html",
@@ -17,47 +17,57 @@
"api/AXSharp.Abstractions.Presentation.IGroupLayoutProvider.html": {
"href": "api/AXSharp.Abstractions.Presentation.IGroupLayoutProvider.html",
"title": "Interface IGroupLayoutProvider | System.Dynamic.ExpandoObject",
- "keywords": "Interface IGroupLayoutProvider Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public interface IGroupLayoutProvider Methods | Improve this Doc View Source GetControl(GroupLayout) Declaration (string assembly, string fullTypeName) GetControl(GroupLayout layoutType) Parameters Type Name Description GroupLayout layoutType Returns Type Description (string assembly, string fullTypeName)"
+ "keywords": "Interface IGroupLayoutProvider Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public interface IGroupLayoutProvider Methods | Improve this Doc View Source GetControl(GroupLayout) Declaration (string assembly, string fullTypeName) GetControl(GroupLayout layoutType) Parameters Type Name Description GroupLayout layoutType Returns Type Description (string assembly, string fullTypeName)"
},
"api/AXSharp.Abstractions.Presentation.ILayoutProvider.html": {
"href": "api/AXSharp.Abstractions.Presentation.ILayoutProvider.html",
"title": "Interface ILayoutProvider | System.Dynamic.ExpandoObject",
- "keywords": "Interface ILayoutProvider Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public interface ILayoutProvider Methods | Improve this Doc View Source GetControl(Layout) Declaration (string assembly, string fullTypeName) GetControl(Layout layoutType) Parameters Type Name Description Layout layoutType Returns Type Description (string assembly, string fullTypeName)"
+ "keywords": "Interface ILayoutProvider Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public interface ILayoutProvider Methods | Improve this Doc View Source GetControl(Layout) Declaration (string assembly, string fullTypeName) GetControl(Layout layoutType) Parameters Type Name Description Layout layoutType Returns Type Description (string assembly, string fullTypeName)"
},
"api/AXSharp.Abstractions.Presentation.PresentationProvider.html": {
"href": "api/AXSharp.Abstractions.Presentation.PresentationProvider.html",
"title": "Class PresentationProvider | System.Dynamic.ExpandoObject",
- "keywords": "Class PresentationProvider Inheritance object PresentationProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public class PresentationProvider Properties | Improve this Doc View Source Get Declaration public static PresentationProvider Get { get; } Property Value Type Description PresentationProvider | Improve this Doc View Source GroupLayoutProvider Declaration public IGroupLayoutProvider GroupLayoutProvider { get; } Property Value Type Description IGroupLayoutProvider | Improve this Doc View Source LayoutProvider Declaration public ILayoutProvider LayoutProvider { get; } Property Value Type Description ILayoutProvider Methods | Improve this Doc View Source Create(ILayoutProvider, IGroupLayoutProvider) Declaration public static PresentationProvider Create(ILayoutProvider layoutProvider, IGroupLayoutProvider groupLayoutProvider) Parameters Type Name Description ILayoutProvider layoutProvider IGroupLayoutProvider groupLayoutProvider Returns Type Description PresentationProvider"
+ "keywords": "Class PresentationProvider Inheritance object PresentationProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public class PresentationProvider Properties | Improve this Doc View Source Get Declaration public static PresentationProvider Get { get; } Property Value Type Description PresentationProvider | Improve this Doc View Source GroupLayoutProvider Declaration public IGroupLayoutProvider GroupLayoutProvider { get; } Property Value Type Description IGroupLayoutProvider | Improve this Doc View Source LayoutProvider Declaration public ILayoutProvider LayoutProvider { get; } Property Value Type Description ILayoutProvider Methods | Improve this Doc View Source Create(ILayoutProvider, IGroupLayoutProvider) Declaration public static PresentationProvider Create(ILayoutProvider layoutProvider, IGroupLayoutProvider groupLayoutProvider) Parameters Type Name Description ILayoutProvider layoutProvider IGroupLayoutProvider groupLayoutProvider Returns Type Description PresentationProvider"
},
"api/AXSharp.Abstractions.Presentation.PresentationProviderNotAssignedException.html": {
"href": "api/AXSharp.Abstractions.Presentation.PresentationProviderNotAssignedException.html",
"title": "Class PresentationProviderNotAssignedException | System.Dynamic.ExpandoObject",
- "keywords": "Class PresentationProviderNotAssignedException Inheritance object System.Exception PresentationProviderNotAssignedException Implements System.Runtime.Serialization.ISerializable Inherited Members System.Exception.GetBaseException() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.ToString() System.Exception.Data System.Exception.HelpLink System.Exception.HResult System.Exception.InnerException System.Exception.Message System.Exception.Source System.Exception.StackTrace System.Exception.TargetSite System.Exception.SerializeObjectState object.Equals(object) object.Equals(object, object) object.GetHashCode() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp - Backup.Abstractions.dll Syntax public class PresentationProviderNotAssignedException : Exception, ISerializable Constructors | Improve this Doc View Source PresentationProviderNotAssignedException() Initializes a new instance of the PresentationProviderNotAssignedException class. Declaration public PresentationProviderNotAssignedException() | Improve this Doc View Source PresentationProviderNotAssignedException(SerializationInfo, StreamingContext) Initializes a new instance of the PresentationProviderNotAssignedException class with serialized data. Declaration protected PresentationProviderNotAssignedException(SerializationInfo info, StreamingContext context) Parameters Type Name Description System.Runtime.Serialization.SerializationInfo info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. System.Runtime.Serialization.StreamingContext context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. Exceptions Type Condition System.ArgumentNullException The info parameter is null. System.Runtime.Serialization.SerializationException The class name is null or System.Exception.HResult is zero (0). | Improve this Doc View Source PresentationProviderNotAssignedException(string, Exception) Initializes a new instance of the PresentationProviderNotAssignedException class with a specified error message and a reference to the inner exception that is the cause of this exception. Declaration public PresentationProviderNotAssignedException(string message, Exception innerException) Parameters Type Name Description string message The error message that explains the reason for the exception. System.Exception innerException The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. | Improve this Doc View Source PresentationProviderNotAssignedException(string) Declaration public PresentationProviderNotAssignedException(string message) Parameters Type Name Description string message Implements System.Runtime.Serialization.ISerializable"
+ "keywords": "Class PresentationProviderNotAssignedException Inheritance object System.Exception PresentationProviderNotAssignedException Implements System.Runtime.Serialization.ISerializable Inherited Members System.Exception.GetBaseException() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.ToString() System.Exception.Data System.Exception.HelpLink System.Exception.HResult System.Exception.InnerException System.Exception.Message System.Exception.Source System.Exception.StackTrace System.Exception.TargetSite System.Exception.SerializeObjectState object.Equals(object) object.Equals(object, object) object.GetHashCode() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: AXSharp.Abstractions.Presentation Assembly: AXSharp.Abstractions.dll Syntax public class PresentationProviderNotAssignedException : Exception, ISerializable Constructors | Improve this Doc View Source PresentationProviderNotAssignedException() Initializes a new instance of the PresentationProviderNotAssignedException class. Declaration public PresentationProviderNotAssignedException() | Improve this Doc View Source PresentationProviderNotAssignedException(SerializationInfo, StreamingContext) Initializes a new instance of the PresentationProviderNotAssignedException class with serialized data. Declaration protected PresentationProviderNotAssignedException(SerializationInfo info, StreamingContext context) Parameters Type Name Description System.Runtime.Serialization.SerializationInfo info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. System.Runtime.Serialization.StreamingContext context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. Exceptions Type Condition System.ArgumentNullException The info parameter is null. System.Runtime.Serialization.SerializationException The class name is null or System.Exception.HResult is zero (0). | Improve this Doc View Source PresentationProviderNotAssignedException(string, Exception) Initializes a new instance of the PresentationProviderNotAssignedException class with a specified error message and a reference to the inner exception that is the cause of this exception. Declaration public PresentationProviderNotAssignedException(string message, Exception innerException) Parameters Type Name Description string message The error message that explains the reason for the exception. System.Exception innerException The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. | Improve this Doc View Source PresentationProviderNotAssignedException(string) Declaration public PresentationProviderNotAssignedException(string message) Parameters Type Name Description string message Implements System.Runtime.Serialization.ISerializable"
},
"api/AXSharp.Compiler.Apax.html": {
"href": "api/AXSharp.Compiler.Apax.html",
"title": "Class Apax | System.Dynamic.ExpandoObject",
- "keywords": "Class Apax Data transfer object for apax.yml file. Inheritance object Apax Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class Apax Constructors | Improve this Doc View Source Apax() Creates new instance of Apax Declaration [Obsolete(\"Use `CreateApax` instead.\")] public Apax() Properties | Improve this Doc View Source Dependencies Gets or sets ax projects dependencies. Declaration public IDictionary? Dependencies { get; set; } Property Value Type Description System.Collections.Generic.IDictionary | Improve this Doc View Source DevDependencies Gets or sets ax projects development dependencies. Declaration public IDictionary? DevDependencies { get; set; } Property Value Type Description System.Collections.Generic.IDictionary | Improve this Doc View Source Files Gets or sets ax project files to include in package. Declaration public IEnumerable? Files { get; set; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source Name Gets or sets ax project name. Declaration public string? Name { get; set; } Property Value Type Description string | Improve this Doc View Source Targets Gets or sets ax targets. Declaration public IEnumerable? Targets { get; set; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source Type Ax project type. Declaration public string? Type { get; set; } Property Value Type Description string | Improve this Doc View Source Version Gets or sets the version of the AX project. Declaration public string? Version { get; set; } Property Value Type Description string Methods | Improve this Doc View Source CreateApax(string) Creates new instance of Apax. Declaration public static Apax CreateApax(string projectFile) Parameters Type Name Description string projectFile Project file from which the ApaxFile object will be created. Returns Type Description Apax Exceptions Type Condition System.IO.FileNotFoundException | Improve this Doc View Source UpdateVersion(string, string) Update version in an apax.yml file Declaration public static void UpdateVersion(string apaxFile, string version) Parameters Type Name Description string apaxFile Apax file to update. string version Version. Exceptions Type Condition System.IO.FileNotFoundException"
+ "keywords": "Class Apax Data transfer object for apax.yml file. Inheritance object Apax Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class Apax Constructors | Improve this Doc View Source Apax() Creates new instance of Apax Declaration [Obsolete(\"Use `CreateApax` instead.\")] public Apax() Properties | Improve this Doc View Source Dependencies Gets or sets ax projects dependencies. Declaration public IDictionary? Dependencies { get; set; } Property Value Type Description System.Collections.Generic.IDictionary | Improve this Doc View Source DevDependencies Gets or sets ax projects development dependencies. Declaration public IDictionary? DevDependencies { get; set; } Property Value Type Description System.Collections.Generic.IDictionary | Improve this Doc View Source Files Gets or sets ax project files to include in package. Declaration public IEnumerable? Files { get; set; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source Name Gets or sets ax project name. Declaration public string? Name { get; set; } Property Value Type Description string | Improve this Doc View Source Targets Gets or sets ax targets. Declaration public IEnumerable? Targets { get; set; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source Type Ax project type. Declaration public string? Type { get; set; } Property Value Type Description string | Improve this Doc View Source Version Gets or sets the version of the AX project. Declaration public string? Version { get; set; } Property Value Type Description string Methods | Improve this Doc View Source CreateApaxDto(string) Creates new instance of Apax. Declaration public static Apax CreateApaxDto(string projectFile) Parameters Type Name Description string projectFile Project file from which the ApaxFile object will be created. Returns Type Description Apax Exceptions Type Condition System.IO.FileNotFoundException | Improve this Doc View Source TryCreateApaxDto(string) Declaration public static Apax TryCreateApaxDto(string projectFile) Parameters Type Name Description string projectFile Returns Type Description Apax | Improve this Doc View Source UpdateVersion(string, string) Update version in an apax.yml file Declaration public static void UpdateVersion(string apaxFile, string version) Parameters Type Name Description string apaxFile Apax file to update. string version Version. Exceptions Type Condition System.IO.FileNotFoundException"
},
"api/AXSharp.Compiler.AxProject.html": {
"href": "api/AXSharp.Compiler.AxProject.html",
"title": "Class AxProject | System.Dynamic.ExpandoObject",
- "keywords": "Class AxProject Contains information about AX project. Inheritance object AxProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AxProject Constructors | Improve this Doc View Source AxProject(string, string[]) Creates new instance of AxProject. It is expected that the project folder contains apax.yml file and src folder containing the sources of the project. It is also expected that the .apax folder contains the dependencies of the project. Declaration public AxProject(string axProjectFolder, string[] sourceFiles) Parameters Type Name Description string axProjectFolder AX project folder. string[] sourceFiles List of source files to be included in the compilation. | Improve this Doc View Source AxProject(string) Creates new instance of AxProject. It is expected that the project folder contains apax.yml file and src folder containing the sources of the project. It is also expected that the .apax folder contains the dependencies of the project. Declaration public AxProject(string axProjectFolder) Parameters Type Name Description string axProjectFolder AX project folder. Properties | Improve this Doc View Source IxReferences Gets paths of this project's references to other ix projects. Declaration public IEnumerable IxReferences { get; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source ProjectFile Gets project file. Declaration public string ProjectFile { get; } Property Value Type Description string | Improve this Doc View Source ProjectFolder Gets project folder. Declaration public string ProjectFolder { get; } Property Value Type Description string | Improve this Doc View Source ProjectInfo Get apax project information. Declaration public Apax ProjectInfo { get; } Property Value Type Description Apax | Improve this Doc View Source Sources Get sources of the this instance of the AxProject. Declaration public IEnumerable Sources { get; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source SrcFolder Gets the location of the source folder of this AX project. Declaration public string SrcFolder { get; } Property Value Type Description string"
+ "keywords": "Class AxProject Contains information about AX project. Inheritance object AxProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AxProject Constructors | Improve this Doc View Source AxProject(string, string[]) Creates new instance of AxProject. It is expected that the project folder contains apax.yml file and src folder containing the sources of the project. It is also expected that the .apax folder contains the dependencies of the project. Declaration public AxProject(string axProjectFolder, string[] sourceFiles) Parameters Type Name Description string axProjectFolder AX project folder. string[] sourceFiles List of source files to be included in the compilation. | Improve this Doc View Source AxProject(string) Creates new instance of AxProject. It is expected that the project folder contains apax.yml file and src folder containing the sources of the project. It is also expected that the .apax folder contains the dependencies of the project. Declaration public AxProject(string axProjectFolder) Parameters Type Name Description string axProjectFolder AX project folder. Properties | Improve this Doc View Source AXSharpReferences Gets paths of this project's references to other ix projects. Declaration public IEnumerable AXSharpReferences { get; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source ProjectFile Gets project file. Declaration public string ProjectFile { get; } Property Value Type Description string | Improve this Doc View Source ProjectFolder Gets project folder. Declaration public string ProjectFolder { get; } Property Value Type Description string | Improve this Doc View Source ProjectInfo Get apax project information. Declaration public Apax ProjectInfo { get; } Property Value Type Description Apax | Improve this Doc View Source Sources Get sources of the this instance of the AxProject. Declaration public IEnumerable Sources { get; } Property Value Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source SrcFolder Gets the location of the source folder of this AX project. Declaration public string SrcFolder { get; } Property Value Type Description string"
},
"api/AXSharp.Compiler.AXSharpConfig.html": {
"href": "api/AXSharp.Compiler.AXSharpConfig.html",
"title": "Class AXSharpConfig | System.Dynamic.ExpandoObject",
- "keywords": "Class AXSharpConfig Provides configuration setting for the AX# project. Inheritance object AXSharpConfig Implements ICompilerOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AXSharpConfig : ICompilerOptions Constructors | Improve this Doc View Source AXSharpConfig() Creates new instance of IxConfig object. Declaration [Obsolete(\"Use 'Create IxConfig' instead.\")] public AXSharpConfig() Fields | Improve this Doc View Source CONFIG_FILE_NAME Ix config file name. Declaration public const string CONFIG_FILE_NAME = \"AXSharp.config.json\" Field Value Type Description string Properties | Improve this Doc View Source AxProjectFolder Gets or sets the output folder for the Ix project. Declaration [JsonIgnore] public string AxProjectFolder { get; set; } Property Value Type Description string | Improve this Doc View Source OutputProjectFolder Gets or sets the output folder for the Ix project. Declaration public string OutputProjectFolder { get; set; } Property Value Type Description string Methods | Improve this Doc View Source RetrieveIxConfig(string) Declaration public static AXSharpConfig RetrieveIxConfig(string ixConfigFilePath) Parameters Type Name Description string ixConfigFilePath Returns Type Description AXSharpConfig | Improve this Doc View Source UpdateAndGetIxConfig(string, ICompilerOptions?) Gets updated or creates default config for given AX project. Declaration public static AXSharpConfig UpdateAndGetIxConfig(string directory, ICompilerOptions? cliCompilerOptions = null) Parameters Type Name Description string directory AX project directory ICompilerOptions cliCompilerOptions Compiler options. Returns Type Description AXSharpConfig Ix configuration for given AX project. Implements ICompilerOptions"
+ "keywords": "Class AXSharpConfig Provides configuration setting for the AX# project. Inheritance object AXSharpConfig Implements ICompilerOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AXSharpConfig : ICompilerOptions Constructors | Improve this Doc View Source AXSharpConfig() Creates new instance of IxConfig object. Declaration [Obsolete(\"Use 'Create RetrieveAXSharpConfig instead.\")] public AXSharpConfig() Fields | Improve this Doc View Source CONFIG_FILE_NAME Ix config file name. Declaration public const string CONFIG_FILE_NAME = \"AXSharp.config.json\" Field Value Type Description string Properties | Improve this Doc View Source AxProjectFolder Gets or sets the output folder for the Ix project. Declaration [JsonIgnore] public string AxProjectFolder { get; set; } Property Value Type Description string | Improve this Doc View Source IgnoreS7Pragmas Declaration public bool IgnoreS7Pragmas { get; set; } Property Value Type Description bool | Improve this Doc View Source NoDependencyUpdate Declaration public bool NoDependencyUpdate { get; set; } Property Value Type Description bool | Improve this Doc View Source OutputProjectFolder Gets or sets the output folder for the Ix project. Declaration public string OutputProjectFolder { get; set; } Property Value Type Description string | Improve this Doc View Source ProjectFile Gets or sets name of the output project file. Declaration public string? ProjectFile { get; set; } Property Value Type Description string | Improve this Doc View Source UseBase Gets or sets whether compiler should use $base for base types of a class. Declaration public bool UseBase { get; set; } Property Value Type Description bool Methods | Improve this Doc View Source RetrieveAXSharpConfig(string) Declaration public static AXSharpConfig RetrieveAXSharpConfig(string ixConfigFilePath) Parameters Type Name Description string ixConfigFilePath Returns Type Description AXSharpConfig | Improve this Doc View Source UpdateAndGetAXSharpConfig(string, ICompilerOptions?) Gets updated or creates default config for given AX project. Declaration public static AXSharpConfig UpdateAndGetAXSharpConfig(string directory, ICompilerOptions? newCompilerOptions = null) Parameters Type Name Description string directory AX project directory ICompilerOptions newCompilerOptions Compiler options. Returns Type Description AXSharpConfig Ix configuration for given AX project. Implements ICompilerOptions"
},
"api/AXSharp.Compiler.AXSharpProject.html": {
"href": "api/AXSharp.Compiler.AXSharpProject.html",
"title": "Class AXSharpProject | System.Dynamic.ExpandoObject",
- "keywords": "Class AXSharpProject Provides entry point for compilation of AX project sources. Inheritance object AXSharpProject Implements IAXSharpProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AXSharpProject : IAXSharpProject Constructors | Improve this Doc View Source AXSharpProject(AxProject, IEnumerable, Type, ICompilerOptions?) Creates new instance of the AXSharpProject Declaration public AXSharpProject(AxProject axProject, IEnumerable builderTypes, Type targetProjectType, ICompilerOptions? cliCompilerOptions = null) Parameters Type Name Description AxProject axProject Instance of source AX project. System.Collections.Generic.IEnumerable builderTypes List of output builders. The builders must implement ISourceBuilder and ICombinedThreeVisitor System.Type targetProjectType Target project type. The target project type must implement ITargetProject ICompilerOptions cliCompilerOptions Compiler options from CLI. Properties | Improve this Doc View Source AxProject Get AX project. Declaration public AxProject AxProject { get; } Property Value Type Description AxProject | Improve this Doc View Source CompilerOptions Gets compiler option for this AXSharpProject Declaration public ICompilerOptions? CompilerOptions { get; } Property Value Type Description ICompilerOptions | Improve this Doc View Source OutputFolder Gets root output folder where the generated sources will be emitted. Declaration public string OutputFolder { get; } Property Value Type Description string | Improve this Doc View Source TargetProject Gets target project. Declaration public ITargetProject TargetProject { get; } Property Value Type Description ITargetProject Methods | Improve this Doc View Source CleanOutput(string) Cleans all output files from the output directory Declaration public void CleanOutput(string folderToClean) Parameters Type Name Description string folderToClean | Improve this Doc View Source Generate() Generates outputs from the builders and emits the files into output folder. Declaration public void Generate() | Improve this Doc View Source GetRelativePath(string, string) Declaration public static string GetRelativePath(string fromPath, string toPath) Parameters Type Name Description string fromPath string toPath Returns Type Description string Implements IAXSharpProject"
+ "keywords": "Class AXSharpProject Provides entry point for compilation of AX project sources. Inheritance object AXSharpProject Implements IAXSharpProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class AXSharpProject : IAXSharpProject Constructors | Improve this Doc View Source AXSharpProject(AxProject, IEnumerable, Type, ICompilerOptions?) Creates new instance of the AXSharpProject Declaration public AXSharpProject(AxProject axProject, IEnumerable builderTypes, Type targetProjectType, ICompilerOptions? cliCompilerOptions = null) Parameters Type Name Description AxProject axProject Instance of source AX project. System.Collections.Generic.IEnumerable builderTypes List of output builders. The builders must implement ISourceBuilder and ICombinedThreeVisitor System.Type targetProjectType Target project type. The target project type must implement ITargetProject ICompilerOptions cliCompilerOptions Compiler options from CLI. Properties | Improve this Doc View Source AxProject Get AX project. Declaration public AxProject AxProject { get; } Property Value Type Description AxProject | Improve this Doc View Source CompilerOptions Gets compiler option for this AXSharpProject Declaration public ICompilerOptions? CompilerOptions { get; } Property Value Type Description ICompilerOptions | Improve this Doc View Source OutputFolder Gets root output folder where the generated sources will be emitted. Declaration public string OutputFolder { get; } Property Value Type Description string | Improve this Doc View Source TargetProject Gets target project. Declaration public ITargetProject TargetProject { get; } Property Value Type Description ITargetProject | Improve this Doc View Source UseBaseSymbol Declaration public bool UseBaseSymbol { get; } Property Value Type Description bool Methods | Improve this Doc View Source CleanOutput(string) Cleans all output files from the output directory Declaration public void CleanOutput(string folderToClean) Parameters Type Name Description string folderToClean | Improve this Doc View Source Generate() Generates outputs from the builders and emits the files into output folder. Declaration public void Generate() | Improve this Doc View Source GetRelativePath(string, string) Declaration public static string GetRelativePath(string fromPath, string toPath) Parameters Type Name Description string fromPath string toPath Returns Type Description string Implements IAXSharpProject"
+ },
+ "api/AXSharp.Compiler.CompanionInfo.html": {
+ "href": "api/AXSharp.Compiler.CompanionInfo.html",
+ "title": "Class CompanionInfo | System.Dynamic.ExpandoObject",
+ "keywords": "Class CompanionInfo Inheritance object CompanionInfo Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.dll Syntax public class CompanionInfo Fields | Improve this Doc View Source COMPANIONS_FILE_NAME Declaration public const string COMPANIONS_FILE_NAME = \"axsharp.companion.json\" Field Value Type Description string Properties | Improve this Doc View Source Id Declaration public string Id { get; set; } Property Value Type Description string | Improve this Doc View Source Version Declaration public string Version { get; set; } Property Value Type Description string Methods | Improve this Doc View Source FromFile(string) Declaration public static CompanionInfo? FromFile(string filePath) Parameters Type Name Description string filePath Returns Type Description CompanionInfo | Improve this Doc View Source ToFile(CompanionInfo, string) Declaration public static void ToFile(CompanionInfo info, string filePath) Parameters Type Name Description CompanionInfo info string filePath | Improve this Doc View Source TryFromFile(string) Declaration public static CompanionInfo? TryFromFile(string filePath) Parameters Type Name Description string filePath Returns Type Description CompanionInfo"
+ },
+ "api/AXSharp.Compiler.Core.eCommAccessibility.html": {
+ "href": "api/AXSharp.Compiler.Core.eCommAccessibility.html",
+ "title": "Enum eCommAccessibility | System.Dynamic.ExpandoObject",
+ "keywords": "Enum eCommAccessibility Namespace: AXSharp.Compiler.Core Assembly: AXSharp.Compiler.dll Syntax public enum eCommAccessibility Fields Name Description None ReadOnly ReadWrite"
},
"api/AXSharp.Compiler.Core.html": {
"href": "api/AXSharp.Compiler.Core.html",
"title": "Namespace AXSharp.Compiler.Core | System.Dynamic.ExpandoObject",
- "keywords": "Namespace AXSharp.Compiler.Core Classes IxNodeVisitor Provides implementation of combined syntax-semantic three. Data object must implement ICombinedThreeVisitor's methods to provide source generation. Not all Visit are implemented. We only visit nodes that have relevance for PLC's twin objects (Types, Variables etc). TypeNotFoundInSemanticTreeException Provides exception details when while crossing syntax tree no matching type is found in the semantic tree. Interfaces ICombinedThreeVisitor Provides implementation abstraction for syntax-semantic tree visitor. ISourceBuilder Provides abstraction for source emitting classes."
+ "keywords": "Namespace AXSharp.Compiler.Core Classes IxNodeVisitor Provides implementation of combined syntax-semantic three. Data object must implement ICombinedThreeVisitor's methods to provide source generation. Not all Visit are implemented. We only visit nodes that have relevance for PLC's twin objects (Types, Variables etc). TypeNotFoundInSemanticTreeException Provides exception details when while crossing syntax tree no matching type is found in the semantic tree. Interfaces ICombinedThreeVisitor Provides implementation abstraction for syntax-semantic tree visitor. ISourceBuilder Provides abstraction for source emitting classes. Enums eCommAccessibility"
},
"api/AXSharp.Compiler.Core.ICombinedThreeVisitor.html": {
"href": "api/AXSharp.Compiler.Core.ICombinedThreeVisitor.html",
@@ -67,7 +77,7 @@
"api/AXSharp.Compiler.Core.ISourceBuilder.html": {
"href": "api/AXSharp.Compiler.Core.ISourceBuilder.html",
"title": "Interface ISourceBuilder | System.Dynamic.ExpandoObject",
- "keywords": "Interface ISourceBuilder Provides abstraction for source emitting classes. Namespace: AXSharp.Compiler.Core Assembly: AXSharp.Compiler.dll Syntax public interface ISourceBuilder Properties | Improve this Doc View Source BuilderType Gets builder type. Builder type is used by CompilerOmits attribute to prevent compilation of constructs for specific compilation outputs. Declaration string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration string OutputFileSuffix { get; } Property Value Type Description string"
+ "keywords": "Interface ISourceBuilder Provides abstraction for source emitting classes. Namespace: AXSharp.Compiler.Core Assembly: AXSharp.Compiler.dll Syntax public interface ISourceBuilder Properties | Improve this Doc View Source BuilderType Gets builder type. Builder type is used by CompilerOmits attribute to prevent compilation of constructs for specific compilation outputs. Declaration string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source CompilerOptions Declaration ICompilerOptions? CompilerOptions { get; } Property Value Type Description ICompilerOptions | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration string OutputFileSuffix { get; } Property Value Type Description string | Improve this Doc View Source TypeCommAccessibility Declaration eCommAccessibility TypeCommAccessibility { get; } Property Value Type Description eCommAccessibility"
},
"api/AXSharp.Compiler.Core.IxNodeVisitor.html": {
"href": "api/AXSharp.Compiler.Core.IxNodeVisitor.html",
@@ -107,7 +117,7 @@
"api/AXSharp.Compiler.Cs.Onliner.CsOnlinerSourceBuilder.html": {
"href": "api/AXSharp.Compiler.Cs.Onliner.CsOnlinerSourceBuilder.html",
"title": "Class CsOnlinerSourceBuilder | System.Dynamic.ExpandoObject",
- "keywords": "Class CsOnlinerSourceBuilder Source builder for AXSharp.Compiler.Cs.Onliner twins. Inheritance object CsOnlinerSourceBuilder Implements ICombinedThreeVisitor ISourceBuilder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs.Onliner Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsOnlinerSourceBuilder : ICombinedThreeVisitor, ISourceBuilder Constructors | Improve this Doc View Source CsOnlinerSourceBuilder(AXSharpProject, Compilation) Creates new instance of CsOnlinerSourceBuilder Declaration public CsOnlinerSourceBuilder(AXSharpProject project, Compilation compilation) Parameters Type Name Description AXSharpProject project Ix project name. AX.ST.Semantic.Compilation compilation AX compilation Properties | Improve this Doc View Source BuilderType Gets builder type. Builder type is used by CompilerOmits attribute to prevent compilation of constructs for specific compilation outputs. Declaration public string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration public Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration public string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration public string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration public string OutputFileSuffix { get; } Property Value Type Description string Methods | Improve this Doc View Source CreateArrayTypeDeclaration(IArrayTypeDeclaration, IxNodeVisitor) Creates array type declaration. Declaration public void CreateArrayTypeDeclaration(IArrayTypeDeclaration arrayTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration Array type semantics IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateClassDeclaration(IClassDeclarationSyntax, IClassDeclaration, IxNodeVisitor) Creates class declaration starting in AX.ST.Syntax.Tree.ClassDeclarationSyntax node and continues in respective semantic node of AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclarationSyntax classDeclarationSyntax, IClassDeclaration classDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IClassDeclarationSyntax classDeclarationSyntax Class declaration syntax node. AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateConfigDeclaration(IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from semantic node of AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration Declaration public void CreateConfigDeclaration(IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantic node. IxNodeVisitor visitor | Improve this Doc View Source CreateConfigDeclaration(IConfigDeclarationSyntax, IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from starting from syntax node and proceeds in respective semantic node. Declaration public void CreateConfigDeclaration(IConfigDeclarationSyntax configDeclarationSyntax, IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IConfigDeclarationSyntax configDeclarationSyntax Configuration declaration syntax node. AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateDocComment(IDocComment, ICombinedThreeVisitor) Creates documentation for Declaration public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment semanticTypeAccess ICombinedThreeVisitor data Associated visitor | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax, ITypeDeclaration, IxNodeVisitor) Created enum declaration starting from syntax node and continues in respective semantic node. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax, ITypeDeclaration typeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax Enum type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Enum type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFile(IFileSyntax, IxNodeVisitor) Creates file declaration from AX.ST.Syntax.Tree.IFileSyntax node of given syntax tree. Declaration public void CreateFile(IFileSyntax fileSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IFileSyntax fileSyntax File syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateImplementsList(IImplementsListSyntax, ICombinedThreeVisitor) Creates implements list. Declaration public void CreateImplementsList(IImplementsListSyntax implementsListSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IImplementsListSyntax implementsListSyntax Implements syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration from semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclarationSyntax, IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration syntax starting from syntax node and continues in respective semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclarationSyntax interfaceDeclarationSyntax, IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IInterfaceDeclarationSyntax interfaceDeclarationSyntax Interface declaration syntax node. AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declarations syntax semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamedValueTypeDeclaration(INamedValueTypeDeclarationSyntax, INamedValueTypeDeclaration, IxNodeVisitor) Creates Named Value Type declaration. Declaration public void CreateNamedValueTypeDeclaration(INamedValueTypeDeclarationSyntax namedValueTypeDeclarationSyntax, INamedValueTypeDeclaration namedValueTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamedValueTypeDeclarationSyntax namedValueTypeDeclarationSyntax Named value type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.INamedValueTypeDeclaration namedValueTypeDeclaration Named value type declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamespaceDeclaration(INamespaceDeclarationSyntax, IxNodeVisitor) Creates namespace declaration from AX.ST.Syntax.Tree.INamespaceDeclarationSyntax node of given syntax tree. Declaration public void CreateNamespaceDeclaration(INamespaceDeclarationSyntax namespaceDeclarationSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamespaceDeclarationSyntax namespaceDeclarationSyntax Namespace declaration syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreatePragma(IPragma, ICombinedThreeVisitor) Creates pragma declaration. Declaration public void CreatePragma(IPragma pragma, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Pragmas.IPragma pragma Pragma declaration semantics ICombinedThreeVisitor visitor Associated visitor | Improve this Doc View Source CreateStructuredType(IStructTypeDeclarationSyntax, IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type declaration. Declaration public void CreateStructuredType(IStructTypeDeclarationSyntax structTypeDeclarationSyntax, IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IStructTypeDeclarationSyntax structTypeDeclarationSyntax Structured type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateUsingDirective(IUsingDirectiveSyntax, ICombinedThreeVisitor) Creates using directive. Declaration public void CreateUsingDirective(IUsingDirectiveSyntax usingDirectiveSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IUsingDirectiveSyntax usingDirectiveSyntax Using directive syntax node. ICombinedThreeVisitor visitor Associated visitor. Implements ICombinedThreeVisitor ISourceBuilder"
+ "keywords": "Class CsOnlinerSourceBuilder Source builder for AXSharp.Compiler.Cs.Onliner twins. Inheritance object CsOnlinerSourceBuilder Implements ICombinedThreeVisitor ISourceBuilder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs.Onliner Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsOnlinerSourceBuilder : ICombinedThreeVisitor, ISourceBuilder Constructors | Improve this Doc View Source CsOnlinerSourceBuilder(AXSharpProject, Compilation) Creates new instance of CsOnlinerSourceBuilder Declaration public CsOnlinerSourceBuilder(AXSharpProject project, Compilation compilation) Parameters Type Name Description AXSharpProject project Ix project name. AX.ST.Semantic.Compilation compilation AX compilation Properties | Improve this Doc View Source BuilderType Gets builder type. Builder type is used by CompilerOmits attribute to prevent compilation of constructs for specific compilation outputs. Declaration public string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration public Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source CompilerOptions Declaration public ICompilerOptions? CompilerOptions { get; } Property Value Type Description ICompilerOptions | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration public string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration public string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration public string OutputFileSuffix { get; } Property Value Type Description string | Improve this Doc View Source TypeCommAccessibility Declaration public eCommAccessibility TypeCommAccessibility { get; } Property Value Type Description eCommAccessibility Methods | Improve this Doc View Source CreateArrayTypeDeclaration(IArrayTypeDeclaration, IxNodeVisitor) Creates array type declaration. Declaration public void CreateArrayTypeDeclaration(IArrayTypeDeclaration arrayTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration Array type semantics IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateClassDeclaration(IClassDeclarationSyntax, IClassDeclaration, IxNodeVisitor) Creates class declaration starting in AX.ST.Syntax.Tree.ClassDeclarationSyntax node and continues in respective semantic node of AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclarationSyntax classDeclarationSyntax, IClassDeclaration classDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IClassDeclarationSyntax classDeclarationSyntax Class declaration syntax node. AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateConfigDeclaration(IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from semantic node of AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration Declaration public void CreateConfigDeclaration(IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantic node. IxNodeVisitor visitor | Improve this Doc View Source CreateConfigDeclaration(IConfigDeclarationSyntax, IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from starting from syntax node and proceeds in respective semantic node. Declaration public void CreateConfigDeclaration(IConfigDeclarationSyntax configDeclarationSyntax, IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IConfigDeclarationSyntax configDeclarationSyntax Configuration declaration syntax node. AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateDocComment(IDocComment, ICombinedThreeVisitor) Creates documentation for Declaration public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment semanticTypeAccess ICombinedThreeVisitor data Associated visitor | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax, ITypeDeclaration, IxNodeVisitor) Created enum declaration starting from syntax node and continues in respective semantic node. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax, ITypeDeclaration typeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax Enum type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Enum type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFile(IFileSyntax, IxNodeVisitor) Creates file declaration from AX.ST.Syntax.Tree.IFileSyntax node of given syntax tree. Declaration public void CreateFile(IFileSyntax fileSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IFileSyntax fileSyntax File syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateImplementsList(IImplementsListSyntax, ICombinedThreeVisitor) Creates implements list. Declaration public void CreateImplementsList(IImplementsListSyntax implementsListSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IImplementsListSyntax implementsListSyntax Implements syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration from semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclarationSyntax, IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration syntax starting from syntax node and continues in respective semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclarationSyntax interfaceDeclarationSyntax, IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IInterfaceDeclarationSyntax interfaceDeclarationSyntax Interface declaration syntax node. AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declarations syntax semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamedValueTypeDeclaration(INamedValueTypeDeclarationSyntax, INamedValueTypeDeclaration, IxNodeVisitor) Creates Named Value Type declaration. Declaration public void CreateNamedValueTypeDeclaration(INamedValueTypeDeclarationSyntax namedValueTypeDeclarationSyntax, INamedValueTypeDeclaration namedValueTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamedValueTypeDeclarationSyntax namedValueTypeDeclarationSyntax Named value type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.INamedValueTypeDeclaration namedValueTypeDeclaration Named value type declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamespaceDeclaration(INamespaceDeclarationSyntax, IxNodeVisitor) Creates namespace declaration from AX.ST.Syntax.Tree.INamespaceDeclarationSyntax node of given syntax tree. Declaration public void CreateNamespaceDeclaration(INamespaceDeclarationSyntax namespaceDeclarationSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamespaceDeclarationSyntax namespaceDeclarationSyntax Namespace declaration syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreatePragma(IPragma, ICombinedThreeVisitor) Creates pragma declaration. Declaration public void CreatePragma(IPragma pragma, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Pragmas.IPragma pragma Pragma declaration semantics ICombinedThreeVisitor visitor Associated visitor | Improve this Doc View Source CreateStructuredType(IStructTypeDeclarationSyntax, IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type declaration. Declaration public void CreateStructuredType(IStructTypeDeclarationSyntax structTypeDeclarationSyntax, IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IStructTypeDeclarationSyntax structTypeDeclarationSyntax Structured type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateUsingDirective(IUsingDirectiveSyntax, ICombinedThreeVisitor) Creates using directive. Declaration public void CreateUsingDirective(IUsingDirectiveSyntax usingDirectiveSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IUsingDirectiveSyntax usingDirectiveSyntax Using directive syntax node. ICombinedThreeVisitor visitor Associated visitor. Implements ICombinedThreeVisitor ISourceBuilder"
},
"api/AXSharp.Compiler.Cs.Onliner.html": {
"href": "api/AXSharp.Compiler.Cs.Onliner.html",
@@ -117,7 +127,7 @@
"api/AXSharp.Compiler.Cs.Plain.CsPlainSourceBuilder.html": {
"href": "api/AXSharp.Compiler.Cs.Plain.CsPlainSourceBuilder.html",
"title": "Class CsPlainSourceBuilder | System.Dynamic.ExpandoObject",
- "keywords": "Class CsPlainSourceBuilder Provides builder for Plain twin objects. Inheritance object CsPlainSourceBuilder Implements ICombinedThreeVisitor ISourceBuilder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs.Plain Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsPlainSourceBuilder : ICombinedThreeVisitor, ISourceBuilder Constructors | Improve this Doc View Source CsPlainSourceBuilder(AXSharpProject, Compilation) Creates new instance of CsPlainSourceBuilder Declaration public CsPlainSourceBuilder(AXSharpProject project, Compilation compilation) Parameters Type Name Description AXSharpProject project Ix project AX.ST.Semantic.Compilation compilation AX compilation Properties | Improve this Doc View Source BuilderType Declaration public string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration public Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration public string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration public string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration public string OutputFileSuffix { get; } Property Value Type Description string Methods | Improve this Doc View Source CreateArrayTypeDeclaration(IArrayTypeDeclaration, IxNodeVisitor) Creates array type declaration. Declaration public void CreateArrayTypeDeclaration(IArrayTypeDeclaration arrayTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration Array type semantics IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateClassDeclaration(IClassDeclaration, IxNodeVisitor) Creates class declaration from semantic node AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclaration classDeclaration, IxNodeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantics. IxNodeVisitor data | Improve this Doc View Source CreateClassDeclaration(IClassDeclarationSyntax, IClassDeclaration, IxNodeVisitor) Creates class declaration starting in AX.ST.Syntax.Tree.ClassDeclarationSyntax node and continues in respective semantic node of AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclarationSyntax classDeclarationSyntax, IClassDeclaration classDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IClassDeclarationSyntax classDeclarationSyntax Class declaration syntax node. AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateConfigDeclaration(IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from semantic node of AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration Declaration public void CreateConfigDeclaration(IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantic node. IxNodeVisitor visitor | Improve this Doc View Source CreateConfigDeclaration(IConfigDeclarationSyntax, IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from starting from syntax node and proceeds in respective semantic node. Declaration public void CreateConfigDeclaration(IConfigDeclarationSyntax configDeclarationSyntax, IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IConfigDeclarationSyntax configDeclarationSyntax Configuration declaration syntax node. AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateDocComment(IDocComment, ICombinedThreeVisitor) Creates documentation for Declaration public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment semanticTypeAccess ICombinedThreeVisitor data Associated visitor | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclaration, IxNodeVisitor) Creates enum type. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclaration enumTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IEnumTypeDeclaration enumTypeDeclaration Enum type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax, ITypeDeclaration, IxNodeVisitor) Created enum declaration starting from syntax node and continues in respective semantic node. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax, ITypeDeclaration typeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax Enum type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Enum type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFieldDeclaration(IFieldDeclaration, IxNodeVisitor) Creates field (type member) declaration from semantic node AX.ST.Semantic.Model.Declarations.IFieldDeclaration. Declaration public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration fieldDeclaration Field declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFile(IFileSyntax, IxNodeVisitor) Creates file declaration from AX.ST.Syntax.Tree.IFileSyntax node of given syntax tree. Declaration public void CreateFile(IFileSyntax fileSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IFileSyntax fileSyntax File syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateImplementsList(IImplementsListSyntax, ICombinedThreeVisitor) Creates implements list. Declaration public void CreateImplementsList(IImplementsListSyntax implementsListSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IImplementsListSyntax implementsListSyntax Implements syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration from semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclarationSyntax, IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration syntax starting from syntax node and continues in respective semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclarationSyntax interfaceDeclarationSyntax, IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IInterfaceDeclarationSyntax interfaceDeclarationSyntax Interface declaration syntax node. AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declarations syntax semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamedValueTypeDeclaration(INamedValueTypeDeclaration, IxNodeVisitor) Creates named value type declaration. Declaration public virtual void CreateNamedValueTypeDeclaration(INamedValueTypeDeclaration namedValueTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.INamedValueTypeDeclaration namedValueTypeDeclaration Named value type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamespaceDeclaration(INamespaceDeclarationSyntax, IxNodeVisitor) Creates namespace declaration from AX.ST.Syntax.Tree.INamespaceDeclarationSyntax node of given syntax tree. Declaration public void CreateNamespaceDeclaration(INamespaceDeclarationSyntax namespaceDeclarationSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamespaceDeclarationSyntax namespaceDeclarationSyntax Namespace declaration syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreatePragma(IPragma, ICombinedThreeVisitor) Creates pragma declaration. Declaration public void CreatePragma(IPragma pragma, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Pragmas.IPragma pragma Pragma declaration semantics ICombinedThreeVisitor visitor Associated visitor | Improve this Doc View Source CreateReferenceToDeclaration(IReferenceTypeDeclaration, IxNodeVisitor) Creates referenced type declaration. Declaration public void CreateReferenceToDeclaration(IReferenceTypeDeclaration referenceTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IReferenceTypeDeclaration referenceTypeDeclaration Reference type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateScalarTypeDeclaration(IScalarTypeDeclaration, IxNodeVisitor) Create scalar type declaration. Declaration public void CreateScalarTypeDeclaration(IScalarTypeDeclaration scalarTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IScalarTypeDeclaration scalarTypeDeclaration Scalar type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateSemanticTypeAccess(ISemanticTypeAccess, IxNodeVisitor) Creates semantic type access. Declaration public void CreateSemanticTypeAccess(ISemanticTypeAccess semanticTypeAccess, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.ISemanticTypeAccess semanticTypeAccess Semantic type access semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStringTypeDeclaration(IStringTypeDeclaration, IxNodeVisitor) Creates string type declaration. Declaration public void CreateStringTypeDeclaration(IStringTypeDeclaration stringTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IStringTypeDeclaration stringTypeDeclaration String type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStructuredType(IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type. Declaration public void CreateStructuredType(IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStructuredType(IStructTypeDeclarationSyntax, IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type declaration. Declaration public void CreateStructuredType(IStructTypeDeclarationSyntax structTypeDeclarationSyntax, IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IStructTypeDeclarationSyntax structTypeDeclarationSyntax Structured type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateUsingDirective(IUsingDirectiveSyntax, ICombinedThreeVisitor) Creates using directive. Declaration public void CreateUsingDirective(IUsingDirectiveSyntax usingDirectiveSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IUsingDirectiveSyntax usingDirectiveSyntax Using directive syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateVariableDeclaration(IVariableDeclaration, IxNodeVisitor) Creates variable declaration. Declaration public void CreateVariableDeclaration(IVariableDeclaration fieldDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration fieldDeclaration IxNodeVisitor visitor Associated visitor. Implements ICombinedThreeVisitor ISourceBuilder"
+ "keywords": "Class CsPlainSourceBuilder Provides builder for Plain twin objects. Inheritance object CsPlainSourceBuilder Implements ICombinedThreeVisitor ISourceBuilder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs.Plain Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsPlainSourceBuilder : ICombinedThreeVisitor, ISourceBuilder Constructors | Improve this Doc View Source CsPlainSourceBuilder(AXSharpProject, Compilation) Creates new instance of CsPlainSourceBuilder Declaration public CsPlainSourceBuilder(AXSharpProject project, Compilation compilation) Parameters Type Name Description AXSharpProject project Ix project AX.ST.Semantic.Compilation compilation AX compilation Properties | Improve this Doc View Source BuilderType Declaration public string BuilderType { get; } Property Value Type Description string | Improve this Doc View Source Compilation Get the semantic compilation for this builder. Declaration public Compilation Compilation { get; } Property Value Type Description AX.ST.Semantic.Compilation | Improve this Doc View Source CompilerOptions Declaration public ICompilerOptions? CompilerOptions { get; } Property Value Type Description ICompilerOptions | Improve this Doc View Source Group Get source group name. The output of this builder will be places into sub-folder name after this Group property. Declaration public string Group { get; } Property Value Type Description string | Improve this Doc View Source Output Gets string output of the builder. Declaration public string Output { get; } Property Value Type Description string | Improve this Doc View Source OutputFileSuffix Suffix of output files. Declaration public string OutputFileSuffix { get; } Property Value Type Description string | Improve this Doc View Source TypeCommAccessibility Declaration public eCommAccessibility TypeCommAccessibility { get; } Property Value Type Description eCommAccessibility Methods | Improve this Doc View Source CreateArrayTypeDeclaration(IArrayTypeDeclaration, IxNodeVisitor) Creates array type declaration. Declaration public void CreateArrayTypeDeclaration(IArrayTypeDeclaration arrayTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration Array type semantics IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateClassDeclaration(IClassDeclaration, IxNodeVisitor) Creates class declaration from semantic node AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclaration classDeclaration, IxNodeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantics. IxNodeVisitor data | Improve this Doc View Source CreateClassDeclaration(IClassDeclarationSyntax, IClassDeclaration, IxNodeVisitor) Creates class declaration starting in AX.ST.Syntax.Tree.ClassDeclarationSyntax node and continues in respective semantic node of AX.ST.Semantic.Model.Declarations.IClassDeclaration. Declaration public void CreateClassDeclaration(IClassDeclarationSyntax classDeclarationSyntax, IClassDeclaration classDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IClassDeclarationSyntax classDeclarationSyntax Class declaration syntax node. AX.ST.Semantic.Model.Declarations.IClassDeclaration classDeclaration Class declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateConfigDeclaration(IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from semantic node of AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration Declaration public void CreateConfigDeclaration(IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantic node. IxNodeVisitor visitor | Improve this Doc View Source CreateConfigDeclaration(IConfigDeclarationSyntax, IConfigurationDeclaration, IxNodeVisitor) Creates configuration declaration from starting from syntax node and proceeds in respective semantic node. Declaration public void CreateConfigDeclaration(IConfigDeclarationSyntax configDeclarationSyntax, IConfigurationDeclaration configurationDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IConfigDeclarationSyntax configDeclarationSyntax Configuration declaration syntax node. AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configurationDeclaration Configuration declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateDocComment(IDocComment, ICombinedThreeVisitor) Creates documentation for Declaration public void CreateDocComment(IDocComment semanticTypeAccess, ICombinedThreeVisitor data) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment semanticTypeAccess ICombinedThreeVisitor data Associated visitor | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclaration, IxNodeVisitor) Creates enum type. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclaration enumTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IEnumTypeDeclaration enumTypeDeclaration Enum type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax, ITypeDeclaration, IxNodeVisitor) Created enum declaration starting from syntax node and continues in respective semantic node. Declaration public void CreateEnumTypeDeclaration(IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax, ITypeDeclaration typeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IEnumTypeDeclarationSyntax enumTypeDeclarationSyntax Enum type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Enum type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFieldDeclaration(IFieldDeclaration, IxNodeVisitor) Creates field (type member) declaration from semantic node AX.ST.Semantic.Model.Declarations.IFieldDeclaration. Declaration public void CreateFieldDeclaration(IFieldDeclaration fieldDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration fieldDeclaration Field declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateFile(IFileSyntax, IxNodeVisitor) Creates file declaration from AX.ST.Syntax.Tree.IFileSyntax node of given syntax tree. Declaration public void CreateFile(IFileSyntax fileSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IFileSyntax fileSyntax File syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateImplementsList(IImplementsListSyntax, ICombinedThreeVisitor) Creates implements list. Declaration public void CreateImplementsList(IImplementsListSyntax implementsListSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IImplementsListSyntax implementsListSyntax Implements syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration from semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declaration semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateInterfaceDeclaration(IInterfaceDeclarationSyntax, IInterfaceDeclaration, IxNodeVisitor) Creates interface declaration syntax starting from syntax node and continues in respective semantic node. Declaration public void CreateInterfaceDeclaration(IInterfaceDeclarationSyntax interfaceDeclarationSyntax, IInterfaceDeclaration interfaceDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IInterfaceDeclarationSyntax interfaceDeclarationSyntax Interface declaration syntax node. AX.ST.Semantic.Model.Declarations.IInterfaceDeclaration interfaceDeclaration Interface declarations syntax semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamedValueTypeDeclaration(INamedValueTypeDeclaration, IxNodeVisitor) Creates named value type declaration. Declaration public virtual void CreateNamedValueTypeDeclaration(INamedValueTypeDeclaration namedValueTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.INamedValueTypeDeclaration namedValueTypeDeclaration Named value type declaration semantic node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateNamespaceDeclaration(INamespaceDeclarationSyntax, IxNodeVisitor) Creates namespace declaration from AX.ST.Syntax.Tree.INamespaceDeclarationSyntax node of given syntax tree. Declaration public void CreateNamespaceDeclaration(INamespaceDeclarationSyntax namespaceDeclarationSyntax, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.INamespaceDeclarationSyntax namespaceDeclarationSyntax Namespace declaration syntax node. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreatePragma(IPragma, ICombinedThreeVisitor) Creates pragma declaration. Declaration public void CreatePragma(IPragma pragma, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Pragmas.IPragma pragma Pragma declaration semantics ICombinedThreeVisitor visitor Associated visitor | Improve this Doc View Source CreateReferenceToDeclaration(IReferenceTypeDeclaration, IxNodeVisitor) Creates referenced type declaration. Declaration public void CreateReferenceToDeclaration(IReferenceTypeDeclaration referenceTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IReferenceTypeDeclaration referenceTypeDeclaration Reference type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateScalarTypeDeclaration(IScalarTypeDeclaration, IxNodeVisitor) Create scalar type declaration. Declaration public void CreateScalarTypeDeclaration(IScalarTypeDeclaration scalarTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IScalarTypeDeclaration scalarTypeDeclaration Scalar type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateSemanticTypeAccess(ISemanticTypeAccess, IxNodeVisitor) Creates semantic type access. Declaration public void CreateSemanticTypeAccess(ISemanticTypeAccess semanticTypeAccess, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.ISemanticTypeAccess semanticTypeAccess Semantic type access semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStringTypeDeclaration(IStringTypeDeclaration, IxNodeVisitor) Creates string type declaration. Declaration public void CreateStringTypeDeclaration(IStringTypeDeclaration stringTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IStringTypeDeclaration stringTypeDeclaration String type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStructuredType(IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type. Declaration public void CreateStructuredType(IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateStructuredType(IStructTypeDeclarationSyntax, IStructuredTypeDeclaration, IxNodeVisitor) Creates structured type declaration. Declaration public void CreateStructuredType(IStructTypeDeclarationSyntax structTypeDeclarationSyntax, IStructuredTypeDeclaration structuredTypeDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IStructTypeDeclarationSyntax structTypeDeclarationSyntax Structured type declaration syntax node. AX.ST.Semantic.Model.Declarations.Types.IStructuredTypeDeclaration structuredTypeDeclaration Structured type semantics. IxNodeVisitor visitor Associated visitor. | Improve this Doc View Source CreateUsingDirective(IUsingDirectiveSyntax, ICombinedThreeVisitor) Creates using directive. Declaration public void CreateUsingDirective(IUsingDirectiveSyntax usingDirectiveSyntax, ICombinedThreeVisitor visitor) Parameters Type Name Description AX.ST.Syntax.Tree.IUsingDirectiveSyntax usingDirectiveSyntax Using directive syntax node. ICombinedThreeVisitor visitor Associated visitor. | Improve this Doc View Source CreateVariableDeclaration(IVariableDeclaration, IxNodeVisitor) Creates variable declaration. Declaration public void CreateVariableDeclaration(IVariableDeclaration fieldDeclaration, IxNodeVisitor visitor) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration fieldDeclaration IxNodeVisitor visitor Associated visitor. Implements ICombinedThreeVisitor ISourceBuilder"
},
"api/AXSharp.Compiler.Cs.Plain.html": {
"href": "api/AXSharp.Compiler.Cs.Plain.html",
@@ -127,7 +137,7 @@
"api/AXSharp.Compiler.Cs.PragmaExtensions.html": {
"href": "api/AXSharp.Compiler.Cs.PragmaExtensions.html",
"title": "Class PragmaExtensions | System.Dynamic.ExpandoObject",
- "keywords": "Class PragmaExtensions Provides series of methods for working with IX pragmas. Inheritance object PragmaExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs Assembly: AXSharp.Compiler.Cs.dll Syntax public static class PragmaExtensions Fields | Improve this Doc View Source PRAGMA_ATTRIBUTE_SIGNATURE Declaration public const string PRAGMA_ATTRIBUTE_SIGNATURE = \"#ix-attr:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_DECLARE_PROPERTY_SIGNATURE Declaration public const string PRAGMA_DECLARE_PROPERTY_SIGNATURE = \"#ix-prop:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_PROPERTY_GENERIC_ATTRIBUTES Declaration public const string PRAGMA_PROPERTY_GENERIC_ATTRIBUTES = \"#ix-generic:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_PROPERTY_SET_SIGNATURE Declaration public const string PRAGMA_PROPERTY_SET_SIGNATURE = \"#ix-set:\" Field Value Type Description string Methods | Improve this Doc View Source AddAnnotations(IDeclaration) Produces statement to annotate the member based on attributes. Declaration public static string AddAnnotations(this IDeclaration declaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDeclaration declaration Declaration Returns Type Description string Annotation statements | Improve this Doc View Source AddAttributes(IEnumerable) Produces clr attributes from list of ix pragmas. Declaration public static string AddAttributes(this IEnumerable pragmas) Parameters Type Name Description System.Collections.Generic.IEnumerable pragmas Pragmas Returns Type Description string Attribute syntax from given ix pragmas. | Improve this Doc View Source DeclareProperties(IConfigurationDeclaration) Produces property from list of ix pragmas declared in configuration declaration. Declaration public static string DeclareProperties(this IConfigurationDeclaration configDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configDeclaration Type declaration Returns Type Description string Property syntax from given ix pragmas. | Improve this Doc View Source DeclareProperties(ITypeDeclaration) Produces property from list of ix pragmas declared on type declaration. Declaration public static string DeclareProperties(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Type declaration Returns Type Description string Property syntax from given ix pragmas. | Improve this Doc View Source GetGenericAttributes(IFieldDeclaration) Declaration public static IEnumerable GetGenericAttributes(this IFieldDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration typeDeclaration Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source GetGenericAttributes(ITypeDeclaration) Declaration public static VisitorProduct GetGenericAttributes(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Returns Type Description VisitorProduct | Improve this Doc View Source GetPropertyValue(IDeclaration, string, string) Gets a value of a property declared with set value pragma. If a property with given name is not found member name is returned instead. Declaration public static string GetPropertyValue(this IDeclaration declaration, string propertyName, string memberName = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDeclaration declaration Declaration string propertyName Property name string memberName Member name Returns Type Description string | Improve this Doc View Source SetProperties(IFieldDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this IFieldDeclaration fieldDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration fieldDeclaration Field declaration Returns Type Description string Statement setting property to given value. | Improve this Doc View Source SetProperties(IVariableDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this IVariableDeclaration variableDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variableDeclaration Variable declaration Returns Type Description string Statement setting property to given value. | Improve this Doc View Source SetProperties(ITypeDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Type declaration Returns Type Description string Statement setting property to given value."
+ "keywords": "Class PragmaExtensions Provides series of methods for working with IX pragmas. Inheritance object PragmaExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs Assembly: AXSharp.Compiler.Cs.dll Syntax public static class PragmaExtensions Fields | Improve this Doc View Source PRAGMA_ATTRIBUTE_SIGNATURE Declaration public const string PRAGMA_ATTRIBUTE_SIGNATURE = \"#ix-attr:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_DECLARE_PROPERTY_SIGNATURE Declaration public const string PRAGMA_DECLARE_PROPERTY_SIGNATURE = \"#ix-prop:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_PROPERTY_GENERIC_ATTRIBUTES Declaration public const string PRAGMA_PROPERTY_GENERIC_ATTRIBUTES = \"#ix-generic:\" Field Value Type Description string | Improve this Doc View Source PRAGMA_PROPERTY_SET_SIGNATURE Declaration public const string PRAGMA_PROPERTY_SET_SIGNATURE = \"#ix-set:\" Field Value Type Description string Methods | Improve this Doc View Source AddAnnotations(IDeclaration, ISourceBuilder) Produces statement to annotate the member based on attributes. Declaration public static string AddAnnotations(this IDeclaration declaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDeclaration declaration Declaration ISourceBuilder sourceBuilder Source builder. Returns Type Description string Annotation statements | Improve this Doc View Source AddAttributes(IEnumerable) Produces clr attributes from list of ix pragmas. Declaration public static string AddAttributes(this IEnumerable pragmas) Parameters Type Name Description System.Collections.Generic.IEnumerable pragmas Pragmas Returns Type Description string Attribute syntax from given ix pragmas. | Improve this Doc View Source DeclareProperties(IConfigurationDeclaration) Produces property from list of ix pragmas declared in configuration declaration. Declaration public static string DeclareProperties(this IConfigurationDeclaration configDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IConfigurationDeclaration configDeclaration Type declaration Returns Type Description string Property syntax from given ix pragmas. | Improve this Doc View Source DeclareProperties(ITypeDeclaration) Produces property from list of ix pragmas declared on type declaration. Declaration public static string DeclareProperties(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Type declaration Returns Type Description string Property syntax from given ix pragmas. | Improve this Doc View Source GetGenericAttributes(IFieldDeclaration) Declaration public static IEnumerable GetGenericAttributes(this IFieldDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration typeDeclaration Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source GetGenericAttributes(ITypeDeclaration) Declaration public static VisitorProduct GetGenericAttributes(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Returns Type Description VisitorProduct | Improve this Doc View Source GetPropertyValue(IDeclaration, string, string) Gets a value of a property declared with set value pragma. If a property with given name is not found member name is returned instead. Declaration public static string GetPropertyValue(this IDeclaration declaration, string propertyName, string memberName = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDeclaration declaration Declaration string propertyName Property name string memberName Member name Returns Type Description string | Improve this Doc View Source SetProperties(IFieldDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this IFieldDeclaration fieldDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration fieldDeclaration Field declaration Returns Type Description string Statement setting property to given value. | Improve this Doc View Source SetProperties(IVariableDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this IVariableDeclaration variableDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variableDeclaration Variable declaration Returns Type Description string Statement setting property to given value. | Improve this Doc View Source SetProperties(ITypeDeclaration) Produces statement to set a value of a property in constructor. Declaration public static string SetProperties(this ITypeDeclaration typeDeclaration) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration Type declaration Returns Type Description string Statement setting property to given value."
},
"api/AXSharp.Compiler.Cs.Pragmas.PragmaParser.GenericAttributeAstNode.html": {
"href": "api/AXSharp.Compiler.Cs.Pragmas.PragmaParser.GenericAttributeAstNode.html",
@@ -147,12 +157,12 @@
"api/AXSharp.Compiler.Cs.SemanticsHelpers.html": {
"href": "api/AXSharp.Compiler.Cs.SemanticsHelpers.html",
"title": "Class SemanticsHelpers | System.Dynamic.ExpandoObject",
- "keywords": "Class SemanticsHelpers Provides a series of helpers for semantics. Inheritance object SemanticsHelpers Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs Assembly: AXSharp.Compiler.Cs.dll Syntax public static class SemanticsHelpers Methods | Improve this Doc View Source AddDocumentationComment(IDocComment, ISourceBuilder) Create triple-slash documentation. Declaration public static string AddDocumentationComment(this IDocComment docComment, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment docComment Documentation comment ISourceBuilder sourceBuilder Source builder Returns Type Description string | Improve this Doc View Source IsMemberEligibleForConstructor(IFieldDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForConstructor(this IFieldDeclaration field, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration field Field declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForConstructor(IVariableDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForConstructor(this IVariableDeclaration variable, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variable Variable declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForConstructor(IArrayTypeDeclaration, ISourceBuilder) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForConstructor(this IArrayTypeDeclaration arrayTypeDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration ISourceBuilder sourceBuilder Source builder Returns Type Description bool | Improve this Doc View Source IsMemberEligibleForTranspile(IFieldDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForTranspile(this IFieldDeclaration field, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration field Field declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder signature Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForTranspile(IVariableDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForTranspile(this IVariableDeclaration variable, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variable Variable declaration ISourceBuilder sourceBuilder Source builder string coBuilder Co-builder signature (e.g. POCO, Onliner, etc.) Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsTypeEligibleForTranspile(ITypeDeclaration, ISourceBuilder) Determines whether the member or type is eligible for generation. Declaration public static bool IsTypeEligibleForTranspile(this ITypeDeclaration typeDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.ITypeDeclaration typeDeclaration ISourceBuilder sourceBuilder Returns Type Description bool"
+ "keywords": "Class SemanticsHelpers Provides a series of helpers for semantics. Inheritance object SemanticsHelpers Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler.Cs Assembly: AXSharp.Compiler.Cs.dll Syntax public static class SemanticsHelpers Methods | Improve this Doc View Source AddDocumentationComment(IDocComment, ISourceBuilder) Create triple-slash documentation. Declaration public static string AddDocumentationComment(this IDocComment docComment, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDocComment docComment Documentation comment ISourceBuilder sourceBuilder Source builder Returns Type Description string | Improve this Doc View Source GetCommAccessibility(IDeclaration, ISourceBuilder) Declaration public static eCommAccessibility GetCommAccessibility(this IDeclaration declaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IDeclaration declaration ISourceBuilder sourceBuilder Returns Type Description eCommAccessibility | Improve this Doc View Source IsEligibleForTranspile(IFieldDeclaration, ISourceBuilder) Determines whether the member or type is eligible for generation. Declaration public static bool IsEligibleForTranspile(this IFieldDeclaration fieldDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration fieldDeclaration ISourceBuilder sourceBuilder Returns Type Description bool True when the type is eligible | Improve this Doc View Source IsEligibleForTranspile(IVariableDeclaration, ISourceBuilder) Determines whether the member or type is eligible for generation. Declaration public static bool IsEligibleForTranspile(this IVariableDeclaration variableDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variableDeclaration ISourceBuilder sourceBuilder Returns Type Description bool True when the type is eligible | Improve this Doc View Source IsEligibleForTranspile(IArrayTypeDeclaration, ISourceBuilder) Determines whether the member is eligible for generation. Declaration public static bool IsEligibleForTranspile(this IArrayTypeDeclaration arrayTypeDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration ISourceBuilder sourceBuilder Source builder Returns Type Description bool | Improve this Doc View Source IsMemberEligibleForConstructor(IFieldDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForConstructor(this IFieldDeclaration field, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration field Field declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForConstructor(IVariableDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForConstructor(this IVariableDeclaration variable, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variable Variable declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForConstructor(IArrayTypeDeclaration, ISourceBuilder) Declaration public static bool IsMemberEligibleForConstructor(this IArrayTypeDeclaration arrayTypeDeclaration, ISourceBuilder sourceBuilder) Parameters Type Name Description AX.ST.Semantic.Model.Declarations.Types.IArrayTypeDeclaration arrayTypeDeclaration ISourceBuilder sourceBuilder Returns Type Description bool | Improve this Doc View Source IsMemberEligibleForTranspile(IFieldDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForTranspile(this IFieldDeclaration field, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IFieldDeclaration field Field declaration ISourceBuilder sourceBuilder Source builder string coBuilder Lateral builder signature Returns Type Description bool True when the member is eligible for generation. | Improve this Doc View Source IsMemberEligibleForTranspile(IVariableDeclaration, ISourceBuilder, string) Determines whether the member is eligible for generation. Declaration public static bool IsMemberEligibleForTranspile(this IVariableDeclaration variable, ISourceBuilder sourceBuilder, string coBuilder = \"\") Parameters Type Name Description AX.ST.Semantic.Model.Declarations.IVariableDeclaration variable Variable declaration ISourceBuilder sourceBuilder Source builder string coBuilder Co-builder signature (e.g. POCO, Onliner, etc.) Returns Type Description bool True when the member is eligible for generation."
},
"api/AXSharp.Compiler.CsProject.html": {
"href": "api/AXSharp.Compiler.CsProject.html",
"title": "Class CsProject | System.Dynamic.ExpandoObject",
- "keywords": "Class CsProject Provides information about CSharp project from csproj file. Inheritance object CsProject Implements ITargetProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsProject : ITargetProject Constructors | Improve this Doc View Source CsProject(AXSharpProject) Create new instance of the CsProject. Declaration public CsProject(AXSharpProject AXSharpProject) Parameters Type Name Description AXSharpProject AXSharpProject Properties | Improve this Doc View Source GetMetaDataFolder Get folder for project metadata. Declaration public string GetMetaDataFolder { get; } Property Value Type Description string | Improve this Doc View Source IxProjectFile Gets associated IxProject file. Declaration public string IxProjectFile { get; } Property Value Type Description string | Improve this Doc View Source ProjectRootNamespace Gets project's root namespace. In this namespace will be enclosed all types generated by the builders. Declaration public string ProjectRootNamespace { get; } Property Value Type Description string Methods | Improve this Doc View Source GenerateResources() Declaration public void GenerateResources() | Improve this Doc View Source LoadReferences() Retrieves references from csproj file associated with given project. Declaration public IEnumerable LoadReferences() Returns Type Description System.Collections.Generic.IEnumerable List of references. | Improve this Doc View Source ProvisionProjectStructure() Provisions project structure. Declaration public void ProvisionProjectStructure() Implements ITargetProject"
+ "keywords": "Class CsProject Provides information about CSharp project from csproj file. Inheritance object CsProject Implements ITargetProject Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Cs.dll Syntax public class CsProject : ITargetProject Constructors | Improve this Doc View Source CsProject(AXSharpProject) Create new instance of the CsProject. Declaration public CsProject(AXSharpProject AXSharpProject) Parameters Type Name Description AXSharpProject AXSharpProject Properties | Improve this Doc View Source GetMetaDataFolder Get folder for project metadata. Declaration public string GetMetaDataFolder { get; } Property Value Type Description string | Improve this Doc View Source IxProjectFile Gets associated IxProject file. Declaration public string IxProjectFile { get; } Property Value Type Description string | Improve this Doc View Source ProjectRootNamespace Gets project's root namespace. In this namespace will be enclosed all types generated by the builders. Declaration public string ProjectRootNamespace { get; } Property Value Type Description string Methods | Improve this Doc View Source GenerateCompanionData() Declaration public void GenerateCompanionData() | Improve this Doc View Source GenerateResources() Declaration public void GenerateResources() | Improve this Doc View Source GetRelativePath(string, string) Declaration public static string GetRelativePath(string fromPath, string toPath) Parameters Type Name Description string fromPath string toPath Returns Type Description string | Improve this Doc View Source InstallAXSharpDependencies(IEnumerable) Installs dependencies to the companion twin project from using dependencies from apax.yml file of a given AX project. Declaration public void InstallAXSharpDependencies(IEnumerable dependencies) Parameters Type Name Description System.Collections.Generic.IEnumerable dependencies | Improve this Doc View Source LoadReferences() Retrieves references from csproj file associated with given project. Declaration public IEnumerable LoadReferences() Returns Type Description System.Collections.Generic.IEnumerable List of references. | Improve this Doc View Source ProvisionProjectStructure() Provisions project structure. Declaration public void ProvisionProjectStructure() Implements ITargetProject"
},
"api/AXSharp.Compiler.Exceptions.FailedToCreateCombineThreeVisitorException.html": {
"href": "api/AXSharp.Compiler.Exceptions.FailedToCreateCombineThreeVisitorException.html",
@@ -192,7 +202,7 @@
"api/AXSharp.Compiler.html": {
"href": "api/AXSharp.Compiler.html",
"title": "Namespace AXSharp.Compiler | System.Dynamic.ExpandoObject",
- "keywords": "Namespace AXSharp.Compiler Classes Apax Data transfer object for apax.yml file. AxProject Contains information about AX project. AXSharpConfig Provides configuration setting for the AX# project. AXSharpProject Provides entry point for compilation of AX project sources. CsProject Provides information about CSharp project from csproj file. FailedToCreateSourceBuilderException FailedToDeterminePackageVersion LegalAcrobatics Log Provides logger for the compiler. PackageReference Provides information about package reference from csproj file. ProjectReference Provide information about project reference from csproj file. Interfaces IAXSharpProject ICompilerOptions IPackageReference IProjectReference IReference ITargetProject"
+ "keywords": "Namespace AXSharp.Compiler Classes Apax Data transfer object for apax.yml file. AxProject Contains information about AX project. AXSharpConfig Provides configuration setting for the AX# project. AXSharpProject Provides entry point for compilation of AX project sources. CompanionInfo CsProject Provides information about CSharp project from csproj file. FailedToCreateSourceBuilderException FailedToDeterminePackageVersion LegalAcrobatics Log Provides logger for the compiler. PackageReference Provides information about package reference from csproj file. ProjectReference Provide information about project reference from csproj file. Interfaces IAXSharpProject ICompilerOptions IPackageReference IProjectReference IReference ITargetProject"
},
"api/AXSharp.Compiler.IAXSharpProject.html": {
"href": "api/AXSharp.Compiler.IAXSharpProject.html",
@@ -202,7 +212,7 @@
"api/AXSharp.Compiler.ICompilerOptions.html": {
"href": "api/AXSharp.Compiler.ICompilerOptions.html",
"title": "Interface ICompilerOptions | System.Dynamic.ExpandoObject",
- "keywords": "Interface ICompilerOptions Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Abstractions.dll Syntax public interface ICompilerOptions Properties | Improve this Doc View Source OutputProjectFolder Declaration string? OutputProjectFolder { get; set; } Property Value Type Description string"
+ "keywords": "Interface ICompilerOptions Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Abstractions.dll Syntax public interface ICompilerOptions Properties | Improve this Doc View Source IgnoreS7Pragmas Declaration bool IgnoreS7Pragmas { get; set; } Property Value Type Description bool | Improve this Doc View Source NoDependencyUpdate Declaration bool NoDependencyUpdate { get; set; } Property Value Type Description bool | Improve this Doc View Source OutputProjectFolder Declaration string? OutputProjectFolder { get; set; } Property Value Type Description string | Improve this Doc View Source ProjectFile Declaration string? ProjectFile { get; set; } Property Value Type Description string | Improve this Doc View Source UseBase Declaration bool UseBase { get; set; } Property Value Type Description bool"
},
"api/AXSharp.Compiler.IPackageReference.html": {
"href": "api/AXSharp.Compiler.IPackageReference.html",
@@ -222,7 +232,7 @@
"api/AXSharp.Compiler.ITargetProject.html": {
"href": "api/AXSharp.Compiler.ITargetProject.html",
"title": "Interface ITargetProject | System.Dynamic.ExpandoObject",
- "keywords": "Interface ITargetProject Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Abstractions.dll Syntax public interface ITargetProject Properties | Improve this Doc View Source GetMetaDataFolder Get folder for project metadata. Declaration string GetMetaDataFolder { get; } Property Value Type Description string | Improve this Doc View Source ProjectRootNamespace Declaration string ProjectRootNamespace { get; } Property Value Type Description string Methods | Improve this Doc View Source GenerateResources() Declaration void GenerateResources() | Improve this Doc View Source LoadReferences() Declaration IEnumerable LoadReferences() Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source ProvisionProjectStructure() Provisions project structure. Declaration void ProvisionProjectStructure()"
+ "keywords": "Interface ITargetProject Namespace: AXSharp.Compiler Assembly: AXSharp.Compiler.Abstractions.dll Syntax public interface ITargetProject Properties | Improve this Doc View Source GetMetaDataFolder Get folder for project metadata. Declaration string GetMetaDataFolder { get; } Property Value Type Description string | Improve this Doc View Source ProjectRootNamespace Declaration string ProjectRootNamespace { get; } Property Value Type Description string Methods | Improve this Doc View Source GenerateCompanionData() Declaration void GenerateCompanionData() | Improve this Doc View Source GenerateResources() Declaration void GenerateResources() | Improve this Doc View Source InstallAXSharpDependencies(IEnumerable) Declaration void InstallAXSharpDependencies(IEnumerable dependencies) Parameters Type Name Description System.Collections.Generic.IEnumerable dependencies | Improve this Doc View Source LoadReferences() Declaration IEnumerable LoadReferences() Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source ProvisionProjectStructure() Provisions project structure. Declaration void ProvisionProjectStructure()"
},
"api/AXSharp.Compiler.LegalAcrobatics.html": {
"href": "api/AXSharp.Compiler.LegalAcrobatics.html",
@@ -269,10 +279,15 @@
"title": "Class CompilerOmitsAttribute | System.Dynamic.ExpandoObject",
"keywords": "Class CompilerOmitsAttribute Prevents ixc builder to create a member for specific group of output type (Shadow, Plain, Onliner). note This attribute must be declared in the PLC code to be effective during build process. This example demonstrates how to prevent the ixc builder to compile specific property into specific output group. // This will not compile to 'omitsInPlainString' member into respective 'Plain' type. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer))]} ommitsInPlainString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; // This will not compile to 'ommitsInPlainAndShadowerInterfaceString' member into respective 'Plain' type and Shadow interface. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer, CompilerOmissionGroups.BuilderShadowerInterface))]} ommitsInPlainAndShadowerInterfaceString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; Inheritance object System.Attribute CompilerOmitsAttribute Inherited Members System.Attribute.Equals(object) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.Assembly) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, bool) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, bool) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.Module) System.Attribute.GetCustomAttributes(System.Reflection.Module, bool) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, bool) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.GetHashCode() System.Attribute.IsDefaultAttribute() System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, bool) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.IsDefined(System.Reflection.Module, System.Type) System.Attribute.IsDefined(System.Reflection.Module, System.Type, bool) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.Match(object) System.Attribute.TypeId object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax [AttributeUsage(AttributeTargets.Property)] public class CompilerOmitsAttribute : Attribute Constructors | Improve this Doc View Source CompilerOmitsAttribute(params CompilerOmissionGroups[]) Creates an instance of CompilerOmitsAttribute. Declaration public CompilerOmitsAttribute(params CompilerOmissionGroups[] omissions) Parameters Type Name Description CompilerOmissionGroups[] omissions Determines group(s) of output type where the member shall be omitted. CompilerOmissionGroups | Improve this Doc View Source CompilerOmitsAttribute(params string[]) Creates an instance of CompilerOmitsAttribute. Declaration public CompilerOmitsAttribute(params string[] omissions) Parameters Type Name Description string[] omissions Determines group(s) of output type where the member shall be omitted. Properties | Improve this Doc View Source Omissions Gets the list of groups of output type in which the member will not be included. Declaration public IEnumerable Omissions { get; } Property Value Type Description System.Collections.Generic.IEnumerable"
},
+ "api/AXSharp.Connector.ConcurrentSet-1.html": {
+ "href": "api/AXSharp.Connector.ConcurrentSet-1.html",
+ "title": "Class ConcurrentSet | System.Dynamic.ExpandoObject",
+ "keywords": "Class ConcurrentSet Concurent implementation HasSet comes from: https://stackoverflow.com/questions/18922985/concurrent-hashsett-in-net-framework https://stackoverflow.com/questions/4306936/how-to-implement-concurrenthashset-in-net Inheritance object ConcurrentSet Implements System.Collections.Generic.ISet System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public class ConcurrentSet : ISet, ICollection, IEnumerable, IEnumerable Type Parameters Name Description T Properties | Improve this Doc View Source Count Gets the number of elements in the set. Declaration public int Count { get; } Property Value Type Description int | Improve this Doc View Source IsEmpty Gets a value that indicates if the set is empty. Declaration public bool IsEmpty { get; } Property Value Type Description bool | Improve this Doc View Source IsReadOnly Gets a value indicating whether the System.Collections.Generic.ICollection is read-only. Declaration public bool IsReadOnly { get; } Property Value Type Description bool true if the System.Collections.Generic.ICollection is read-only; otherwise, false. | Improve this Doc View Source Values Declaration public ICollection Values { get; } Property Value Type Description System.Collections.Generic.ICollection Methods | Improve this Doc View Source Add(T) Adds an element to the current set and returns a value to indicate if the element was successfully added. Declaration public bool Add(T item) Parameters Type Name Description T item The element to add to the set. Returns Type Description bool true if the element is added to the set; false if the element is already in the set. | Improve this Doc View Source Clear() Declaration public void Clear() | Improve this Doc View Source Contains(T) Declaration public bool Contains(T item) Parameters Type Name Description T item Returns Type Description bool | Improve this Doc View Source CopyTo(T[], int) Copies the elements of the System.Collections.Generic.ICollection to an System.Array, starting at a particular System.Array index. Declaration public void CopyTo(T[] array, int arrayIndex) Parameters Type Name Description T[] array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection. The System.Array must have zero-based indexing. int arrayIndex The zero-based index in array at which copying begins. Exceptions Type Condition System.ArgumentNullException array is null. System.ArgumentOutOfRangeException arrayIndex is less than 0. System.ArgumentException array is multidimensional.-or-The number of elements in the source System.Collections.Generic.ICollection is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array. | Improve this Doc View Source ExceptWith(IEnumerable) Removes all elements in the specified collection from the current set. Declaration public void ExceptWith(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection of items to remove from the set. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source GetEnumerator() Returns an enumerator that iterates through the collection. Declaration public IEnumerator GetEnumerator() Returns Type Description System.Collections.Generic.IEnumerator A System.Collections.Generic.IEnumerator that can be used to iterate through the collection. | Improve this Doc View Source IntersectWith(IEnumerable) Modifies the current set so that it contains only elements that are also in a specified collection. Declaration public void IntersectWith(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source IsProperSubsetOf(IEnumerable) Determines whether the current set is a property (strict) subset of a specified collection. Declaration public bool IsProperSubsetOf(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the current set is a correct subset of other; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source IsProperSupersetOf(IEnumerable) Determines whether the current set is a correct superset of a specified collection. Declaration public bool IsProperSupersetOf(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the System.Collections.Generic.ISet object is a correct superset of other; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source IsSubsetOf(IEnumerable) Determines whether a set is a subset of a specified collection. Declaration public bool IsSubsetOf(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the current set is a subset of other; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source IsSupersetOf(IEnumerable) Determines whether the current set is a superset of a specified collection. Declaration public bool IsSupersetOf(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the current set is a superset of other; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source Overlaps(IEnumerable) Determines whether the current set overlaps with the specified collection. Declaration public bool Overlaps(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the current set and other share at least one common element; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source Remove(T) Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection. Declaration public bool Remove(T item) Parameters Type Name Description T item The object to remove from the System.Collections.Generic.ICollection. Returns Type Description bool true if item was successfully removed from the System.Collections.Generic.ICollection; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection. Exceptions Type Condition System.NotSupportedException The System.Collections.Generic.ICollection is read-only. | Improve this Doc View Source SetEquals(IEnumerable) Determines whether the current set and the specified collection contain the same elements. Declaration public bool SetEquals(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Returns Type Description bool true if the current set is equal to other; otherwise, false. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source SymmetricExceptWith(IEnumerable) Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. Declaration public void SymmetricExceptWith(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Exceptions Type Condition System.ArgumentNullException other is null. | Improve this Doc View Source ToArray() Declaration public T[] ToArray() Returns Type Description T[] | Improve this Doc View Source TryAdd(T) Declaration public bool TryAdd(T item) Parameters Type Name Description T item Returns Type Description bool | Improve this Doc View Source TryRemove(T) Declaration public bool TryRemove(T item) Parameters Type Name Description T item Returns Type Description bool | Improve this Doc View Source UnionWith(IEnumerable) Modifies the current set so that it contains all elements that are present in both the current set and in the specified collection. Declaration public void UnionWith(IEnumerable other) Parameters Type Name Description System.Collections.Generic.IEnumerable other The collection to compare to the current set. Exceptions Type Condition System.ArgumentNullException other is null. Implements System.Collections.Generic.ISet System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable"
+ },
"api/AXSharp.Connector.Connector.html": {
"href": "api/AXSharp.Connector.Connector.html",
"title": "Class Connector | System.Dynamic.ExpandoObject",
- "keywords": "Class Connector Abstract base class provides implementation contract for the PLC connector and basic common underlying logic. Inheritance object RootTwinObject Connector DummyConnector WebApiConnector Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Inherited Members RootTwinObject.Identity RootTwinObject.GetSymbolTail() RootTwinObject.Poll() RootTwinObject.Interpreter RootTwinObject.AttributeName RootTwinObject.Symbol RootTwinObject.HumanReadable RootTwinObject.GetChildren() RootTwinObject.GetParent() RootTwinObject.AddChild(ITwinObject) RootTwinObject.GetValueTags() RootTwinObject.AddValueTag(ITwinPrimitive) RootTwinObject.GetConnector() RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(T) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(T) RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(object) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(object) RootTwinObject.AddKid(ITwinElement) RootTwinObject.GetKids() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public abstract class Connector : RootTwinObject, ITwinObject, ITwinElement, INotifyPropertyChanged Constructors | Improve this Doc View Source Connector() Creates new instance of Connector class Declaration protected Connector() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source Connector(object[]) Creates an instance of Connector class Declaration protected Connector(object[] parameters) Parameters Type Name Description object[] parameters Connection parameters Examples var connector = new IConnector(); See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Properties | Improve this Doc View Source ConcurrentRequestDelay Gets or sets delay between Concurrent Requests. It is applied when ConcurrentRequestMaxCount is reached. Declaration public int ConcurrentRequestDelay { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ConcurrentRequestMaxCount Gets or sets maximal count of Concurrent Request. Maximum number of simultaneous requests is 4. Note The property will be capped to this value if higher value is assigned. Important When setting this value take into account that other devices may communicate with your target system. Declaration public int ConcurrentRequestMaxCount { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ConnectorAdapter Gets adapter for onliners. Declaration public ConnectorAdapter ConnectorAdapter { get; } Property Value Type Description ConnectorAdapter See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicRwDuration Gets the last duration of Read/Write cycle in milliseconds. Declaration public long CyclicRwDuration { get; } Property Value Type Description long See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ErrorCount Gets or sets error counter of the adapter. Declaration public int ErrorCount { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ExceptionBehaviour Gets or sets how the connector should handle communication exceptions. Declaration public CommExceptionBehaviour ExceptionBehaviour { get; set; } Property Value Type Description CommExceptionBehaviour See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source IdentityProvider Gets object identity provider. Declaration public TwinIdentityProvider IdentityProvider { get; } Property Value Type Description TwinIdentityProvider See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source IsRwLoopSuspended Gets or set whether RW loop is suspended. Declaration public bool IsRwLoopSuspended { get; set; } Property Value Type Description bool See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source Logger Provides logging capability for this connector. Declaration public ILogger Logger { get; } Property Value Type Description Serilog.ILogger See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source MonitorConnector Gets or sets value indicating whether the performance of the monitor should be active. Declaration public bool MonitorConnector { get; set; } Property Value Type Description bool See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source OnlineTags Gets online value items tags attached to this connector. Declaration public IEnumerable OnlineTags { get; } Property Value Type Description System.Collections.Generic.IEnumerable See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReadWriteCycleDelay Gets or sets delay between Read/Write cycles. Declaration public int ReadWriteCycleDelay { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source RwCycleCount Gets the number of Read Write cycles from the start of the connector. Declaration public long RwCycleCount { get; protected set; } Property Value Type Description long See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source StartUpTime Get the connector's startup timestamp. Declaration public DateTime StartUpTime { get; protected set; } Property Value Type Description System.DateTime See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SubscriptionMode Gets or sets subscription mode for reading data from the controller. Declaration public ReadSubscriptionMode SubscriptionMode { get; set; } Property Value Type Description ReadSubscriptionMode See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Methods | Improve this Doc View Source BuildAndStart() Builds and starts this connector. Declaration public abstract Connector BuildAndStart() Returns Type Description Connector See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ClearPeriodicReadSet() Declaration protected void ClearPeriodicReadSet() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CreateHumanReadable(string, string) Return humanized path combining parent's and member's names. Declaration public static string CreateHumanReadable(string parent, string member) Parameters Type Name Description string parent Parent's name. string member Members name. Returns Type Description string Combine symbol of parent and member. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CreateSymbol(string, string) Return symbol path combining parent's and member's symbol. Declaration public static string CreateSymbol(string parent, string member) Parameters Type Name Description string parent Parent's path. string member Members name. Returns Type Description string Combine symbol of parent and member. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicRead() Reads online variables required to be read. Declaration protected Task CyclicRead() Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicWrite() Writes modified online variables. Declaration protected Task CyclicWrite() Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReadBatchAsync(IEnumerable) Reads batch of value items from the plc. Declaration public abstract Task ReadBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Primitive items to be read. Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReloadConnector() Forces the connector to reload symbols. Declaration public abstract void ReloadConnector() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SetField(ref T, T, string) Sets properties backing field value and notifies over INotifyPropertyChanged interface. Declaration protected bool SetField(ref T field, T value, string propertyName) Parameters Type Name Description T field Field. T value Value to be set. string propertyName Property name. Returns Type Description bool Type Parameters Name Description T Type of backing field. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SetLoggerConfiguration(ILogger) Sets logger for this connector. ![NOTE] The default logger is implemented. Default implementation will log into console and in simple text file. Declaration public void SetLoggerConfiguration(ILogger logger) Parameters Type Name Description Serilog.ILogger logger Logger See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source StartReadWriteOps() Starts cyclical read write operation on this connector. Declaration protected void StartReadWriteOps() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source WriteBatchAsync(IEnumerable) Writes batch of value items to the plc. Declaration public abstract Task WriteBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Primitive items to be written. Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Events | Improve this Doc View Source PropertyChanged Implementation of System.ComponentModel.INotifyPropertyChanged Declaration public event PropertyChangedEventHandler PropertyChanged Event Type Type Description System.ComponentModel.PropertyChangedEventHandler See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Extension Methods TranslatorExtension.Translate(ITwinElement, string) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement) TwinObjectExtensions.CreatePoco(ITwinObject) TwinObjectExtensions.MakeReadOnce(ITwinObject) TwinObjectExtensions.MakeReadOnly(ITwinObject) TwinObjectExtensions.OnlineToShadowAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.RetrievePrimitives(ITwinObject, List) TwinObjectExtensions.ShadowToOnlineAsync(ITwinObject) TwinObjectExtensions.SubscribeEditValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.SubscribeShadowValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.UnSubscribeEditValueChange(ITwinObject) TwinObjectExtensions.UnSubscribeShadowValueChange(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject) See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged"
+ "keywords": "Class Connector Abstract base class provides implementation contract for the PLC connector and basic common underlying logic. Inheritance object RootTwinObject Connector DummyConnector WebApiConnector Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Inherited Members RootTwinObject.Identity RootTwinObject.GetSymbolTail() RootTwinObject.Poll() RootTwinObject.Interpreter RootTwinObject.AttributeName RootTwinObject.GetAttributeName(CultureInfo) RootTwinObject.GetHumanReadable(CultureInfo) RootTwinObject.Symbol RootTwinObject.HumanReadable RootTwinObject.GetChildren() RootTwinObject.GetParent() RootTwinObject.AddChild(ITwinObject) RootTwinObject.GetValueTags() RootTwinObject.AddValueTag(ITwinPrimitive) RootTwinObject.GetConnector() RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(T) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(T) RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(object) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(object) RootTwinObject.AddKid(ITwinElement) RootTwinObject.GetKids() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public abstract class Connector : RootTwinObject, ITwinObject, ITwinElement, INotifyPropertyChanged Constructors | Improve this Doc View Source Connector() Creates new instance of Connector class Declaration protected Connector() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source Connector(object[]) Creates an instance of Connector class Declaration protected Connector(object[] parameters) Parameters Type Name Description object[] parameters Connection parameters Examples var connector = new IConnector(); See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Properties | Improve this Doc View Source ConcurrentRequestDelay Gets or sets delay between Concurrent Requests. It is applied when ConcurrentRequestMaxCount is reached. Declaration public int ConcurrentRequestDelay { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ConcurrentRequestMaxCount Gets or sets maximal count of Concurrent Request. Maximum number of simultaneous requests is 4. Note The property will be capped to this value if higher value is assigned. Important When setting this value take into account that other devices may communicate with your target system. Declaration public int ConcurrentRequestMaxCount { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ConnectorAdapter Gets adapter for onliners. Declaration public ConnectorAdapter ConnectorAdapter { get; } Property Value Type Description ConnectorAdapter See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicRwDuration Gets the last duration of Read/Write cycle in milliseconds. Declaration public long CyclicRwDuration { get; } Property Value Type Description long See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ErrorCount Gets or sets error counter of the adapter. Declaration public int ErrorCount { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ExceptionBehaviour Gets or sets how the connector should handle communication exceptions. Declaration public CommExceptionBehaviour ExceptionBehaviour { get; set; } Property Value Type Description CommExceptionBehaviour See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source IdentityProvider Gets object identity provider. Declaration public TwinIdentityProvider IdentityProvider { get; } Property Value Type Description TwinIdentityProvider See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source IsRwLoopSuspended Gets or set whether RW loop is suspended. Declaration public bool IsRwLoopSuspended { get; set; } Property Value Type Description bool See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source Logger Provides logging capability for this connector. Declaration public ILogger Logger { get; } Property Value Type Description Serilog.ILogger See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source MonitorConnector Gets or sets value indicating whether the performance of the monitor should be active. Declaration public bool MonitorConnector { get; set; } Property Value Type Description bool See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source OnlineTags Gets online value items tags attached to this connector. Declaration public IEnumerable OnlineTags { get; } Property Value Type Description System.Collections.Generic.IEnumerable See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReadWriteCycleDelay Gets or sets delay between Read/Write cycles. Declaration public int ReadWriteCycleDelay { get; set; } Property Value Type Description int See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source RwCycleCount Gets the number of Read Write cycles from the start of the connector. Declaration public long RwCycleCount { get; protected set; } Property Value Type Description long See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source StartUpTime Get the connector's startup timestamp. Declaration public DateTime StartUpTime { get; protected set; } Property Value Type Description System.DateTime See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SubscriptionMode Gets or sets subscription mode for reading data from the controller. Declaration public ReadSubscriptionMode SubscriptionMode { get; set; } Property Value Type Description ReadSubscriptionMode See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Methods | Improve this Doc View Source BuildAndStart() Builds and starts this connector. Declaration public abstract Connector BuildAndStart() Returns Type Description Connector See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ClearPeriodicReadSet() Declaration protected void ClearPeriodicReadSet() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CreateHumanReadable(string, string) Return humanized path combining parent's and member's names. Declaration public static string CreateHumanReadable(string parent, string member) Parameters Type Name Description string parent Parent's name. string member Members name. Returns Type Description string Combine symbol of parent and member. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CreateSymbol(string, string) Return symbol path combining parent's and member's symbol. Declaration public static string CreateSymbol(string parent, string member) Parameters Type Name Description string parent Parent's path. string member Members name. Returns Type Description string Combine symbol of parent and member. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicRead() Reads online variables required to be read. Declaration protected Task CyclicRead() Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source CyclicWrite() Writes modified online variables. Declaration protected Task CyclicWrite() Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReadBatchAsync(IEnumerable) Reads batch of value items from the plc. Declaration public abstract Task ReadBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Primitive items to be read. Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source ReloadConnector() Forces the connector to reload symbols. Declaration public abstract void ReloadConnector() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SetCulture(CultureInfo) Sets the culture for this connector. Declaration public static void SetCulture(CultureInfo culture) Parameters Type Name Description System.Globalization.CultureInfo culture Desired culture See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SetField(ref T, T, string) Sets properties backing field value and notifies over INotifyPropertyChanged interface. Declaration protected bool SetField(ref T field, T value, string propertyName) Parameters Type Name Description T field Field. T value Value to be set. string propertyName Property name. Returns Type Description bool Type Parameters Name Description T Type of backing field. See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source SetLoggerConfiguration(ILogger) Sets logger for this connector. ![NOTE] The default logger is implemented. Default implementation will log into console and in simple text file. Declaration public void SetLoggerConfiguration(ILogger logger) Parameters Type Name Description Serilog.ILogger logger Logger See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source StartReadWriteOps() Starts cyclical read write operation on this connector. Declaration protected void StartReadWriteOps() See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged | Improve this Doc View Source WriteBatchAsync(IEnumerable) Writes batch of value items to the plc. Declaration public abstract Task WriteBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Primitive items to be written. Returns Type Description System.Threading.Tasks.Task See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Events | Improve this Doc View Source PropertyChanged Implementation of System.ComponentModel.INotifyPropertyChanged Declaration public event PropertyChangedEventHandler PropertyChanged Event Type Type Description System.ComponentModel.PropertyChangedEventHandler See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Extension Methods TranslatorExtension.Translate(ITwinElement, string, CultureInfo) TwinObjectExtensions.HasAttribute(ITwinElement) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement) TwinObjectExtensions.CreatePoco(ITwinObject) TwinObjectExtensions.MakeReadOnce(ITwinObject) TwinObjectExtensions.MakeReadOnly(ITwinObject) TwinObjectExtensions.OnlineToShadowAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.RetrievePrimitives(ITwinObject, List) TwinObjectExtensions.ShadowToOnlineAsync(ITwinObject) TwinObjectExtensions.SubscribeEditValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.SubscribeShadowValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.UnSubscribeEditValueChange(ITwinObject) TwinObjectExtensions.UnSubscribeShadowValueChange(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject) See Also RootTwinObject System.ComponentModel.INotifyPropertyChanged"
},
"api/AXSharp.Connector.ConnectorAdapter.html": {
"href": "api/AXSharp.Connector.ConnectorAdapter.html",
@@ -292,7 +307,7 @@
"api/AXSharp.Connector.DummyConnector.html": {
"href": "api/AXSharp.Connector.DummyConnector.html",
"title": "Class DummyConnector | System.Dynamic.ExpandoObject",
- "keywords": "Class DummyConnector Provides a connector without real target system connections. Inheritance object RootTwinObject Connector DummyConnector Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Inherited Members Connector.SetLoggerConfiguration(ILogger) Connector.Logger Connector.ConnectorAdapter Connector.ExceptionBehaviour Connector.SubscriptionMode Connector.ErrorCount Connector.IdentityProvider Connector.RwCycleCount Connector.CyclicRwDuration Connector.StartUpTime Connector.MonitorConnector Connector.ReadWriteCycleDelay Connector.ConcurrentRequestDelay Connector.ConcurrentRequestMaxCount Connector.OnlineTags Connector.IsRwLoopSuspended Connector.PropertyChanged Connector.CreateSymbol(string, string) Connector.CreateHumanReadable(string, string) Connector.SetField(ref T, T, string) Connector.StartReadWriteOps() Connector.CyclicRead() Connector.CyclicWrite() Connector.ClearPeriodicReadSet() RootTwinObject.Identity RootTwinObject.GetSymbolTail() RootTwinObject.Poll() RootTwinObject.Interpreter RootTwinObject.AttributeName RootTwinObject.Symbol RootTwinObject.HumanReadable RootTwinObject.GetChildren() RootTwinObject.GetParent() RootTwinObject.AddChild(ITwinObject) RootTwinObject.GetValueTags() RootTwinObject.AddValueTag(ITwinPrimitive) RootTwinObject.GetConnector() RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(T) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(T) RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(object) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(object) RootTwinObject.AddKid(ITwinElement) RootTwinObject.GetKids() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public class DummyConnector : Connector, ITwinObject, ITwinElement, INotifyPropertyChanged Methods | Improve this Doc View Source BuildAndStart() This method does not have effect on DummyConnector Declaration public override Connector BuildAndStart() Returns Type Description Connector Overrides Connector.BuildAndStart() | Improve this Doc View Source ReadBatchAsync(IEnumerable) Reads batch of value items from the plc. Declaration public override Task ReadBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Value items to be read. Returns Type Description System.Threading.Tasks.Task Overrides Connector.ReadBatchAsync(IEnumerable) | Improve this Doc View Source ReloadConnector() This method does not have effect on dummy connector. Declaration public override void ReloadConnector() Overrides Connector.ReloadConnector() | Improve this Doc View Source WriteBatchAsync(IEnumerable) Writes batch of value items to the plc. Declaration public override Task WriteBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Value items to be written. Returns Type Description System.Threading.Tasks.Task Overrides Connector.WriteBatchAsync(IEnumerable) Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Extension Methods TranslatorExtension.Translate(ITwinElement, string) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement) TwinObjectExtensions.CreatePoco(ITwinObject) TwinObjectExtensions.MakeReadOnce(ITwinObject) TwinObjectExtensions.MakeReadOnly(ITwinObject) TwinObjectExtensions.OnlineToShadowAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.RetrievePrimitives(ITwinObject, List) TwinObjectExtensions.ShadowToOnlineAsync(ITwinObject) TwinObjectExtensions.SubscribeEditValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.SubscribeShadowValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.UnSubscribeEditValueChange(ITwinObject) TwinObjectExtensions.UnSubscribeShadowValueChange(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject)"
+ "keywords": "Class DummyConnector Provides a connector without real target system connections. Inheritance object RootTwinObject Connector DummyConnector Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Inherited Members Connector.SetLoggerConfiguration(ILogger) Connector.Logger Connector.ConnectorAdapter Connector.ExceptionBehaviour Connector.SubscriptionMode Connector.ErrorCount Connector.IdentityProvider Connector.RwCycleCount Connector.CyclicRwDuration Connector.StartUpTime Connector.MonitorConnector Connector.ReadWriteCycleDelay Connector.ConcurrentRequestDelay Connector.ConcurrentRequestMaxCount Connector.OnlineTags Connector.IsRwLoopSuspended Connector.PropertyChanged Connector.CreateSymbol(string, string) Connector.CreateHumanReadable(string, string) Connector.SetField(ref T, T, string) Connector.SetCulture(CultureInfo) Connector.StartReadWriteOps() Connector.CyclicRead() Connector.CyclicWrite() Connector.ClearPeriodicReadSet() RootTwinObject.Identity RootTwinObject.GetSymbolTail() RootTwinObject.Poll() RootTwinObject.Interpreter RootTwinObject.AttributeName RootTwinObject.GetAttributeName(CultureInfo) RootTwinObject.GetHumanReadable(CultureInfo) RootTwinObject.Symbol RootTwinObject.HumanReadable RootTwinObject.GetChildren() RootTwinObject.GetParent() RootTwinObject.AddChild(ITwinObject) RootTwinObject.GetValueTags() RootTwinObject.AddValueTag(ITwinPrimitive) RootTwinObject.GetConnector() RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(T) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(T) RootTwinObject.OnlineToPlain() RootTwinObject.PlainToOnline(object) RootTwinObject.ShadowToPlain() RootTwinObject.PlainToShadow(object) RootTwinObject.AddKid(ITwinElement) RootTwinObject.GetKids() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public class DummyConnector : Connector, ITwinObject, ITwinElement, INotifyPropertyChanged Methods | Improve this Doc View Source BuildAndStart() This method does not have effect on DummyConnector Declaration public override Connector BuildAndStart() Returns Type Description Connector Overrides Connector.BuildAndStart() | Improve this Doc View Source ReadBatchAsync(IEnumerable) Reads batch of value items from the plc. Declaration public override Task ReadBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Value items to be read. Returns Type Description System.Threading.Tasks.Task Overrides Connector.ReadBatchAsync(IEnumerable) | Improve this Doc View Source ReloadConnector() This method does not have effect on dummy connector. Declaration public override void ReloadConnector() Overrides Connector.ReloadConnector() | Improve this Doc View Source WriteBatchAsync(IEnumerable) Writes batch of value items to the plc. Declaration public override Task WriteBatchAsync(IEnumerable primitives) Parameters Type Name Description System.Collections.Generic.IEnumerable primitives Value items to be written. Returns Type Description System.Threading.Tasks.Task Overrides Connector.WriteBatchAsync(IEnumerable) Implements ITwinObject ITwinElement System.ComponentModel.INotifyPropertyChanged Extension Methods TranslatorExtension.Translate(ITwinElement, string, CultureInfo) TwinObjectExtensions.HasAttribute(ITwinElement) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement) TwinObjectExtensions.CreatePoco(ITwinObject) TwinObjectExtensions.MakeReadOnce(ITwinObject) TwinObjectExtensions.MakeReadOnly(ITwinObject) TwinObjectExtensions.OnlineToShadowAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.ReadAsync(ITwinObject) TwinObjectExtensions.RetrievePrimitives(ITwinObject, List) TwinObjectExtensions.ShadowToOnlineAsync(ITwinObject) TwinObjectExtensions.SubscribeEditValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.SubscribeShadowValueChange(ITwinObject, OnlinerBase.ValueChangeDelegate) TwinObjectExtensions.UnSubscribeEditValueChange(ITwinObject) TwinObjectExtensions.UnSubscribeShadowValueChange(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject) TwinObjectExtensions.WriteAsync(ITwinObject)"
},
"api/AXSharp.Connector.DummyConnectorExtensions.html": {
"href": "api/AXSharp.Connector.DummyConnectorExtensions.html",
@@ -312,7 +327,7 @@
"api/AXSharp.Connector.html": {
"href": "api/AXSharp.Connector.html",
"title": "Namespace AXSharp.Connector | System.Dynamic.ExpandoObject",
- "keywords": "Namespace AXSharp.Connector Classes CompilerOmitsAttribute Prevents ixc builder to create a member for specific group of output type (Shadow, Plain, Onliner). note This attribute must be declared in the PLC code to be effective during build process. This example demonstrates how to prevent the ixc builder to compile specific property into specific output group. // This will not compile to 'omitsInPlainString' member into respective 'Plain' type. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer))]} ommitsInPlainString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; // This will not compile to 'ommitsInPlainAndShadowerInterfaceString' member into respective 'Plain' type and Shadow interface. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer, CompilerOmissionGroups.BuilderShadowerInterface))]} ommitsInPlainAndShadowerInterfaceString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; Connector Abstract base class provides implementation contract for the PLC connector and basic common underlying logic. ConnectorAdapter Provides basic abstractions for twin connectors. ConnectorAdapterBuilder Provides access to extension method for creating connector adapters. ConnectorFactory Provides abstraction for creation of Connector and value types (tags) for twin connector. DummyConnector Provides a connector without real target system connections. DummyConnectorExtensions Provides extensions for DummyConnector and DummyConnectorFactory. DummyConnectorFactory Dummy connector factory class. Serves as offline connector with no connection to a controller. EnumeratorDiscriminatorAttribute Attribute provides information about the member being treated as enum. IgnoreReflectionAttribute Indicates that the member should not be reflected within the ix framework. IPlainExtensions Provides a series of extension methods to work with POCO objects. ITwinController Represents twin object for PLC controller. PrimitiveAccessStatus Provides information about access to a primitive item. ReadOnceAttribute Indicates that the member should be access only once throughout the life time of the application during periodic reading. This attribute would be typically used for members that do not change value during the life time of the application. ReadOnlyAttribute Attribute allows to prevent writing to the members of twin connector. ReadOnlyAttribute can be declared for member of a FB, GVL or STRUCT. note This attribute is typically defined in the declaration section of PLC block and then trans-piled by ixc builder. warning Use of ReadOnlyAttribute does not prevent the PLC program to write to the variable that declares this attribute. This example demonstrates declaration of ReadOnlyAttribute on a member of a FB. FUNCTION_BLOCK fbSomeReadOnlyMembers VAR {#ix-attr:[ReadOnly()]]} _nonWrittableItem : BOOL; // Member is readonly for .net application. {#ix-attr:[ReadOnly()]]} _nonWrittableFunctionBlock : fbNonWrittable; // Member and its members are readonly for the .net application. END_VAR RootTwinObject Object to represent the root TwinObject. Instance of this class is typically used as root for the connector object. StringInterpolator Provides extension methods for PLC's string interpolation. TwinObjectExtensions Extensions methods for ITwinObject. TwinPrimitiveExtensions Provides series of extension method for accessing primitive items. WebApiConnectorExtensions Provides extension methods for instantiating WebAPI connector. Interfaces IPlain Basic abstraction for 'Plain' types. note Implementation used in building process. Not to be declared by framework consumers. ITwinElement Basic contract for any type that is product of building process. ITwinObject Basic contract for any complex object that is product of build process. ITwinOnlineObject Basic abstraction for 'IOnline' types. note Implementation used in building process. Not to be declared by framework consumers. ITwinPrimitive Provides basic contract for plc tag. ITwinPrimitiveInfo Provides interface for information about value types symbols. ITwinShadowObject Basic abstraction for 'IShadow' types. note Implementation used in building process. Not to be declared by framework consumers. Enums CommExceptionBehaviour Specifies how the connector should behave when a communication exception occurs. CompilerOmissionGroups Builder omission groups enumerator. Enumerates builder output groups suitable for the omission. ReadSubscriptionMode Specifies how the variables should be subscribed to."
+ "keywords": "Namespace AXSharp.Connector Classes CompilerOmitsAttribute Prevents ixc builder to create a member for specific group of output type (Shadow, Plain, Onliner). note This attribute must be declared in the PLC code to be effective during build process. This example demonstrates how to prevent the ixc builder to compile specific property into specific output group. // This will not compile to 'omitsInPlainString' member into respective 'Plain' type. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer))]} ommitsInPlainString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; // This will not compile to 'ommitsInPlainAndShadowerInterfaceString' member into respective 'Plain' type and Shadow interface. {#ix-attr:[CompilerOmits(CompilerOmissionGroups.BuilderPlainer, CompilerOmissionGroups.BuilderShadowerInterface))]} ommitsInPlainAndShadowerInterfaceString : STRING(50) := 'THIS IS OMMITED IN PLAINER'; ConcurrentSet Concurent implementation HasSet comes from: https://stackoverflow.com/questions/18922985/concurrent-hashsett-in-net-framework https://stackoverflow.com/questions/4306936/how-to-implement-concurrenthashset-in-net Connector Abstract base class provides implementation contract for the PLC connector and basic common underlying logic. ConnectorAdapter Provides basic abstractions for twin connectors. ConnectorAdapterBuilder Provides access to extension method for creating connector adapters. ConnectorFactory Provides abstraction for creation of Connector and value types (tags) for twin connector. DummyConnector Provides a connector without real target system connections. DummyConnectorExtensions Provides extensions for DummyConnector and DummyConnectorFactory. DummyConnectorFactory Dummy connector factory class. Serves as offline connector with no connection to a controller. EnumeratorDiscriminatorAttribute Attribute provides information about the member being treated as enum. IgnoreOnPocoOperation This attribute will prevent R/W operation on on given member or type, when performing operation with POCO objects. IgnoreReflectionAttribute Indicates that the member should not be reflected within the ix framework. IPlainExtensions Provides a series of extension methods to work with POCO objects. ITwinController Represents twin object for PLC controller. PrimitiveAccessStatus Provides information about access to a primitive item. ReadOnceAttribute Indicates that the member should be access only once throughout the life time of the application during periodic reading. This attribute would be typically used for members that do not change value during the life time of the application. ReadOnlyAttribute Attribute allows to prevent writing to the members of twin connector. ReadOnlyAttribute can be declared for member of a FB, GVL or STRUCT. note This attribute is typically defined in the declaration section of PLC block and then trans-piled by ixc builder. warning Use of ReadOnlyAttribute does not prevent the PLC program to write to the variable that declares this attribute. This example demonstrates declaration of ReadOnlyAttribute on a member of a FB. FUNCTION_BLOCK fbSomeReadOnlyMembers VAR {#ix-attr:[ReadOnly()]]} _nonWrittableItem : BOOL; // Member is readonly for .net application. {#ix-attr:[ReadOnly()]]} _nonWrittableFunctionBlock : fbNonWrittable; // Member and its members are readonly for the .net application. END_VAR RootTwinObject Object to represent the root TwinObject. Instance of this class is typically used as root for the connector object. StringInterpolator Provides extension methods for PLC's string interpolation. TwinObjectExtensions Extensions methods for ITwinObject. TwinPrimitiveExtensions Provides series of extension method for accessing primitive items. WebApiConnectorExtensions Provides extension methods for instantiating WebAPI connector. Interfaces IPlain Basic abstraction for 'Plain' types. note Implementation used in building process. Not to be declared by framework consumers. ITwinElement Basic contract for any type that is product of building process. ITwinObject Basic contract for any complex object that is product of build process. ITwinOnlineObject Basic abstraction for 'IOnline' types. note Implementation used in building process. Not to be declared by framework consumers. ITwinPrimitive Provides basic contract for plc tag. ITwinPrimitiveInfo Provides interface for information about value types symbols. ITwinShadowObject Basic abstraction for 'IShadow' types. note Implementation used in building process. Not to be declared by framework consumers. Enums CommExceptionBehaviour Specifies how the connector should behave when a communication exception occurs. CompilerOmissionGroups Builder omission groups enumerator. Enumerates builder output groups suitable for the omission. ReadSubscriptionMode Specifies how the variables should be subscribed to."
},
"api/AXSharp.Connector.Identity.html": {
"href": "api/AXSharp.Connector.Identity.html",
@@ -339,6 +354,11 @@
"title": "Class TwinIdentityProvider | System.Dynamic.ExpandoObject",
"keywords": "Class TwinIdentityProvider Provides access to the objects by their identities. Inheritance object TwinIdentityProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector.Identity Assembly: AXSharp.Connector.dll Syntax public class TwinIdentityProvider Constructors | Improve this Doc View Source TwinIdentityProvider() Creates new instance of TwinIdentityProvider. Declaration [Obsolete(\"Use `TwinIdentityProvider(Connector connector)` instead.\")] public TwinIdentityProvider() | Improve this Doc View Source TwinIdentityProvider(Connector) Creates an instance of TwinIdentityProvider Declaration public TwinIdentityProvider(Connector connector) Parameters Type Name Description Connector connector Properties | Improve this Doc View Source Identities Get dictionary of identities. Declaration public SortedDictionary Identities { get; } Property Value Type Description System.Collections.Generic.SortedDictionary | Improve this Doc View Source IdentitiesCount Get count of identities. Declaration public long IdentitiesCount { get; } Property Value Type Description long Methods | Improve this Doc View Source AddIdentity(ITwinIdentity) Adds twin object to the list of identities. Declaration public void AddIdentity(ITwinIdentity twinObject) Parameters Type Name Description ITwinIdentity twinObject twin object | Improve this Doc View Source ConstructIdentitiesAsync() Refreshes and sorts identities. Declaration public Task ConstructIdentitiesAsync() Returns Type Description System.Threading.Tasks.Task | Improve this Doc View Source GetTwinByIdentity(ITwinIdentity) Gets twin object by identity. Declaration public dynamic GetTwinByIdentity(ITwinIdentity obj) Parameters Type Name Description ITwinIdentity obj Twin object. Returns Type Description dynamic Twin object with given identity. | Improve this Doc View Source GetTwinByIdentity(object) Gets twin object by identity, if the object implements ITwinIdentity. If object does not implements ITwinIdentity the same object is returned. Declaration public dynamic GetTwinByIdentity(object obj) Parameters Type Name Description object obj Object with identity Returns Type Description dynamic twin object with given identity. | Improve this Doc View Source GetTwinByIdentity(ulong) Gets twin object by identity. Declaration public ITwinIdentity GetTwinByIdentity(ulong identity) Parameters Type Name Description ulong identity Twin identity address. Returns Type Description ITwinIdentity Twin object with given identity."
},
+ "api/AXSharp.Connector.IgnoreOnPocoOperation.html": {
+ "href": "api/AXSharp.Connector.IgnoreOnPocoOperation.html",
+ "title": "Class IgnoreOnPocoOperation | System.Dynamic.ExpandoObject",
+ "keywords": "Class IgnoreOnPocoOperation This attribute will prevent R/W operation on on given member or type, when performing operation with POCO objects. Inheritance object System.Attribute IgnoreOnPocoOperation Inherited Members System.Attribute.Equals(object) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, bool) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.Assembly) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, bool) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, bool) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.Module) System.Attribute.GetCustomAttributes(System.Reflection.Module, bool) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, bool) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, bool) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.GetHashCode() System.Attribute.IsDefaultAttribute() System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, bool) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, bool) System.Attribute.IsDefined(System.Reflection.Module, System.Type) System.Attribute.IsDefined(System.Reflection.Module, System.Type, bool) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, bool) System.Attribute.Match(object) System.Attribute.TypeId object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax [AttributeUsage(AttributeTargets.Class|AttributeTargets.Property|AttributeTargets.Field)] public class IgnoreOnPocoOperation : Attribute Constructors | Improve this Doc View Source IgnoreOnPocoOperation() Creates new instance of IgnoreOnPocoOperation Declaration public IgnoreOnPocoOperation()"
+ },
"api/AXSharp.Connector.IgnoreReflectionAttribute.html": {
"href": "api/AXSharp.Connector.IgnoreReflectionAttribute.html",
"title": "Class IgnoreReflectionAttribute | System.Dynamic.ExpandoObject",
@@ -362,12 +382,12 @@
"api/AXSharp.Connector.ITwinElement.html": {
"href": "api/AXSharp.Connector.ITwinElement.html",
"title": "Interface ITwinElement | System.Dynamic.ExpandoObject",
- "keywords": "Interface ITwinElement Basic contract for any type that is product of building process. Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public interface ITwinElement Properties | Improve this Doc View Source AttributeName Gets Name of this instance. Declaration string AttributeName { get; } Property Value Type Description string | Improve this Doc View Source HumanReadable Provides a string combined from AttributeName of ancestors (GetParent()) of this instance and the tail of this instance. Declaration string HumanReadable { get; } Property Value Type Description string | Improve this Doc View Source Interpreter Declaration Translator Interpreter { get; } Property Value Type Description Translator | Improve this Doc View Source Symbol Get symbol of this instance. Declaration string Symbol { get; } Property Value Type Description string Methods | Improve this Doc View Source GetParent() Gets the parent object of this instance. Parent object is the object that created this instance. Declaration ITwinObject GetParent() Returns Type Description ITwinObject Parent object. | Improve this Doc View Source GetSymbolTail() Get symbol tail of this instance. Declaration string GetSymbolTail() Returns Type Description string | Improve this Doc View Source Poll() Add this element for polling the in the next connector read cycle. Declaration void Poll() Extension Methods TranslatorExtension.Translate(ITwinElement, string) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement)"
+ "keywords": "Interface ITwinElement Basic contract for any type that is product of building process. Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public interface ITwinElement Properties | Improve this Doc View Source AttributeName Gets Name of this instance. Declaration string AttributeName { get; } Property Value Type Description string | Improve this Doc View Source HumanReadable Provides a string combined from AttributeName of ancestors (GetParent()) of this instance and the tail of this instance. Declaration string HumanReadable { get; } Property Value Type Description string | Improve this Doc View Source Interpreter Declaration Translator Interpreter { get; } Property Value Type Description Translator | Improve this Doc View Source Symbol Get symbol of this instance. Declaration string Symbol { get; } Property Value Type Description string Methods | Improve this Doc View Source GetAttributeName(CultureInfo) Declaration string GetAttributeName(CultureInfo culture) Parameters Type Name Description System.Globalization.CultureInfo culture Returns Type Description string | Improve this Doc View Source GetHumanReadable(CultureInfo) Declaration string GetHumanReadable(CultureInfo culture) Parameters Type Name Description System.Globalization.CultureInfo culture Returns Type Description string | Improve this Doc View Source GetParent() Gets the parent object of this instance. Parent object is the object that created this instance. Declaration ITwinObject GetParent() Returns Type Description ITwinObject Parent object. | Improve this Doc View Source GetSymbolTail() Get symbol tail of this instance. Declaration string GetSymbolTail() Returns Type Description string | Improve this Doc View Source Poll() Add this element for polling the in the next connector read cycle. Declaration void Poll() Extension Methods TranslatorExtension.Translate(ITwinElement, string, CultureInfo) TwinObjectExtensions.HasAttribute(ITwinElement) TwinObjectExtensions.StartPolling(ITwinElement, int, object) TwinObjectExtensions.StopPolling(ITwinElement, object) TwinPrimitiveExtensions.GetAttribute(ITwinElement) TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement)"
},
"api/AXSharp.Connector.ITwinObject.html": {
"href": "api/AXSharp.Connector.ITwinObject.html",
"title": "Interface ITwinObject | System.Dynamic.ExpandoObject",
- "keywords": "Interface ITwinObject Basic contract for any complex object that is product of build process. Inherited Members ITwinElement.Symbol ITwinElement.AttributeName ITwinElement.HumanReadable ITwinElement.GetParent() ITwinElement.GetSymbolTail() ITwinElement.Poll() ITwinElement.Interpreter Namespace: AXSharp.Connector Assembly: AXSharp.Connector.dll Syntax public interface ITwinObject : ITwinElement Methods | Improve this Doc View Source AddChild(ITwinObject) Adds child object to the list of children of this object. GetChildren() note This method is used by the objects built in building process. Not to be used by framework consumers. Declaration void AddChild(ITwinObject twinObject) Parameters Type Name Description ITwinObject twinObject Child ITwinObject | Improve this Doc View Source AddKid(ITwinElement) Adds kid object to the list of kids of this object. note This method is used by the objects built in building process. Not to be used by framework consumers. Declaration void AddKid(ITwinElement kid) Parameters Type Name Description ITwinElement kid Child ITwinElement | Improve this Doc View Source AddValueTag(ITwinPrimitive) Adds child value tag to the list of value tags of this object. GetValueTags() note This method is used by the objects built in building process. Not to be used by framework consumers. Declaration void AddValueTag(ITwinPrimitive twinPrimitive) Parameters Type Name Description ITwinPrimitive twinPrimitive Child ITwinPrimitive | Improve this Doc View Source GetChildren() Gets all complex object that are created by this instance. Declaration IEnumerable GetChildren() Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source GetConnector() Gets the instance of the Connector class to which this ITwinObject belongs. Declaration Connector GetConnector() Returns Type Description Connector Connector | Improve this Doc View Source GetKids() Gets kids of this instance. Declaration IEnumerable GetKids() Returns Type Description System.Collections.Generic.IEnumerable | Improve this Doc View Source GetValueTags() Get all base type objects (tags) that are created by this instance. Declaration IEnumerable