QCanBusDevice Class

멤버 함수 문서

[explicit] QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

지정된 parent 으로 직렬 버스 장치를 구축합니다.

[virtual] QCanBusDevice::CanBusStatus QCanBusDevice::busStatus()

현재 CAN 버스 상태를 반환합니다. 상태를 요청할 수 없는 경우 QCanBusDevice::UnknownStatus가 반환됩니다.

hasBusStatus() 및 resetController()도 참조하세요 .

void QCanBusDevice::clear(QCanBusDevice::Directions direction = Direction::AllDirections)

direction 에 따라 장치 입력 또는 출력 버퍼를 지웁니다.

이 함수는 QCanBusDevice 버퍼에서만 작동합니다. 이미 CAN 드라이버 또는 CAN 하드웨어 계층에 기록되었거나 이러한 계층에서 아직 읽지 않은 프레임은 이 기능으로 지워지지 않습니다.

framesAvailable(), readFrame(), framesToWrite() 및 writeFrame()도 참조하세요 .

[protected] void QCanBusDevice::clearError()

마지막 장치 오류에 대한 오류 ID와 사람이 읽을 수 있는 설명을 지웁니다.

CAN 버스 구현은 이 함수를 사용하여 장치의 오류 상태를 업데이트해야 합니다.

error(), errorOccurred() 및 setError()도 참조하세요 .

[pure virtual protected] void QCanBusDevice::close()

이 함수는 CAN 버스 연결을 닫는 역할을 합니다. 구현 시 인스턴스의 state()가 QCanBusDevice::UnconnectedState 으로 설정되어 있는지 확인해야 합니다.

이 함수의 가장 중요한 작업은 CAN 장치에 대한 소켓을 닫고 QCanBusDevice::setState()를 호출하는 것입니다.

disconnectDevice()도 참조하세요 .

QList<QCanBusDevice::ConfigurationKey> QCanBusDevice::configurationKeys() const

CAN 버스 연결에 사용되는 키 목록을 반환합니다.

키의 의미는 ConfigurationKey 와 동일합니다. 키가 명시적으로 언급되지 않은 경우 해당 키에 대한 플랫폼의 기본 설정이 사용됩니다.

QVariant QCanBusDevice::configurationParameter(QCanBusDevice::ConfigurationKey key) const

ConfigurationKey key 에 할당된 현재 값을 반환하고, 그렇지 않으면 잘못된 QVariant 을 반환합니다.

setConfigurationParameter() 및 configurationKeys()도 참조하세요 .

bool QCanBusDevice::connectDevice()

장치를 CAN 버스에 연결합니다. 성공하면 true, 그렇지 않으면 false 을 반환합니다.

이 함수는 구현의 일부로 open()를 호출합니다.

disconnectDevice()도 참조하세요 .

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

발신 프레임의 내부 목록에서 다음 QCanBusFrame 을 반환하고, 그렇지 않으면 잘못된 QCanBusFrame 을 반환합니다. 반환된 프레임은 내부 목록에서 제거됩니다.

[virtual, since 6.2] QCanBusDeviceInfo QCanBusDevice::deviceInfo() const

현재 QCanBusDevice 에 대한 QCanBusDeviceInfo 을 반환합니다. 이 함수가 QCanBusDevice 의 서브클래스에 의해 구현되지 않으면 기본 생성된 객체가 반환됩니다.

이 함수는 Qt 6.2에 도입되었습니다.

void QCanBusDevice::disconnectDevice()

장치를 CAN 버스에서 분리합니다.

이 함수는 구현의 일부로 close()를 호출합니다.

connectDevice()도 참조하세요 .

[protected] void QCanBusDevice::enqueueOutgoingFrame(const QCanBusFrame &newFrame)

writeFrame()로 액세스할 수 있는 발신 프레임의 내부 목록에 newFrame 을 추가합니다.

서브클래스는 새 프레임을 작성할 때 이 함수를 호출해야 합니다.

[protected] void QCanBusDevice::enqueueReceivedFrames(const QList<QCanBusFrame> &newFrames)

readFrame()을 사용하여 액세스할 수 있는 내부 프레임 목록에 newFrames 을 추가하고 framesReceived() 신호를 내보냅니다.

