Namespace Vortex.Connector.Attributes

Classes

AssemblyPlcCounterPart

Provides meta information about Plc controller types that is linked to respective connector.

note

This attribute is not applicable in framework consumers code. It serves a purpose of providing information about the library metadata.

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';     

ReadOnlyAttribute

Attribute allows to prevent writing to the members of Vortex 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 Vortex.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
        {attribute clr [ReadOnly()]]}
        _nonWrittableItem : BOOL;       // Member is readonly for .net application.
        {attribute clr [ReadOnly()]]}
        _nonWrittableFunctionBlock : fbNonWrittable; // Member and its members are readonly for the .net application.
    END_VAR

TypeMetaDescriptorAttribute

Provides meta information about Plc controller type for the library compilation process.

note

This attribute is not applicable in framework consumers code. It serves a purpose of providing information about the library metadata.

Enums

CompilerOmissionGroups

Builder omission groups enumerator. Enumerates builder output groups suitable for the omission.