Fifo.get_option()
Info | Value |
---|---|
Package | mvnc |
Module | mvncapi |
Version | 2.0 |
See also | Fifo, FifoOption, Fifo.set_option() |
Overview
This method returns an option value for the Fifo. The available options and possible values can be found in the FifoOption enumeration.
Syntax
value = fifo.get_option(option)
Parameters
Parameter | Type | Description |
---|---|---|
option | int | A member of the FifoOption enumeration that specifies which option value to get. |
Return
value
The value for the specified option. The value type depends on the option specified. See the FifoOption enumeration for the type that corresponds to each option.
Raises
Exception with a Status.INVALID_PARAMETERS code if an invalid option is passed or Exception with a status code from Status if underlying function calls return a status other than Status.OK.
Notes
- The FifoState must be CREATED or ALLOCATED.
Example
from mvnc import mvncapi
# Initialize a Fifo
fifo = mvncapi.Fifo('', FifoType.HOST_RW)
# Print the Fifo data type
print('The Fifo data type is', fifo.get_option(mvncapi.FifoOption.RW_DATA_TYPE))
# Destroy the Fifo
fifo.destroy()