Class CompilerOmitsAttribute

Prevents vortex 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 vortex builder to compile specific property into specific output group. 
    // This will not compile to 'omitsInPlainString' member into respective 'Plain' type.
    {attribute clr [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.
    {attribute clr [CompilerOmits(CompilerOmissionGroups.BuilderPlainer, CompilerOmissionGroups.BuilderShadowerInterface))]} 
    ommitsInPlainAndShadowerInterfaceString : STRING(50) := 'THIS IS OMMITED IN PLAINER';
Inheritance
System.Object
System.Attribute
CompilerOmitsAttribute
Inherited Members
System.Attribute.Equals(System.Object)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetHashCode()
System.Attribute.IsDefaultAttribute()
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Module, System.Type)
System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.Match(System.Object)
System.Attribute.TypeId
Namespace: Vortex.Connector.Attributes
Assembly: Vortex.Connector.dll
Syntax
[AttributeUsage(AttributeTargets.Property)]
public class CompilerOmitsAttribute : Attribute

Constructors

CompilerOmitsAttribute(String[])

Creates an instance of CompilerOmitsAttribute.

Declaration
public CompilerOmitsAttribute(params string[] omissions)
Parameters
Type Name Description
System.String[] omissions

Determines group(s) of output type where the member shall be omitted.

CompilerOmitsAttribute(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

Properties

Omissions

Gets the list of groups of output type in which the member will not be included.

Declaration
public IEnumerable<string> Omissions { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

Extension Methods