Port interface.  
 More...
|  | 
| constant int | NO_ERROR = 0 | 
|  | Error codes.  More... 
 | 
|  | 
| constant int | ERR_INVALID_PARAM = 1 | 
|  | invalid parameter for an operation 
 | 
|  | 
| constant int | ERR_DEVICE_BUSY = 2 | 
|  | operation fails because connected device is busy 
 | 
|  | 
◆ DetectionType
Port detection type. 
| Enumerator | 
|---|
| AUTO | auto detection of connected devices  | 
| PINNED | port is pinned to a specific device type  | 
| DISABLED | port is disabled and will not detect any device connected  | 
 
 
◆ getDetectableDevices()
      
        
          | vector< string > portsmodel::Port::getDetectableDevices | ( |  | ) |  | 
      
 
Get all detectable devices of this port. 
- Returns
- List of all registered detectable Devices 
 
 
◆ getDevice()
      
        
          | Object portsmodel::Port::getDevice | ( |  | ) |  | 
      
 
Get the connected device of the port. 
- Returns
- Device connected to Port 
 
 
◆ getDeviceConfig()
      
        
          | Object portsmodel::Port::getDeviceConfig | ( | in string | deviceType | ) |  | 
      
 
Get device type specific configuration interface. 
- Parameters
- 
  
    | deviceType | Device type to get configuration interface for |  
 
- Returns
- Device configuration interface 
 
 
◆ getFuse()
Get the fuse for this port. 
- Returns
- A fuse instance, if available 
 
 
◆ getProperties()
◆ setDetectionMode()
Set the detection mode for the port. 
- Parameters
- 
  
  
- Returns
- NO_ERROR on success 
- 
ERR_INVALID_PARAM invalid parameter 
- 
ERR_DEVICE_BUSY device busy (e.g. Asset Strip Firmware Update) 
 
 
◆ setName()
      
        
          | void portsmodel::Port::setName | ( | in string | name | ) |  | 
      
 
NOT USED RIGHT NOW! 
Set the port name
- Parameters
- 
  
  
 
 
◆ NO_ERROR
      
        
          | constant int portsmodel::Port::NO_ERROR = 0 | 
      
 
Error codes. 
operation successful, no error 
 
 
The documentation for this interface was generated from the following file: