@mdf.js/openc2-core/dist/helpers/Accessors.d.ts

MMS - API Core - OpenC2

/**
 * Copyright 2024 Mytra Control S.L. All rights reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 * or at https://opensource.org/licenses/MIT.
 */
import { Health } from '@mdf.js/core';
import { Control } from '../types';
export declare class Accessors {
    /**
     * Return the target of the actual message
     * @param command - message to be processed
     * @returns target
     */
    static getTargetFromCommandMessage(command: Control.CommandMessage): string;
    /**
     * Return the target of the actual command
     * @param command - command to be processed
     * @returns target
     */
    static getTargetFromCommand(command: Control.Command): string;
    /**
     * Return the action of the actual message
     * @param command - message to be processed
     * @returns action
     */
    static getActionFromCommandMessage(command: Control.CommandMessage): Control.Action;
    /**
     * Return the action of the actual command
     * @param command - command to be processed
     * @returns action
     */
    static getActionFromCommand(command: Control.Command): Control.Action;
    /**
     * Return the actuators in the command message
     * @param command - message to be processed
     * @returns actuators
     */
    static getActuatorsFromCommandMessage(command: Control.CommandMessage): string[];
    /**
     * Return the actuators in the command
     * @param command - command to be processed
     * @returns actuators
     */
    static getActuatorsFromCommand(command: Control.Command): string[];
    /**
     * Return the a property from actuators in the command
     * @param command - command to be processed
     * @param profile - actuator profile to find
     * @returns property value
     */
    static getActuatorAssetId(command: Control.Command, profile: string): any;
    /**
     * Return the delay allowed from command message
     * @param command - message to be processed
     * @returns delay in milliseconds
     */
    static getDelayFromCommandMessage(command: Control.CommandMessage): number;
    /**
     * Return the delay allowed from command
     * @param command - message to be processed
     * @returns delay in milliseconds
     */
    static getDelayFromCommand(command: Control.Command): number;
    /**
     * Convert consumer status to Subcomponent status
     * @param response - response message to be processed
     * @returns Subcomponent status
     */
    static getStatusFromResponseMessage(response: Control.ResponseMessage): Health.Status;
}
//# sourceMappingURL=Accessors.d.ts.map