NPortComponentModel

class pyedb.grpc.database.definition.component_model.NPortComponentModel(core)

Class managing NPortComponentModel

Overview

Constructors

create	Create an N-Port component model.
find_by_id	Find an N-Port component model by IO count in a given component definition.
find_by_name	Find an N-Port component model by name in a given component definition.

Properties

is_null	Check if the N-Port component model is null.
name	Get the name of the N-Port component model.
reference_file	Get the reference file of the N-Port component model.

Attributes

core

Import detail

from pyedb.grpc.database.definition.component_model import NPortComponentModel

Property detail

property NPortComponentModel.is_null

Check if the N-Port component model is null.

Returns:

bool

True if the N-Port component model is null, False otherwise.

property NPortComponentModel.name

Get the name of the N-Port component model.

Returns:

str

The name of the N-Port component model.

property NPortComponentModel.reference_file

Get the reference file of the N-Port component model.

Returns:

str

The reference file of the N-Port component model.

Attribute detail

NPortComponentModel.core

Method detail

classmethod NPortComponentModel.create(name: str) → NPortComponentModel

Create an N-Port component model.

Parameters:

namestr

Name of the N-Port component model.

Returns:

NPortComponentModel

The created N-Port component model object.

classmethod NPortComponentModel.find_by_id(component_definition, id: int) → None | NPortComponentModel

Find an N-Port component model by IO count in a given component definition.

Parameters:

component_definitionComponentDef

Component definition to search for the N-Port component model.

idint

IO count of the N-Port component model.

Returns

——-

NPortComponentModel

N-Port component model that is found, None otherwise.

classmethod NPortComponentModel.find_by_name(component_definition, name: str) → None | NPortComponentModel

Find an N-Port component model by name in a given component definition.

Parameters:

component_definitionComponentDef

Component definition to search for the N-Port component model.

namestr

Name of the N-Port component model.

Returns:

NPortComponentModel

N-Port component model that is found, None otherwise.