import { Enumeration, BitEnumeration, FieldTypeEnumeration } from './definition'; /** * Retrieves the list of available enumerations from the Canboat library. * * @returns {Enumeration[]} An array of enumeration objects. * @category PGN Definition Access */ export declare const getEnumerations: () => Enumeration[]; /** * Retrieves an enumeration object by its name. * * @param enumName - The name of the enumeration to search for. * @returns The matching `Enumeration` object if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getEnumeration: (enumName: string) => Enumeration | undefined; /** * Retrieves the numeric value associated with a given enumeration name and value string. * * This function looks up an enumeration by its name, then searches for an enumeration value * matching the provided value string. If the enumeration name is 'INDUSTRY_CODE' and the value * is 'Marine', it will substitute 'Marine Industry' for the lookup. Returns the corresponding * numeric value if found, otherwise returns `undefined`. * * @param enumName - The name of the enumeration to search. * @param value - The string value to look up within the enumeration. * @returns The numeric value associated with the enumeration value, or `undefined` if not found. * @category PGN Definition Access */ export declare const getEnumerationValue: (enumName: string, value: string) => number | undefined; /** * Retrieves the name of an enumeration value given the enumeration's name and the value. * * @param enumName - The name of the enumeration to search. * @param value - The numeric value of the enumeration member. * @returns The name of the enumeration member if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getEnumerationName: (enumName: string, value: number) => string | undefined; /** * Retrieves the list of bit enumerations from the canboat library. * * @returns {BitEnumeration[]} An array of bit enumeration objects. * @category PGN Definition Access */ export declare const getBitEnumerations: () => BitEnumeration[]; /** * Retrieves a bit enumeration object by its name. * * @param enumName - The name of the bit enumeration to search for. * @returns The matching `BitEnumeration` object if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getBitEnumeration: (enumName: string) => BitEnumeration | undefined; /** * Retrieves the bit value associated with a specific enumeration value name from a named bit enumeration. * * @param enumName - The name of the bit enumeration to search within. * @param value - The name of the enumeration value whose bit value is to be retrieved. * @returns The bit value as a number if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getBitEnumerationValue: (enumName: string, value: string) => number | undefined; /** * Retrieves the name associated with a specific bit value from a named bit enumeration. * * @param enumName - The name of the bit enumeration to search. * @param value - The bit value for which to find the corresponding name. * @returns The name associated with the given bit value, or `undefined` if not found. * @category PGN Definition Access */ export declare const getBitEnumerationName: (enumName: string, value: number) => string | undefined; /** * @category PGN Definition Editing */ export declare const updateLookup: (enumeration: Enumeration) => void; /** * @category PGN Definition Editing */ export declare const removeLookup: (enumeration: Enumeration) => void; /** * @category PGN Definition Editing */ export declare const updateBitLookup: (enumeration: BitEnumeration) => void; /** * @category PGN Definition Editing */ export declare const removeBitLookup: (enumeration: BitEnumeration) => void; /** * Retrieves the list of field type enumerations from the Canboat library. * * @returns {FieldTypeEnumeration[]} An array of field type enumerations. * @category PGN Definition Access */ export declare const getFieldTypeEnumerations: () => FieldTypeEnumeration[]; /** * Retrieves a specific field type enumeration by its name. * * @param enumName - The name of the field type enumeration to search for. * @returns The matching {@link FieldTypeEnumeration} object if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getFieldTypeEnumeration: (enumName: string) => FieldTypeEnumeration | undefined; /** * Retrieves the numeric value associated with a specific enumeration field type value. * * Given an enumeration name and a value name, this function looks up the corresponding * enumeration object and searches for the field type value by name. If found, it returns * the associated numeric value; otherwise, it returns `undefined`. * * @param enumName - The name of the enumeration to search within. * @param value - The name of the field type value to look up. * @returns The numeric value of the field type if found, or `undefined` if not found. * @category PGN Definition Access */ export declare const getFieldTypeEnumerationValue: (enumName: string, value: string) => number | undefined; /** * Retrieves the name of an enumeration value from a specified field type enumeration. * * @param enumName - The name of the enumeration to search within. * @param value - The numeric value of the enumeration member to look up. * @returns The name of the enumeration member if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getFieldTypeEnumerationName: (enumName: string, value: number) => string | undefined; /** * Retrieves the bit representation for a specific value from a field type enumeration. * * @param enumName - The name of the enumeration to search. * @param value - The value within the enumeration for which to get the bit representation. * @returns The bit representation as a number if found; otherwise, `undefined`. * @category PGN Definition Access */ export declare const getFieldTypeEnumerationBits: (enumName: string, value: number) => number | undefined; //# sourceMappingURL=lookups.d.ts.map