서브클래스는 프레임을 수신할 때 이 함수를 호출해야 합니다.

QCanBusDevice::CanBusError QCanBusDevice::error() const

마지막으로 발생한 오류를 반환합니다. 오류 값은 항상 마지막으로 발생한 오류로 설정되며 재설정되지 않습니다.

setError() 및 errorString()도 참조하세요 .

[signal] void QCanBusDevice::errorOccurred(QCanBusDevice::CanBusError)

이 신호는 오류가 발생하면 발산됩니다.

QString QCanBusDevice::errorString() const

마지막으로 발생한 장치 오류에 대한 사람이 읽을 수 있는 설명을 반환합니다.

error()도 참조하세요 .

qint64 QCanBusDevice::framesAvailable() const

사용 가능한 프레임 수를 반환합니다. 사용 가능한 프레임이 없으면 이 함수는 0을 반환합니다.

clear(), readFrame() 및 readAllFrames()도 참조하세요 .

[signal] void QCanBusDevice::framesReceived()

이 신호는 하나 이상의 프레임이 수신되었을 때 방출됩니다. 프레임은 readFrame() 및 framesAvailable()을 사용하여 읽어야 합니다.

qint64 QCanBusDevice::framesToWrite() const

버퍼링된 장치의 경우, 이 함수는 쓰기 대기 중인 프레임 수를 반환합니다. 버퍼링되지 않은 장치의 경우 이 함수는 항상 0을 반환합니다.

clear() 및 writeFrame()도 참조하세요 .

[signal] void QCanBusDevice::framesWritten(qint64 framesCount)

이 신호는 프레임 페이로드가 CAN 버스에 기록될 때마다 발생합니다. framesCount 인수는 이 페이로드에 기록된 프레임 수로 설정됩니다.

[virtual] bool QCanBusDevice::hasBusStatus() const

CAN 플러그인이 CAN 버스 상태 요청을 지원하면 true를 반환합니다.

busStatus()도 참조하세요 .

[protected] bool QCanBusDevice::hasOutgoingFrames() const

발신 프레임의 내부 목록이 비어 있지 않으면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다.

[pure virtual] QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)

frame 을 오류 프레임으로 해석하고 사람이 읽을 수 있는 오류 설명을 반환합니다.

frame 이 오류 프레임이 아닌 경우 반환되는 문자열은 비어 있습니다.

[pure virtual protected] bool QCanBusDevice::open()

이 함수는 connectDevice()에 의해 호출됩니다. 서브클래스는 CAN 버스 연결이 가능한 경우 true 을 반환하고, 그렇지 않으면 false 을 반환하는 구현을 제공해야 합니다. QCanBusDevice 구현은 이 함수를 호출할 때 디바이스의 state()이 이미 QCanBusDevice::ConnectingState 로 설정되어 있는지 확인합니다.

구현은 성공 시 인스턴스의 state()가 QCanBusDevice::ConnectedState 으로 설정되어 있는지, 그렇지 않으면 QCanBusDevice::UnconnectedState 으로 설정되어 있는지 확인해야 합니다. setState()를 사용하여 새 장치 상태를 설정해야 합니다.

사용자 정의 구현은 소켓 열기, 잠재적으로 필요한 QSocketNotifier 인스턴스화, 사용자 정의 및 기본 QCanBusDevice::configurationParameter()의 적용을 담당합니다.

connectDevice()도 참조하세요 .

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

큐에서 모든 QCanBusFrame를 반환하고, 그렇지 않으면 빈 QList 을 반환합니다. 반환된 프레임은 큐에서 제거됩니다.

큐는 FIFO 원칙에 따라 작동합니다.

clear(), framesAvailable() 및 readFrame()도 참조하세요 .

QCanBusFrame QCanBusDevice::readFrame()

큐에서 다음 QCanBusFrame 을 반환하고, 그렇지 않으면 빈 QCanBusFrame 을 반환합니다. 반환된 프레임은 큐에서 제거됩니다.

큐는 FIFO 원칙에 따라 작동합니다.

clear(), framesAvailable() 및 readAllFrames()도 참조하세요 .

[virtual] void QCanBusDevice::resetController()

