IoEComponent holds and manipulates the IoEComponent on IoE devices. More...
Inheritance diagram for IoEComponent:
Public Member Functions | |
| string | getSlotName () |
| Returns the name of the slot. More... | |
| int | getSlotNumber () |
| Returns the number of the slot. More... | |
| string | getComponentType () |
| Returns the type of the component. More... | |
| void | setIsOutputMode (bool) |
| set the flag of slot is using output mode or not. More... | |
| bool | isOutputMode () |
| Returns true if the slot is using output mode, otherwise false. More... | |
| bool | isInputMode () |
| Returns true if the slot is using input mode, otherwise false. More... | |
| void | digitalWrite (int) |
| digital write a value to the slot. More... | |
| int | digitalRead () |
| Returns int digital read from the slot. More... | |
| void | analogWrite (int) |
| analog write a value to the slot. More... | |
| int | analogRead () |
| Returns int analog read from the slot. More... | |
| void | customWrite (string) |
| custom write a string to the slot. More... | |
| string | customRead () |
| Returns the string custom read from the slot. More... | |
| void | valueChanged () |
| This event is emitted when value of the slot changed. More... | |
 Public Member Functions inherited from Port | |
| string | getName () |
| Returns the name of the port. More... | |
| int | getChannel () |
| Returns the channel of the port. More... | |
| void | setChannel (int) |
| Sets the channel of the port. More... | |
| string | getTerminalTypeShortString () |
| Returns the name of the port shortened, without number. More... | |
| string | getPortNameNumber () |
| Returns the port number. Can have something like 0/0/0, etc. More... | |
| PortType | getType () |
| Returns the type of the port. More... | |
| void | setDescription (string) |
| Sets the description for the port. More... | |
| string | getDescription () |
| Returns the description of the port. More... | |
| void | setPower (bool) |
| Sets the power state for the port. More... | |
| bool | getPower () |
| Returns true if the port is on, false if the port is off. More... | |
| void | powerChanged (bool) |
| This event is emitted when the power state of the port changes. More... | |
| bool | isStraightPins () |
| Returns true if the pins are straight, for ethernet. More... | |
| bool | isAutoCross () |
| Returns true if the port is configured for auto crossover, for ethernet. More... | |
| void | setBandwidth (int) |
| Sets the bandwidth for the port. More... | |
| int | getBandwidth () |
| Returns the bandwidth of the port. More... | |
| void | setBandwidthAutoNegotiate (bool) |
| Enables or disables bandwidth auto negotiation. More... | |
| bool | isBandwidthAutoNegotiate () |
| Returns true if bandwidth auto negotiation is enabled, otherwise false. More... | |
| void | setFullDuplex (bool) |
| Enables or disables full duplex mode. More... | |
| bool | isFullDuplex () |
| Returns true if full duplex mode is enabled, otherwise false. More... | |
| void | setDuplexAutoNegotiate (bool) |
| Enables or disables duplex auto negotiation. More... | |
| bool | isDuplexAutoNegotiate () |
| Returns true if duplex auto negotiation is enabled, otherwise false. More... | |
| void | setMacAddress (mac) |
| Sets the MAC address on the port. More... | |
| mac | getMacAddress () |
| Returns the MAC address set on the port. More... | |
| void | macChanged (mac, mac) |
| This event is emitted when the MAC address on the port changes. More... | |
| mac | getBia () |
| Returns the burned-in address of the port. More... | |
| void | setClockRate (int) |
| Sets the clock rate on the port. More... | |
| int | getClockRate () |
| Returns the clock rate on the port. More... | |
| Link | getLink () |
| Returns the link connected to the port. More... | |
| bool | isProtocolUp () |
| Returns true if the line protocol is up on the port, otherwise false. More... | |
| bool | isPortUp () |
| Returns true if the status is up on the port, otherwise false. More... | |
| Process | getEncapProcess () |
| Returns the encapsulation process. More... | |
| Process | getKeepAliveProcess () |
| Returns the keepalive process. More... | |
| QString | getRemotePortName () |
| Returns the name of the remote port. More... | |
| LightStatus | getLightStatus () |
| Returns the link light status. More... | |
| void | lightStatusChanged (LightStatus) |
| This event is emitted when the link light changes. More... | |
| void | lightBlinked () |
| This event is emitted when the link light blinks. More... | |
| void | portStatusChanged (bool) |
| This event is emitted when the port status changes. More... | |
| void | lineProtocolChanged (bool) |
| This event is emitted when the line protocol status changes. More... | |
| void | packetReceived (string, int) |
| This event is emitted when the port receives a packet. More... | |
| void | packetSent (string, int) |
| This event is emitted when the port sends a packet. More... | |
| void | packetReceivedWithDetails (Signal, int) |
| This event is emitted when the port receives a packet with details. More... | |
| void | packetSentWithDetails (Signal, int) |
| This event is emitted when the port sends a packet with details. More... | |
| int | getHigherProcessCount () |
| Returns the higher process count. More... | |
| HardwareQueue | getHardwareQueue () |
| Returns the hardware queue. More... | |
| QueueProcess | getQosQueue () |
| Returns the qos queue. More... | |
| bool | isEthernetPort () |
| Returns true if it is a ethernet port, false if not. More... | |
| bool | isWirelessPort () |
| Returns true if it is a wireless port, false if not. More... | |
| bool | isPowerOn () |
| Returns true if the power is on, false if not. More... | |
| void | deleteLink () |
| Public Member Functions inherited from Process | |
| Device | getOwnerDevice () |
| Returns the device for this process. More... | |
Detailed Description
IoEComponent holds and manipulates the IoEComponent on IoE devices.
Member Function Documentation
◆ analogRead()
| int IoEComponent::analogRead | ( | ) |
Returns int analog read from the slot.
- Returns
- bool, int analog read from the slot.
◆ analogWrite()
| void IoEComponent::analogWrite | ( | int | ) |
analog write a value to the slot.
- Parameters
-
value,the value to write to the slot.
◆ customRead()
| string IoEComponent::customRead | ( | ) |
Returns the string custom read from the slot.
- Returns
- string, the string custom read from the slot.
◆ customWrite()
| void IoEComponent::customWrite | ( | string | ) |
custom write a string to the slot.
- Parameters
-
value,the string to write to the slot.
◆ digitalRead()
| int IoEComponent::digitalRead | ( | ) |
Returns int digital read from the slot.
- Returns
- bool, int digital read from the slot.
◆ digitalWrite()
| void IoEComponent::digitalWrite | ( | int | ) |
digital write a value to the slot.
- Parameters
-
value,the value to write to the slot.
◆ getComponentType()
| string IoEComponent::getComponentType | ( | ) |
Returns the type of the component.
- Returns
- string, type of the component.
◆ getSlotName()
| string IoEComponent::getSlotName | ( | ) |
Returns the name of the slot.
- Returns
- string, the name of the slot.
◆ getSlotNumber()
| int IoEComponent::getSlotNumber | ( | ) |
Returns the number of the slot.
- Returns
- int, the number of the slot.
◆ isInputMode()
| bool IoEComponent::isInputMode | ( | ) |
Returns true if the slot is using input mode, otherwise false.
- Returns
- bool, true if the slot is using input mode, otherwise false.
◆ isOutputMode()
| bool IoEComponent::isOutputMode | ( | ) |
Returns true if the slot is using output mode, otherwise false.
- Returns
- bool, true if the slot is using output mode, otherwise false.
◆ setIsOutputMode()
| void IoEComponent::setIsOutputMode | ( | bool | ) |
set the flag of slot is using output mode or not.
- Parameters
-
isOutput,true if slot is using output mode, false otherwise.
◆ valueChanged()
| void IoEComponent::valueChanged | ( | ) |
This event is emitted when value of the slot changed.
IPC event.
The documentation for this class was generated from the following file:
