libstored

This is a generator for a C++ class (store) with your application’s variables, and a tool set to synchronize updates between processes (including FPGA), and debug it remotely.

Content

• libstored
  • TL;DR
    • What is it?
    • When do I need it?
    • Does it work on my platform?
    • Huh? But how you do know my hardware architecture?
    • Great! How do I use it?
  • Table of contents
  • Introduction
  • libstored - Store by description
  • libstored - Store on a distributed system
  • libstored - Store for Embedded Debugger
    • Example
    • Embedded Debugger protocol
  • How to build
    • How to integrate in your build
  • License
• CHANGELOG
  • Unreleased
    • Added
  • 1.8.0 - 2025-09-11
    • Added
    • Changed
    • Fixed
  • 1.7.1 - 2024-02-28
    • Added
    • Changed
    • Fixed
  • 1.7.0 - 2023-11-17
    • Added
    • Changed
  • 1.6.0 - 2023-09-13
    • Added
    • Changed
    • Fixed
  • 1.5.0 - 2023-07-07
    • Added
    • Changed
  • 1.4.0 - 2023-04-06
    • Added
    • Fixed
  • 1.3.1 - 2022-10-21
    • Fixed
  • 1.3.0 - 2022-10-20
    • Added
    • Changed
    • Fixed
  • 1.2.0 - 2022-03-28
    • Added
    • Changed
    • Fixed
  • 1.1.0 - 2022-01-07
    • Added
    • Changed
    • Removed
  • 1.0.0 - 2021-08-25
    • Added
• Presentation
• Workflow
• C++
  • Config
    • stored::DefaultConfig
      • stored::DefaultConfig
        • AvoidDynamicMemory
        • CompressStreams
        • Debug
        • DebuggerAlias
        • DebuggerEcho
        • DebuggerIdentification
        • DebuggerList
        • DebuggerListPrefixAlways
        • DebuggerMacro
        • DebuggerRead
        • DebuggerReadMem
        • DebuggerStreamBuffer
        • DebuggerStreamBufferOverflow
        • DebuggerStreams
        • DebuggerTrace
        • DebuggerVersion
        • DebuggerWrite
        • DebuggerWriteMem
        • EnableAssert
        • EnableHooks
        • FullNames
        • StoreInLittleEndian
        • UnalignedAccess
        • stored::DefaultConfig::Allocator
          • type
    • stored::Config
      • stored::Config
  • Components
    • stored::Amplifier
    • stored::FirstOrderFilter
    • stored::PID
    • stored::PinIn
    • stored::PinOut
    • stored::PulseWave
    • stored::Ramp
    • stored::Sine
  • Debugger
    • Protocol
      • Capabilities
      • Echo
      • Read
      • Write
      • List
      • Alias
      • Macro
      • Identification
      • Version
      • Read memory
      • Write memory
      • Streams
      • Flush
      • Tracing
    • stored::Debugger
      • stored::Debugger
        • ListCallbackArg
        • StoreMap
        • Debugger()
        • ~Debugger()
        • capabilities()
        • decode()
        • find()
        • identification()
        • list()
        • map()
        • process()
        • setIdentification()
        • setVersions()
        • stores()
        • stream()
        • stream()
        • stream()
        • stream()
        • streams()
        • trace()
        • tracing()
        • unmap()
        • version()
        • Ack
        • CmdAlias
        • CmdCapabilities
        • CmdEcho
        • CmdFlush
        • CmdIdentification
        • CmdList
        • CmdMacro
        • CmdRead
        • CmdReadMem
        • CmdStream
        • CmdTrace
        • CmdVersion
        • CmdWrite
        • CmdWriteMem
        • Nack
        • stored::Debugger::StorePrefixComparator
          • operator()()
    • stored::DebugStoreBase
      • stored::DebugStoreBase
        • ListCallbackArg
        • ~DebugStoreBase()
        • find()
        • list()
        • name()
    • stored::DebugVariant
      • stored::DebugVariant
        • base
        • DebugVariant()
        • DebugVariant()
        • get()
        • operator!=()
        • operator==()
        • set()
        • size()
        • type()
        • valid()
  • Directory
    • stored::find()
      • find()
    • stored::list()
      • list()
  • Pipes
    • stored::pipes::PipeBase
    • stored::pipes::Pipe
    • stored::pipes::PipeEntry
    • stored::pipes::PipeExit
    • stored::pipes::Group
    • stored::pipes::Buffer
    • stored::pipes::Call
    • stored::pipes::Cast
    • stored::pipes::Changes
    • stored::pipes::Constrained
    • stored::pipes::Convert
    • stored::pipes::Get
    • stored::pipes::Identity
    • stored::pipes::Log
    • stored::pipes::Map
    • stored::pipes::Mux
    • stored::pipes::RateLimit
    • stored::pipes::Set
    • stored::pipes::Signal
    • stored::pipes::Tee
    • stored::pipes::Transistor
    • stored::pipes::Triggered
  • Poller
    • Pollables
      • stored::Pollable
        • stored::Pollable
          • Events
          • Events_value
          • EventsFlags
            • PollInIndex
            • PollOutIndex
            • PollErrIndex
            • PollPriIndex
            • PollHupIndex
            • FlagCount
          • Pollable()
          • events
          • revents
          • user_data
          • PollErr
          • PollHup
          • PollIn
          • PollOut
          • PollPri
      • stored::PollableCallback
        • stored::PollableCallback
          • PollableCallback()
          • operator()()
          • f
        • pollable()
      • stored::PollableFd
        • stored::PollableFd
          • PollableFd()
          • fd
        • pollable()
      • stored::PollableFileLayer
        • stored::PollableFileLayer
          • PollableFileLayer()
          • layer
        • pollable()
      • stored::PollableHandle
        • stored::PollableHandle
          • PollableHandle()
          • handle
      • stored::PollableSocket
        • stored::PollableSocket
          • PollableSocket()
          • socket
        • pollable()
      • stored::PollableZmqLayer
        • stored::PollableZmqLayer
          • PollableZmqLayer()
          • layer
        • pollable()
      • stored::PollableZmqSocket
        • stored::PollableZmqSocket
          • PollableZmqSocket()
          • socket
        • pollable()
    • stored::InheritablePoller
      • stored::InheritablePoller
        • Result
        • ~InheritablePoller()
        • add()
        • clear()
        • empty()
        • poll()
        • remove()
        • reserve()
    • stored::Poller
      • stored::Poller
        • base
        • Poller()
        • ~Poller()
  • Protocol
    • stored::AsciiEscapeLayer
      • stored::AsciiEscapeLayer
        • base
        • AsciiEscapeLayer()
        • ~AsciiEscapeLayer()
        • decode()
        • encode()
        • mtu()
        • Esc
        • EscMask
    • stored::BufferLayer
      • stored::BufferLayer
        • base
        • BufferLayer()
        • ~BufferLayer()
        • encode()
        • reset()
    • stored::CallbackLayer
    • stored::CompressLayer
      • stored::CompressLayer
        • Window
        • Lookahead
        • DecodeInputBuffer
        • FlagEncoding
        • FlagDecoding
        • base
        • CompressLayer()
        • ~CompressLayer()
        • decode()
        • encode()
        • idle()
        • mtu()
        • setPurgeableResponse()
    • stored::Crc16Layer
      • stored::Crc16Layer
        • polynomial
        • init
        • base
        • Crc16Layer()
        • ~Crc16Layer()
        • decode()
        • encode()
        • mtu()
        • reset()
    • stored::Crc8Layer
      • stored::Crc8Layer
        • polynomial
        • init
        • base
        • Crc8Layer()
        • ~Crc8Layer()
        • decode()
        • encode()
        • mtu()
        • reset()
    • stored::DebugArqLayer
      • stored::DebugArqLayer
        • base
        • DebugArqLayer()
        • ~DebugArqLayer()
        • decode()
        • encode()
        • mtu()
        • reset()
        • setPurgeableResponse()
        • ResetFlag
    • stored::DebugZmqLayer
      • stored::DebugZmqLayer
        • DefaultPort
        • base
        • DebugZmqLayer()
        • ~DebugZmqLayer()
        • recv()
    • stored::DoublePipeLayer
      • stored::DoublePipeLayer
        • base
        • DoublePipeLayer()
        • ~DoublePipeLayer()
        • encode()
        • fd()
        • isConnected()
        • isOpen()
        • recv()
        • reopen()
        • reset()
    • stored::FifoLoopback
    • stored::FifoLoopback1
    • stored::FileLayer
      • stored::FileLayer
        • DefaultBufferSize
        • base
        • fd_type
        • FileLayer()
        • FileLayer()
        • ~FileLayer()
        • encode()
        • fd()
        • isOpen()
        • recv()
    • stored::IdleCheckLayer
      • stored::IdleCheckLayer
        • base
        • IdleCheckLayer()
        • ~IdleCheckLayer()
        • decode()
        • encode()
        • idle()
        • idleDown()
        • idleUp()
        • setIdle()
    • stored::Loopback
      • stored::Loopback
        • Loopback()
        • ~Loopback()
        • reserve()
    • stored::NamedPipeLayer
      • stored::NamedPipeLayer
        • BufferSize
        • Inbound
        • Outbound
        • Duplex
        • base
        • NamedPipeLayer()
        • ~NamedPipeLayer()
        • encode()
        • handle()
        • isConnected()
        • name()
        • recv()
        • reopen()
    • stored::PrintLayer
      • stored::PrintLayer
        • base
        • PrintLayer()
        • ~PrintLayer()
        • decode()
        • disable()
        • enable()
        • enabled()
        • encode()
        • file()
        • setFile()
    • stored::SegmentationLayer
      • stored::SegmentationLayer
        • base
        • SegmentationLayer()
        • ~SegmentationLayer()
        • decode()
        • encode()
        • lowerMtu()
        • mtu()
        • reset()
        • ContinueMarker
        • EndMarker
    • stored::SerialLayer
      • stored::SerialLayer
        • BufferSize
        • base
        • SerialLayer()
        • ~SerialLayer()
        • resetAutoBaud()
    • stored::StdioLayer
      • stored::StdioLayer
        • DefaultBufferSize
        • base
        • fd_type
        • StdioLayer()
        • ~StdioLayer()
        • encode()
        • fd()
        • isOpen()
        • isPipeIn()
        • isPipeOut()
        • recv()
    • stored::SyncZmqLayer
      • stored::SyncZmqLayer
        • base
        • SyncZmqLayer()
        • ~SyncZmqLayer()
    • stored::TerminalLayer
      • stored::TerminalLayer
        • MaxBuffer
        • base
        • TerminalLayer()
        • TerminalLayer()
        • ~TerminalLayer()
        • decode()
        • encode()
        • mtu()
        • nonDebugEncode()
        • reset()
        • Esc
        • EscEnd
        • EscStart
    • stored::XsimLayer
      • stored::XsimLayer
        • base
        • XsimLayer()
        • ~XsimLayer()
        • encode()
        • keepAlive()
        • recv()
        • reopen()
        • req()
        • reset()
        • KeepAlive
    • Abstract classes
      • stored::ArqLayer
        • stored::ArqLayer
          • RetransmitCallbackThreshold
          • base
          • Event
            • EventNone
            • EventReconnect
            • EventEncodeBufferOverflow
            • EventRetransmit
          • ArqLayer()
          • ~ArqLayer()
          • connected()
          • decode()
          • didTransmit()
          • encode()
          • flush()
          • keepAlive()
          • mtu()
          • reset()
          • resetDidTransmit()
          • retransmits()
          • setEventCallback()
          • shrink_to_fit()
          • waitingForAck()
          • AckFlag
          • NopFlag
          • SeqMask
      • stored::PolledFileLayer
        • stored::PolledFileLayer
          • base
          • fd_type
          • ~PolledFileLayer()
          • fd()
      • stored::PolledLayer
        • stored::PolledLayer
          • base
          • ~PolledLayer()
          • isOpen()
          • lastError()
          • recv()
      • stored::ProtocolLayer
        • stored::ProtocolLayer
          • ProtocolLayer()
          • ~ProtocolLayer()
          • bottom()
          • bottom()
          • connected()
          • decode()
          • down()
          • encode()
          • encode()
          • flush()
          • mtu()
          • reset()
          • setDown()
          • setPurgeableResponse()
          • setUp()
          • stack()
          • top()
          • top()
          • up()
          • wrap()
  • Synchronizer
    • Protocol
      • Hello
      • Welcome
      • Update
        • Proposal
      • Bye
    • stored::StoreJournal
      • stored::StoreJournal
        • ShortSeqWindow
        • SeqLowerMargin
        • SeqCleanThreshold
        • Key
        • Seq
        • ShortSeq
        • Size
        • StoreJournal()
        • ~StoreJournal()
        • bumpSeq()
        • changed()
        • clean()
        • decodeBuffer()
        • decodeUpdates()
        • encodeBuffer()
        • encodeHash()
        • encodeUpdates()
        • hasChanged()
        • hasChanged()
        • hash()
        • iterateChanged()
        • keyToBuffer()
        • reserveHeap()
        • seq()
        • decodeHash()
        • encodeHash()
        • keySize()
        • stored::StoreJournal::StoreCallback
          • StoreCallback()
          • ~StoreCallback()
          • doHookChanged()
          • doHookEntryRO()
          • doHookExitRO()
          • doHooks()
          • hookChanged()
          • hookChanged()
          • hookEntryRO()
          • hookEntryRO()
          • hookExitRO()
          • hookExitRO()
    • stored::SyncConnection
      • stored::SyncConnection
        • base
        • Id
        • SyncConnection()
        • ~SyncConnection()
        • decode()
        • drop()
        • isSynchronizing()
        • process()
        • reset()
        • source()
        • synchronizer()
        • Bye
        • Hello
        • Update
        • Welcome
    • stored::Synchronizable
      • stored::Synchronizable
        • MaxMessageSize
        • Objects
        • Synchronizable()
        • ~Synchronizable()
        • journal()
        • journal()
        • operator StoreJournal &()
        • operator StoreJournal const &()
        • reserveHeap()
        • stored::Synchronizable::TypedStoreCallback
          • TypedStoreCallback()
          • ~TypedStoreCallback()
          • doHookChanged()
          • doHookEntryRO()
          • doHookExitRO()
          • doHooks()
          • hookChanged()
          • hookChanged()
          • hookEntryRO()
          • hookEntryRO()
          • hookExitRO()
          • hookExitRO()
    • stored::Synchronizer
      • stored::Synchronizer
        • Synchronizer()
        • ~Synchronizer()
        • connect()
        • disconnect()
        • encodeBuffer()
        • isSynchronizing()
        • isSynchronizing()
        • map()
        • process()
        • process()
        • process()
        • process()
        • process()
        • process()
        • syncFrom()
        • toJournal()
        • unmap()
  • Types
    • stored::Function
      • stored::Function
        • type
        • Function()
        • Function()
        • as()
        • callback()
        • callback()
        • container()
        • get()
        • get()
        • id()
        • operator type()
        • operator!=()
        • operator()()
        • operator()()
        • operator=()
        • operator==()
        • set()
        • set()
        • valid()
        • size()
    • stored::toType
      • stored::toType
        • type
    • stored::Variable
      • stored::Variable
        • type
        • Variable()
        • Variable()
        • Variable()
        • ~Variable()
        • as()
        • container()
        • get()
        • operator type()
        • operator!=()
        • operator=()
        • operator=()
        • operator==()
        • set()
        • valid()
        • size()
    • stored::Variable with hooks
      • stored::Variable< T, Container, true >
        • base
        • type
        • Variable()
        • Variable()
        • Variable()
        • ~Variable()
        • as()
        • container()
        • entryRO()
        • entryX()
        • exitRO()
        • exitX()
        • get()
        • key()
        • operator type()
        • operator=()
        • operator=()
        • set()
        • size()
    • stored::Variant
      • stored::Variant
        • Variant()
        • Variant()
        • Variant()
        • Variant()
        • Variant()
        • buffer()
        • callback()
        • container()
        • copy()
        • entryRO()
        • entryRO()
        • entryX()
        • entryX()
        • exitRO()
        • exitRO()
        • exitX()
        • exitX()
        • function()
        • get()
        • get()
        • get()
        • isFunction()
        • isVariable()
        • key()
        • operator!=()
        • operator==()
        • set()
        • set()
        • set()
        • set()
        • set()
        • set()
        • size()
        • toQString()
        • toQVariant()
        • type()
        • valid()
        • variable()
        • m_buffer
        • m_f
    • stored::Variant<void>
      • stored::Variant< void >
        • Variant()
        • Variant()
        • apply()
        • container()
        • entryRO()
        • entryX()
        • exitRO()
        • exitX()
        • function()
        • function()
        • get()
        • get()
        • isFunction()
        • isVariable()
        • operator!=()
        • operator==()
        • set()
        • set()
        • size()
        • type()
        • valid()
        • variable()
        • variable()
  • Utilities
    • likely
      • likely
      • unlikely
    • saturated_cast
      • saturated_cast()
    • stored_assert
      • stored_assert
    • stored::banner
      • banner()
    • stored::Fifo
    • stored::memcmp_swap
      • memcmp_swap()
      • memcpy_swap()
    • stored::MessageFifo
    • stored::Scratchpad
      • stored::ScratchPad
        • maxSize
        • chunkHeader
        • spare
        • size_type
        • ScratchPad()
        • ~ScratchPad()
        • alloc()
        • capacity()
        • chunks()
        • empty()
        • max()
        • reserve()
        • reset()
        • shrink_to_fit()
        • size()
        • snapshot()
        • stored::ScratchPad::Snapshot
          • Snapshot()
          • ~Snapshot()
          • reset()
          • rollback()
    • stored::Signal
    • stored::Signalling
    • stored::string_literal
      • string_literal()
    • stored::strncmp
      • strncmp()
    • stored::strncpy
      • strncpy()
    • stored::swap_endian
      • swap_endian()
      • swap_endian()
• VHDL
  • Store entity
  • Store package
  • Common package
  • Protocol
    • AsciiEscapeLayer
    • BufferLayer
    • TerminalLayer
    • UARTLayer
    • FileLayer
    • TeeLayer
    • XsimLayer
  • Utilities
    • libstored_droptail
    • libstored_stream_buffer
    • libstored_fifo
• Python
  • Base classes
    • ZmqClient
      • ZmqClient
        • ZmqClient.acquireAlias()
        • ZmqClient.acquireMacro()
        • ZmqClient.assignMacro()
        • ZmqClient.autoSaveState()
        • ZmqClient.capabilities()
        • ZmqClient.close()
        • ZmqClient.closed
        • ZmqClient.context
        • ZmqClient.defaultPollInterval
        • ZmqClient.defaultPollIntervalChanged
        • ZmqClient.defaultStateFile()
        • ZmqClient.echo()
        • ZmqClient.fastPollThreshold_s
        • ZmqClient.find()
        • ZmqClient.identification()
        • ZmqClient.list()
        • ZmqClient.multi
        • ZmqClient.obj()
        • ZmqClient.objects
        • ZmqClient.otherStreams()
        • ZmqClient.poll()
        • ZmqClient.pyname()
        • ZmqClient.readMem()
        • ZmqClient.releaseAlias()
        • ZmqClient.releaseMacro()
        • ZmqClient.req()
        • ZmqClient.reqAsync()
        • ZmqClient.restoreState()
        • ZmqClient.saveState()
        • ZmqClient.slowPollInterval_s
        • ZmqClient.socket
        • ZmqClient.staticMetaObject
        • ZmqClient.stream()
        • ZmqClient.streams()
        • ZmqClient.time()
        • ZmqClient.timestampToTime()
        • ZmqClient.traceDecimate()
        • ZmqClient.traceProcess()
        • ZmqClient.traceThreshold_s
        • ZmqClient.useEventLoop
        • ZmqClient.version()
        • ZmqClient.writeMem()
    • Protocol layers
      • ProtocolLayer
        • ProtocolLayer.activity()
        • ProtocolLayer.close()
        • ProtocolLayer.decode()
        • ProtocolLayer.down
        • ProtocolLayer.encode()
        • ProtocolLayer.lastActivity()
        • ProtocolLayer.mtu
        • ProtocolLayer.name
        • ProtocolLayer.timeout()
        • ProtocolLayer.up
        • ProtocolLayer.wrap()
      • AsciiEscapeLayer
      • TerminalLayer
      • PubTerminalLayer
      • SegmentationLayer
      • DebugArqLayer
      • Crc8Layer
      • Crc16Layer
      • LoopbackLayer
      • RawLayer
    • Protocol stack
      • ProtocolStack
        • ProtocolStack.Iterator
        • ProtocolStack.decode()
        • ProtocolStack.encode()
        • ProtocolStack.lastActivity()
        • ProtocolStack.mtu
        • ProtocolStack.name
        • ProtocolStack.timeout()
      • registerLayerType()
      • buildStack()
  • GUI
    • libstored.gui
  • CLI
    • libstored.cli
  • Visu
    • libstored.visu
  • Wrappers
    • Base classes
      • Stream2Zmq
        • Stream2Zmq
          • Stream2Zmq.activity()
          • Stream2Zmq.close()
          • Stream2Zmq.decode()
          • Stream2Zmq.default_port
          • Stream2Zmq.down
          • Stream2Zmq.encode()
          • Stream2Zmq.isWaiting()
          • Stream2Zmq.lastActivity()
          • Stream2Zmq.mtu
          • Stream2Zmq.name
          • Stream2Zmq.poll()
          • Stream2Zmq.recvAll()
          • Stream2Zmq.registerStream()
          • Stream2Zmq.reset()
          • Stream2Zmq.stdout()
          • Stream2Zmq.timeout()
          • Stream2Zmq.up
          • Stream2Zmq.wrap()
          • Stream2Zmq.zmq
      • Stdio2Zmq
        • Stdio2Zmq
          • Stdio2Zmq.activity()
          • Stdio2Zmq.close()
          • Stdio2Zmq.decode()
          • Stdio2Zmq.default_port
          • Stdio2Zmq.down
          • Stdio2Zmq.encode()
          • Stdio2Zmq.isWaiting()
          • Stdio2Zmq.lastActivity()
          • Stdio2Zmq.mtu
          • Stdio2Zmq.name
          • Stdio2Zmq.poll()
          • Stdio2Zmq.recvAll()
          • Stdio2Zmq.registerStream()
          • Stdio2Zmq.reset()
          • Stdio2Zmq.sendToApp()
          • Stdio2Zmq.stdout()
          • Stdio2Zmq.timeout()
          • Stdio2Zmq.up
          • Stdio2Zmq.wrap()
          • Stdio2Zmq.zmq
      • Serial2Zmq
        • Serial2Zmq
          • Serial2Zmq.activity()
          • Serial2Zmq.close()
          • Serial2Zmq.decode()
          • Serial2Zmq.default_port
          • Serial2Zmq.down
          • Serial2Zmq.drop()
          • Serial2Zmq.encode()
          • Serial2Zmq.isWaiting()
          • Serial2Zmq.lastActivity()
          • Serial2Zmq.mtu
          • Serial2Zmq.name
          • Serial2Zmq.poll()
          • Serial2Zmq.recvAll()
          • Serial2Zmq.registerStream()
          • Serial2Zmq.reset()
          • Serial2Zmq.sendToApp()
          • Serial2Zmq.stdout()
          • Serial2Zmq.timeout()
          • Serial2Zmq.up
          • Serial2Zmq.wrap()
          • Serial2Zmq.zmq
      • ZmqServer
        • ZmqServer
          • ZmqServer.activity()
          • ZmqServer.close()
          • ZmqServer.decode()
          • ZmqServer.default_port
          • ZmqServer.down
          • ZmqServer.encode()
          • ZmqServer.isWaiting()
          • ZmqServer.lastActivity()
          • ZmqServer.mtu
          • ZmqServer.name
          • ZmqServer.poll()
          • ZmqServer.register()
          • ZmqServer.registerStream()
          • ZmqServer.req()
          • ZmqServer.timeout()
          • ZmqServer.unregister()
          • ZmqServer.up
          • ZmqServer.wrap()
    • libstored.wrapper.stdio
    • libstored.wrapper.serial
