Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSerial Class Reference

Description

Represents Serial output settings.

Inherits kObject.

Public Member Functions

kStatus GoSerial_AddSource (GoSerial serial, k32u sourceId)
 Selects the specified source for transmission. More...
 
kStatus GoSerial_ClearSources (GoSerial serial)
 Removes all selected sources for the specified output type. More...
 
k32u GoSerial_OptionAt (GoSerial serial, k32u index)
 Gets the source option at the specified index. More...
 
kSize GoSerial_OptionCount (GoSerial serial)
 Gets the number of source options. More...
 
kArrayList GoSerial_OptionList (GoSerial serial)
 Gets the list of source measurement options. More...
 
kStatus GoSerial_RemoveSource (GoSerial serial, k32u index)
 Removes (deselects) the source at the specified index. More...
 
k32u GoSerial_SelcomRate (GoSerial serial)
 Gets the index of the currently selected Selcom output rate. More...
 
k32u GoSerial_SelcomRateOptionCount (GoSerial serial)
 Returns the number of available Selcom protocol output options. More...
 
kStatus GoSerial_SetSelcomRate (GoSerial serial, kSize index)
 Sets the Selcom protocol output rate. More...
 
k32u GoSerial_SourceAt (GoSerial serial, k32u index)
 Gets the identifier of the selected output source at the specified index. More...
 
kSize GoSerial_SourceCount (GoSerial serial)
 Gets the number of sources of the specified output type that are currently selected for transmission. More...
 

Member Function Documentation

kStatus GoSerial_AddSource ( GoSerial  serial,
k32u  sourceId 
)

Selects the specified source for transmission.

Parameters
serialGoSerial object.
sourceIdSource identifier.
Returns
Operation status.
kStatus GoSerial_ClearSources ( GoSerial  serial)

Removes all selected sources for the specified output type.

Parameters
serialGoSerial object.
Returns
Operation status.
k32u GoSerial_OptionAt ( GoSerial  serial,
k32u  index 
)

Gets the source option at the specified index.

Parameters
serialGoSerial object.
indexSource option index.
Returns
Source option.
kSize GoSerial_OptionCount ( GoSerial  serial)

Gets the number of source options.

Parameters
serialGoSerial object.
Returns
Source option.
kArrayList GoSerial_OptionList ( GoSerial  serial)

Gets the list of source measurement options.

Parameters
serialGoSerial object.
Returns
An array list of source measurement options.
kStatus GoSerial_RemoveSource ( GoSerial  serial,
k32u  index 
)

Removes (deselects) the source at the specified index.

Parameters
serialGoSerial object.
typeOutput source type (value or decision).
indexIndex of the source to be removed.
Returns
Operation status.
k32u GoSerial_SelcomRate ( GoSerial  serial)

Gets the index of the currently selected Selcom output rate.

Parameters
serialGoSerial object.
Returns
An integer corresponding to the current Selcom output rate.
k32u GoSerial_SelcomRateOptionCount ( GoSerial  serial)

Returns the number of available Selcom protocol output options.

Parameters
serialGoSerial object.
Returns
A number representing the available Selcom protocol output options.
kStatus GoSerial_SetSelcomRate ( GoSerial  serial,
kSize  index 
)

Sets the Selcom protocol output rate.

Parameters
serialGoSerial object.
indexAn index value representing the Selcom rate to set.
Returns
Operation status.
k32u GoSerial_SourceAt ( GoSerial  serial,
k32u  index 
)

Gets the identifier of the selected output source at the specified index.

Parameters
serialGoSerial object.
indexSelected source index.
Returns
Source identifier.
kSize GoSerial_SourceCount ( GoSerial  serial)

Gets the number of sources of the specified output type that are currently selected for transmission.

Parameters
serialGoSerial object.
Returns
Count of selected sources.

The documentation for this class was generated from the following file: