ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update endpoints diagram

pull/7426/head
Donatien Garnier 2018-08-06 14:28:07 +01:00
parent 912f75c377
commit f7ff432535
2 changed files with 63 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
features/nfc/doc/uml_diagram_endpoints.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 113 KiB

88
features/nfc/doc/uml_diagram_endpoints.txt
View File

@ -1,40 +1,77 @@
@startuml @startuml
abstract class NFCEndpoint { abstract class NFCNDEFCapable {
+{abstract} bool is_ndef_supported() const
+void set_ndef_message_parser(ndef::MessageParser* parser) const
+void set_ndef_message_builder(ndef::MessageBuilder* builder) const
#ndef::MessageParser* ndef_message_parser()
#ndef::MessageBuilder* ndef_message_builder()
}
abstract class NFCRemoteEndpoint {
+void is_lost() +void is_lost()
+nfc_rf_protocols_bitmask_t rf_protocols() const +nfc_rf_protocols_bitmask_t rf_protocols() const
} }
abstract class NFCEndpointDelegate { abstract class NFCRemoteEndpoint::Delegate {
+void on_lost() +{abstract} void on_lost()
} }
abstract class NFCTarget { abstract class NFCTarget {
+void write_ndef_message(const NDEFMessage& message) +void set_delegate(NFCTarget::Delegate* delegate)
+void write_ndef_message()
+void erase_ndef_message() +void erase_ndef_message()
+void read_ndef_message() +void read_ndef_message()
} }
abstract class NFCTargetDelegate { abstract class NFCTarget::Delegate {
+void on_ndef_message_written(nfc_err_t result) +{abstract} void on_ndef_message_written(nfc_err_t result)
+void on_ndef_message_erased(nfc_err_t result) +{abstract} void on_ndef_message_erased(nfc_err_t result)
+void on_ndef_message_read(nfc_err_t result, NDEFMessage* message) +{abstract} void on_ndef_message_read(nfc_err_t result)
} }
class NFCEEPROM { class NFCEEPROM {
+void set_delegate(NFCEEPROMDelegate* delegate) +void set_delegate(NFCEEPROM::Delegate* delegate)
} }
abstract class NFCEEPROMDelegate { abstract class NFCEEPROM::Delegate {
} }
abstract class NFCEEPROMDriver {
+void set_delegate(Delegate* delegate)
+{abstract} void reset()
+{abstract} size_t get_max_size()
+{abstract} void start_session()
+{abstract} void end_session()
+{abstract} void read_bytes(uint32_t address, size_t count)
+{abstract} void write_bytes(uint32_t address, const uint8_t* bytes, size_t count)
+{abstract} void set_size(size_t count)
+{abstract} void get_size()
+{abstract} void erase_bytes(uint32_t address, size_t size)
}
abstract class NFCEEPROMDriver::Delegate {
+{abstract} void has_started_session(bool success)
+{abstract} void has_read_bytes(bool success, const uint8_t* bytes)
+{abstract} void has_written_bytes(bool success)
+{abstract} void has_set_size(bool success)
+{abstract} void has_gotten_size(bool success, size_t size)
+{abstract} void has_erased_bytes(bool success)
}
NFCNDEFCapable <-- NFCTarget
NFCTarget <-- NFCEEPROM NFCTarget <-- NFCEEPROM
NFCTargetDelegate <-- NFCEEPROMDelegate NFCTarget::Delegate <-- NFCEEPROM::Delegate
NFCEEPROM o-- NFCEEPROMDelegate NFCEEPROM o-- NFCEEPROM::Delegate
NFCEEPROM o-- NFCEEPROMDriver
NFCEEPROMDriver::Delegate <-- NFCEEPROM
class NFCRemoteInitiator { class NFCRemoteInitiator {
+void set_delegate(NFCRemoteInitiatorDelegate* delegate) +void set_delegate(NFCRemoteInitiator::Delegate* delegate)
+bool is_iso7816_supported() +bool is_iso7816_supported()
+void add_iso7816_application(ISO7816App* app); +void add_iso7816_application(ISO7816App* app);
@ -47,30 +84,31 @@ class NFCRemoteInitiator {
+nfc_err_t get_ndef_message(NDEFMessage* message) +nfc_err_t get_ndef_message(NDEFMessage* message)
} }
abstract class NFCRemoteInitiatorDelegate { abstract class NFCRemoteInitiator::Delegate {
+void on_selected() +void on_selected()
+void on_deselected() +void on_deselected()
+void on_before_ndef_read() +void on_before_ndef_message_read()
+void on_after_ndef_write() +void on_after_ndef_message_write()
} }
NFCEndpoint <-- NFCRemoteInitiator NFCNDEFCapable <-- NFCRemoteInitiator
NFCEndpointDelegate <-- NFCRemoteInitiatorDelegate NFCRemoteEndpoint <-- NFCRemoteInitiator
NFCRemoteInitiator o-- NFCRemoteInitiatorDelegate NFCRemoteEndpoint::Delegate <-- NFCRemoteInitiator::Delegate
NFCRemoteInitiator o-- NFCRemoteInitiator::Delegate
class NFCRemoteTarget { class NFCRemoteTarget {
+void set_delegate(NFCRemoteTargetDelegate* delegate) +void set_delegate(NFCRemoteTarget::Delegate* delegate)
} }
abstract class NFCRemoteTargetDelegate { abstract class NFCRemoteTarget::Delegate {
} }
NFCEndpoint <-- NFCRemoteTarget NFCRemoteEndpoint <-- NFCRemoteTarget
NFCTarget <-- NFCRemoteTarget NFCTarget <-- NFCRemoteTarget
NFCEndpointDelegate <-- NFCRemoteTargetDelegate NFCRemoteEndpoint::Delegate <-- NFCRemoteTarget::Delegate
NFCTargetDelegate <-- NFCRemoteTargetDelegate NFCTarget::Delegate <-- NFCRemoteTarget::Delegate
NFCRemoteTarget o-- NFCRemoteTargetDelegate NFCRemoteTarget o-- NFCRemoteTarget::Delegate
@enduml @enduml