Home Reference Source
public class | source

Module

Extends:

Identified → Module

Class to represent an SBOL2 module instantiation.

Constructor Summary

Public Constructor
public

constructor(sbolDocument: *, uri: *)

Member Summary

Public Members
public set

definition(definition: string | URI | ModuleDefinition): *

Set the ModuleDefinition for this Module.
public get

Retrieve the ModuleDefinition for this Module.
public get

Retrieve the list of mappings assigned to this Module.

Method Summary

Public Methods
public

addMapping(mapping: string | URI | MapsTo)

Add a MapsTo to this Module.
public

link()

Attempt to resolve the ModuleDefinition and mappings by URI.

Public Constructors

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

Parameters:

NameTypeAttributeDescription
sbolDocument *
uri *

Public Members

public set definition(definition: string | URI | ModuleDefinition): * source

Set the ModuleDefinition for this Module.

public get definition: URI | ModuleDefinition: * source

Retrieve the ModuleDefinition for this Module. Returns either a URI or a ModuleDefinition, depending on whether the URI has been resolved by link().

Returns:

URI | ModuleDefinition

public get mappings: MapsTo[]: * source

Retrieve the list of mappings assigned to this Module. There may be URIs present in this list if the mapping(s) have not yet been resolved.

Returns:

MapsTo[]

Public Methods

public addMapping(mapping: string | URI | MapsTo) source

Add a MapsTo to this Module.

Parameters:

NameTypeAttributeDescription
mapping string | URI | MapsTo
  • optional

Attempt to resolve the ModuleDefinition and mappings by URI.