Home Reference Source
public class | source

ModuleDefinition

Extends:

Identified → ModuleDefinition

Class to represent an SBOL2 ModuleDefinition.

Constructor Summary

Public Constructor
public

constructor(sbolDocument: *, uri: *)

Member Summary

Public Members
public get

Retrieve the list of FunctionalComponents assigned to this ModuleDefinition.

public get

Retrieve the list of Interactions assigned to this ModuleDefinition.

public get

modules: Module[]: *

Retrieve the list of modules assigned to this ModuleDefinition.

public get

roles: URI[]: *

Retrieve the list of roles assigned to this ModuleDefinition

Method Summary

Public Methods
public

Add a FunctionalComponent to this ModuleDefinition.

public

addInteraction(interaction: string | URI | Interaction)

Add an Interaction to this ModuleDefinition.

public

addModule(module: string | URI | Module)

Add a Module to this ModuleDefinition.

public

addRole(role: string | URI)

Assign a role to this ModuleDefinition.

public

link()

Attempt to resolve the Modules, FunctionalComponents, and Interactions assigned to this ModuleDefinition by URI.

Public Constructors

public constructor(sbolDocument: *, uri: *) source

Parameters:

NameTypeAttributeDescription
sbolDocument *
uri *

Public Members

public get functionalComponents: FunctionalComponent[]: * source

Retrieve the list of FunctionalComponents assigned to this ModuleDefinition. There may be URIs present in this list if the component(s) have not yet been resolved.

Returns:

FunctionalComponent[]

public get interactions: Interaction[]: * source

Retrieve the list of Interactions assigned to this ModuleDefinition. There may be URIs present in this list if the interaction(s) have not yet been resolved.

Returns:

Interaction[]

public get modules: Module[]: * source

Retrieve the list of modules assigned to this ModuleDefinition. There may be URIs present in this list if the module(s) have not yet been resolved.

Returns:

Module[]

public get roles: URI[]: * source

Retrieve the list of roles assigned to this ModuleDefinition

Returns:

URI[]

Public Methods

public addFunctionalComponent(component: string | URI | FunctionalComponent) source

Add a FunctionalComponent to this ModuleDefinition.

Parameters:

NameTypeAttributeDescription
component string | URI | FunctionalComponent
  • optional

public addInteraction(interaction: string | URI | Interaction) source

Add an Interaction to this ModuleDefinition.

Parameters:

NameTypeAttributeDescription
interaction string | URI | Interaction
  • optional

public addModule(module: string | URI | Module) source

Add a Module to this ModuleDefinition.

Parameters:

NameTypeAttributeDescription
module string | URI | Module
  • optional

public addRole(role: string | URI) source

Assign a role to this ModuleDefinition.

Parameters:

NameTypeAttributeDescription
role string | URI
  • optional

Attempt to resolve the Modules, FunctionalComponents, and Interactions assigned to this ModuleDefinition by URI.