Content table

• Installation
  • Installation using graphical installer
    • GUI install
    • Python install
    • Troubleshoots
  • Installation from docker image
  • Installation from source
    • Download
    • Dependencies
    • Build instructions
      • Command line build
• User Guide
  • Launch Falcon from command line
    • Command-line
    • Control commands with a Falcon running graph
      • Keyboard commands
      • Falcon-client gui
  • Define processing graph
    • Processor nodes
    • Data stream connections between processors
    • Shared states
  • Configuring falcon
    • network
    • graph
    • logging
    • server side storage
  • Frequent errors
• Falcon client
  • Generic control app
  • Graph display app
  • Interaction with Falcon
    • Send commands to Falcon
    • Receive log messages
  • Create custom user interface
    • Interaction with Falcon
      • Send commands to Falcon
      • Receive log messages
    • User-side graph
      • Create a new graph
      • Build an new graph
    • Python library
  • Python library
• Developer’s guide
  • Code organization and style guide
  • Style guide
  • System overview
    • Command system
    • Configuration system
    • Logging system
    • Graph system
      • Graph life cycle
      • Stream dataflow
      • Graph API
    • Utilities
      • Options
      • Factory
• Extending Falcon
  • Create new processor
    • Setup for the new processor
    • Develop a processor class
    • Create the internal documentation of your processor
  • Create new data type
  • Add Tools and Resources in an extension
