S7Explorer/DotNetSiemensPLCToolBoxLibr...

2423 lines
128 KiB
XML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0"?>
<doc>
<assembly>
<name>DotNetSiemensPLCToolBoxLibrary</name>
</assembly>
<members>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner">
<summary>
can scan an given ipadress/port conmbinations if they are available
</summary>
<remarks></remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.CheckTimeOut">
<summary>
specifies the timeout to wait before canceling an adress probing
</summary>
<value></value>
<returns></returns>
<remarks></remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.DiscoveredAdresses">
<summary>
contains all adresses, that have been found. the value is only valid after the scan is completed
</summary>
<value></value>
<returns></returns>
<remarks></remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.isRunning">
<summary>
specifies if the scanner is stll runing
</summary>
<value></value>
<returns></returns>
<remarks></remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.RunningThreadCount">
<summary>
specifies the amount of thread, currently running
</summary>
<value></value>
<returns></returns>
<remarks></remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.ThreadCount">
<summary>
Specifies the maximum amount of threads to use for the scanning
</summary>
<value></value>
<returns></returns>
<remarks></remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.BeginScan(System.Collections.Generic.List{System.Net.IPEndPoint})">
<summary>
Starts an asynchronous scanning of the given adresses
</summary>
<param name="AdressesToCheck"></param>
<remarks></remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.EndScan">
<summary>
blocks until the scan has completed
</summary>
<remarks></remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.AbortScan">
<summary>
tries to abort the adress scanning
</summary>
<remarks></remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.Scan(System.Collections.Generic.List{System.Net.IPEndPoint})">
<summary>
Starts an synchronous scan for the Adress range
</summary>
<param name="AdressesToCheck"></param>
<returns></returns>
<remarks></remarks>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.Discovery.IPScanner.ScannerWorker">
<summary>
Thread wrapper to wrap the thread and its local variables
</summary>
<remarks></remarks>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.libnodave.daveResOK">
Library specific:
*
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.libnodave.daveInterface.setTimeout(System.Int32)">
<summary>
Set the default Response timeout
</summary>
<param name="time">Time in Microseconds</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.libnodave.daveConnection.davePutNCProgram(System.String,System.String,System.String,System.Byte[],System.Int32)">
<summary>
Send File to NC
</summary>
<param name="filename">Path + Filename</param>
<param name="ts">DateTime: dt.ToString("yyMMddHHmmss")</param>
<param name="buffer">Filedata to send</param>
<param name="length">buffer.Length</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.libnodave.putS7Stringat(System.Byte[],System.Int32,System.String,System.Int32)">
<summary>
This put's a String as a S7 String to the PLC
</summary>
<param name="b"></param>
<param name="pos"></param>
<param name="value"></param>
<param name="length"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.libnodave.putStringat(System.Byte[],System.Int32,System.String,System.Int32)">
<summary>
This put's a String as a Char-Array to the PLC
</summary>
<param name="b"></param>
<param name="pos"></param>
<param name="value"></param>
<param name="length"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Library.ByteFunctions.putS7Stringat(System.Byte[],System.Int32,System.String,System.Int32)">
<summary>
This put's a String as a S7 String to the PLC
</summary>
<param name="b"></param>
<param name="pos"></param>
<param name="value"></param>
<param name="length"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Library.ByteFunctions.putStringat(System.Byte[],System.Int32,System.String,System.Int32)">
<summary>
This put's a String as a Char-Array to the PLC
</summary>
<param name="b"></param>
<param name="pos"></param>
<param name="value"></param>
<param name="length"></param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Library.ConnectionConfig.ConnectionType">
<summary>
1 = PG Connection, 2 = OP Connection
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Library.Interfaces.Interface.TimeOut">
<summary>
default 1,5s
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.SocketExtensions.SetKeepAlive(System.Net.Sockets.Socket,System.UInt64,System.UInt64)">
<summary>
Sets the keep-alive interval for the socket.
</summary>
<param name="socket">The socket.</param>
<param name="time">Time between two keep alive "pings".</param>
<param name="interval">Time between two keep alive "pings" when first one fails.</param>
<returns>If the keep alive infos were succefully modified.</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.Status">
<summary>
Status of the socket client
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.Status.DISCONNECTED">
<summary>client is not connected with the server</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.Status.LISTENING">
<summary>the client try to connect the server</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.Status.CONNECTING">
<summary>the client try to connect the server</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.Status.CONNECTED">
<summary>the client is connected</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.Networking.TCPFunctionsAsync.AllowMultipleClients">
<summary>
On a Socket Server, allow multiple Clients
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.#ctor(DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration,DotNetSiemensPLCToolBoxLibrary.Communication.LibNoDave.IDaveConnection)">
<summary>
Constructor for untiitests
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.#ctor(DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration)">
<summary>
Constructor wich uses a LibNoDavaeConnectionConfiguration from outside.
</summary>
<param name="akConfig"></param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.Connected">
<summary>
Is the Connection established?
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.Connect">
<summary>
Connect to the PLC with the selected Configuration
/// </summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.CheckConnection">
<summary>
Internal Helper function that checks if the PLC is connectec, reconnects automatially or throws an Exception
Call this function befor accessing the PLC Communication
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.Disconnect">
<summary>
This Disconnects from the PLC and the Adapter
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCStop">
<summary>
Stop execution of the User Program in the Controller
WARNING! use with caution!
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCStart">
<summary>
Start execution of the User Program in the Controller
WARNING! use with caution!
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCReadTime">
<summary>
Read the current time of the controllers system time
</summary>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCSetTime(System.DateTime)">
<summary>
Set the controllers current system time
</summary>
<param name="tm"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCstartRequestDiagnosticData(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7FunctionBlock,System.Int32,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7FunctionBlockRow.SelectedStatusValues)">
<summary>
This Starts a Request for the Status of a PLC FunctionBlock
</summary>
<param name="myBlock"></param>
<param name="StartAWLByteAdress"></param>
<param name="selRegister"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCSendPassword(System.String)">
<summary>
Send the password to the PLC for authentication. this is only necessary if the controllers password protection is active
</summary>
<param name="pwd"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetState">
<summary>
Get the current Execution status from the controller
</summary>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCListBlocks(DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockType)">
<summary>
Load an full or partial list of all currently loaded code and data blocks in the controller
</summary>
<param name="myBlk">the block type that will be listed</param>
<returns>Returns an list of string short names of the existing blocks such as "DB1" "FC987"...</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCListBlocks2(DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockType)">
<summary>
Load an full or partial list of all currently loaded code and data blocks in the controller
</summary>
<param name="myBlk">the block type that will be listed</param>
<returns>Returns an list of Block Names containing the block types and numbers</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetBlockCount">
<summary>
Returns the amount of blocks per block type in the PLC
</summary>
<returns>An Dictionary containing the block count for each Block type in the PLC</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetBlockHeader(System.String)">
<summary>
Load the basic header information from the PLC. This is more efficient than loading whole MC7 code from the plc
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetBlockHeader(DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockType,System.Int32)">
<summary>
Load the basic header information from the PLC. This is more efficient than loading whole MC7 code from the plc
</summary>
<param name="type"></param>
<param name="number"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetDataBlockSize(System.String)">
<summary>
Returns the data block size of th Requested data block
</summary>
<param name="BlockName">The short name representation of the data block. such as "DB1" or "DB992"</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetBlockInMC7(System.String)">
<summary>
Get the MC7 Code from the controller of the requested block. The MC7 code represents the whole code and all header information of the block
</summary>
<param name="BlockName">The short name representation of the data block. such as "DB1" or "DB992"</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCPutBlockFromMC7toPLC(System.String,System.Byte[])">
<summary>
Downloads an MC7 formatted block to the PLC. WARNING use with caution!
</summary>
<param name="BlockName">The short name representation of the data block. such as "DB1" or "DB992"</param>
<param name="buffer">An buffer containing the MC7 code of the block to download</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCDeleteBlock(System.String)">
<summary>
Deletes an code or data block from the connected controller. WARNING use with cation!
</summary>
<param name="BlockName">The short name representation of the data block. such as "DB1" or "DB992"</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetSZL(System.UInt16,System.UInt16)">
<summary>
Upload an System State list (SZL) from the controller that hold configuration, state and capability information
For information about SZLNummbers and indexes please consult the information from SIEMENS regarding SFC51 "RDSYSST"
</summary>
<param name="SZLNummer">The System State list Number</param>
<param name="Index">The System State sub list number</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetSZL(System.Int16,System.Int16)">
<summary>
Upload an System State list (SZL) from the controller that hold configuration, state and capability information
For information about SZLNummbers and indexes please consult the information from SIEMENS regarding SFC51 "RDSYSST"
</summary>
<param name="SZLNummer">The System State list Number</param>
<param name="Index">The System State sub list number</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCGetDiagnosticBuffer">
<summary>
Read the Controllers Diagnostic buffer containing controller events
</summary>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCCompressMemory">
<summary>
Compress the Memory of the PLC. This performs an "de-fragmentation" of the PLCs memory
in order to produce bigger "chunks" of free memory.
</summary>
<remarks>This function takes a very, very long time to process</remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.PLCCopyRamToRom">
<summary>
Copy the Content of the volatile RAM memory to the Non-volatile ROM memory
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValues(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag})">
<summary>
This Function Reads Values from the PLC it needs a Array of LibNodaveValues
It tries to Optimize how the Values are Read from the PLC
</summary>
<param name="valueList">The List of values to be read form the controller</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValuesWithCheck(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag},System.Boolean)">
<summary>
This function read Values from the PLC but also tries to verify the data-block sizes against
the current sizes in the controller. If an requested TAG exceeds the data-blocks current size
the item will be set to "ItemDoesNotExist". This will only affect Tags reading from data-blocks
</summary>
<param name="valueList">The list of tags to read from the controller</param>
<param name="cacheDbSizes">Read the data-blocks length and cache them for future requests.</param>
<remarks>This function potentially improves read performance when there are many tags with different data block length.
if the tag exceeds the data-blocks length, it will fail before sending it to the controller</remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValues(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag},System.Boolean)">
<summary>
This Function Reads Values from the PLC it needs a Array of LibNodaveValues
It tries to Optimize how the Values are Read from the PLC
</summary>
<param name="valueList">The List of values to be read form the controller</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValuesFetchWrite(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag},System.Boolean)">
<summary>
Read PLC Tags using the Fetch/Write mechanism
</summary>
<param name="valueList"></param>
<param name="useReadOptimization"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue(System.String,DotNetSiemensPLCToolBoxLibrary.DataTypes.TagDataType)">
<summary>
Read one single value from the PLC
</summary>
<param name="address">An Simatic Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag"/> for syntax</param>
<param name="type">The PLC data type to load and convert</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue``1(System.String,DotNetSiemensPLCToolBoxLibrary.DataTypes.TagDataType)">
<summary>
Read one single value from the PLC
</summary>
<param name="address">An Simatic Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag"/> for syntax</param>
<param name="type">The PLC data type to load and convert</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue(System.String)">
<summary>
Read one single value from the PLC
</summary>
<param name="address">An Simatic Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag"/> for syntax</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue``1(System.String)">
<summary>
Read one single value from the PLC
</summary>
<param name="address">An Simatic Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag"/> for syntax</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue(DotNetSiemensPLCToolBoxLibrary.Communication.NC_Var)">
<summary>
Read one single value from the NCK
</summary>
<param name="address">An Sinumerik Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCNckTag"/> for syntax</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue``1(DotNetSiemensPLCToolBoxLibrary.Communication.NC_Var)">
<summary>
Read one single value from the NCK
</summary>
<param name="address">An Sinumerik Address Identifier. see <seealso cref="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCNckTag"/> for syntax</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValue(DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag)">
<summary>
This Function Reads One LibNoDave Value from the PLC
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.ReadValuesFromByteArray(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag},System.Byte[],System.Int32)">
<summary>
This Function Reads a List of LibNoDaveValues from a Byte Array.
This can be used if you want to send Variables via a TCP Byte Stream from a PLC, and this
Function is also used for the optimized reading.
</summary>
<param name="values">List of the Values</param>
<param name="bytearray">ByteArray</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteValue(DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag)">
<summary>
Writes a single Value to the PLC
</summary>
<param name="value"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteQueueClear">
<summary>
Remove all PLC tags currently in the write Queue. This aborts the pending write requests.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteQueueAdd(DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag)">
<summary>
Add an new PLC tag to the Queue to be written to the PLC
</summary>
<param name="tag"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteQueueWriteToPLC">
<summary>
Write all pending PLC tags in the Queue to the PLC
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteValues(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag})">
<summary>
Write an list of values to the PLC
</summary>
<param name="valueList">The list of Values to write to the controller</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.WriteValues(System.Collections.Generic.IEnumerable{DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag},System.Boolean)">
<summary>
Write an list of values to the PLC
</summary>
<param name="valueList">The list of Values to write to the controller</param>
<param name="useWriteOptimation">If set to true, write optimation is enabled, but then, the order of your written values can varry, also a 4 byte value can be splittet written to the plc!</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.BinaryUploadFromNC(System.String,System.Boolean)">
<summary>
Load complete file from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.UploadFromNC(System.String,System.Boolean)">
<summary>
Load complete file from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.UploadFromNC(System.String,System.Int32,System.Boolean)">
<summary>
Load complete file from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="size">size of the file (buffer)</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.BinaryUploadNcFile(System.String,System.Int32,System.Boolean)">
<summary>
Load complete file from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="size">size of the file (buffer)</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.UploadNcFile(System.String,System.Int32,System.Boolean)">
<summary>
Load complete file from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="size">size of the file (buffer)</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.UploadNcFileSize(System.String,System.Boolean)">
<summary>
Load file size from NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="F_XFER">Start PI-Service F_XFER before upload</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnection.DownloadToNC(System.String,System.String,System.String)">
<summary>
Transfer file to NC
</summary>
<param name="fullFileName">full filename inc. path</param>
<param name="ts">DateTime Format: yyMMddHHmmss</param>
<param name="data">Data of the file</param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ConnectionName">
<summary>
Name of the connection. This value can be freely defined by the user
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.EntryPoint">
<summary>
the entry point of the Simatic NEt configuration to be used.
Please refer to the Simatic Net documentation for details.
by default is S7ONLINE
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.CpuRack">
<summary>
The Rack where the destination CPU is inserted. This value should be 0 in almost all cases.
Only in Multi CPU configurations this needs to be adjusted.
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.CpuSlot">
<summary>
The slot where the destination CPU is inserted in the selected Rack.
This value depends on the particular hardware configuration of the CPU.
Usually it is 2 for S7-300 CPUs and 3 for S7-400 CPUs
On Redundant H-CPU configurations this value must be set accordingly, in order for the comunication to work properly
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.CpuMpi">
<summary>
The MPI address of the remote CPU. this depends on the particular hardware configuration and is usually
set to 2 by default.
Only relevant for MPI connections
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.CpuIP">
<summary>
The IP-Adress or Hostname of the CPU's ethernet connection.
Only relevant for ISO over TCP connections.
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.Port">
<summary>
The TCP Port to be used for connecting the CPU via ISO over TCP.
This value usually should set to the default 102 (ISO Transport Service Access Point (TSAP) Class 0 protocol)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.LokalMpi">
<summary>
The local MPI Address to be used by the MPI adapter to comunicate with the CPU.
By convention the address 0 is reserved for Programing devices.
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ComPort">
<summary>
The Com port name where the MPI adapter is connected to.
if an RS232 to USB adapter is used (such as the Siamtic USB-MPI adapter)
the Virtual com port name of the adapter must be chosen.
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.PLCConnectionType">
<summary>
Defines the Connection resource to be used in the PLC
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ConnectionType">
<summary>
Defines how the connection to the PLC should be established
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.BusSpeed">
<summary>
defines the Bus speed for the connected MPI adapter
The default MPI bus speed is 19200 bit / second
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ComPortSpeed">
<summary>
defines the Bus speed for the connected MPI adapter
The default MPI bus speed is 19200 bit / second
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ComPortParity">
<summary>
Com port parity to use for MPI connection. By default MPI uses Even parity
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.Timeout">
<summary>
The timeout to wait for responses from the PLC
in microseconds
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.TimeoutMicroseconds">
<summary>
Used for serialization only.
</summary>
<remarks>The Problem is that the XML Serializer can not serialize Timespans. So serialize an "hidden" integer instead</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.TimeoutIPConnect">
<summary>
The default Timeout to be used for ISO over TCP conection
In miliseconds
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.TimeoutIPConnectMiliseconds">
<summary>
Used for serialization only.
</summary>
<remarks>The Problem is that the XML Serializer can not serialize Timespans. So serialize an "hidden" integer instead</remarks>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.#ctor">
<summary>
Empty Constructor for Serialization
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.#ctor(System.String)">
<summary>
Normal Constructor of the Config Object
</summary>
<param name="ConnectionName"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.#ctor(System.String,DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionConfigurationType)">
<summary>
Normal Constructor of the Config Object
</summary>
<param name="ConnectionName"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ExportConfigurations">
<summary>
Normal Constructor of the Config Object
</summary>
<param name="ConnectionName"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.ImportConfigurations(System.Collections.Generic.List{DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration})">
<summary>
Normal Constructor of the Config Object
</summary>
<param name="ConnectionName"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.LoadConfigFile(System.IO.TextReader)">
<summary>
Reads the configuration from an Stream
</summary>
<param name="strm"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.repairConfig(System.String)">
<summary>
Try to repair the configuration file if an error is encoutnerd
</summary>
<param name="original"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCConnectionConfiguration.fixEnum(System.String,System.String,System.Type)">
<summary>
Replace the numerical enumeration value with its textual Value
</summary>
<param name="original">The original Config file content to search in</param>
<param name="PropertyName">The Name of the property to replace the value on</param>
<param name="PropertyEnumType">The type of Enumeration of the property in question</param>
<returns></returns>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.MPI_über_Serial_Adapter">
<summary>
Connection via MPI adapter connected to an Serial Com Port
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.PPI_über_Serial_Adapter">
<summary>
Connection via PPI protocoll of an MPI/PB adapter. This is usually used for S7-200 family
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.AS_511">
<summary>
Connection via the AS511 Protocoll used by S5 series PLCs
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.Use_Step7_DLL">
<summary>
Connection via the Simatic Net libraries. Simatic Net must be installed
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.ISO_over_TCP">
<summary>
Connections via the TCP/IP protocoll
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionTypes.ISO_over_TCP_CP_243">
<summary>
Connections via TCP/IP to an CP243 for S7-200 series PLCs
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed">
<summary>
Communication Speeds for Profibus and MPI bus connection Adapters.
The possible speeds can not be chosen freely, but are rather defined by the ProfiBus Standard
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_9k">
<summary>
9.6 kbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_19k">
<summary>
19.2 kbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_187k">
<summary>
187,5 kbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_500k">
<summary>
0,5 Mbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_1500k">
<summary>
1.5 Mbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_45k">
<summary>
45.45 kbps
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionBusSpeed.Speed_93k">
<summary>
93.75 kbps
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource">
<summary>
Defines the type of connection resource to use for communiction with the PLC
Depending on the connection partner and connection type, the range of values is automatically limited to valid values or the value of the connection resource is assigned permanently.
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource.unknown">
<summary>
Unknown connection resource
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource.PG">
<summary>
Programming device connection
Free connection (not configured)
At least one resource per CPU is reserved for programming device connections. However, for certain S7-300 CPUs it is possible to reserve multiple resources in the CPU properties.
S7 connections that are typically set up from a programming device or from a PC (with ES functionality). This type of connection is used to configure and program the addressed station/module as well as to test and commission it;
afterwards, the connection is typically cleared again. This connection resource allows both read and write access (e.g., monitoring and loading).
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource.OP">
<summary>
OP connection
Free connection (not configured)
At least one resource per CPU is reserved for OP connections. However, for certain S7-300 CPUs it is possible to reserve multiple resources in the CPU properties.
S7 connections that are typically set up from an OP or from a PC (with OS functionality). This type of connection is used to monitor the addressed station/module with regard to the process that is being controlled.
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource.Other">
<summary>
Other
Free connection (configured, unspecified connection)
This connection resource can operate multiple connections. Use: Connection configured at one end with unspecified connection partner! The connection partner does not have to be configured if the connection resource 0x03 is addressed.
Use is not specified. For example, this resource is used automatically when an S7 connection configured at both ends is configured from an S7-400 to an S7-300.
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.Communication.LibNodaveConnectionResource.CPU">
<summary>
CPU
Connections that are typically set up from a CPU to another module (CPU, FM, etc.) within a subnet. The connection setup is initiated by the application program,
in which a connection configuration does not exist. This type of connection allows process data to be exchanged between the modules. For certain S7-300 CPUs, it is possible to reserve resources for S7 basic communication.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCNckTag.#ctor(DotNetSiemensPLCToolBoxLibrary.Communication.PLCNckTag,System.Object)">
<summary>
Create an new Nck tag from an existing one by copying its information
</summary>
<param name="oldTag"></param>
<param name="tag"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCNckTag.#ctor(DotNetSiemensPLCToolBoxLibrary.Communication.NC_Var,System.Object)">
<summary>
Create an new Nck tag from an existing one by copying its information
</summary>
<param name="ncVar"></param>
<param name="tag"></param>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag">
<summary>
Represents on single data Tag or data unit that can be read or written to the controller
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.ValueName">
<summary>
This is a Property which addresses the values you've read with a Name
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.ByteAddress">
<summary>
The byte offset or Byte address of the data in the controller. Represents the start of the data
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.BitAddress">
<summary>
Represents the Bit offset of the data int the controller. Only relevant for boolean values
Will be ignored for non boolean values
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.ItemDoesNotExist">
<summary>
The Item does not exist in the controller, or the data can not be read completely from the controller (byte size wrong,..)
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.#ctor">
<summary>
Create an new PLC Tag
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.#ctor(DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag)">
<summary>
Create an new PLC tag from an existing one by copying its information
</summary>
<param name="oldTag"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.#ctor(System.String,DotNetSiemensPLCToolBoxLibrary.DataTypes.TagDataType)">
<summary>
Create an new PLC Tag
</summary>
<param name="address">The Simatic Address for the data in the controller such as:
Inputs: I4.0, IB4, IW4 , ID4
Outputs: Q124.0, QB124, QW124, QD124
Markers: M11.0, MB10, MW10, MD10
Timers: T34
Counters: C23
Data Block: DB5.DBX2.0, DB5.DBW6
Arrays and String: "P#DB25.DBX0.0 BYTE 14"; "P#M0.0 WORD 2"; "P#I0.0 DWORD 5"
</param>
<param name="type">The data type to be read from the Controller</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.#ctor(System.String)">
<summary>
The initalizationString can be a PLC Address like: "DB100.DBW2" or a init String like: "User,DB100.DBW2,Word,Decimal"
</summary>
<param name="initalizationString"></param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.DataBlockNumber">
<summary>
The Data block number of the tag. If the TagDataSource is not in an data-block this number is 0
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.TagDataSource">
<summary>
Specifies the area where the PLCTags data is located in the controller
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.DataTypeStringFormat">
<summary>
The tats display type. Defines how the tags data should be represented
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.TagDataType">
<summary>
The type of data of the tag
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.OldValues">
<summary>
An list of values of the previous read requests from the controller
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.BackupValuesCount">
<summary>
Sets or gets the amount of values to be kept as oldValues after each read request
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.DontSplitValue">
<summary>
This Tag can not be splittet into more then one PDU (if there are a few rest Bytes in a PDU aviable)
--> If this is set, the Tag is not allowed to be bigger!
This bit should be set in all Tags wich are used for indirect Addressing! (Becaus eit could be you read 2 bytes of a double, then the value chages in the plc, then you read the rest!)
This is also used when Writing the Value, and when set, it is not splitted. When the Value is bigger then a PDU, an error occurs
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.ArraySize">
<summary>
Defines the length of Array data types. Only valid (and used!) with String, CharArray and ByteArray Type!
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag._setValueProp">
<summary>
Helper Property to Set the Value, because the Setter of the normal Value Sets Control Value!
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.Value">
<summary>
Value of the Tag. The Setter of this Property sets Controlvalue, because the Tag firstly got this Value when it's written!
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag.ParseValueFromByteArray(System.Byte[],System.Int32)">
<summary>
This Parses the PLCTag From a Byte Array
this is used, when the Tag is not Read via my Functions, but the PLCTags are used as Wrapper
</summary>
<param name="buff"></param>
<param name="startpos"></param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag`1.FromBytes(System.Type,System.Byte[],System.Int32)">
<summary>
Creates a struct of a specified type by an array of bytes.
</summary>
<param name="structType">The struct type</param>
<param name="bytes">The array of bytes</param>
<returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag`1.GetStructSize(System.Type)">
<summary>
Gets the size of the struct in bytes.
</summary>
<param name="structType">the type of the struct</param>
<returns>the number of bytes</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTag`1.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="structValue">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.Communication.PLCTagReadHelper">
<summary>
This is a internal used Tag for Read optimazions
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.Index">
<summary>
· Byte 1: B#16#04: CPU-Schutzstufe, Bedienschalterstellungen und Prüfsummen
· Byte 0:Standard-CPU: B#16#00H-CPU: Bits 0 bis 2: Baugruppenträger-Nr.Bit 3: 0 = Reserve-CPU, 1 = Master-CPUBits 4 bis 7: 1111
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.sch_schal">
<summary>
Durch Betriebsartenschalter eingestellte Schutzstufe (1, 2, 3)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.sch_par">
<summary>
Parametrierte Schutzstufe (0, 1, 2, 3; 0: kein Paßword vergeben, parametrierte Schutzstufe ungültig).
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.sch_rel">
<summary>
Gültige Schutzstufe der CPU
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.bart_sch">
<summary>
Stellung des Betriebsartenschalters (1:RUN, 2:RUN-P, 3:STOP, 4:MRES, 0:undefiniert bzw. nicht ermittelbar)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.anl_sch">
<summary>
Stellung des Anlaufartenschalters (1:CRST, 2:WRST, 0:undefiniert, nicht vorhanden oder nicht ermittelbar)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_f">
<summary>
Reserviert
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_rel">
<summary>
Kennung für die Gültigkeit der vier folgenden Prüfsummen (0: ungültig)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_ver1_hw">
<summary>
Prüfsumme 1 der Hardwarekonfiguration (Intel-Format):Exklusiv-Oder-Verknüpfung über die Längen aller Systemdatenbausteine
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_ver2_hw">
<summary>
Prüfsumme 2 der Hardwarekonfiguration (Intel-Format):Exklusiv-Oder-Verknüpfung über die Prüfsummen aller Systemdatenbausteine
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_ver1_awp">
<summary>
Prüfsumme 1 des Anwenderprogramms (Intel-Format):Exklusiv-Oder-Verknüpfung über die Längen der folgenden Bausteine: OBs, DBs, FBs, FCs
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.ken_ver2_awp">
<summary>
Prüfsumme 2 des Anwenderprogramms (Intel-Format):Exklusiv-Oder-Verknüpfung über die Prüfsummen der folgenden Bausteine: OBs, DBs, FBs, FCs
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.res">
<summary>
Reserviert
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.sfc_req">
<summary>
Anforderung von Schutzstufe 2 bzw. 3 durch SFC 109 (1: Anforderung ist erfolgt)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.sfc_act">
<summary>
Aktivierung von Schutzstufe 2 bzw. 3 durch SFC 109 (1: Aktivierung ist erfolgt)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.Communication.S7_xxx.xy32_4Dataset.res2">
<summary>
Reserviert
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.AWL.Step7V5.S7ConvertingOptions">
<summary>
Options that define how Step7 Project will behave when opened by this library.
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.AWL.Step7V5.S7ConvertingOptions.UseFBDeclarationForInstanceDB">
<summary>
use the FB instance declartion symbolics for displaying Instance DB Variables
Otherwise it is using the Symbolics stored for each individual instance DB, which may be different than the Function Block
The Step7 Default is TRUE. Simatic Manager always shows the FB declarations.
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Block">
<summary>
Base Block for all Blocks, Subblocks are VATBlock, FunctionBlock, DataBlock, (DataBlockS5, FunctionBlockS5 maybe)
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.IProjectBlockInfo">
<summary>
This can be Information about a PLC Block (DB, FC,...) or a Block in the Source Folder
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo">
<summary>
This can be Information about a PLC Block (DB, FC,...) or a Block in the Source Folder
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step5.S5Parameter">
<summary>
Description of S5Parameter.
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step5.S5ParameterFormat">
<summary>
Description of S5ParameterFormat.
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step5.S5ParameterType">
<summary>
Description of S5ParameterType.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V11.TIADataBlock.GetArrayExpandedStructure(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataBlockExpandOptions)">
<summary>
With this function you get the Structure with expanden Arrays!
</summary>
<returns></returns>
</member>
<!-- Badly formed XML comment ignored for member "M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V11.TIADataRow.ClearBlockAddress" -->
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.BlockVersion">
<summary>
The blocks version
</summary>
<remarks>This field does not correspond to the Version field in Simatic Manager</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.BlockAttribute">
<summary>
The Block Attributes that contain information about the block status and special properties
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Attributes">
<summary>
The Block Attributes defined from the Simatic Manager in Attributes Tab
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Length">
<summary>
The total lenght of the Block. Correspnds to the "Load Memory Requirement" in Simatic Manager
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Title">
<summary>
The Title of the Block from the S7 Project file. it is not the online name of the block.
</summary>
<remarks>The Header name of an online block is in the "Name" field</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Author">
<summary>
The Author of the Block
</summary>
<remarks>Limited to 8 chars</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Family">
<summary>
The Family of the Block
</summary>
<remarks>Limited to 8 chars</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.Version">
<summary>
The version of the Block
</summary>
<remarks>Limited from 0.0 to 9.9</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.LastCodeChange">
<summary>
Timestamp of the last change to the blocks MC7 code
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.LastInterfaceChange">
<summary>
Timestamp of the last change to the interface of the blocks
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.LastInterfaceChangeHistory">
<summary>
Timestamp of the last interface change associated with the plaintext database record
If a block is uploaded to the project with a timestamp conflict, this field contains the previous modified date of the interface before the upload
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.InterfaceSize">
<summary>
The total size of the Interface table
</summary>
<remarks>this is an internal property, that is not shown in Simatic Manager</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.SegmentTableSize">
<summary>
The total size of the Segement table in the header
</summary>
<remarks>this is an internal property, that is not shown in Simatic Manager</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.LocalDataSize">
<summary>
The size of the local Temp data stack. Only aplicable to OB, FC or FB blocks
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.CodeSize">
<summary>
The actual MC7 code size of the block. This corresonds to the "MC7" field in Simatic Manager
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.WorkMemorySize">
<summary>
the Work memory requirement from Simatic Manager
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.KnowHowProtection">
<summary>
The block has currently set an Password
</summary>
<remarks>be aware that the block can also be be marked as protected via the "BlockAttributes"</remarks>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.CheckSum">
<summary>
The checksum of the Blocks MC7 code (without the actual values of Datablocks)
This property can be used to detect Block changes
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.S7BlockAtributes.Linked">
<summary>
The block exists in the controller, and is also linked into execution.
if this attribute is FALSE:
-For Code blocks such as FB or FC, this means that they are existing in the controller but not actually executed
-For data blocks this means, that they do not have any Actual values assigned to them. Any attempt to read current data from them will fail.
</summary>
<remarks>
This corresponds to the "Unlinked" attribute in the Simatic manager, which actually shows the status in reverse
This Attribute is only false when either especifically selected from simatic manager (only possible for Datablocks)
or during a breif period when an Code block is alrady downloaded, but not yet linked (usually part of the "Block Download" process
</remarks>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.S7BlockAtributes.StandardBlock">
<summary>
This is an standard block from the default library
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.S7BlockAtributes.KnowHowProtected">
<summary>
The block is protected by an Password
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.S7BlockAtributes.NonRetain">
<summary>
Only applies to datablocks. if an DB is non retentive, its actual data get reset to its initial values every time the controller
restarts
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.S7BlockAtributes.FBlock">
<summary>
This is an Safety Block in an Safety PLC.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block.HasTimestampConflict(System.DateTime,System.DateTime)">
<summary>
Returns true if dt1 and dt2 are not equal
Also checks that both values are not the default value (DateTime.MinValue)
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataBlock.GetArrayExpandedStructure(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataBlockExpandOptions)">
<summary>
With this function you get the Structure with expanden Arrays!
</summary>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRow.ClearBlockAddress">
<summary>
This function is used, when a Member is added or Removed, or the Type is changed so the the Addresses are recalculated!
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRowType.MultiInst_FB">
<summary>
an declaration for an FB as Multi instance parameter. May only occur in STATIC Block declaration
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRowType.MultiInst_SFB">
<summary>
an declaration for an System-FB as Multi instance parameter. May only occur in STATIC Block declaration
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7FunctionBlockRow.GetNumberOfLines">
<summary>
Returns the Number of Lines this Command needs (Calls needs more then 1 Line)
</summary>
<returns></returns>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaNCK">
<summary>
N: NC Daten
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaBag">
<summary>
B: Daten Betriebsartengruppe
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaChannel">
<summary>
C: Kanalzugeordnete Daten
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaAxis">
<summary>
A: Achsspezifische Grundeinstellungen
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaTool">
<summary>
T: Wergzeugdaten
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaFeedDrive">
<summary>
V: Vorschubantrieb
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaMainDrive">
<summary>
H: Hauptantrieb
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaMMC">
<summary>
M: MMC-Daten
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.NCK_Area.AreaUnknown">
<summary>
?: Unbekannt
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockName">
<summary>
Represents an PLC Block type and name
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockName.BlockType">
<summary>
The type of Block
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockName.BlockNumber">
<summary>
The number of the Block
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage">
<summary>
The programming language in which an S7Block was created
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.AWL">
<summary>
"Anweisungsliste" or AWL for short. The English term is
"Statement list" or STL
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.KOP">
<summary>
"Kontaktplan" or KOP for short. The English term is
"Ladder" or Lad
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FUP">
<summary>
"Funktionsplan" or FUP for short. The English term is
"Functional Block diagram" or FDB
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.SCL">
<summary>
"Structured Text" or SCL for short
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.DB">
<summary>
The Datablock declaration language. Only used for Datablocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.GRAPH">
<summary>
Graphset language
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.CFC">
<summary>
Continous Function Chart
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.SFC">
<summary>
Sequencial Funcion Chart
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FAWL">
<summary>
Same as AWL but for Safty blocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FKOP">
<summary>
Same as KOP but for Safty blocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FFUP">
<summary>
Same as FUP but for Safty blocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FSCL">
<summary>
Same as SCL but for Safty blocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FDB">
<summary>
Same as DB but for Safty blocks
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCLanguage.FCALL">
<summary>
F-Call blocks are special code blocks that are neceseary to Execute Safty Programms
Only applicable on Safety CPU's
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.IProgrammFolder">
<summary>
This is the Main Folder, it Contains a BlockInfos Folder and a Symbol Table!
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.ProjectFolder">
<summary>
Base Abstract Class for every Project Folder.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.intReadPlcBlocksList">
<summary>
Read all blocks from the S7 Project and cache them into the 'tmpBlocks' field.
</summary>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.TmpBlock">
<summary>
Help class, used to hold unparsed raw data read from the S7 Project files from disk
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlockBytes(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo)">
<summary>
Reads the raw data from the S7 Project files, without parsing the data
</summary>
<param name="blkInfo">The Block info object that identifies the block to read from Disk</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlockBytes(System.String)">
<summary>
Reads the raw data from the S7 Project files, without parsing the data
</summary>
<param name="blkName">The blockname to be read from disk. eg. DB2, FB38....</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlock(System.String)">
<summary>
Reads an Block from the Project and returns the block data that is stored in the S7 Project
</summary>
<param name="BlockName">The blockname to be read from disk. eg. DB2, FB38....</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlock(System.String,DotNetSiemensPLCToolBoxLibrary.DataTypes.AWL.Step7V5.S7ConvertingOptions)">
<summary>
Reads an Block from the Project and returns the block data that is stored in the S7 Project
</summary>
<param name="BlockName">The blockname to be read from disk. eg. DB2, FB38....</param>
<param name="myConvOpt">Defines options that determine how the Block will be converted</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlock(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo)">
<summary>
Reads an Block from the Project and returns the block data that is stored in the S7 Project
</summary>
<param name="blkInfo">The Block info object that identifies the block to read from Disk</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetBlock(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo,DotNetSiemensPLCToolBoxLibrary.DataTypes.AWL.Step7V5.S7ConvertingOptions)">
<summary>
Reads an Block from the Project and returns the block data that is stored in the S7 Project
</summary>
<param name="blkInfo">The Block info object that identifies the block to read from Disk</param>
<param name="myConvOpt">Defines options that determine how the Block will be converted</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetInterfaceStructureFromMC7(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo,DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.TmpBlock,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block,System.Collections.Generic.List{System.String}@)">
<summary>
Converts the MC7 code of the block interface to S7DataRow
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder.GetSourceBlock(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.ProjectBlockInfo,System.Boolean)">
<summary>
With this Function you get the AWL Source of a Block, so that it can be imported into Step7
</summary>
<param name="blkInfo">The BlockInfo from the Block you wish to get the Source of!</param>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.Step7ProjectFolder">
<summary>
Base Abstract Class for every Project Folder.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.SymbolTable.GetSymbolTableAsSdf">
<summary>
Returns the symbol list as a string that
is formatted in the same way as an export from
the Simatic Symbol Editor when saving it as .SDF
(System Data Format) type.
</summary>
<param name="language"></param>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType">
<summary>
Data type of an field / key
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.B">
<summary>
Binary
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.C">
<summary>
String
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.D">
<summary>
Date (YYYYMMDD)
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.N">
<summary>
Number (Double)
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.F">
<summary>
Float
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.L">
<summary>
Logical (Boolean) Byte
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.M">
<summary>
Memo
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.dBaseType.T">
<summary>
DateTime
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat">
<summary>
Format of a tag header key
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat.RLDT">
<summary>
Right, Left, DTOC
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat.Descending">
<summary>
Descending
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat.String">
<summary>
String
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat.Distinct">
<summary>
Distinct
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagHeaderKeyFormat.Unique">
<summary>
Unique
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagKeyFormat">
<summary>
The format of the index key
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagKeyFormat.Calculated">
<summary>
Calculated
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Enums.TagKeyFormat.DataField">
<summary>
DataField
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.BTree.findPosition(DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeKey)">
<summary>
Find te position of a Key within the BinaryTree
</summary>
<param name="KeyToFind">The key to find</param>
<returns>The BinaryTree Node that contains the Key</returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.BTree.Key">
<summary>
The NodeKey of this BinaryTree
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.BTree.Least">
<summary>
Get the least tree (furthest away from root)
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.BTree.Next">
<summary>
Get the highest tree (closest to the root or root)
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.next_available">
<summary>
Address of the next available node
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.shortKeyLength">
<summary>
Length of a key without overhead
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.shortKeysPerNode">
<summary>
Number of Keys per Page/Node
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.objKeyType">
<summary>
Datatype of the Key
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.key_entry_size">
<summary>
Length of a key entry (must be devidable by 4)
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.unique_key">
<summary>
Is this Index a unique key?
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.key_definition">
<summary>
Syntax definition of the key
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.BuildKey">
<summary>
Builds a NodeKey from this Index
</summary>
<returns>The created NodeKey</returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.Index.IsUnique">
<summary>
Tells if the Key is unique or not
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MDX">
<summary>
A MDX-Structure (Part of a MDX-File)
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MDX.Read(System.IO.BinaryReader,System.Byte,System.Int32)">
<summary>
Read the MDX subentry from the parent MDXFile structure
</summary>
<param name="Reader">A binary reader that contains the filestream of the MDX File</param>
<param name="LengthOfTagTableHeader">The byte length of the TagTableHeader</param>
<param name="StartPosition">The start position of the first tag table header</param>
<returns>"True" if the operation was successfull</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MDXFile">
<summary>
Represents a complete MDX file, containing all sub indexes, headers and read / write methods
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MDXFile.Finalize">
<summary>
Destructor
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MDXFile.Dispose">
<summary>
Dispose this object
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MNode.Read(System.IO.BinaryReader)">
<summary>
Read node from the parent MDX Entry
</summary>
<param name="Reader">The BinaryReader that contains the MDXFile Stream</param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MNode.LowerLevel">
<summary>
Sets / Returns the next lower level of the b-tree structrue, containing the nodes
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.MDX.MNode.PreviousPage">
<summary>
Sets / Returns the previous node page of the index
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat">
<summary>
Custom Type to represent Step7 float datatype with integrated conversion functions.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.#ctor(System.Byte[])">
<summary>
Create a float from a byte array, containing a S7 float value
</summary>
<param name="ByteValue">The BCD byte array</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.#ctor(System.Double)">
<summary>
Create a float from a double value
</summary>
<param name="DoubleValue">The double value to create the float from</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.CompareTo(System.Object)">
<summary>
Compare this NodeFloat object against another
</summary>
<param name="obj">The NodeFloat object you want to compare</param>
<returns></returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.GetDouble">
<summary>
The value of this NodeFloat as Double
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.GetString">
<summary>
The value of this NodeFloat as String
</summary>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeFloat.GetByteArray">
<summary>
The value of this NodeFloat as byte array
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Index.NodeKey">
<summary>
A node key with a dynamic type (string, float, double)
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.ParseDBF.WriteValue(System.String,System.String,System.Int32,System.Object,DotNetSiemensPLCToolBoxLibrary.General.ZipHelper,System.Char)">
<summary>
This Function Writes directly to a DBF File.
It reads the Field list, and writes to the correct position.
To access the deleted flag, use DELETED_FLAG as column Name
</summary>
<param name="dbfFile"></param>
<param name="column"></param>
<param name="row"></param>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.DBFHeader">
<summary>
The header of a DBF file
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.DBT.DBTHeader">
<summary>
The header of a DBT file
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.DBT.MemoHeader">
<summary>
The header of a memo
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.FieldDescriptor">
<summary>
The DBF field descriptor structure. There will be one of these for each column in the table.
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDX4TagTableHeader">
<summary>
A MDX4 Tag Table Header
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDX4TagTableHeader.Read(System.IO.BinaryReader,System.Byte,System.Int32)">
<summary>
Extracts a MDX4TagTableHeader from a Stream
</summary>
<param name="Reader">The BinaryReader that contains the MDX4TTH structure</param>
<param name="LengthOfTags">The total length of a single MDX4TTH structrue + overhead</param>
<param name="StreamPosition">The start position in the stream</param>
<returns>An MDX4TagTableHeader structure or null (if the operation failed)</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDX7TagTableHeader">
<summary>
A MDX7 Tag Table Header
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDX7TagTableHeader.Read(System.IO.BinaryReader,System.Byte,System.Int32)">
<summary>
Extracts a MDX7TagTableHeader from a Stream
</summary>
<param name="Reader">The BinaryReader that contains the MDX7TTH structure</param>
<param name="LengthOfTags">The total length of a single MDX7TTH structrue + overhead</param>
<param name="StreamPosition">The start position in the stream</param>
<returns>An MDX7TagTableHeader structure or null (if the operation failed)</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDXHeader">
<summary>
A MDX file header
</summary>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDXTagHeader">
<summary>
A MDX tag header
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDXTagHeader.Read(System.IO.BinaryReader,System.Int32)">
<summary>
Extracts a MDXTagHeader from a Stream
</summary>
<param name="Reader">The BinaryReader that contains the MDXTH structure</param>
<param name="LengthOfTags">The total length of a single MDXTH structrue + overhead</param>
<param name="StreamPosition">The start position in the stream</param>
<returns>An MDXTagHeader structure or null (if the operation failed)</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.Structures.MDX.MDXTagHeader.Write(System.IO.BinaryWriter)">
<summary>
Write this MDXTagHeader to the current position of a Stream
</summary>
<param name="Writer">A BinaryWriter to write the MDXTH to</param>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter">
<summary>
Contains functions to convert dBase data types to .NET types and the other way around
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.L_ToBool(System.Byte)">
<summary>
Converts a logical byte ('L') to a boolean value
</summary>
<param name="dBaseByte">the logical byte from dBase</param>
<returns>The boolean value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.L_FromBool(System.Boolean)">
<summary>
Converts a boolean value to a dBase logical byte
</summary>
<param name="dBaseByte">The boolean value to convert</param>
<returns>A dBase logical byte</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.F_ToDouble(System.Byte[])">
<summary>
Converts a float byte array('F') to a double value
</summary>
<param name="dBaseByte">The float byte array from dBase</param>
<returns>The double value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.F_FromDouble(System.Double)">
<summary>
Converts a double value to a dBase Float byte array
</summary>
<param name="DoubleToConvert">The double value to convert</param>
<returns>A dBase float byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.T_ToDateTime(System.Byte[])">
<summary>
Converts a timestamp byte array('T') to a datetime value
</summary>
<param name="dBaseTimeBytes">The timestamp byte array from dBase(8 bytes long)</param>
<returns>The datetime value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.T_FromDateTime(System.DateTime)">
<summary>
Converts a datetime value to a dBase timestamp byte array
</summary>
<param name="DateTimeToConvert">The double value to convert</param>
<returns>A dBase float byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.C_ToString(System.Byte[],System.Text.Encoding)">
<summary>
Converts a character byte array('C') to a string value
</summary>
<param name="dBaseCharacterBytes">The character byte array from dBase</param>
<returns>A string value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.C_FromString(System.String)">
<summary>
Converts a string value to a dBase character byte array
</summary>
<param name="StringToConvert">The string value to convert</param>
<returns>A dBase character byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.D_ToDateTime(System.Byte[])">
<summary>
Converts a datetime byte array('D') to a DateTime value
</summary>
<param name="dBaseDateTimeBytes">The datetime byte array from dBase</param>
<returns>A datetime value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.D_FromDateTime(System.DateTime)">
<summary>
Converts a DateTime value to a dBase datetime byte array
</summary>
<param name="DateTimeToConvert">The DateTime value to convert</param>
<returns>A dBase DateTime byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.N_IsDecimal(System.Byte[])">
<summary>
Differentiate between Integer or Decimal numbers comming from dBase
</summary>
<param name="dBaseNumberBytes">the number byte array from dBase</param>
<returns>True if the submittet byte array is a decimal number</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.N_ToDecimal(System.Byte[])">
<summary>
Converts a number byte array('N') to a Decimal value
</summary>
<param name="dBaseNumberBytes">The number byte array from dBase</param>
<returns>A Decimal value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.N_ToInt(System.Byte[])">
<summary>
Converts a number byte array('N') to a Integer value
</summary>
<param name="dBaseNumberBytes">The number byte array from dBase</param>
<returns>A Integer value</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.N_FromNumber(System.Decimal)">
<summary>
Converts a Decimal value to a dBase datetime byte array
</summary>
<param name="DecimalToConvert">The decimal value to convert</param>
<returns>A dBase number byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.N_FromNumber(System.Int32)">
<summary>
Converts a Integer value to a dBase datetime byte array
</summary>
<param name="IntToConvert">The integer value to convert</param>
<returns>A dBase number byte array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.DBF.dBaseConverter.JulianToDateTime(System.Int64)">
<summary>
Convert a Julian Date to a .NET DateTime structure
Implemented from pseudo code at http://en.wikipedia.org/wiki/Julian_day
</summary>
<param name="lJDN">Julian Date to convert (days since 01/01/4713 BC)</param>
<returns>DateTime</returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream">
<summary>
Defines a MemoryStream that does not sit on the Large Object Heap, thus avoiding memory fragmentation.
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.DefaultChunkSize">
<summary>
Defines the default chunk size. Currently defined as 0x10000.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.#ctor">
<summary>
Initializes a new instance of the <see cref="T:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream"/> class.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream"/> class.
</summary>
<param name="chunkSize">Size of the underlying chunks.</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.#ctor(System.Byte[])">
<summary>
Initializes a new instance of the <see cref="T:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream"/> class based on the specified byte array.
</summary>
<param name="buffer">The array of unsigned bytes from which to create the current stream.</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.#ctor(System.Int32,System.Byte[])">
<summary>
Initializes a new instance of the <see cref="T:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream"/> class based on the specified byte array.
</summary>
<param name="chunkSize">Size of the underlying chunks.</param>
<param name="buffer">The array of unsigned bytes from which to create the current stream.</param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.FreeOnDispose">
<summary>
Gets or sets a value indicating whether to free the underlying chunks on dispose.
</summary>
<value><c>true</c> if [free on dispose]; otherwise, <c>false</c>.</value>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Dispose(System.Boolean)">
<summary>
Releases the unmanaged resources used by the <see cref="T:System.IO.Stream"/> and optionally releases the managed resources.
</summary>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Flush">
<summary>
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
This implementation does nothing.
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
</summary>
<param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between <paramref name="offset"/> and (<paramref name="offset"/> + <paramref name="count"/> - 1) replaced by the bytes read from the current source.</param>
<param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin storing the data read from the current stream.</param>
<param name="count">The maximum number of bytes to be read from the current stream.</param>
<returns>
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
</returns>
<exception cref="T:System.ArgumentException">
The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer"/> is null.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> or <paramref name="count"/> is negative.
</exception>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.ReadByte">
<summary>
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
</summary>
<returns>
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
</returns>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
When overridden in a derived class, sets the position within the current stream.
</summary>
<param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
<returns>
The new position within the current stream.
</returns>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.SetLength(System.Int64)">
<summary>
When overridden in a derived class, sets the length of the current stream.
</summary>
<param name="value">The desired length of the current stream in bytes.</param>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.ToArray">
<summary>
Converts the current stream to a byte array.
</summary>
<returns>An array of bytes</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
</summary>
<param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
<param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
<param name="count">The number of bytes to be written to the current stream.</param>
<exception cref="T:System.ArgumentException">
The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer"/> is null.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> or <paramref name="count"/> is negative.
</exception>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.WriteByte(System.Byte)">
<summary>
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
</summary>
<param name="value">The byte to write to the stream.</param>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.WriteTo(System.IO.Stream)">
<summary>
Writes to the specified stream.
</summary>
<param name="stream">The stream.</param>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.CanRead">
<summary>
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
</summary>
<value></value>
<returns>true if the stream supports reading; otherwise, false.
</returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.CanSeek">
<summary>
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
</summary>
<value></value>
<returns>true if the stream supports seeking; otherwise, false.
</returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.CanWrite">
<summary>
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
</summary>
<value></value>
<returns>true if the stream supports writing; otherwise, false.
</returns>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Length">
<summary>
When overridden in a derived class, gets the length in bytes of the stream.
</summary>
<value></value>
<returns>
A long value representing the length of the stream in bytes.
</returns>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.ChunkSize">
<summary>
Gets or sets the size of the underlying chunks. Cannot be greater than or equal to 85000.
</summary>
<value>The chunks size.</value>
</member>
<member name="P:DotNetSiemensPLCToolBoxLibrary.General.ChunkedMemoryStream.Position">
<summary>
When overridden in a derived class, gets or sets the position within the current stream.
</summary>
<value></value>
<returns>
The current position within the stream.
</returns>
<exception cref="T:System.ObjectDisposedException">
Methods were called after the stream was closed.
</exception>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.IEnumerableExtensions.ToArray(System.Collections.IEnumerable)">
<summary>
Konvertiert eine allgemeine Liste in ein Array aus Objekten
</summary>
<param name="list">Liste</param>
<returns>Liste als Array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.General.IEnumerableExtensions.ToArray``1(System.Collections.IEnumerable)">
<summary>
Konvertiert eine allgemeine Liste in ein Array eines bestimmten Typs
</summary>
<typeparam name="T">Zieltyp des Rückgabearrays</typeparam>
<param name="list">Liste</param>
<returns>Liste als Array</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.Hardware.DB0SystemData.ParseDB0fromBytes(System.Byte[])">
<summary>
We could use that to simply load SDB0 from the plc and then parse the bytes directly
</summary>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.AWLToSource.DataRowToSource(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRow,System.String,System.Boolean)">
<summary>
This is a Helper Function wich is used by GetSourceBlock
</summary>
<param name="datrw"></param>
<param name="leerz"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Helper.GetParameterValueInt(System.String)">
<summary>
Returns the Parameter as an Int!
</summary>
<param name="parameter"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Helper.GetParameterValueBytes(System.String)">
<summary>
This Function Returns a byte Array of a Value Parameter
</summary>
<param name="parameter"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Helper.GetCallParameterByte(System.String)">
<summary>
This Function Returns the Hex Value of a Parameter Pointer of a UC or CC.
</summary>
<param name="parameter"></param>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.MC7Converter">
<summary>
These functions to Convert from MC7 to AWL could not be done withou the help of Steffen Krayer !
Many of the Code is from him (From his Delphi Prog) and also he created Excel sheets wich decribe
how MC7 for most of the AWL Commands looks.
</summary>
<remarks>
The general structure of an online block is as follows:
0 - 35 Block header
36 - x MC7 code for Code blocks; Current data for datablocks
x - x Interface
x - x Start Values (if any)
x - x Segment table
Len -36 Block footer. The footer is always located 36 bytes at the end of the block
all values x are depending on the blocks layout and apropiate length fields must be parsed from code
</remarks>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.MC7Converter.MC7Start_or_DBBodyStart">
<summary>
This value marks the lenght of the actual Block header, and since the MC7 code immeadiatly follows,
also marks the start of the MC7 Code or Datablock body
</summary>
</member>
<member name="F:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.MC7Converter.FooterLength">
<summary>
This value marks the lenght of the actual Block footer which is always situatted at the end of the MC7 code data
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.MC7Converter.ParseBlockHeaderAndFooterFromMC7(System.Byte[],DotNetSiemensPLCToolBoxLibrary.DataTypes.MnemonicLanguage)">
<summary>
Parse the Header and Footer information from an online MC7Code byte blob
</summary>
<param name="MC7Code">The online MC7 Code blob from the PLC</param>
<param name="MnemoricLanguage">The Mnemoric that should be used when parsing the Blocks data</param>
<returns></returns>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter">
<summary>
This class is responsible for parsing Interface declarations from MC7. It parses all variables from the interface declaration and optionally fills in the startvalues and
actual values. This class is used by the MC7 converter
</summary>
<remarks>
The Interface of an MC7 block is structured as follows:
Header:
0 Block Type: 0x05 (DB) 0x10 (DI)
1-2 Again Block Number or FB Number on a DI (but bytes swapped)
3-4 Interface Length minus this header (7 bytes)
5-6 Start Value Length
Interface:
7-x Line 1
x-x Line 2
...
for more information about the format of an Interface Line, please look at GetVarTypeEN
</remarks>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.ParameterType">
<summary>
Represents the Type of Parameter in an Interfacer, Not the Datatype.
Basically ther are In, Out, INOUT, Static and Temp
The _Init versions are the same with the above, except they have initial values that must ge parsed
the _EX_ version are slightly different, in that they include an extra parameter in the interface declaration row.
I think this parameter is some kind of BitFiled declaring some options, but i am not sure what it is? See GetVarEn function for details
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetFunctionParameterFromNumber(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRow,System.Int32)">
<summary>
Goes down in the parameter rows and finds the datarow corresponding to the In, Out or InOut parameter that corresponds to Index
It goes throught the interface of the Function of FunctionBlock the same way as S7 would (first In, Out then InOut
</summary>
<param name="parameters">The interface of the block</param>
<param name="index">The number of the Parameter of the block</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.IsInterfaceCompatible(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.IDataRow,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.IDataRow)">
<summary>
Compares the structure of two Interface declarations and returns true if they are compatible and false if not
They are compatible if the Structure and Datatypes match up. Datarow names are ignored, since the interface remain
compatible as long as the general structure matches up.
Also Actual values are ignores
</summary>
<param name="Block1">The first interface to compare</param>
<param name="Block2">The second interface to campare</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetInterfaceOrDBFromStep7ProjectString(System.String,System.Collections.Generic.List{System.String}@,DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockType,System.Boolean,DotNetSiemensPLCToolBoxLibrary.DataTypes.Projectfolders.Step7V5.BlocksOfflineFolder,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block,DotNetSiemensPLCToolBoxLibrary.DataTypes.AWL.Step7V5.S7ConvertingOptions,System.Byte[])">
<summary>
Parses the interface from an Step7 Source code as stored in Step7 Project Files
</summary>
<param name="txt">The Step7 Code to be parsed</param>
<param name="ParaList">An list of Parameters that where found in the Step7 Declaration</param>
<param name="blkTP">The block type that is beeing Parsed</param>
<param name="isInstanceDB">Indicates if an block is an Instance DB</param>
<param name="myFld">The BlocksOffline Folder where the parsed block code belongs to</param>
<param name="myBlk">The Block where the Parsed Step7 code belongs to</param>
<param name="actualValues">the current values of the DB, if it is an DB</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.FillActualValuesInDataBlock(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRow,System.Byte[])">
<summary>
Find and assign the Actual value of an Intervace to an given S7Datarow
</summary>
<param name="row"></param>
<param name="actualValues"></param>
<param name="valuePos">OUT: an pointer for tracking the current value position in the parsing process</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetInterface(System.Byte[],System.Byte[],System.Byte[],System.Collections.Generic.List{System.String}@,DotNetSiemensPLCToolBoxLibrary.DataTypes.PLCBlockType,System.Boolean,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block)">
<summary>
Parses the interface from an MC7 Interface block
</summary>
<param name="interfaceBytes">The interface bytes from the MC7 code</param>
<param name="startValueBytes">The corresponding Current data values. Only valid for DB</param>
<param name="ParaList">OUT: The parsed Parameter list</param>
<param name="blkTP">the block type of the block interface to be parsed</param>
<param name="isInstanceDB">Indicates if the data block belongs to an Function block</param>
<param name="myBlk">The block header</param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetVarTypeEN(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRow,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRowType,System.Boolean,System.Boolean,System.String,System.Byte[],System.Int32@,System.Byte[],System.Int32@,System.Collections.Generic.List{System.String}@,System.Int32@,DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.VarNameGenerator,DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7Block)">
<summary>
Parses an Interface parameter Row from the Interface of an MC7 block
</summary>
<param name="currPar">The Parent Interface Row of the rows to be parsed</param>
<param name="datatype">The Interface parameter data type"/></param>
<param name="Struct">The parameter row is inside an struct</param>
<param name="Array">the parameter row is inside an array</param>
<param name="VarName">The variable name to be used for the current row</param>
<param name="interfaceBytes">the interface bytes from the MC7 Code</param>
<param name="InterfacePos">OUT: the current parsing position</param>
<param name="startValueBytes">The current data bytes from the MC7 code</param>
<param name="StartValuePos">OUT: the current parsing position for Initial values</param>
<param name="ParaList">OUT: the parsed parameter row number</param>
<param name="StackNr">OUT: The current parsing stack depth</param>
<param name="VarNameGen">The prefix to be used to generate the variable names from</param>
<param name="myBlk">The block, where the interface belongs to</param>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetVarCurrentValue(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRowType,System.Byte[],DotNetSiemensPLCToolBoxLibrary.DataTypes.ByteBitAddress)">
<summary>
Get corresponding current value. These values essentially have the exact same layout as one is familiar with the "GetBytes" interfaces
From the communication library.
</summary>
<param name="dataType">The data-type of the interface row</param>
<param name="data">Either an Array containing the Start Values or Actual Values</param>
<param name="valpos">OUT: Current position of parsing</param>
<returns>the parsed value acording to the given datatyep and adress. If the datatype is invalid (such as struct) it returns Null</returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.GetVarInitialValue(DotNetSiemensPLCToolBoxLibrary.DataTypes.Blocks.Step7V5.S7DataRowType,System.Byte[],System.Int32@)">
<summary>
Get corresponding Initial value
</summary>
<param name="dataType">The data-type of the interface row</param>
<param name="data">Either an Array containing the Start Values or Actual Values</param>
<param name="valpos">OUT: Current position of parsing</param>
<returns>the parsed value acording to the given datatyep and adress. If the datatype is invalid (such as struct) it returns Null</returns>
<remarks>
The Initial values are encoded in an compacted manner. Meaning, if an varialbe does not have an
Initial value, it does not appear in the start values list!
this means the valpos must be tracked, and increased every time an Avlue was parsed from the array
WARNING! be aware that for somehow reason Siemens encoded the Startvalues in Little Endien format,
completly contrary to the comon S7 format! This means one can not use the Libnodave.Getxxx funcions,
but rather has to use the usual Bitconverter
Basically the logic here uses the default libnodave.getxxx function, but with Bitconverter instead.
</remarks>
</member>
<member name="T:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.VarNameGenerator">
<summary>
Small helper class to keep track of the current Variable name
</summary>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.PLCs.S7_xxx.MC7.Parameter.VarNameGenerator.GetNextVarName">
<summary>
Returns the next Variable name and increments the internal Variable count
</summary>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Projectfiles.Projects.GetStep7ProjectsFromDirectory(System.String)">
<summary>
This Function Returens a Step7 Project Instance for every Project Folder in the Path.
</summary>
<param name="dirname"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Projectfiles.Projects.GetStep7ProjectsFromDirectory(System.String,DotNetSiemensPLCToolBoxLibrary.DataTypes.Credentials)">
<summary>
This Function Returens a Step7 Project Instance for every Project Folder in the Path.
</summary>
<param name="dirname"></param>
<returns></returns>
</member>
<member name="M:DotNetSiemensPLCToolBoxLibrary.Source.AWLSourceParser.ParseAWL(System.String,System.String)">
<summary>
Parses the AWL Text and returns the S7Blocks
</summary>
<param name="AWL"></param>
<param name="SymbolTable">Can be null</param>
<returns></returns>
</member>
<member name="M:System.Net.Sockets.SocketExtensions.SetKeepAlive(System.Net.Sockets.Socket,System.UInt64,System.UInt64)">
<summary>
Sets the keep-alive interval for the socket.
</summary>
<param name="socket">The socket.</param>
<param name="time">Time between two keep alive "pings".</param>
<param name="interval">Time between two keep alive "pings" when first one fails.</param>
<returns>If the keep alive infos were succefully modified.</returns>
</member>
</members>
</doc>