• Articles
  • API reference
  • Previous Versions
Show / Hide Table of Contents
  • Connector
    • Vortex.Adapters.Connector.Tc3
      • AdsConnector
      • AdsConnector.OnAdsStateChangeDelegate
      • LiveClient
      • OnlineSymbolRetriever
      • OnlineVariableInfo
      • OnlineVariableInfo.SymbolLoaderSettings
      • ReportingConsole
      • ReportingConsole.UpdateStartUpDelegate
    • Vortex.Adapters.Connector.Tc3.Adapter
      • ConnectorFactory
      • SymbolLoadingMode
      • SymbolLoadMethod
      • Tc3ConnectorAdapter
    • Vortex.Adapters.Connector.Tc3.AdsExceptionsHandling
      • ExceptionHandler
    • Vortex.Adapters.Connector.Tc3.AdsValueTypes
      • AdsBit
      • AdsBool
      • AdsByte
      • AdsDate
      • AdsDateTime
      • AdsDInt
      • AdsDWord
      • AdsInt
      • AdsLInt
      • AdsLReal
      • AdsLTime
      • AdsLWord
      • AdsReal
      • AdsSInt
      • AdsString
      • AdsTime
      • AdsTimeOfDay
      • AdsUDInt
      • AdsUInt
      • AdsULInt
      • AdsUSInt
      • AdsWord
      • AdsWString
      • ClientSymbol
      • IAdsBaseType
    • Vortex.Adapters.Connector.Tc3Adapter.Adapter
      • NamespaceDoc
    • Vortex.Connector
      • CommStateEnum
      • ConnectorAdapter
      • DataExchangeStatusEnum
      • DummyConnector
      • DummyConnectorFactory
      • EnumeratorDiscriminatorAttribute
      • IConnector
      • IConnectorFactory
      • IgnoreReflectionAttribute
      • InterpolatedAncestor
      • InvalidLicenseConnector
      • InvalidLicenseConnectorAdapter
      • InvalidLicenseConnectorFactory
      • IPlain
      • ITwinController
      • ITwinObject
      • ITwinPrimitive
      • IValueTag
      • IValueTagExtensions
      • IValueTagInfo
      • IVortexElement
      • IVortexObject
      • IVortexObjectExtensions
      • IVortexOnlineObject
      • IVortexShadowObject
      • NamespaceDoc
      • RootVortexerObject
      • StringInterpolator
      • TypeComplexityEnum
    • Vortex.Connector.Attributes
      • AssemblyPlcCounterPart
      • CompilerOmissionGroups
      • CompilerOmitsAttribute
      • ReadOnlyAttribute
      • TypeMetaDescriptorAttribute
    • Vortex.Connector.Identity
      • IVortexIdentity
      • MemberByIdentityAttribute
      • NullVortexIdentity
      • VortexIdentityProvider
    • Vortex.Connector.LibraryDescriptors
      • TypeMetaData
    • Vortex.Connector.ValueTypes
      • NamespaceDoc
      • OnlinerBaseType
      • OnlinerBaseType.ValueChangeDelegate
      • OnlinerBaseType<T>
      • OnlinerBit
      • OnlinerBool
      • OnlinerByte
      • OnlinerDate
      • OnlinerDateTime
      • OnlinerDInt
      • OnlinerDWord
      • OnlinerInt
      • OnlinerLInt
      • OnlinerLReal
      • OnlinerLTime
      • OnlinerLWord
      • OnlinerReal
      • OnlinerSInt
      • OnlinerString
      • OnlinerTime
      • OnlinerTimeOfDay
      • OnlinerUDInt
      • OnlinerUInt
      • OnlinerULInt
      • OnlinerUSInt
      • OnlinerWord
      • OnlinerWString
      • ReadWriteAccess
      • ValueChangedEventArgs
      • ValueChangedEventHandlerDelegate
    • Vortex.Connector.ValueTypes.Online
      • IOnline<T>
      • IOnlineBit
      • IOnlineBool
      • IOnlineByte
      • IOnlineDate
      • IOnlineDateTime
      • IOnlineDInt
      • IOnlineDWord
      • IOnlineInt
      • IOnlineLInt
      • IOnlineLReal
      • IOnlineLTime
      • IOnlineLWord
      • IOnlineReal
      • IOnlineSInt
      • IOnlineString
      • IOnlineTime
      • IOnlineTimeOfDay
      • IOnlineUDInt
      • IOnlineUInt
      • IOnlineULInt
      • IOnlineUSInt
      • IOnlineWord
      • IOnlineWString
      • NamespaceDoc
    • Vortex.Connector.ValueTypes.Shadows
      • IShadow<T>
      • IShadowBit
      • IShadowBool
      • IShadowByte
      • IShadowDate
      • IShadowDateTime
      • IShadowDInt
      • IShadowDWord
      • IShadowInt
      • IShadowLInt
      • IShadowLReal
      • IShadowLTime
      • IShadowLWord
      • IShadowReal
      • IShadowSInt
      • IShadowString
      • IShadowTime
      • IShadowTimeOfDay
      • IShadowUDInt
      • IShadowUInt
      • IShadowULInt
      • IShadowUSInt
      • IShadowWord
      • IShadowWString
      • NamespaceDoc
    • Vortex.Connector.ValueValidation
      • BitValueValidationRule
      • BoolValueValidationRule
      • ByteValueValidationRule
      • DateTimeValueValidationRule
      • DateValueValidationRule
      • DintValueValidationRule
      • DWordValueValidationRule
      • IntValueValidationRule
      • IValueBoundaries<T>
      • LIntValueValidationRule
      • LRealValueValidationRule
      • LTimeValueValidationRule
      • LWordValueValidationRule
      • NamespaceDoc
      • OnlinerValidationRule<T>
      • RealValueValidationRule
      • SIntValueValidationRule
      • StringValueValidationRule
      • TimeOfDayValueValidationRule
      • TimeValueValidationRule
      • UDIntValueValidationRule
      • UIntValueValidationRule
      • ULIntValueValidationRule
      • USintValueValidationRule
      • ValidationResult
      • WordValueValidationRule
      • WStringValueValidationRule
    • Vortex.Localizations
      • IdentifierValidator
      • LocalizableItem
      • Localizables
      • LocalizationHelper
      • LocalizerDictionary
  • Presentation
    • Vortex.Presentation.Controls.Wpf
      • DateTimePickerBox
      • MultiConverter
      • TimePickerBaseBox
      • TimeTextBoxBaseBox
    • Vortex.Presentation.Controls.Wpf.Enumerators
      • EnumeratorContainer
      • EnumeratorContainerControlSlimView
      • EnumeratorContainerControlSlimViewModel
      • EnumeratorContainerControlView
      • EnumeratorContainerControlViewModel
      • EnumeratorContainerDisplaySlimView
      • EnumeratorContainerDisplaySlimViewModel
      • EnumeratorContainerDisplayView
      • EnumeratorContainerDisplayViewModel
      • EnumeratorContainerShadowControlSlimView
      • EnumeratorContainerShadowControlSlimViewModel
      • EnumeratorContainerShadowControlView
      • EnumeratorContainerShadowControlViewModel
      • EnumeratorContainerShadowDisplaySlimView
      • EnumeratorContainerShadowDisplaySlimViewModel
      • EnumeratorContainerShadowDisplayView
      • EnumeratorContainerShadowDisplayViewModel
      • EnumeratorContainerViewModel
      • EnumToIntConverter
    • Vortex.Presentation.Controls.Wpf.Extension
      • AttributeStringFormatExtensions
      • DateTimePicker
    • Vortex.Presentation.Controls.Wpf.OnlineControl
      • OnlineControlCheckBox
      • OnlineControlCheckBoxValue
      • OnlineControlDate
      • OnlineControlDateTime
      • OnlineControlLTime
      • OnlineControlTextBox
      • OnlineControlTextBoxValue
      • OnlineControlTime
      • OnlineControlTimeOfDay
      • OnlineControlTimeTextBox
    • Vortex.Presentation.Controls.Wpf.OnlineControls
      • OnlineControlSlimCheckBox
      • OnlineControlSlimCheckBoxValue
      • OnlineControlSlimDate
      • OnlineControlSlimDateTime
      • OnlineControlSlimLTime
      • OnlineControlSlimTextBox
      • OnlineControlSlimTextBoxValue
      • OnlineControlSlimTime
      • OnlineControlSlimTimeOfDay
    • Vortex.Presentation.Controls.Wpf.OnlineDisplay
      • OnlineDisplayCheckBox
      • OnlineDisplayTextBox
      • OnlineDisplayTextBoxValue
      • OnlineDisplayTimeTextBox
    • Vortex.Presentation.Controls.Wpf.ShadowControl
      • ShadowControlCheckBox
      • ShadowControlCheckBoxValue
      • ShadowControlDate
      • ShadowControlDateTime
      • ShadowControlLTime
      • ShadowControlTextBox
      • ShadowControlTextBoxValue
      • ShadowControlTime
      • ShadowControlTimeOfDay
      • ShadowControlTimeTextBox
    • Vortex.Presentation.Controls.Wpf.ShadowDisplay
      • ShadowDisplayCheckBox
      • ShadowDisplayTextBox
      • ShadowDisplayTextBoxValue
      • ShadowDisplayTimeTextBox
    • Vortex.Presentation.Controls.Wpf.Shared.Base
      • TimeAndDateConverterFactory
    • Vortex.Presentation.ControlSlims.Wpf
      • MultiConverter
    • Vortex.Presentation.ControlSlims.Wpf.OnlineDisplaySlim
      • OnlineDisplaySlimCheckBox
      • OnlineDisplaySlimTextBox
      • OnlineDisplaySlimTextBoxValue
      • OnlineDisplaySlimTimeTextBox
    • Vortex.Presentation.ControlSlims.Wpf.ShadowControlSlim
      • ShadowControlSlimCheckBox
      • ShadowControlSlimCheckBoxValue
      • ShadowControlSlimDate
      • ShadowControlSlimDateTime
      • ShadowControlSlimLTime
      • ShadowControlSlimTextBox
      • ShadowControlSlimTextBoxValue
      • ShadowControlSlimTime
      • ShadowControlSlimTimeOfDay
    • Vortex.Presentation.ControlSlims.Wpf.ShadowDisplaySlim
      • ShadowDisplaySlimCheckBox
      • ShadowDisplaySlimTextBox
      • ShadowDisplaySlimTextBoxValue
      • ShadowDisplaySlimTimeTextBox
    • Vortex.Presentation.Styling.Wpf
      • VortexResources
    • Vortex.Presentation.Styling.Wpf.Assist
      • DataGridAssist
    • Vortex.Presentation.Wpf
      • ActionRunner
      • ActionRunner.UserApprovedActionDelegate
      • BindableBase
      • ConsoleWriter
      • ConsoleWriterEventArgs
      • ContentOpeningMode
      • CreatorFailureDisplayBox
      • DateFormatConverter
      • DateTimeFormatConverter
      • EnumeratorHelper
      • EnumHelper
      • EnumToCollectionConverter
      • INavigable
      • LazyRenderer
      • MenuControlsHelper
      • MenuControlView
      • MenuControlViewModel
      • MenuControlViewTestViewModel
      • MenuRenderableControlViewModel
      • MvvmVisualState
      • NavCommand
      • NavigableRenderableViewModelBase
      • NavigableViewModelBase
      • PresentationHelper
      • RelayCommand
      • RelayCommand<T>
      • RenderableAssemblyAttribute
      • RenderableContentControl
      • RenderableContentDelayedControl
      • RenderableViewModel
      • RenderContentConverter
      • RenderContentDelayedConverter
      • Renderer
      • Renderer.BaseTypeProperies
      • Renderer.ComponentsCacheItem
      • ReportingLevel
      • SelectedButtonConverter
      • StartUpWindow
      • TestView
      • TimeFormatConverter
      • TooManyObjectsToRenderException
      • ValueDescription
      • WpfLayoutProvider
    • Vortex.Presentation.Wpf.Converters
      • BaseConverter
      • BaseMultiConverter
      • CapitalizeConverter

Class OnlineSymbolRetriever

Class provides access to the symbols accessible from the PLC controller.

Inheritance
System.Object
OnlineSymbolRetriever
Namespace: Vortex.Adapters.Connector.Tc3
Assembly: Vortex.Adapters.Connector.Tc3.dll
Syntax
sealed class OnlineSymbolRetriever

Fields

onlineVariableSymbolInfoList

Declaration
List<OnlineVariableInfo> onlineVariableSymbolInfoList
Field Value
Type Description
System.Collections.Generic.List<OnlineVariableInfo>

Properties

OnlineVariableSymbolInfoList

Declaration
List<OnlineVariableInfo> OnlineVariableSymbolInfoList
{
}
Property Value
Type Description
System.Collections.Generic.List<OnlineVariableInfo>

Methods

CreateSymbolInfo(IAdsSymbol, String, AdsClient)

Declaration
static OnlineVariableInfo CreateSymbolInfo(IAdsSymbol adsSymbolInfo, string symbol, AdsClient client)
Parameters
Type Name Description
TwinCAT.Ads.TypeSystem.IAdsSymbol adsSymbolInfo
System.String symbol
TwinCAT.Ads.AdsClient client
Returns
Type Description
OnlineVariableInfo

GetOnLineVariableSymbolInformation(String)

Declaration
OnlineVariableInfo GetOnLineVariableSymbolInformation(string symbol)
Parameters
Type Name Description
System.String symbol
Returns
Type Description
OnlineVariableInfo

LoadAllSymbolsWithSymbolInfoReader(AdsConnector)

Declaration
void LoadAllSymbolsWithSymbolInfoReader(AdsConnector connector)
Parameters
Type Name Description
AdsConnector connector

LoadOnLineSymbolList(AdsConnector)

The creates list of symbols present at the current Ads connection.

Declaration
void LoadOnLineSymbolList(AdsConnector connector)
Parameters
Type Name Description
AdsConnector connector

The connector.

Exceptions
Type Condition
System.Exception

Exception during symbol loading from the current Ads connection.

Extension Methods

IValueTagExtensions.Cast<T>(T, Object)
In This Article
Back to top

Generated by DocFX | Developed with ❤ at MTS - putting the heart into manufacturing.