pamoja for TypeScript - v0.2.0
    Preparing search index...

    Variable nameConst

    name: {
        ddsTopic: (fqn: string, kind: EntityKindName) => string | null;
        ddsTypeName: (rosType: string) => string | null;
        isFullyQualified: (name: string) => boolean;
        isValid: (name: string) => boolean;
        percentMangle: (name: string) => string;
        prefixFor: (kind: EntityKindName) => string;
        suffixFor: (kind: EntityKindName) => string;
    } = ...

    The ROS 2 rules for what a name may be and what it maps onto.

    Type Declaration

    • ReadonlyddsTopic: (fqn: string, kind: EntityKindName) => string | null

      Returns the DDS topic a fully qualified name maps onto, or null if the name is not fully qualified.

    • ReadonlyddsTypeName: (rosType: string) => string | null

      Returns the DDS type name an interface type maps onto, or null if the type is not a valid package/namespace/Type.

    • ReadonlyisFullyQualified: (name: string) => boolean

      Reports whether a name resolves with no namespace applied.

    • ReadonlyisValid: (name: string) => boolean

      Reports whether a string is a valid ROS 2 topic or service name.

    • ReadonlypercentMangle: (name: string) => string

      Percent-mangles a name as rmw_zenoh writes it in a liveliness token, each / as %.

    • ReadonlyprefixFor: (kind: EntityKindName) => string

      Returns the DDS topic prefix a subsystem uses.

    • ReadonlysuffixFor: (kind: EntityKindName) => string

      Returns what the middleware appends to a name for a subsystem: nothing for a topic, Request for a service request, and Reply for a service response.

    Settings
    Member Visibility