가능한 경우 CAN 컨트롤러 재설정을 수행하여 CAN 컨트롤러를 버스 오프 상태에서 해제합니다.

busStatus()도 참조하세요 .

[virtual] void QCanBusDevice::setConfigurationParameter(QCanBusDevice::ConfigurationKey key, const QVariant &value)

CAN 버스 연결에 대한 구성 파라미터 key 를 value 로 설정합니다. 잠재적 키는 ConfigurationKey 로 표시됩니다.

잘못된 QVariant 을 설정하여 파라미터를 설정 해제할 수 있습니다. 파라미터를 설정 해제하면 구성이 기본 설정으로 재설정됩니다.

configurationParameter()도 참조하세요 .

[protected] void QCanBusDevice::setError(const QString &errorText, QCanBusDevice::CanBusError errorId)

마지막 장치 오류에 대한 사람이 읽을 수 있는 설명을 errorText 으로 설정합니다. errorId 은 오류 유형을 분류합니다.

CAN 버스 구현은 이 함수를 사용하여 장치의 오류 상태를 업데이트해야 합니다.

error(), errorOccurred() 및 clearError()도 참조하세요 .

[protected] void QCanBusDevice::setState(QCanBusDevice::CanBusDeviceState newState)

디바이스 상태를 newState 로 설정합니다. CAN 버스 구현은 이 함수를 사용하여 장치 상태를 업데이트해야 합니다.

state()도 참조하세요 .

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

디바이스의 현재 상태를 반환합니다.

setState() 및 stateChanged()도 참조하세요 .

[signal] void QCanBusDevice::stateChanged(QCanBusDevice::CanBusDeviceState state)

이 신호는 디바이스의 상태가 변경될 때마다 발신됩니다. 새 상태는 state 로 표시됩니다.

setState() 및 state()도 참조하세요 .

[virtual] bool QCanBusDevice::waitForFramesReceived(int msecs)

새 프레임을 읽을 수 있고 framesReceived() 신호가 전송될 때까지 또는 msecs 밀리초가 경과할 때까지 차단합니다. msecs 가 -1 인 경우 이 함수는 시간 초과되지 않습니다.

새 프레임을 읽을 수 있고 framesReceived() 신호가 전송되면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다(작업 시간이 초과되었거나 오류가 발생한 경우).

waitForFramesWritten()도 참조하세요 .

[virtual] bool QCanBusDevice::waitForFramesWritten(int msecs)

버퍼링된 디바이스의 경우 이 함수는 모든 버퍼링된 프레임이 디바이스에 기록되고 framesWritten() 신호가 전송될 때까지 또는 msecs 밀리초가 경과할 때까지 대기합니다. msecs 이 -1이면 이 함수는 시간 초과되지 않습니다. 버퍼가 없는 디바이스의 경우 writeFrame()에는 쓰기 버퍼가 필요하지 않으므로 false 으로 즉시 반환됩니다.

framesWritten() 신호가 발생하면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다(즉, 작업 시간이 초과되었거나 오류가 발생한 경우).

waitForFramesReceived()도 참조하세요 .

[pure virtual] bool QCanBusDevice::writeFrame(const QCanBusFrame &frame)

frame 을 CAN 버스에 쓰고 성공하면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다.

일부 플랫폼에서는 프레임이 대기열에 삽입될 수 있으며 반환 값은 대기열에 성공적으로 삽입된 것만 나타낼 수 있습니다. 실제 프레임은 나중에 전송됩니다. 따라서 framesWritten() 신호는 프레임이 전송 계층으로 전달되었음을 최종적으로 확인하는 신호입니다. 오류가 발생하면 errorOccurred()가 전송됩니다.

CAN 버스 사양에 따라 remote transfer request (RTR) 유형의 프레임에는 페이로드가 없고 0에서 8까지의 길이(포함)가 있습니다. 이 길이는 원격 당사자로부터 예상되는 응답 페이로드 길이를 나타냅니다. 따라서 이 기능을 사용하여 RTR 프레임을 전송할 때는 frame 에 임의의 페이로드를 설정해야 할 수 있습니다. 임의 페이로드의 길이는 RTR 프레임의 예상 크기로 설정된 길이입니다.

QCanBusFrame::setPayload()도 참조하세요 .