Module aivis_engine_v2_cn_sdk_python.hub

Classes

class ConstraintNavigatorHub (handle, key)

Class for creating and handling constraint navigator hub. This is your entry point for all constraint navigator hub methods.

Private constructor. To create new instance, use: - ConstraintNavigatorHub.create()

Static methods

def create(cls, model_context: ConstraintNavigatorModelContext, config_json) ‑> ConstraintNavigatorHub

@FlavourRequirement([Flavour.FULL])

Create constraint navigator hub

Use ConstraintNavigatorHub.get_model() or ConstraintNavigatorHub.get_report() to get instances of DtoHubModel or DtoHubReport as JSON string.

Parameters

model_context : aivis_engine_v2_cn_sdk_python.model_context.ModelContext

Instance of model context

config_json : str

DtoHubConfig as JSON string

Returns

Hub

Instance of constraint navigator hub

Methods

def destroy(self)

@FlavourRequirement([Flavour.FULL])

Destroy this constraint navigator hub. It's always safe to destroy a hub. Internally the destruction only takes place after all references to this object have been released.

def get_model(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this hub's DtoHubModel

Returns

str

DtoHubModel as JSON string

def get_report(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this hub's DtoHubReport

Returns

str

DtoHubReport as JSON string