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)

newFrame 를 writeFrame()를 통해 접근할 수 있는 발신 프레임의 내부 목록에 추가합니다.

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

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

` newFrames `를 ` readFrame()`를 통해 액세스할 수 있는 내부 프레임 목록에 추가하고, ` 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()도 참조하십시오 .