Gocator API
|
Represents Ethernet output settings.
Inherits kObject.
Public Member Functions | |
kStatus | GoEthernet_AddSource (GoEthernet ethernet, GoOutputSource type, k32u sourceId) |
Selects the specified source for transmission. More... | |
k32u | GoEthernet_AsciiControlPort (GoEthernet ethernet) |
Gets the ASCII protocol control channel port number. More... | |
kChar * | GoEthernet_AsciiCustomDataFormat (GoEthernet ethernet) |
Gets the ASCII protocol output custom data format string. More... | |
kBool | GoEthernet_AsciiCustomFormatEnabled (GoEthernet ethernet) |
Returns the value of whether the ASCII protocol custom data format is enabled or disabled. More... | |
k32u | GoEthernet_AsciiDataPort (GoEthernet ethernet) |
Gets the ASCII protocol data channel port number. More... | |
kChar * | GoEthernet_AsciiDelimiter (GoEthernet ethernet) |
Gets the ASCII protocol output delimiter string. More... | |
k32u | GoEthernet_AsciiHealthPort (GoEthernet ethernet) |
Gets the ASCII protocol health channel port number. More... | |
kChar * | GoEthernet_AsciiInvalidValue (GoEthernet ethernet) |
Gets the ASCII protocol output invalid value string. More... | |
GoAsciiOperation | GoEthernet_AsciiOperation (GoEthernet ethernet) |
Gets the ASCII protocol operational mode. More... | |
kChar * | GoEthernet_AsciiTerminator (GoEthernet ethernet) |
Gets the ASCII protocol output terminator string. More... | |
kStatus | GoEthernet_ClearAllSources (GoEthernet ethernet) |
Removes all selected sources for all possible ethernet output types. More... | |
kStatus | GoEthernet_ClearSources (GoEthernet ethernet, GoOutputSource type) |
Removes all selected sources for the specified output type. More... | |
kBool | GoEthernet_EIPBufferingEnabled (GoEthernet ethernet) |
Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled. More... | |
kStatus | GoEthernet_EnableAsciiCustomFormat (GoEthernet ethernet, kBool enabled) |
Enables or disables the ASCII protocol output custom data format. More... | |
kBool | GoEthernet_ModbusBufferingEnabled (GoEthernet ethernet) |
Returns the value of whether Modbus protocol output buffering is enabled or disabled. More... | |
k32u | GoEthernet_OptionAt (GoEthernet ethernet, GoOutputSource type, k32u index) |
Gets the source option at the specified index. More... | |
kSize | GoEthernet_OptionCount (GoEthernet ethernet, GoOutputSource type) |
Gets the number of source options for the specified output type. More... | |
GoEthernetProtocol | GoEthernet_Protocol (GoEthernet ethernet) |
Gets the protocol that the ethernet utilizes for output. More... | |
kStatus | GoEthernet_RemoveSource (GoEthernet ethernet, GoOutputSource type, kSize index) |
Removes (deselects) the source at the specified index. More... | |
kStatus | GoEthernet_SetAsciiControlPort (GoEthernet ethernet, k32u port) |
Sets the port number of the ASCII control port. More... | |
kStatus | GoEthernet_SetAsciiCustomDataFormat (GoEthernet ethernet, const kChar *string) |
Sets the ASCII protocol output custom data format string. More... | |
kStatus | GoEthernet_SetAsciiDataPort (GoEthernet ethernet, k32u port) |
Sets the port number of the ASCII data port. More... | |
kStatus | GoEthernet_SetAsciiDelimiter (GoEthernet ethernet, const kChar *string) |
Sets the ASCII protocol output delimiter string. More... | |
kStatus | GoEthernet_SetAsciiHealthPort (GoEthernet ethernet, k32u port) |
Sets the port number of the ASCII health port. More... | |
kStatus | GoEthernet_SetAsciiInvalidValue (GoEthernet ethernet, const kChar *string) |
Sets the ASCII protocol output invalid value string. More... | |
kStatus | GoEthernet_SetAsciiOperation (GoEthernet ethernet, GoAsciiOperation mode) |
Sets the ASCII operation mode. More... | |
kStatus | GoEthernet_SetAsciiTerminator (GoEthernet ethernet, const kChar *string) |
Sets the ASCII protocol output terminator string. More... | |
kStatus | GoEthernet_SetEIPBufferingEnabled (GoEthernet ethernet, kBool enabled) |
Enables or disables EthernetIP protocol output buffering. More... | |
kStatus | GoEthernet_SetModbusBufferingEnabled (GoEthernet ethernet, kBool enabled) |
Enables or disables Modbus protocol output buffering. More... | |
kStatus | GoEthernet_SetProtocol (GoEthernet ethernet, GoEthernetProtocol protocol) |
Sets the protocol which will be output via ethernet. More... | |
k32u | GoEthernet_SourceAt (GoEthernet ethernet, GoOutputSource type, k32u index) |
Gets the identifier of the selected output at the specified index. More... | |
kSize | GoEthernet_SourceCount (GoEthernet ethernet, GoOutputSource type) |
Gets the number of sources of the specified output type that are currently selected for transmission. More... | |
kStatus GoEthernet_AddSource | ( | GoEthernet | ethernet, |
GoOutputSource | type, | ||
k32u | sourceId | ||
) |
Selects the specified source for transmission.
ethernet | GoEthernet object. |
type | Output source type. |
sourceId | Output source identifier. |
k32u GoEthernet_AsciiControlPort | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol control channel port number.
ethernet | GoEthernet object. |
kChar * GoEthernet_AsciiCustomDataFormat | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol output custom data format string.
ethernet | GoEthernet object. |
kBool GoEthernet_AsciiCustomFormatEnabled | ( | GoEthernet | ethernet | ) |
Returns the value of whether the ASCII protocol custom data format is enabled or disabled.
ethernet | GoEthernet object. |
k32u GoEthernet_AsciiDataPort | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol data channel port number.
ethernet | GoEthernet object. |
kChar * GoEthernet_AsciiDelimiter | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol output delimiter string.
ethernet | GoEthernet object. |
k32u GoEthernet_AsciiHealthPort | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol health channel port number.
ethernet | GoEthernet object. |
kChar * GoEthernet_AsciiInvalidValue | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol output invalid value string.
ethernet | GoEthernet object. |
GoAsciiOperation GoEthernet_AsciiOperation | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol operational mode.
ethernet | GoEthernet object. |
kChar * GoEthernet_AsciiTerminator | ( | GoEthernet | ethernet | ) |
Gets the ASCII protocol output terminator string.
ethernet | GoEthernet object. |
kStatus GoEthernet_ClearAllSources | ( | GoEthernet | ethernet | ) |
Removes all selected sources for all possible ethernet output types.
ethernet | GoEthernet object. |
kStatus GoEthernet_ClearSources | ( | GoEthernet | ethernet, |
GoOutputSource | type | ||
) |
Removes all selected sources for the specified output type.
ethernet | GoEthernet object. |
type | Output source type. |
kBool GoEthernet_EIPBufferingEnabled | ( | GoEthernet | ethernet | ) |
Returns the value of whether the EthernetIP protocol output buffering is enabled or disabled.
ethernet | GoEthernet object. |
kStatus GoEthernet_EnableAsciiCustomFormat | ( | GoEthernet | ethernet, |
kBool | enabled | ||
) |
Enables or disables the ASCII protocol output custom data format.
ethernet | GoEthernet object. |
enabled | kTRUE to enable custom data format output. kFALSE to use the default output format. |
kBool GoEthernet_ModbusBufferingEnabled | ( | GoEthernet | ethernet | ) |
Returns the value of whether Modbus protocol output buffering is enabled or disabled.
ethernet | GoEthernet object. |
k32u GoEthernet_OptionAt | ( | GoEthernet | ethernet, |
GoOutputSource | type, | ||
k32u | index | ||
) |
Gets the source option at the specified index.
ethernet | GoEthernet object. |
type | Output source type. |
index | Source option index. |
kSize GoEthernet_OptionCount | ( | GoEthernet | ethernet, |
GoOutputSource | type | ||
) |
Gets the number of source options for the specified output type.
ethernet | GoEthernet object. |
type | Output source type. |
GoEthernetProtocol GoEthernet_Protocol | ( | GoEthernet | ethernet | ) |
Gets the protocol that the ethernet utilizes for output.
ethernet | GoEthernet object. |
kStatus GoEthernet_RemoveSource | ( | GoEthernet | ethernet, |
GoOutputSource | type, | ||
kSize | index | ||
) |
Removes (deselects) the source at the specified index.
ethernet | GoEthernet object. |
type | Output source type. |
index | Index of the source to be removed. |
kStatus GoEthernet_SetAsciiControlPort | ( | GoEthernet | ethernet, |
k32u | port | ||
) |
Sets the port number of the ASCII control port.
ethernet | GoEthernet object. |
port | The selected ASCII control port value. |
kStatus GoEthernet_SetAsciiCustomDataFormat | ( | GoEthernet | ethernet, |
const kChar * | string | ||
) |
Sets the ASCII protocol output custom data format string.
ethernet | GoEthernet object. |
string | A pointer to the string representing the ASCII protocol output custom data format. |
kStatus GoEthernet_SetAsciiDataPort | ( | GoEthernet | ethernet, |
k32u | port | ||
) |
Sets the port number of the ASCII data port.
ethernet | GoEthernet object. |
port | The selected ASCII data port value. |
kStatus GoEthernet_SetAsciiDelimiter | ( | GoEthernet | ethernet, |
const kChar * | string | ||
) |
Sets the ASCII protocol output delimiter string.
ethernet | GoEthernet object. |
string | A pointer to the string representing the ASCII protocol output delimiter. |
kStatus GoEthernet_SetAsciiHealthPort | ( | GoEthernet | ethernet, |
k32u | port | ||
) |
Sets the port number of the ASCII health port.
ethernet | GoEthernet object. |
port | The selected ASCII health port value. |
kStatus GoEthernet_SetAsciiInvalidValue | ( | GoEthernet | ethernet, |
const kChar * | string | ||
) |
Sets the ASCII protocol output invalid value string.
ethernet | GoEthernet object. |
string | A pointer to the string representing the ASCII protocol output invalid value. |
kStatus GoEthernet_SetAsciiOperation | ( | GoEthernet | ethernet, |
GoAsciiOperation | mode | ||
) |
Sets the ASCII operation mode.
ethernet | GoEthernet object. |
mode | The selected ASCII operation mode. |
kStatus GoEthernet_SetAsciiTerminator | ( | GoEthernet | ethernet, |
const kChar * | string | ||
) |
Sets the ASCII protocol output terminator string.
ethernet | GoEthernet object. |
string | A pointer to the string representing the ASCII protocol output terminator. |
kStatus GoEthernet_SetEIPBufferingEnabled | ( | GoEthernet | ethernet, |
kBool | enabled | ||
) |
Enables or disables EthernetIP protocol output buffering.
ethernet | GoEthernet object. |
enabled | kTRUE to enable buffering. kFALSE to disable it. |
kStatus GoEthernet_SetModbusBufferingEnabled | ( | GoEthernet | ethernet, |
kBool | enabled | ||
) |
Enables or disables Modbus protocol output buffering.
ethernet | GoEthernet object. |
enabled | kTRUE to enable buffering. kFALSE to disable it. |
kStatus GoEthernet_SetProtocol | ( | GoEthernet | ethernet, |
GoEthernetProtocol | protocol | ||
) |
Sets the protocol which will be output via ethernet.
ethernet | GoEthernet object. |
protocol | The selected ethernet protocol. |
k32u GoEthernet_SourceAt | ( | GoEthernet | ethernet, |
GoOutputSource | type, | ||
k32u | index | ||
) |
Gets the identifier of the selected output at the specified index.
ethernet | GoEthernet object. |
type | Output source type. |
index | Selected source index. |
kSize GoEthernet_SourceCount | ( | GoEthernet | ethernet, |
GoOutputSource | type | ||
) |
Gets the number of sources of the specified output type that are currently selected for transmission.
ethernet | GoEthernet object. |
type | Output source type. |