Module: Origen::Tester::Generator::FlowControlAPI::Interface

Defined in:
lib/origen/tester/generator/flow_control_api.rb

Instance Method Summary (collapse)

Instance Method Details

- (Boolean) context_changed?(*args, &block)

Alias for flow#context_changed?

Returns:

  • (Boolean)


599
600
601
# File 'lib/origen/tester/generator/flow_control_api.rb', line 599

def context_changed?(*args, &block)
  flow.context_changed?(*args, &block)
end

- (Object) current_context(*args, &block)

Alias for flow#current_context



594
595
596
# File 'lib/origen/tester/generator/flow_control_api.rb', line 594

def current_context(*args, &block)
  flow.current_context(*args, &block)
end

- (Object) extract_flow_control_options!(*args)



516
517
518
# File 'lib/origen/tester/generator/flow_control_api.rb', line 516

def extract_flow_control_options!(*args)
  flow.extract_flow_control_options!(*args)
end

- (Object) extract_relation_options!(*args)



512
513
514
# File 'lib/origen/tester/generator/flow_control_api.rb', line 512

def extract_relation_options!(*args)
  flow.extract_relation_options!(*args)
end

- (Object) filter_id(id, _options = {})

Implement this method in your application interface if you want to sanitize all ID references used in the flow control API. For example you could use this to append a flow name prefix to every ID reference within a flow which can help with ID duplication problems when flow snippets are re-used.



508
509
510
# File 'lib/origen/tester/generator/flow_control_api.rb', line 508

def filter_id(id, _options = {})
  id
end

- (Object) if_all_failed(*args, &block) Also known as: unless_any_passed

Alias for flow#if_all_failed



583
584
585
# File 'lib/origen/tester/generator/flow_control_api.rb', line 583

def if_all_failed(*args, &block)
  flow.if_all_failed(*args, &block)
end

- (Object) if_all_passed(*args, &block) Also known as: unless_any_failed

Alias for flow#if_all_passed



571
572
573
# File 'lib/origen/tester/generator/flow_control_api.rb', line 571

def if_all_passed(*args, &block)
  flow.if_all_passed(*args, &block)
end

- (Object) if_any_failed(*args, &block) Also known as: unless_all_passed

Alias for flow#if_any_failed



577
578
579
# File 'lib/origen/tester/generator/flow_control_api.rb', line 577

def if_any_failed(*args, &block)
  flow.if_any_failed(*args, &block)
end

- (Object) if_any_passed(*args, &block) Also known as: unless_all_failed

Alias for flow#if_any_passed



565
566
567
# File 'lib/origen/tester/generator/flow_control_api.rb', line 565

def if_any_passed(*args, &block)
  flow.if_any_passed(*args, &block)
end

- (Object) if_enable(*args, &block) Also known as: if_enabled

Alias for flow#if_enable



521
522
523
# File 'lib/origen/tester/generator/flow_control_api.rb', line 521

def if_enable(*args, &block)
  flow.if_enable(*args, &block)
end

- (Object) if_failed(*args, &block) Also known as: unless_passed

Alias for flow#if_failed



553
554
555
# File 'lib/origen/tester/generator/flow_control_api.rb', line 553

def if_failed(*args, &block)
  flow.if_failed(*args, &block)
end

- (Object) if_job(*args, &block)

Alias for flow#if_job



533
534
535
# File 'lib/origen/tester/generator/flow_control_api.rb', line 533

def if_job(*args, &block)
  flow.if_job(*args, &block)
end

- (Object) if_passed(*args, &block) Also known as: unless_failed

Alias for flow#if_passed



559
560
561
# File 'lib/origen/tester/generator/flow_control_api.rb', line 559

def if_passed(*args, &block)
  flow.if_passed(*args, &block)
end

- (Object) if_ran(*args, &block)

Alias for flow#if_ran



548
549
550
# File 'lib/origen/tester/generator/flow_control_api.rb', line 548

def if_ran(*args, &block)
  flow.if_ran(*args, &block)
end

- (Object) skip(*args, &block)

Alias for flow#skip



589
590
591
# File 'lib/origen/tester/generator/flow_control_api.rb', line 589

def skip(*args, &block)
  flow.skip(*args, &block)
end

- (Object) unless_enable(*args, &block) Also known as: unless_enabled

Alias for flow#unless_enable



527
528
529
# File 'lib/origen/tester/generator/flow_control_api.rb', line 527

def unless_enable(*args, &block)
  flow.unless_enable(*args, &block)
end

- (Object) unless_job(*args, &block)

Alias for flow#unless_job



538
539
540
# File 'lib/origen/tester/generator/flow_control_api.rb', line 538

def unless_job(*args, &block)
  flow.unless_job(*args, &block)
end

- (Object) unless_ran(*args, &block)

Alias for flow#unless_ran



543
544
545
# File 'lib/origen/tester/generator/flow_control_api.rb', line 543

def unless_ran(*args, &block)
  flow.unless_ran(*args, &block)
end