Module: OroGen::Spec

Extended by:
Logger::Hierarchy
Defined in:
lib/orogen.rb,
lib/orogen/spec.rb,
lib/orogen/spec/doc.rb,
lib/orogen/spec/port.rb,
lib/orogen/spec/project.rb,
lib/orogen/spec/typekit.rb,
lib/orogen/spec/property.rb,
lib/orogen/spec/attribute.rb,
lib/orogen/spec/operation.rb,
lib/orogen/spec/deployment.rb,
lib/orogen/spec/input_port.rb,
lib/orogen/spec/output_port.rb,
lib/orogen/spec/task_context.rb,
lib/orogen/spec/dynamic_ports.rb,
lib/orogen/spec/opaque_definition.rb,
lib/orogen/spec/configuration_object.rb

Defined Under Namespace

Modules: DynamicPort Classes: Attribute, ConfigurationObject, ConnPolicy, Deployment, DynamicInputPort, DynamicOutputPort, GenericObjectDeployment, InputPort, OpaqueDefinition, Operation, OperationDeployment, OutputPort, Port, PortDeployment, Project, Property, PropertyDeployment, TaskContext, TaskDeployment, TaskModelExtension, Typekit

Constant Summary collapse

ACTIVITY_TYPES =
{
    :fd_driven    => 'FileDescriptorActivity',
    :irq_driven   => 'IRQActivity',
    :slave        => 'SlaveActivity',
    :periodic     => 'PeriodicActivity',
    :triggered    => 'NonPeriodicActivity',
    :sequential   => 'SequentialActivity'
}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.default_nonrt_minimal_trigger_latencyObject

Default minimal latency value used for non-realtime scheduling

See TaskDeployment::minimal_trigger_latency


17
18
19
# File 'lib/orogen/spec/deployment.rb', line 17

def default_nonrt_minimal_trigger_latency
  @default_nonrt_minimal_trigger_latency
end

.default_nonrt_worstcase_trigger_latencyObject

Default expected latency value used for non-realtime scheduling

See TaskDeployment::worstcase_trigger_latency


21
22
23
# File 'lib/orogen/spec/deployment.rb', line 21

def default_nonrt_worstcase_trigger_latency
  @default_nonrt_worstcase_trigger_latency
end

.default_rt_minimal_trigger_latencyObject

Default minimal latency value used for realtime scheduling

See TaskDeployment::minimal_trigger_latency


8
9
10
# File 'lib/orogen/spec/deployment.rb', line 8

def default_rt_minimal_trigger_latency
  @default_rt_minimal_trigger_latency
end

.default_rt_worstcase_trigger_latencyObject

Default expected latency value used for realtime scheduling

See TaskDeployment::worstcase_trigger_latency


12
13
14
# File 'lib/orogen/spec/deployment.rb', line 12

def default_rt_worstcase_trigger_latency
  @default_rt_worstcase_trigger_latency
end

Class Method Details

.load_documentation(object, defmethod) ⇒ Object


3
4
5
6
7
# File 'lib/orogen/spec/doc.rb', line 3

def self.load_documentation(object, defmethod)
    if !object.doc && (doc = MetaRuby::DSLs.parse_documentation_block(/\.orogen$/, defmethod))
        object.doc(doc)
    end
end