origen

Submodules

• origen.application
  • Classes
• origen.attributes
  • Classes
• origen.blocks
  • Submodules
    • origen.blocks.memories
      • Classes
• origen.boot
  • Functions
  • Variables
• origen.compiler
  • Classes
  • Exceptions
• origen.controller
  • Classes
• origen.errors
  • Exceptions
• origen.helpers
  • Submodules
    • origen.helpers.doc
      • Functions
    • origen.helpers.num
      • Functions
  • Functions
• origen.interface
  • Functions
  • Classes
• origen.pins
  • Classes
• origen.producer
  • Classes
• origen.services
  • Classes
• origen.sub_blocks
  • Classes
• origen.target
  • Functions
• origen.tester
  • Classes
• origen.timesets
  • Classes
• origen.translator
  • Classes
• origen.translators
  • Submodules
    • origen.translators.ip_xact
      • Classes
• origen.web
  • Submodules
    • origen.web.origen_sphinx_extension
      • Submodules
        • origen.web.origen_sphinx_extension.misc
          • Functions
        • origen.web.origen_sphinx_extension.shorthand_defs
        • origen.web.origen_sphinx_extension.subprojects
          • Functions
          • Classes
        • origen.web.origen_sphinx_extension.templating
          • Functions
      • Functions
    • origen.web.rustdoc
      • Functions
      • Classes
    • origen.web.shorthand
      • Submodules
        • origen.web.shorthand.dev
          • Functions
        • origen.web.shorthand.shorthand
          • Functions
          • Classes
      • Functions
  • Functions

Functions

• current_user(): Undocumented.

• flow_ast(): Returns a serialized representation of the AST for the current test program flow

• has_plugin(): Returns true if an Origen plugin matching the given name is found in the current environment

• load_file(): Undocumented.

• plugin(): Returns an Origen application instance representing

• reg_description_parsing(): Undocumented.

• set_mode(): Sets the current mode

• standard_context(): Returns the context (locals) that are available by default within files

• test_ast(): Returns a serialized representation of the AST for the current pattern

origen.current_user()

origen.flow_ast() → List[str]

Returns a serialized representation of the AST for the current test program flow

origen.has_plugin(name)

Returns true if an Origen plugin matching the given name is found in the current environment

origen.load_file(path, globals={}, locals={})

origen.plugin(name)

Returns an Origen application instance representing the given Origen plugin. None is returned if no plugin is found matching the given name within the current environment.

origen.reg_description_parsing()

origen.set_mode(val: str) → None

Sets the current mode

origen.standard_context()

Returns the context (locals) that are available by default within files loaded by Origen, e.g. dut, tester, origen, etc.

origen.test_ast() → List[str]

Returns a serialized representation of the AST for the current pattern

Variables

• config

• status

• root

• version

• running_on_windows

• running_on_linux

• frontend_root

• app

• dut

• tester

• producer

• users

• mailer

• ldaps

• logger

origen.config

Dictionary of configurable workspace settings.

Keys include: ['python_cmd', 'pkg_server', 'pkg_server_push', 'pkg_server_pull', 'some_val']

Returns

Configurable workspace settings.

Return type

dict

See also

Configuring Origen

origen.status

Dictionary of various application and workspace attributes Keys include: ['is_app_present', 'root', 'origen_version', 'home', 'on_windows']

Returns

Application and/or workspace attributes as key-value pairs.

Return type

dict

origen.root

Path subclass for Windows systems.

On a Windows system, instantiating a Path should return this object.

origen.version

Returns the version of the Origen executable.

Returns

Origen executable version

Return type

str

>>> origen.version
'2.0.0.dev4'

origen.running_on_windows

Indicates if Origen is currently running on Windows.

Returns

Return type

bool

>>> origen.running_on_windows
False

origen.running_on_linux

Indicates if Origen is currently running on Linux.

Returns

Return type

bool

>>> origen.running_on_linux
True

origen.frontend_root

Returns the directory of the origen module as a pathlib.Path

origen.app

Pointer to the current application instance, or None, if Origen was not invoked from within an application workspace.

If app is not None, it should be child of the base class origen.application.Base

See also

The Application Workspace

origen.dut

Pointer to the current DUT, or None, if no DUT has been set.

if dut is not None, then it should be a child of the base class origen.controller.Base

origen.tester

Pointer to the global tester object, origen.tester.Tester

origen.producer

Pointer to the global producer object, origen.producer.Producer

origen.users

dict-like container for current and added Users

Put another way, accessor for global Users object

See also

• Users in the guides

origen.mailer

Accessor to the global Mailer

See also

• Mailers in the guides

origen.ldaps

dict-like container for current and added Users

Put another way, accessor for global LDAPs object

See also

• LDAPs in the guides

origen.logger

Direct access to the build-in logger module for logging and displaying user-friendly output. Also available as log

Returns

Pointer to _origen.logger

Return type

_origen.logger

See also

• _origen.logger

• Logging Output