• Falcon API
  • Class Hierarchy
  • File Hierarchy
  • Full API
    • Namespaces
      • Namespace commands
      • Namespace factory
      • Namespace graph
      • Namespace nsAnyType
      • Namespace options
      • Namespace Serialization
      • Namespace std
      • Namespace units
      • Namespace units::precise
      • Namespace YAML
    • Classes and Structs
      • Struct EventCounter
      • Struct Parameters
      • Struct RingBufferStatus
      • Struct TimestampRegister
      • Template Struct convert< Serialization::Encoding >
      • Template Struct convert< Serialization::Format >
      • Class AnyType
      • Class BadGraphDefinition
      • Class CommandHandler
      • Class CommandLineCommands
      • Class CommandSource
      • Class KeyboardCommands
      • Class ZMQCommands
      • Class Configuration
      • Template Class DataFactory
      • Class ExternalPermissionTracker
      • Class DuplicateClass
      • Template Class ObjectFactory
      • Class UnknownClass
      • Class GlobalContext
      • Class GraphManager
      • Class ProcessorGraph
      • Class GraphException
      • Class InvalidGraphCommandError
      • Class InvalidGraphError
      • Class InvalidProcessorError
      • Class InvalidStateError
      • Class IPortIn
      • Class IPortOut
      • Class IProcessor
      • Class ISlotIn
      • Class ISlotOut
      • Class IState
      • Class IStreamInfo
      • Template Class IterativePercentile
      • Template Class Linear
      • Class NoGraphError
      • Class Capabilities
      • Class Data
      • Template Class clamped
      • Class ConversionError
      • Template Class each
      • Template Class inrange
      • Class invert
      • Class isdir
      • Class isfile
      • Template Class Measurement
      • Template Class measurement_fromyaml
      • Template Class measurement_toyaml
      • Template Class multiplied
      • Template Class notempty
      • Template Class Option
      • Class OptionBase
      • Class OptionList
      • Template Class positive
      • Class SkipError
      • Template Class squared
      • Class ValidationError
      • Template Class validator
      • Template Class Value
      • Class ValueBase
      • Template Class ValueMap
      • Template Class Vector
      • Template Class zeroismax
      • Class Permissions
      • Class PortAddress
      • Template Class PortIn
      • Class PortInPolicy
      • Template Class PortOut
      • Class PortOutPolicy
      • Class PortPolicy
      • Class ProcessingConfigureError
      • Class ProcessingContext
      • Class ProcessingCreatePortsError
      • Class ProcessingError
      • Class ProcessingPrepareError
      • Class ProcessingPreprocessingError
      • Class ProcessingStreamInfoError
      • Class ProcessorInternalError
      • Template Class ProcessorRegistrar
      • Template Class Range
      • Template Class ReadableState
      • Class RunContext
      • Class ScreenSink
      • Class BinarySerializer
      • Class FlatBufferSerializer
      • Class Serializer
      • Class YAMLSerializer
      • Class SharedStateAlias
      • Class SharedStateMap
      • Class SlotAddress
      • Template Class SlotIn
      • Template Class SlotOut
      • Template Class StateCloneable
      • Class StorageContext
      • Template Class StreamInfo
      • Template Class stride_iter
      • Template Class WritableState
      • Class ZMQSink
    • Enums
      • Enum GraphState
      • Enum NodePart
      • Enum OptionError
      • Enum Permission
      • Enum Encoding
      • Enum Format
      • Enum TruncateFlag
    • Functions
      • Function check_buffer_sizes
      • Function check_buffer_sizes_and_log(double, double&, bool, size_t&, std::string)
      • Function check_buffer_sizes_and_log(double, double&, bool, size_t&, std::string)
      • Function compare_doubles(double, double, double, double)
      • Function compare_doubles(double, double, double, double)
      • Function complete_path(std::string, std::string, std::string)
      • Function complete_path(std::string, std::string, std::string)
      • Function compute_delta_ts(uint64_t, uint64_t)
      • Function compute_delta_ts(uint64_t, uint64_t)
      • Function convert_name(std::string&)
      • Function convert_name(std::string&)
      • Function custom_sleep_for(uint64_t)
      • Function custom_sleep_for(uint64_t)
      • Function expand_home(const std::string&)
      • Function expand_home(const std::string&)
      • Function expandConnectionRule(ConnectionRule, StreamConnections&)
      • Function expandConnectionRule(ConnectionRule, StreamConnections&)
      • Function expandProcessorName
      • Function expandSingleConnectionRule(SingleConnectionRule)
      • Function expandSingleConnectionRule(SingleConnectionRule)
      • Function extract_path_to_folder(std::string)
      • Function extract_path_to_folder(std::string)
      • Template Function factory::createInstance
      • Template Function from_string(std::string)
      • Template Function from_string(std::string)
      • Template Function get_type_string
      • Specialized Template Function get_type_string< bool >
      • Specialized Template Function get_type_string< char >
      • Specialized Template Function get_type_string< double >
      • Specialized Template Function get_type_string< float >
      • Specialized Template Function get_type_string< int16_t >
      • Specialized Template Function get_type_string< int32_t >
      • Specialized Template Function get_type_string< int64_t >
      • Specialized Template Function get_type_string< int8_t >
      • Specialized Template Function get_type_string< uint16_t >
      • Specialized Template Function get_type_string< uint32_t >
      • Specialized Template Function get_type_string< uint64_t >
      • Specialized Template Function get_type_string< uint8_t >
      • Function getAllFilesInDir(const std::string&)
      • Function getAllFilesInDir(const std::string&)
      • Function graph_state_string
      • Function IdentifyNextSlot(int, int, bool, const PortPolicy&)
      • Function IdentifyNextSlot(int, int, bool, const PortPolicy&)
      • Template Function join(const A&, const A&, const T&)
      • Template Function join(const A&, const A&, const T&)
      • Template Function join(const std::vector<T>&, std::string)
      • Template Function join(const std::vector<T>&, std::string)
      • Function kbhit()
      • Function kbhit()
      • Template Function linspace(T, T, std::size_t)
      • Template Function linspace(T, T, std::size_t)
      • Function LoadProcessorDoc(std::string)
      • Function LoadProcessorDoc(std::string)
      • Function main
      • Template Function make_unique(Args&&…)
      • Template Function make_unique(Args&&…)
      • Template Function nan_mean(ForwardIterator, ForwardIterator, int)
      • Template Function nan_mean(ForwardIterator, ForwardIterator, int)
      • Template Function nan_sum(ForwardIterator, ForwardIterator)
      • Template Function nan_sum(ForwardIterator, ForwardIterator)
      • Function next_pow2(int)
      • Function next_pow2(int)
      • Function nonblock(int)
      • Function nonblock(int)
      • Template Function options::compose
      • Template Function options::generic_fromyaml
      • Template Function options::generic_toyaml
      • Function options::get_nested_yaml_node
      • Function options::set_nested_yaml_node
      • Template Function options::vector_fromyaml
      • Function parse_directory(const std::string&, bool, bool)
      • Function parse_directory(const std::string&, bool, bool)
      • Function parse_file(const std::string&, bool)
      • Function parse_file(const std::string&, bool)
      • Function parseConnectionRule(std::string)
      • Function parseConnectionRule(std::string)
      • Function ParseConnectionRules
      • Function path_exists(const std::string&)
      • Function path_exists(const std::string&)
      • Function permission_from_string(std::string)
      • Function permission_from_string(std::string)
      • Function permission_to_string(Permission, bool)
      • Function permission_to_string(Permission, bool)
      • Function printConnectionList(const StreamConnections&)
      • Function printConnectionList(const StreamConnections&)
      • Function printConnectionPart(const ConnectionPart&)
      • Function printConnectionPart(const ConnectionPart&)
      • Function printConnectionRule(const ConnectionRule&)
      • Function printConnectionRule(const ConnectionRule&)
      • Function printSingleConnectionRule(const SingleConnectionRule&)
      • Function printSingleConnectionRule(const SingleConnectionRule&)
      • Function resolve_server_path(std::string, const std::map<std::string, std::string>&, std::string)
      • Function resolve_server_path(std::string, const std::map<std::string, std::string>&, std::string)
      • Function s_blocking_recv_multi(zmq::socket_t&)
      • Function s_blocking_recv_multi(zmq::socket_t&)
      • Function s_catch_sigint_signal(void)
      • Function s_catch_sigint_signal(void)
      • Function s_nonblocking_recv_multi(zmq::socket_t&, zmq_frames&)
      • Function s_nonblocking_recv_multi(zmq::socket_t&, zmq_frames&)
      • Function s_recv(zmq::socket_t&, std::string&, int)
      • Function s_recv(zmq::socket_t&, std::string&, int)
      • Function s_send(zmq::socket_t&, const std::string&, int)
      • Function s_send(zmq::socket_t&, const std::string&, int)
      • Function s_send_multi(zmq::socket_t&, const zmq_frames&)
      • Function s_send_multi(zmq::socket_t&, const zmq_frames&)
      • Function s_signal_handler(int)
      • Function s_signal_handler(int)
      • Template Function samples2time(T, double)
      • Template Function samples2time(T, double)
      • Function Serialization::encoding_to_string
      • Function Serialization::format_to_string
      • Function Serialization::serializer
      • Function Serialization::serializer_from_string
      • Function Serialization::string_to_encoding
      • Function Serialization::string_to_format
      • Function set_realtime_priority(pthread_t, ThreadPriority)
      • Function set_realtime_priority(pthread_t, ThreadPriority)
      • Function set_thread_core(pthread_t, ThreadCore)
      • Function set_thread_core(pthread_t, ThreadCore)
      • Function sockopt_rcvmore(zmq::socket_t&)
      • Function sockopt_rcvmore(zmq::socket_t&)
      • Function split(const std::string&, char, std::vector<std::string>&)
      • Function split(const std::string&, char)
      • Function split(const std::string&, char, std::vector<std::string>&)
      • Function split(const std::string&, char)
      • Template Function time2samples(double, double, TruncateFlag)
      • Template Function time2samples(double, double, TruncateFlag)
      • Function time_to_string(std::time_t, std::string)
      • Function time_to_string(std::time_t, std::string)
      • Template Function to_string_n(const T, const int)
      • Template Function to_string_n(const T, const int)
      • Function units::precise::sample_units
      • Function units::precise::spike_units
    • Variables
      • Variable CORE_NOT_PINNED
      • Variable ERROR
      • Variable IRREGULARSTREAM
      • Variable MAX_N_HOURS_TEST
      • Variable MAX_TEST_SAMPLING_FREQUENCY
      • Variable PRIORITY_HIGH
      • Variable PRIORITY_LOW
      • Variable PRIORITY_MEDIUM
      • Variable PRIORITY_NONE
      • Variable s_interrupted
      • Variable s_interrupted
      • Variable Serialization::VERSION
      • Variable STATE
      • Variable UPDATE
    • Defines
      • Define GRAPHERROR
      • Define GRAPHEXCEPTION
      • Define GRAPHWARNING
      • Define INCLUDE_STD_FILESYSTEM_EXPERIMENTAL
      • Define MATCH
      • Define MATCH
      • Define MATCH
      • Define MATCH
      • Define MATCH_NONE
      • Define PROCESS_STATE
      • Define REGISTERPROCESSOR
    • Typedefs
      • Typedef BroadcasterState
      • Typedef ChannelRange
      • Typedef ClaimStrategy
      • Typedef Clock
      • Typedef ConnectionPart
      • Typedef ConnectionRule
      • Typedef ConnectionRules
      • Typedef factory::ObjectCreator
      • Typedef FollowerState
      • Typedef IFactory
      • Typedef options::Bool
      • Typedef options::Double
      • Typedef options::Int
      • Typedef options::NullableBool
      • Typedef options::NullableDouble
      • Typedef options::NullableInt
      • Typedef options::NullableString
      • Typedef options::option_error_handler
      • Typedef options::String
      • Typedef options::ValidatorFunc
      • Typedef ProcessorFactory
      • Typedef ProcessorMap
      • Typedef ProducerState
      • Typedef RingAlertException
      • Typedef RingBarrier
      • Typedef RingBatch
      • Typedef RingBuffer
      • Typedef RingSequence
      • Typedef SingleConnectionRule
      • Typedef SlotRange
      • Typedef SlotType
      • Typedef StaticState
      • Typedef StreamConnections
      • Typedef ThreadCore
      • Typedef ThreadPriority
      • Typedef TimePoint
      • Typedef WaitStrategy
      • Typedef zmq_frames