224 lines
12 KiB
XML
224 lines
12 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Xylem.Common.Hardware.Interfaces.Ports.PortCore</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs">
|
|
<inheritdoc cref="T:System.EventArgs" />
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs._receivedTime">
|
|
<summary>
|
|
Marker for incoming record at time of the PC
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.GetData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.SetData(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.SetReceivedTime(System.DateTimeOffset)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.GetReceivedTime">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.SetSyncMarkRecord(Xylem.Common.CommonCore.Consts.SyncMarkRecord)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.BasePortDataEventArgs.GetSyncMarkRecord">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs">
|
|
<summary>
|
|
Interface for port data event arguments
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.GetData">
|
|
<summary>
|
|
Read data
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.SetData(System.Object)">
|
|
<summary>
|
|
Write data
|
|
</summary>
|
|
<param name="data"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.GetReceivedTime">
|
|
<summary>
|
|
Reading received time
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.SetReceivedTime(System.DateTimeOffset)">
|
|
<summary>
|
|
Writing received time
|
|
</summary>
|
|
<param name="receivedTime"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.SetSyncMarkRecord(Xylem.Common.CommonCore.Consts.SyncMarkRecord)">
|
|
<summary>
|
|
Setting the data marker
|
|
</summary>
|
|
<param name="syncMarkRecord"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs.GetSyncMarkRecord">
|
|
<summary>
|
|
Getting the data marker
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.ListBytePortDataEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.ListBytePortDataEventArgs.#ctor(System.Collections.Generic.List{System.Byte},System.DateTimeOffset,Xylem.Common.CommonCore.Consts.SyncMarkRecord)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.ListBytePortDataEventArgs.GetData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.ListBytePortDataEventArgs.SetData(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.StringPortDataEventArgs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.StringPortDataEventArgs.#ctor(System.String,System.DateTimeOffset,Xylem.Common.CommonCore.Consts.SyncMarkRecord)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.StringPortDataEventArgs.GetData">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.StringPortDataEventArgs.SetData(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort">
|
|
<summary>
|
|
Interface for Ports
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.OnRawRecordReceived">
|
|
<summary>
|
|
event for record received, either bytes or string
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.OnRawRecordSendOut">
|
|
<summary>
|
|
event for record received, either bytes or string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.SynchronizeReceiveBuffer(Xylem.Common.CommonCore.Consts.SyncMarkRecord)">
|
|
<summary>
|
|
set specific mark
|
|
and flush or delete all incoming byte from buffer when SyncMarkRecord is <see cref="F:Xylem.Common.CommonCore.Consts.SyncMarkRecord.SyncStart"/> or
|
|
<see cref="F:Xylem.Common.CommonCore.Consts.SyncMarkRecord.SyncEnd"/>
|
|
</summary>
|
|
<param name="syncMarkRecord"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.Open">
|
|
<summary>
|
|
if the port needs stuff to open, always open for better logical handling
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.Dispose">
|
|
<summary>
|
|
close and dispose all connections
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.IsOpen">
|
|
<summary>
|
|
indicates if the Port is open (also on Ports that did not have an open state)
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.PortWrite(System.Byte[])">
|
|
<summary>
|
|
Write byte[] to the Stream/Port on Child Class
|
|
wrapped with base class error handling
|
|
</summary>
|
|
<param name="data">Array of bytes to write</param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.Clear">
|
|
<summary>
|
|
discard all buffers
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.IPort.GetPortName">
|
|
<summary>
|
|
Return the port name
|
|
</summary>
|
|
<returns>name of the port as string</returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings">
|
|
<summary>
|
|
Store Port settings set most likely from transmit protocol
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.#ctor(System.Nullable{System.Byte},System.Nullable{System.UInt16},System.UInt16,System.Int32,System.UInt32,System.Nullable{System.UInt32},System.Boolean)">
|
|
<summary>
|
|
The transmission protocol needs to inform the communication port how to setup,
|
|
this is the data container.
|
|
</summary>
|
|
<param name="protSyncByte"></param>
|
|
<param name="protLengthIndex"></param>
|
|
<param name="protAddLength"></param>
|
|
<param name="responseTimeoutMs"></param>
|
|
<param name="baudRate"></param>
|
|
<param name="receiveBufferFlushThreshold"></param>
|
|
<param name="doubleSyncByte"></param>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.ProtSyncByte">
|
|
<summary>
|
|
start of receiving synchronization byte at byte receive routine
|
|
syncByte == null: use the readLine routine (ASCII) and NOT the BYTE routine,
|
|
lengthPosition and additionalLength are not used
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.ProtLengthIndex">
|
|
<summary>
|
|
position of length information field in received BYTE record
|
|
lengthIndex == null: take the constant receive length of additionalLength
|
|
because the record doesn't contain length information
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.ProtAddLength">
|
|
<summary>
|
|
additional record length NOT covert by the record length information field
|
|
lengthIndex == null: constant length for received record
|
|
Being used for the BYTE records indicated by a valid syncByte,
|
|
not being used for ASCII records.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.ResponseTimeoutMs">
|
|
<summary>
|
|
Response time out in milliseconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.BaudRate">
|
|
<summary>
|
|
BaudRate for Port
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.ReceiveBufferFlushThreshold">
|
|
<summary>
|
|
lower threshold for buffer flushing if dataMarker != SkipDecoding
|
|
receiveBufferFlushThreshold == null: never flush the communication buffer
|
|
receiveBufferFlushThreshold == 0: flush always the communication buffer
|
|
receiveBufferFlushThreshold == x: flush communication buffer if it exceeds x Byte
|
|
waste old records if an up-to-date record is being needed for start/stop synchronization
|
|
of a measurement. This is the level at which the old data have to be flushed because the
|
|
data have been dammed up in the communication port input buffer which means they are to
|
|
old for synchronization purposes.
|
|
/// </summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.Interfaces.Ports.PortCore.TransmitPortSettings.DoubleSyncByte">
|
|
<summary>
|
|
a special implementation may require the doubling of the sync byte to re-synchronize
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|