Inheritance diagram for VIB_NET::PowerOverEthernet:

Detailed Description

This class represents the PowerOverEthernet (PoE) module, which allows gathering information about the current state of attached PoE devices.

Public Types
enum	ePOE_ERROR
	Error flags of the PoE port, used by GetPortState() More...

enum	ePOE_STATE
	State of the PoE port, used by GetPortState() More...

Public Member Functions
void	GetPortState (const UInt32 PortIndex, PowerOverEthernet::ePOE_STATE % State, PowerOverEthernet::ePOE_ERROR % Error, UInt32 % PoEClass)
	Returns the current state of the given port More...

	PowerOverEthernet ()
	Default constructor for the device object More...

Public Member Functions inherited from VIB_NET::iDevice
void	Close ()
	Closes a device More...

bool	isOpen ()
	Returns the open state of a device object More...

void	Open ()
	Opens a device More...

void	Open (unsigned int Index)
	Opens a device More...

Properties
UInt32	NumberOfPorts `[get]`
	Contains the number of PoE ports More...

virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Properties inherited from VIB_NET::iDevice
virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Member Enumeration Documentation

◆ ePOE_ERROR

enum VIB_NET::PowerOverEthernet::ePOE_ERROR

strong

Error flags of the PoE port, used by GetPortState()

Enumerator
NO	No Error.
NCSI	Communication problem to the NIC.
CLASS	Invalid PoE Class.
VOLTAGE_FAULT	Voltage is wrong.
CURRENT_FAULT	Current is to big.
THERMAL_FAULT	Over temperature occurs.

◆ ePOE_STATE

enum VIB_NET::PowerOverEthernet::ePOE_STATE

strong

State of the PoE port, used by GetPortState()

Enumerator
OFF	The PoE part is off (not Powered)
SEARCHING	Waits for an new connected PoE device.
POWERED	Normal operation, device is sourced by the VisionBox.
OFF_MAXPWR	The total maximum power budget was reached.

Constructor & Destructor Documentation

◆ PowerOverEthernet()

VIB_NET::PowerOverEthernet::PowerOverEthernet ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ GetPortState()

void VIB_NET::PowerOverEthernet::GetPortState	(	const UInt32	PortIndex,
		PowerOverEthernet::ePOE_STATE %	State,
		PowerOverEthernet::ePOE_ERROR %	Error,
		UInt32 %	PoEClass
	)

Returns the current state of the given port

Parameters

PortIndex	Port index 0 ... (NumberOfPorts - 1)
State	Current PoE state
Error	Pending error flags, multiple bits can be active, see ePOE_ERROR
PoEClass	PoE power class used by the device, valid if State is ePOE_STATE::POWERED

Property Documentation

◆ NumberOfPorts

VIB_NET::PowerOverEthernet::NumberOfPorts

get

Contains the number of PoE ports

◆ Type

VIB_NET::PowerOverEthernet::Type

get

Returns the device type for the current instance, see eDEVICE_TYPE