Class: Connection Point (ConnectionPoint)

A connection point is a hardware or software interface that enables an asset to communicate with other assets.

As of now, this schema doesn't specify the structure of common connection points like Ethernet ports. However, it will probably be added in future versions of this schema. Otherwise, details will be provided on specialized schemas.

NOTE: this is an abstract class and should not be instantiated directly

URI: base:ConnectionPoint

 classDiagram
    class ConnectionPoint
    click ConnectionPoint href "../ConnectionPoint/"
      ConnectionPoint <|-- Ipv4Connectivity
        click Ipv4Connectivity href "../Ipv4Connectivity/"
      ConnectionPoint <|-- Ipv6Connectivity
        click Ipv6Connectivity href "../Ipv6Connectivity/"
      ConnectionPoint <|-- EthernetPort
        click EthernetPort href "../EthernetPort/"

      ConnectionPoint : connection_point_type

      ConnectionPoint : id

      ConnectionPoint : name

      ConnectionPoint : related_connection_points





        ConnectionPoint --> "*" RelatedConnectionPoint : related_connection_points
        click RelatedConnectionPoint href "../RelatedConnectionPoint/"

Inheritance

ConnectionPoint

Slots

Name	Cardinality and Range	Description	Inheritance
related_connection_points	* RelatedConnectionPoint	A connection point might rely on another connection point to work	direct
connection_point_type	1 String	Type designator that provides support for polymorphism using connection point...	direct
id	0..1 String	The identifier is used to identify the connection point within the asset	direct
name	0..1 String	Name of the connection point	direct

Usages

used by	used in	type	used
Asset	connection_points	range	ConnectionPoint
Device	connection_points	range	ConnectionPoint
Gateway	connection_points	range	ConnectionPoint
SoftwareArtifact	connection_points	range	ConnectionPoint

Aliases

Port

Examples

Value
Ethernet port
SNMP protocol
API
Bluetooth port
Unix Domain Socket (UDS)
Wireless port
File
Serial port
WebUI
USB port
shared memory

Identifier and Mapping Information

Schema Source

from schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml

Mappings

Mapping Type	Mapped Value
self	base:ConnectionPoint
native	base:ConnectionPoint
close	sietechas:Port

LinkML Source

Direct

name: ConnectionPoint
description: 'A connection point is a hardware or software interface that enables
  an asset to communicate with other assets.

  As of now, this schema doesn''t specify the structure of common connection points
  like Ethernet ports. However, it will probably be added in future versions of this
  schema. Otherwise, details will be provided on specialized schemas.'
title: Connection Point
examples:
- value: Ethernet port
- value: SNMP protocol
- value: API
- value: Bluetooth port
- value: Unix Domain Socket (UDS)
- value: Wireless port
- value: File
- value: Serial port
- value: WebUI
- value: USB port
- value: shared memory
in_subset:
- MostRelevant
- Connectivity
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
aliases:
- Port
close_mappings:
- sietechas:Port
abstract: true
slots:
- related_connection_points
- connection_point_type
attributes:
  id:
    name: id
    description: The identifier is used to identify the connection point within the
      asset. It shall be generated by the asset link. Setting this identifier is only
      needed if the connection point needs to be referenced by an other connection
      point as RelatedConnectionPoint.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    slot_uri: schema:identifier
    domain_of:
    - Asset
    - ConnectionPoint
    range: string
  name:
    name: name
    description: Name of the connection point. The name is provided by the Asset Link
      during the discovery process. Usually, the name is provided by the operating
      system of the asset or may be labeled on the asset itself.
    examples:
    - value: eth0
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    range: string

Induced

name: ConnectionPoint
description: 'A connection point is a hardware or software interface that enables
  an asset to communicate with other assets.

  As of now, this schema doesn''t specify the structure of common connection points
  like Ethernet ports. However, it will probably be added in future versions of this
  schema. Otherwise, details will be provided on specialized schemas.'
title: Connection Point
examples:
- value: Ethernet port
- value: SNMP protocol
- value: API
- value: Bluetooth port
- value: Unix Domain Socket (UDS)
- value: Wireless port
- value: File
- value: Serial port
- value: WebUI
- value: USB port
- value: shared memory
in_subset:
- MostRelevant
- Connectivity
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
aliases:
- Port
close_mappings:
- sietechas:Port
abstract: true
attributes:
  id:
    name: id
    description: The identifier is used to identify the connection point within the
      asset. It shall be generated by the asset link. Setting this identifier is only
      needed if the connection point needs to be referenced by an other connection
      point as RelatedConnectionPoint.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    slot_uri: schema:identifier
    alias: id
    owner: ConnectionPoint
    domain_of:
    - Asset
    - ConnectionPoint
    range: string
  name:
    name: name
    description: Name of the connection point. The name is provided by the Asset Link
      during the discovery process. Usually, the name is provided by the operating
      system of the asset or may be labeled on the asset itself.
    examples:
    - value: eth0
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    alias: name
    owner: ConnectionPoint
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    range: string
  related_connection_points:
    name: related_connection_points
    description: 'A connection point might rely on another connection point to work.

      Examples: a TCP/IP connection can only work if there is some kind of connection
      point at physical level (e.g. Ethernet Port, Bluetooth Port), a container might
      be connected over a virtual ethernet to a software bridge, a software bridge
      might be directly connected to an ethernet port.

      This attribute enables modeling these kind of dependencies in a limited way.
      Other modeling mechanisms might be needed to model complex networking setups.'
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: related_connection_points
    owner: ConnectionPoint
    domain_of:
    - ConnectionPoint
    range: RelatedConnectionPoint
    multivalued: true
    inlined: false
  connection_point_type:
    name: connection_point_type
    description: Type designator that provides support for polymorphism using connection
      points.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    designates_type: true
    alias: connection_point_type
    owner: ConnectionPoint
    domain_of:
    - ConnectionPoint
    range: string
    required: true

Any questions left?

Ask the community