State Machines, Activities, XML Properties, Scripting,...
The Real-Time Toolkit is documented in The Orocos Real-Time Toolkit Online Manual
Classes | |
| class | ActionInterface |
| class | ActivityInterface |
| struct | ArgumentDescription |
| class | AsynchCommandDecorator |
| Based on the software patterns 'command' and 'decorator', this interface represents a wrapper around a given command, which decorates that command as an asynchronous command. More... | |
| class | AtomicQueue |
| A lock-free queue implementation to enqueue or dequeue a pointer of type T. More... | |
| class | Attribute |
| An Attribute has a name and contains data which can be set and get. More... | |
| class | Constant |
| As opposed to a Attribute, a Constant can not be assigned to a new value after creation. More... | |
| class | Alias |
| This class is the most basic Attribute implementation (only suitable for reading a DataSource), does not allow any assignment, just stores a DataSource<T>, and returns it. More... | |
| class | AttributeBase |
| An attribute is a minimalistic, named placeholder for data. More... | |
| class | AttributeRepository |
| class | BufferBase |
| Any Buffer has a capacity, size and can be empty or full. More... | |
| class | BufferConnection |
| A local connection with a Buffer, which is used to connect multiple Ports to that Buffer. More... | |
| class | ReadConnectionInterface |
| This is the interface of a connection which transfers buffered data from a read Port a TaskContext. More... | |
| class | WriteConnectionInterface |
| This is the interface of a connection which transfers buffered data to a write Port of a TaskContext. More... | |
| class | BufferConnectionInterface |
| This is the interface of a connection which transfers buffered data bidirectionally from a port of a TaskContext. More... | |
| class | BufferDataSource |
| A DataSource which provides read-only access to the next value to be read from the buffer, without removing that value from the buffer. More... | |
| class | BufferInterface |
| A Buffer is an object which is used to store (Push) and retrieve (Pop) values from. More... | |
| class | BufferLocked |
| Implements a very simple blocking threadsafe buffer, using mutexes (locks). More... | |
| class | BufferLockFree |
| A Lock-free buffer implementation to read and write data of type T in a FIFO way. More... | |
| struct | NonBlockingPolicy |
| Use this policy to indicate that you do not want to block on an empty or full buffer, queue, fifo,. More... | |
| struct | BlockingPolicy |
| Use this policy to indicate that you do want to block on an empty or full buffer, queue, fifo,. More... | |
| class | ReadBufferPort |
| A Port to a readable Buffer. More... | |
| class | WriteBufferPort |
| A Port to a writable Buffer. More... | |
| class | BufferPort |
| A Port to a read-write Buffer. More... | |
| struct | CallbackInterface |
| class | Command |
| A Command is a function which can be sent to a task for execution and be queried for its execution status. More... | |
| struct | CommandBinary |
| class | CommandC |
| A user friendly Command to a TaskContext. More... | |
| class | CommandComposite |
| class | CommandCounter |
| struct | CommandDataSource |
| A Command which evaluates a DataSourceBase and always returns true. More... | |
| struct | CommandDataSourceBool |
| A Command which evaluates a DataSource<bool> and returns the result of get(). More... | |
| class | CommandDispatch |
| Dispatch a CommandInterface to a CommandProcessor. More... | |
| class | CommandDS |
| A Command storage container. More... | |
| class | ConditionExecFunction |
| A condition which checks if a CommandExecFunction is done or not. More... | |
| class | CommandExecFunction |
| A command which queues (dispatches) a FunctionFraph for execution in a ProgramProcessor. More... | |
| class | CommandFunctor |
| class | CommandIllegal |
| class | CommandNOP |
| The empty command. More... | |
| class | CommandProcessor |
| class | CommandRepository |
| A command repository stores a number of commands from a Task which can be used by other tasks or from scripts. More... | |
| class | CommandString |
| class | CompletionProcessor |
| class | ConditionBool |
| class | ConditionBoolDataSource |
| A Condition which holds a boolean DataSource. More... | |
| class | ConditionBoolProperty |
| ConditionBoolProperty is a Condition which reads out a Property<bool>. More... | |
| class | ConditionCompare |
| A general compare condition. More... | |
| class | ConditionBinaryCompositeAND |
| Compose an 'AND' function of two Conditions. More... | |
| class | ConditionBinaryCompositeOR |
| class | ConditionCompositeNOT |
| class | ConditionDSDuration |
| A conditional that evaluates true after a certain time (in seconds) has passed, given by a DataSource. More... | |
| class | ConditionDuration |
| A conditional that evaluates true after a certain time has passed. More... | |
| class | ConditionExpire |
| A conditional that evaluates true until a certain time has elapsed since construction or the last reset(). More... | |
| class | ConditionFalse |
| A conditional that evaluates false. More... | |
| class | ConditionInterface |
| class | ConditionInvert |
| A conditional that evaluates to the inverse of another Condition. More... | |
| class | ConditionOnce |
| A conditional that evaluates the first time true and afterwards always false (or vice versa). More... | |
| class | ConditionTrue |
| A conditional that evaluates true. More... | |
| class | ConfigurationInterface |
| class | Configurator |
| class | ConnectionC |
| A user friendly callback connection to an event of a TaskContext. More... | |
| class | ConnectionFactory |
| Builds Connections (buffers or data objects) between the ports of tasks. More... | |
| class | ConnectionInterface |
| An Object which manages and maintains a communication connection between Ports. More... | |
| struct | ConnectionTypes |
| Enumerates all the types of connections supported by this factory. More... | |
| struct | AnyConversion |
| This class converts a given application-specific type to a CORBA::Any object and vice versa. More... | |
| struct | AnyConversionHelper |
| struct | AnyConversion< double > |
| struct | AnyConversion< float > |
| struct | AnyConversion< int > |
| struct | AnyConversion< long > |
| struct | AnyConversion< unsigned int > |
| struct | AnyConversion< PropertyBag > |
| struct | AnyConversion< bool > |
| struct | AnyConversion< char > |
| class | DataConnection |
| A local connection with a DataObject, which is used to connect multiple Ports to that DataObject. More... | |
| class | DataConnectionInterface |
| This is the interface of a connection which transfers data unbuffered between two Ports of a TaskContext. More... | |
| class | DataFlowInterface |
| The Interface of a TaskContext which exposes its data-flow ports. More... | |
| class | DataObjectInterface |
| class | DataObjectLocked |
| class | DataObjectPrioritySet |
| class | DataObjectPriorityGet |
| class | DataObjectLockFree |
| class | DataObject |
| class | ReadDataPort |
| A Port to a readable Data Connection. More... | |
| class | WriteDataPort |
| A Port to a writable Data Connection. More... | |
| class | DataPort |
| A data port which can be used as a reader and as a writer. More... | |
| struct | bad_assignment |
| This exception is thrown if the target and source type of an assignment of a DataSource with a DataSourceBase differ. More... | |
| class | DataSource |
| DataSource is a base class representing a generic way to read data of type T. More... | |
| class | AssignableDataSource |
| A DataSource which has set() methods. More... | |
| class | DataSourceBase |
| class | DataSourceCommand |
| A class that wraps a Command in a DataSource<bool> interface. More... | |
| class | DataSourceCondition |
| A class that wraps a Condition in a DataSource<bool> interface. More... | |
| struct | GenerateDataSource |
| A function object which returns a vector of DataSources. More... | |
| class | ValueDataSource |
| A simple, yet very useful DataSource, which keeps a value, and returns it in its get() method. More... | |
| class | ConstantDataSource |
| A DataSource which holds a constant value and returns it in its get() method. More... | |
| class | ReferenceDataSource |
| A DataSource which is used to manipulate a reference to an external value. More... | |
| class | IndexedValueDataSource |
| A ValueDataSource of which individual parts can be updated using an index. More... | |
| class | BinaryDataSource |
| A generic binary composite DataSource. More... | |
| class | TernaryDataSource |
| A DataSource which returns the return value of a ternary function. More... | |
| class | SixaryDataSource |
| A DataSource which returns the return value of a sixary function. More... | |
| class | UnaryDataSource |
| A DataSource which returns the return value of a unary function. More... | |
| class | NArityDataSource |
| A generic N-arity composite DataSource. More... | |
| class | DataSourceTime |
| A DataSource which returns the time elapsed since the last reset in Seconds. More... | |
| class | AnalogInInterface |
| An interface for reading analog input, like for addressing a whole subdevice in comedi. More... | |
| class | AnalogInput |
| A class representing an analog input channel. More... | |
| class | AnalogOutInterface |
| An interface for writing analog output, like for addressing a whole subdevice in comedi. More... | |
| class | AnalogOutput |
| A class representing an analog output channel. More... | |
| class | AxisInterface |
| The AxisInterface represents an axis from a control point of view. More... | |
| class | CalibrationInterface |
| class | DigitalInInterface |
| A class representing a Digital Input device from which a maximum of 32 bits can be read at once. More... | |
| class | DigitalInput |
| A class representing a switch which can be on or off. More... | |
| class | DigitalOutInterface |
| A class representing a Digital Output device which can read or write a maximum of 32 bits at once. More... | |
| class | DigitalOutput |
| A DigitalOut represents any on/off output. More... | |
| class | DriveInterface |
| class | EncoderInterface |
| class | HomingInterface |
| class | PulseTrainGeneratorInterface |
| class | SensorInterface |
| class | DispatchAction |
| An action which invokes a dispatch command in execute(). More... | |
| class | DispatchInterface |
| Dispatch a CommandInterface to a CommandProcessor and track its status. More... | |
| class | EdgeCondition |
| class | Event |
| The Orocos Event is a thread-safe publish-subscribe implementation and provides synchronous and asynchronous callback handling. More... | |
| class | EventC |
| A user friendly event of a TaskContext. More... | |
| class | EventDrivenActivity |
| class | EventProcessor |
| An Asynchronous Event Processor, which catches events and executes the asynchronous callbacks in its RunnableInterface::step(). More... | |
| class | BlockingEventProcessor |
| The Blocking EventProcessor, extended with a blocking implementation, waiting for one Event to complete in its loop(). More... | |
| class | EventService |
| The EventService represents the event interface. More... | |
| class | ExecutionAccess |
| class | ExecutionEngine |
| An execution engine serialises (executes one after the other) the execution of all commands, programs, state machines and incomming events for a task. More... | |
| struct | name_not_found_exception |
| Exception thrown when a factory is requested to create an object with an unknown name. More... | |
| struct | wrong_number_of_args_exception |
| Exception thrown when a factory is requested to create an object but the wrong number of arguments was given. More... | |
| struct | wrong_types_of_args_exception |
| Exception thrown when a factory is requested to create an object, but a wrong argument type was given. More... | |
| struct | non_lvalue_args_exception |
| Exception thrown when a factory is requested to create an object, and one of the arguments needed to be an lvalue (AssignableDataSource) and an rvalue (plain DataSource) was given. More... | |
| class | FunctionGraph |
| This class represents a function. More... | |
| struct | finder |
| class | FunctionGraphBuilder |
| class | Handle |
| class | ScopedHandle |
| A scoped connection Handle of a (connected) slot which disconnects a slot from a signal in its destructor. More... | |
| class | CleanupHandle |
| A connection Handle of a (connected) slot which disconnects and cleans up (free all resources) a slot from a signal in its destructor. More... | |
| class | ListLockFree |
| A simple lock-free list implementation to append or erase data of type T. More... | |
| class | Logger |
| A simple logging class to debug/ analyse what is going on in the Orocos system. More... | |
| class | EmptyHeaderMarshaller |
| class | EmptyMarshaller |
| class | INIMarshaller |
| A Marshaller which writes out the properties in MS .INI format. More... | |
| class | MarshallerAdaptor |
| Converts one marshaller type to another marshaller. More... | |
| class | PropertyAdaptor |
| class | MarshallConfiguration |
| Contains the required classes for a full marshalling operation. More... | |
| class | DemarshallConfiguration |
| Contains the required classes for a full demarshalling operation. More... | |
| class | Orocos1Demarshaller |
| A demarshaller which parses data compatible with the previous Orocos property system. More... | |
| class | Orocos1Marshaller |
| A marshaller which generates data compatible with the previous Orocos property system. More... | |
| class | PropertyDemarshaller |
| class | PropertyMarshaller |
| A class for writing a property or propertybag into file. More... | |
| class | SimpleDemarshaller |
| A simple demarshaller. More... | |
| class | SimpleMarshaller |
| A simple marshaller which flattens your property bag into simple types. More... | |
| class | StreamProcessor |
| class | TableHeaderMarshaller |
| A Marshaller for generating headers of tables. More... | |
| class | TableMarshaller |
| A Marshaller for generating a stream of numbers, ordered in columns. More... | |
| class | TinyDemarshaller |
| class | XMLDemarshaller |
| Unimplemented counterpart of XMLMarshaller. More... | |
| class | XMLMarshaller |
| Marshalls a PropertyBag to a non standard XML format. More... | |
| class | SAX2XMLRPCHandler |
| class | XMLRPCDemarshaller |
| A Demarshaller for the XMLRPC Protocol. More... | |
| class | XMLRPCMarshaller |
| Outputs a Property or PropertyBag into a text stream in the XML-RPC format. More... | |
| class | Marshaller |
| class | Demarshaller |
| class | MarshallingAccess |
| Load and save properties of a TaskContext. More... | |
| class | MemoryPool |
| A memory pool in which allocate() and deallocate() are lock-free. More... | |
| class | FixedSizeMemoryPool |
| A fixed size, lock-free Memory Pool with reference counted memory. More... | |
| class | Method |
| A method which executes a function. More... | |
| class | MethodC |
| A user friendly method to a TaskContext. More... | |
| class | MethodRepository |
| This class allows storage and retrieval of Method objects. More... | |
| struct | MultiVector |
| struct | remove_cr |
| struct | select1st |
| struct | select2nd |
| struct | identity |
| struct | pointer_to_ternary_function |
| struct | pointer_to_sixary_function |
| struct | multiplies3 |
| struct | divides3 |
| struct | divides3< int, int, int > |
| struct | adds3 |
| struct | subs3 |
| class | NameServer |
| class | NameServerRegistrator |
| class | NonPeriodicActivity |
| class | OperationFactory |
| class | OperationInterface |
| The interface for accessing and executing 'operations', being commands, methods, events and attributes. More... | |
| class | OperatorRepository |
| This class builds on upon construction all expression operators known to Orocos. More... | |
| class | PeriodicActivity |
| class | PortInterface |
| A Port of a task is used to connect it with other tasks using a Connector. More... | |
| class | program_load_exception |
| This exception is thrown when a program or state machine could not be loaded into a ProgramProcessor or StateMachineProcessor. More... | |
| class | program_unload_exception |
| This exception is thrown when a program or state machine could not be unloaded into a ProgramProcessor or StateMachineProcessor. More... | |
| class | ProgramInterface |
| class | ProgramProcessor |
| This class implements a real-time program processor. More... | |
| class | Property |
| class | PropertyBag |
| class | PropertyBagIntrospector |
| class | PropertyBase |
| Base class for all properties. More... | |
| class | PropertyBagVisitor |
| A simple introspection interface to visit PropertyBags. More... | |
| class | PropertyIntrospection |
| An interface which all classes which wish to visit a Property should implement. More... | |
| class | PropertyLoader |
| Load and save property files to a TaskContext's PropertyBag. More... | |
| class | PropertySequence |
| class | ReadInterface |
| This interface describes a read interface for value types. More... | |
| struct | StdVectorTypeInfo |
| This class tells Orocos how to handle std::vector<double>. More... | |
| struct | BoolTypeInfo |
| Write boolean as 'true' or 'false'. More... | |
| class | RealTimeToolkitPlugin |
| This interface defines the types of the realTime package. More... | |
| class | RunnableInterface |
| This class adds Activity specific semantics to OS::RunnableInterface and sits in the RTT namespace. More... | |
| class | FunctionFactory |
| A CommandFactory which delivers commands which execute a FunctionGraph in a Processor. More... | |
| class | file_parse_exception |
| This is an exception class that keeps a parse_exception pointer along with the location in the file and the file where it occurred. More... | |
| class | parse_exception |
| This is the uppermost exception class in the parser system. More... | |
| class | ParsedStateMachine |
| State machine created by the scripting engine which represents a parsed state machine. More... | |
| struct | eol_skip_functor |
| Parser used in skip parser. More... | |
| class | Parser |
| class | ParserExecutionAccess |
| class | ParserScriptingAccess |
| This implementation provides access to the loaded programs and state machines and allows execution of code, using the Orocos parser framework. More... | |
| class | ProgramLoader |
| This class loads and unloads Orocos Program Script and Orocos State Description files to a TaskContext's Processor. More... | |
| class | ProgramTask |
| class | StateMachineTask |
| class | StatementProcessor |
| This class parses and executes a single scripting statement. More... | |
| class | ScriptingAccess |
| This interface allows to load program scripts and state machines and allows execution of code. More... | |
| class | SimulationActivity |
| class | SimulationThread |
| This thread is the simulated real-time periodic thread in the Orocos system. More... | |
| class | SingleList |
| A single-linked single list algorithm invented by Timothy L. More... | |
| class | SlaveActivity |
| class | SortedList |
| A single-linked sorted list algorithm invented by Timothy L. More... | |
| class | StateDescription |
| class | StateInterface |
| A State contains an entry, run, handle and exit program. More... | |
| class | StateMachine |
| class | StateMachineProcessor |
| This class implements a real-time state machine executor. More... | |
| class | TaskContext |
| A TaskContext exports the commands, methods, events, properties and ports a task has. More... | |
| class | TaskCore |
| The minimal Orocos task. More... | |
| class | TaskObject |
| A task object groups a set of commands and methods (operations) which may be invoked. More... | |
| class | TemplateTypeInfo |
| This helper class allows user types to be added to Orocos. More... | |
| struct | AlwaysAssignChecker |
| struct | SizeAssignChecker |
| struct | ArrayIndexChecker |
| struct | RangeIndexChecker |
| class | TemplateContainerTypeInfo |
| Template for containers. More... | |
| class | TemplateIndexTypeInfo |
| Template for indexable types. More... | |
| class | Timer |
| This class allows to define a timer object which can be armed in single shot and periodic mode. More... | |
| class | TimerThread |
| This Periodic Thread is meant for executing a PeriodicActivity object periodically. More... | |
| class | TimeService |
| The TimeService is used for system-wide time keeping and conversions. More... | |
| class | ToolkitPlugin |
| This interface defines how additional toolkits are loaded into Orocos. More... | |
| class | Toolkit |
| This class allows the Orocos Real-Time Toolkit to be extended with additional toolkits (ToolkitPlugin), such as for kinematics or any library foreign to Orocos. More... | |
| class | TryCommand |
| A command which tries another command and stores the result in a DataSource<bool>. More... | |
| class | TryCommandResult |
| Returns the (accept/reject) status of another command. More... | |
| class | EvalCommand |
| Evaluates a DataSource<bool> in a command. More... | |
| class | EvalCommandResult |
| The result of a command which evaluates a boolean DataSource. More... | |
| class | EmptyTypeInfo |
| Empty implementation of TypeInfo interface. More... | |
| struct | TypeInfoName |
| This helper class allows only type names to be added to Orocos. More... | |
| struct | TypeBuilder |
| This interface describes how constructors work. More... | |
| class | TypeInfo |
| A class for representing a user type, and which can build instances of that type. More... | |
| class | TypeInfoRepository |
| This class contains all known types to Orocos. More... | |
| class | VertexNode |
| This class represents elements in a program tree. More... | |
| class | WriteInterface |
| This interface describes a write interface for value types. More... | |
| class | CommandFunctor< boost::function< bool(void) > > |
| Specialisation of CommandFunctor. More... | |
| struct | AnyConversion< CORBA::Any_ptr > |
| struct | AnyConversion< CORBA::Any_var > |
| struct | AnyConversion< std::string > |
| struct | AnyConversion< std::vector< double > > |
| class | CPFMarshaller< std::ostream > |
| A class for marshalling a property or propertybag into a component property description, following the CORBA 3 standard. More... | |
Namespaces | |
| namespace | Corba |
| The Corba namespace is used to hold both the Orocos CORBA interfaces and Orocos CORBA implementations. | |
| namespace | detail |
| Implementation specific classes, not intended for users. | |
| namespace | DLib |
| This Namespace contains helper classes for the minimal and real-time 'Distribution Library' of Orocos. | |
| namespace | OS |
| namespace | rt_std |
| (Almost) Real-Time output streams. | |
Typedefs | |
| typedef ActionInterface | CommandInterface |
|
typedef boost::shared_ptr < FunctionGraph > | FunctionGraphPtr |
|
typedef boost::weak_ptr < FunctionGraph > | FunctionGraphWPtr |
|
typedef MultiVector< 6, double > | Double6D |
| A MultiVector consisting of 6 doubles. | |
|
typedef MultiVector< 6, int > | Int6D |
| A MultiVector consisting of 6 integers. | |
|
typedef MultiVector< 6, bool > | Bool6D |
| A MultiVector consisting of 6 booleans. | |
|
typedef MultiVector< 6, long > | Long6D |
| A MultiVector consisting of 6 longs. | |
|
typedef OperationFactory < DispatchInterface * > | CommandFactory |
|
typedef OperationFactory < DataSourceBase * > | MethodFactory |
|
typedef boost::shared_ptr < ProgramInterface > | ProgramInterfacePtr |
|
typedef boost::weak_ptr < ProgramInterface > | ProgramInterfaceWPtr |
|
typedef boost::shared_ptr < ParsedStateMachine > | ParsedStateMachinePtr |
|
typedef boost::weak_ptr < ParsedStateMachine > | ParsedStateMachineWPtr |
| typedef std::string | our_buffer_t |
|
typedef our_buffer_t::iterator | our_iterator_t |
|
typedef position_iterator < our_iterator_t > | our_pos_iter_t |
| typedef our_pos_iter_t | iter_t |
|
typedef skip_parser_iteration_policy < skip_parser_t > | iter_pol_t |
|
typedef scanner_policies < iter_pol_t > | scanner_pol_t |
|
typedef scanner < iter_t, scanner_pol_t > | scanner_t |
| typedef rule< scanner_t > | rule_t |
|
typedef rule < lexeme_scanner < scanner_t >::type > | lexeme_rule_t |
|
typedef boost::shared_ptr < StateMachineTask > | StateMachineTaskPtr |
|
typedef boost::shared_ptr < SimulationThread > | SimulationThreadPtr |
|
typedef boost::shared_ptr < StateMachine > | StateMachinePtr |
|
typedef boost::weak_ptr < StateMachine > | StateMachineWPtr |
| typedef double | Seconds |
| Seconds are stored as a double precision float. | |
| typedef long | secs |
| seconds as a signed long. | |
| typedef long | msecs |
| milliseconds as a signed long. | |
| typedef long | usecs |
| microseconds as a signed long. | |
| typedef long long | nsecs |
| nanoseconds as a signed long long. | |
| typedef long long | psecs |
| picoseconds as a signed long long | |
|
typedef boost::shared_ptr < TimerThread > | TimerThreadPtr |
| TimerThread objects are reference counted such that when the last PeriodicActivity which uses it is deleted, the thread is deleted as well. | |
Enumerations | |
| enum | LoggerLevel { Never = 0, Fatal, Critical, Error, Warning, Info, Debug, RealTime } |
| Enumerate all log-levels from absolute silence to everything. More... | |
| enum | vertex_command_t { vertex_command } |
| enum | vertex_exec_t { vertex_exec } |
Functions | |
| template<class ComF, class ConF, class Object> | |
| Command< typename detail::UnMember < ComF >::type > | command (std::string name, ComF command, ConF condition, Object object, bool invert=false) |
| Factory function to create a Command object which executes a member function of an object. | |
| template<class ComF, class ConF, class Object> | |
| Command< typename detail::UnMember < ComF >::type > | command (std::string name, ComF command, ConF condition, Object object, CommandProcessor *cp, bool invert=false) |
| Factory function to create a Command object which executes a member function of an object. | |
| template<class ComF, class ConF> | |
| Command< typename detail::UnMember < ComF >::type > | command (std::string name, ComF command, ConF condition, CommandProcessor *cp, bool invert=false) |
| Factory function to create a Command object which executes a 'C' function. | |