• Examples
  • 1_hello
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExampleHelloObjects
        • Base
        • Implementation
        • hello
        • world
      • stored::ExampleHelloBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleHelloBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • hello
        • world
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleHello
        • ExampleHello()
  • 2_basic
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExampleBasicObjects
        • Base
        • Implementation
        • _42_test42
        • another_42
        • b
        • blob
        • d
        • f
        • four_ints_0
        • four_ints_1
        • four_ints_2
        • four_ints_3
        • i16
        • i32
        • i64
        • i8
        • s
        • So_this_is_a_perfectly_fine_name_even_if_it_includes_characters_like_and_so_on
        • string_hello
        • test42
        • three_ints_0
        • three_ints_1
        • three_ints_2
        • two_strings_0
        • two_strings_1
        • u16
        • u32
        • u64
        • u8
      • stored::ExampleBasicBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleBasicBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • four_ints_a()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • three_ints_a()
        • two_strings_a()
        • variable()
        • _42_test42
        • another_42
        • b
        • blob
        • d
        • f
        • four_ints_0
        • four_ints_1
        • four_ints_2
        • four_ints_3
        • i16
        • i32
        • i64
        • i8
        • s
        • So_this_is_a_perfectly_fine_name_even_if_it_includes_characters_like_and_so_on
        • string_hello
        • test42
        • three_ints_0
        • three_ints_1
        • three_ints_2
        • two_strings_0
        • two_strings_1
        • u16
        • u32
        • u64
        • u8
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleBasic
        • ExampleBasic()
  • 3_scope
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExampleScopeObjects
        • Base
        • Implementation
        • gravitational_constant_m__s_2
        • scope__an_int
        • scope__some_bool
        • scope__subscope__another_bool
        • top__level1__b
        • top__level1__b2
        • two_scopes_0__i
        • two_scopes_1__i
      • stored::ExampleScopeBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleScopeBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • two_scopes_a__i()
        • variable()
        • gravitational_constant_m__s_2
        • scope__an_int
        • scope__some_bool
        • scope__subscope__another_bool
        • top__level1__b
        • top__level1__b2
        • two_scopes_0__i
        • two_scopes_1__i
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleScope
        • ExampleScope()
  • 4_function
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExampleFunctionObjects
        • Base
        • Implementation
        • echo_0
        • echo_1
        • rand
        • time_s
      • stored::ExampleFunctionBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleFunctionBase()
        • __echo_0()
        • __echo_1()
        • __rand()
        • __time_s()
        • bufferToKey()
        • bufferToType()
        • echo_a()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • echo_0
        • echo_1
        • rand
        • time_s
        • freeFunction()
        • freeVariable()
        • hash()
      • MyExample
        • MyExample()
        • __echo_0()
        • __echo_1()
        • __rand()
        • __time_s()
  • 5_debug
    • Store definition
      • ExampleDebugSomeStore
      • ExampleDebugAnotherStore
    • Application
    • Output
    • Store reference
      • stored::ExampleDebugSomeStoreObjects
        • Base
        • Implementation
        • i
      • stored::ExampleDebugSomeStoreBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleDebugSomeStoreBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • i
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleDebugSomeStore
        • ExampleDebugSomeStore()
      • stored::ExampleDebugAnotherStoreObjects
        • Base
        • Implementation
        • j
      • stored::ExampleDebugAnotherStoreBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleDebugAnotherStoreBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • j
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleDebugAnotherStore
        • ExampleDebugAnotherStore()
  • 6_hooks
    • Store definition
    • Application
    • Store reference
      • stored::ExampleHooksObjects
        • Base
        • Implementation
        • some_function
        • variable_1
        • variable_2
      • stored::ExampleHooksBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleHooksBase()
        • __some_function()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • some_function
        • variable_1
        • variable_2
        • freeFunction()
        • freeVariable()
        • hash()
      • SyncedExampleHooks
        • SyncedExampleHooks()
        • __hookChanged()
        • __hookEntryRO()
        • __hookEntryX()
        • __hookExitRO()
        • __hookExitX()
        • __some_function()
  • 7_protocol
    • Store definition
    • Application
    • Store reference
      • stored::ExampleProtocolObjects
        • Base
        • Implementation
        • a_long_string_that_does_not_fit_in_the_response_buffers
        • a_short_int_that_fits_in_the_response_buffers
        • ber
        • injected_errors
        • MTU
      • stored::ExampleProtocolBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleProtocolBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • a_long_string_that_does_not_fit_in_the_response_buffers
        • a_short_int_that_fits_in_the_response_buffers
        • ber
        • injected_errors
        • MTU
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleProtocol
        • ExampleProtocol()
  • 8_sync
    • Store definition
      • ExampleSync1
      • ExampleSync2
    • Application
    • Store reference
      • stored::ExampleSync1Objects
        • Base
        • Implementation
        • d
        • i
        • sync_ExampleSync2
      • stored::ExampleSync1Base
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleSync1Base()
        • __sync_ExampleSync2()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • d
        • i
        • sync_ExampleSync2
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleSync1
        • ExampleSync1()
        • __sync_ExampleSync2()
      • stored::ExampleSync2Objects
        • Base
        • Implementation
        • b
        • u
      • stored::ExampleSync2Base
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleSync2Base()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • b
        • u
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleSync2
        • ExampleSync2()
  • 9_fpga
    • Store definition
      • ExampleFpga
      • ExampleFpga2
    • Application
    • FPGA
    • Store reference
      • stored::ExampleFpgaObjects
        • Base
        • Implementation
        • blob
        • bool_obj
        • default_register
        • default_register_write_count
        • ignored_function
        • initialized_register
        • read_only_register
        • string
        • t_clk
      • stored::ExampleFpgaBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleFpgaBase()
        • __ignored_function()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • blob
        • bool_obj
        • default_register
        • default_register_write_count
        • ignored_function
        • initialized_register
        • read_only_register
        • string
        • t_clk
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleFpga
        • ExampleFpga()
      • stored::ExampleFpga2Objects
        • Base
        • Implementation
        • other_store_s_int8
      • stored::ExampleFpga2Base
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleFpga2Base()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • other_store_s_int8
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleFpga2
        • ExampleFpga2()
  • components
    • Store definition
    • Application
    • Store reference
      • stored::ExampleComponentsObjects
        • Base
        • Implementation
        • environment__air_molar_mass_kg__mol
        • environment__G_m__s_2
        • environment__surface_air_pressure_Pa
        • environment__temperature_K
        • helicopter__drag_coefficient
        • helicopter__height_m
        • helicopter__lift_coefficient
        • helicopter__mass_kg
        • helicopter__motor_constant
        • helicopter__speed_m__s
        • pid__enable
        • pid__epsilon
        • pid__frequency_Hz
        • pid__high
        • pid__int
        • pid__int_high
        • pid__int_low
        • pid__Kff
        • pid__Kp
        • pid__low
        • pid__override
        • pid__reset
        • pid__setpoint
        • pid__Td_s
        • pid__Ti_s
        • pid__u
        • pid__y
      • stored::ExampleComponentsBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleComponentsBase()
        • __pid__frequency_Hz()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • environment__air_molar_mass_kg__mol
        • environment__G_m__s_2
        • environment__surface_air_pressure_Pa
        • environment__temperature_K
        • helicopter__drag_coefficient
        • helicopter__height_m
        • helicopter__lift_coefficient
        • helicopter__mass_kg
        • helicopter__motor_constant
        • helicopter__speed_m__s
        • pid__enable
        • pid__epsilon
        • pid__frequency_Hz
        • pid__high
        • pid__int
        • pid__int_high
        • pid__int_low
        • pid__Kff
        • pid__Kp
        • pid__low
        • pid__override
        • pid__reset
        • pid__setpoint
        • pid__Td_s
        • pid__Ti_s
        • pid__u
        • pid__y
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleComponentsStore
        • ExampleComponentsStore()
        • __pid__frequency_Hz()
  • concurrency
    • Store definition
      • ExampleConcurrencyMain
      • ExampleConcurrencyControl
    • Application
    • Output
    • Store reference
      • stored::ExampleConcurrencyMainObjects
        • Base
        • Implementation
        • not_synchronized_to_other_thread
      • stored::ExampleConcurrencyMainBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleConcurrencyMainBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • not_synchronized_to_other_thread
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleConcurrencyMain
        • ExampleConcurrencyMain()
      • stored::ExampleConcurrencyControlObjects
        • Base
        • Implementation
        • actual
        • override_obj
        • run
        • setpoint
      • stored::ExampleConcurrencyControlBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleConcurrencyControlBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • actual
        • override_obj
        • run
        • setpoint
        • freeFunction()
        • freeVariable()
        • hash()
      • ControlStore
        • ControlStore()
  • control
    • Store definition
    • Application
    • Store reference
      • stored::ExampleControlObjects
        • Base
        • Implementation
        • amp__enable
        • amp__evaluation_order
        • amp__gain
        • amp__high
        • amp__input
        • amp__low
        • amp__offset
        • amp__output
        • amp__override
        • amp__x_input
        • amp__x_output
        • frequency_Hz
        • interconnect__x_0
        • interconnect__x_1
        • interconnect__x_2
        • interconnect__x_3
        • interconnect__x_4
        • interconnect__x_5
        • interconnect__x_6
        • interconnect__x_7
        • interconnect__x_8
        • interconnect__x_9
        • lowpass__cutoff_frequency_Hz
        • lowpass__enable
        • lowpass__evaluation_order
        • lowpass__input
        • lowpass__output
        • lowpass__override
        • lowpass__reset
        • lowpass__sample_frequency_Hz
        • lowpass__x_input
        • lowpass__x_output
        • pid__enable
        • pid__epsilon
        • pid__evaluation_order
        • pid__frequency_Hz
        • pid__high
        • pid__int
        • pid__int_high
        • pid__int_low
        • pid__Kff
        • pid__Kp
        • pid__low
        • pid__override
        • pid__reset
        • pid__setpoint
        • pid__Td_s
        • pid__Ti_s
        • pid__u
        • pid__x_setpoint
        • pid__x_u
        • pid__x_y
        • pid__y
        • pulse__amplitude
        • pulse__duty_cycle
        • pulse__enable
        • pulse__evaluation_order
        • pulse__frequency_Hz
        • pulse__output
        • pulse__override
        • pulse__phase_rad
        • pulse__sample_frequency_Hz
        • pulse__x_duty_cycle
        • pulse__x_output
        • ramp__acceleration_limit
        • ramp__enable
        • ramp__evaluation_order
        • ramp__input
        • ramp__output
        • ramp__override
        • ramp__reset
        • ramp__sample_frequency_Hz
        • ramp__speed_limit
        • ramp__x_input
        • ramp__x_output
        • sine__amplitude
        • sine__enable
        • sine__evaluation_order
        • sine__frequency_Hz
        • sine__output
        • sine__override
        • sine__phase_rad
        • sine__sample_frequency_Hz
        • sine__x_output
      • stored::ExampleControlBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleControlBase()
        • __frequency_Hz()
        • __lowpass__sample_frequency_Hz()
        • __pid__frequency_Hz()
        • __pulse__sample_frequency_Hz()
        • __ramp__sample_frequency_Hz()
        • __sine__sample_frequency_Hz()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • interconnect__x_a()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • amp__enable
        • amp__evaluation_order
        • amp__gain
        • amp__high
        • amp__input
        • amp__low
        • amp__offset
        • amp__output
        • amp__override
        • amp__x_input
        • amp__x_output
        • frequency_Hz
        • interconnect__x_0
        • interconnect__x_1
        • interconnect__x_2
        • interconnect__x_3
        • interconnect__x_4
        • interconnect__x_5
        • interconnect__x_6
        • interconnect__x_7
        • interconnect__x_8
        • interconnect__x_9
        • lowpass__cutoff_frequency_Hz
        • lowpass__enable
        • lowpass__evaluation_order
        • lowpass__input
        • lowpass__output
        • lowpass__override
        • lowpass__reset
        • lowpass__sample_frequency_Hz
        • lowpass__x_input
        • lowpass__x_output
        • pid__enable
        • pid__epsilon
        • pid__evaluation_order
        • pid__frequency_Hz
        • pid__high
        • pid__int
        • pid__int_high
        • pid__int_low
        • pid__Kff
        • pid__Kp
        • pid__low
        • pid__override
        • pid__reset
        • pid__setpoint
        • pid__Td_s
        • pid__Ti_s
        • pid__u
        • pid__x_setpoint
        • pid__x_u
        • pid__x_y
        • pid__y
        • pulse__amplitude
        • pulse__duty_cycle
        • pulse__enable
        • pulse__evaluation_order
        • pulse__frequency_Hz
        • pulse__output
        • pulse__override
        • pulse__phase_rad
        • pulse__sample_frequency_Hz
        • pulse__x_duty_cycle
        • pulse__x_output
        • ramp__acceleration_limit
        • ramp__enable
        • ramp__evaluation_order
        • ramp__input
        • ramp__output
        • ramp__override
        • ramp__reset
        • ramp__sample_frequency_Hz
        • ramp__speed_limit
        • ramp__x_input
        • ramp__x_output
        • sine__amplitude
        • sine__enable
        • sine__evaluation_order
        • sine__frequency_Hz
        • sine__output
        • sine__override
        • sine__phase_rad
        • sine__sample_frequency_Hz
        • sine__x_output
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleControl
        • ExampleControl()
  • fibered
    • Store definition
    • Application
    • Output
  • meta
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExampleMetaObjects
        • Base
        • Implementation
        • a_double
        • some_int
        • world
      • stored::ExampleMetaBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleMetaBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • a_double
        • some_int
        • world
        • freeFunction()
        • freeVariable()
        • hash()
      • ExampleMeta
        • ExampleMeta()
  • pipes
    • Store definition
    • Application
    • Output
    • Store reference
      • stored::ExamplePipesObjects
        • Base
        • Implementation
        • sensor
        • setpoint
      • stored::ExamplePipesBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExamplePipesBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • sensor
        • setpoint
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExamplePipes
        • ExamplePipes()
  • terminal
    • Store definition
    • Application
    • Store reference
      • stored::ExampleTerminalObjects
        • Base
        • Implementation
        • oh_gosh
        • small__world
        • supercalifragilisticexpialidocious
      • stored::ExampleTerminalBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ExampleTerminalBase()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • oh_gosh
        • small__world
        • supercalifragilisticexpialidocious
        • freeFunction()
        • freeVariable()
        • hash()
      • stored::ExampleTerminal
        • ExampleTerminal()
  • zmqserver
    • Store definition
    • Application
    • Screenshot
    • Store reference
      • stored::ZmqServerStoreObjects
        • Base
        • Implementation
        • a_blob
        • a_bool
        • a_double
        • a_float
        • a_ptr32
        • a_ptr64
        • a_string
        • a_uint16
        • a_uint32
        • a_uint64
        • a_uint8
        • an_int16
        • an_int32
        • an_int64
        • an_int8
        • compute__an_int8_an_int16
        • compute__circle_area_r__a_double
        • compute__length_of__a_string
        • rand
        • stats__object_writes
        • stats__ZMQ_messages
        • t_us
      • stored::ZmqServerStoreBase
        • ObjectCount
        • VariableCount
        • FunctionCount
        • BufferSize
        • Implementation
        • Key
        • ObjectMap
        • Objects
        • root
        • self
        • ~ZmqServerStoreBase()
        • __compute__an_int8_an_int16()
        • __compute__circle_area_r__a_double()
        • __compute__length_of__a_string()
        • __rand()
        • __stats__object_writes()
        • __stats__ZMQ_messages()
        • __t_us()
        • bufferToKey()
        • bufferToType()
        • find()
        • function()
        • implementation()
        • implementation()
        • list()
        • list()
        • longDirectory()
        • map()
        • name()
        • shortDirectory()
        • variable()
        • a_blob
        • a_bool
        • a_double
        • a_float
        • a_ptr32
        • a_ptr64
        • a_string
        • a_uint16
        • a_uint32
        • a_uint64
        • a_uint8
        • an_int16
        • an_int32
        • an_int64
        • an_int8
        • compute__an_int8_an_int16
        • compute__circle_area_r__a_double
        • compute__length_of__a_string
        • rand
        • stats__object_writes
        • stats__ZMQ_messages
        • t_us
        • freeFunction()
        • freeVariable()
        • hash()
      • ZmqServerStore
        • ZmqServerStore()
        • incMessages()

Indices and tables

• Index

• Module Index

• Search Page