classe ara::sm::SmErrorDomain

A função-membro ara::sm::SmErrorDomain::Message serve para determinar de forma síncrona a mensagem textual de erro associada a um código de erro específico do domínio de erros do State Management [SWS_SM_81249]. Encontra-se declarada no ficheiro de cabeçalho ara/sm/sm_error_domain.h dentro do âmbito da classe ara::sm::SmErrorDomain e tem o estado DRAFT na especificação AUTOSAR_AP_SWS_StateManagement §8.1.3.2.2.1 «Message».

A interface possui os seguintes parâmetros e valores de retorno [SWS_SM_81249]:

• Parâmetro: errorCode do tipo CodeType recebe o número de erro numérico para o qual a respetiva mensagem de texto é solicitada.
• Valor de retorno: Um ponteiro do tipo const char * para a mensagem de erro atribuída ao código de erro fornecido.

Para a execução aplicam-se garantias rigorosas relativas a concorrência e tratamento de exceções: A função está especificada como thread-safe e exception safe, e declarada com o identificador noexcept [SWS_SM_81249]. Pode, assim, ser chamada em segurança a partir de quaisquer threads sem bloqueios sincronizadores ou blocos try-catch.

No âmbito da gestão de erros do AUTOSAR Adaptive, o método substitui a função virtual do domínio de erros base. Interpretação: Dado que o valor de retorno está definido como const char * sem interface de alocação, o ponteiro deverá tipicamente apontar para literais de string estáticos que permanecem válidos durante todo o tempo de execução do processo. Pergunta Q-03fc170f18f910b4 (aberta)

O método de API Name da classe de domínio de erros ara::sm::SmErrorDomain serve para obter o nome padronizado do domínio de erros do State Management ([SWS_SM_81248]). De acordo com a especificação, a chamada síncrona devolve sempre o valor constante de cadeia de caracteres "Sm" (SWS StateManagement §8.1.3.2.2.2 «Name»). Para a utilização, é necessário incluir o respetivo ficheiro de cabeçalho ara/sm/sm_error_domain.h.

A função-membro não recebe parâmetros de passagem e oferece total segurança contra exceções: está especificada como noexcept e exception safe ([SWS_SM_81248]), pelo que é garantido que regressa sem lançar exceções e não gera códigos de erro. Interpretação: Como está predefinido o tipo de retorno const char * com o valor fixo "Sm", é provável que a função aponte para um literal de string estático, cuja vida útil é ilimitada. Pergunta Q-855d1837679010a7 (aberta)

No que diz respeito ao contexto de chamada e à concorrência, o método está classificado como thread-safe ([SWS_SM_81248]). Pode, portanto, ser executado em paralelo a partir de múltiplas threads sem sincronização manual. Para integradores e programadores, é ainda relevante que o requisito no release R25-11 possui o estado DRAFT (SWS StateManagement §8.1.3.2.2.2 «Name»).

usar

O construtor padrão SmErrorDomain() cria de forma síncrona uma instância do domínio de erro ara::sm::SmErrorDomain ([SWS_SM_81247]). A declaração encontra-se no arquivo de cabeçalho ara/sm/sm_error_domain.h. A chamada não necessita de parâmetros de passagem e retorna diretamente o objeto de domínio inicializado (SWS StateManagement §8.1.3.2.1.1 «Default Constructor»).

Tratamento de erros

A função é provida do identificador noexcept e classificada como segura contra exceções (exception safe) ([SWS_SM_81247]). Durante a criação, não ocorrem códigos de erro e nenhuma exceção é lançada.

Simultaneidade e restrições

A criação está especificada como thread-safe ([SWS_SM_81247]). Instâncias podem, portanto, ser criadas concorrentemente em ambientes multithreading sem a necessidade de mecanismos adicionais de sincronização. Não existem condições especiais de ordenação.

Interação

O objeto criado pertence à classe ara::sm::SmErrorDomain ([SWS_SM_81241]), que está especificada de acordo com [SWS_CORE_90023]. Dentro do módulo State Management, o domínio de erro interage com os seguintes elementos:

• Errc ([SWS_SM_81245]) e Exception ([SWS_SM_81246]) como sinônimos de tipo para códigos de erro (SmErrc) e tratamento de exceções (SmException).
• Name() ([SWS_SM_81248]) fornece o nome do domínio "Sm".
• Message() ([SWS_SM_81249]) traduz códigos de erro em descrições textuais.
• ThrowAsException() ([SWS_SM_81250]) lança o código de erro como exceção, desde que exceções C++ estejam ativadas ([SWS_CORE_10304]).
• GetSmDomain() ([SWS_SM_81251]) disponibiliza, alternativamente, uma instância global do domínio de erro.

A função ara::sm::SmErrorDomain::ThrowAsException serve para lançar diretamente como exceção C++ um código de erro do domínio de erros do State Management [SWS_SM_81250]. Encontra-se declarada no ficheiro de cabeçalho ara/sm/sm_error_domain.h e substitui a função base correspondente para domínios de erro (SWS StateManagement §8.1.3.2.2.3 «ThrowAsException»).

Chamada e parâmetros

O método é chamado de forma síncrona e recebe como único parâmetro de passagem uma referência constante para errorCode (do tipo ara::core::ErrorCode) [SWS_SM_81250]. Não devolve nenhum valor de retorno (void), visto que instancia e lança a exceção correspondente ao código de erro fornecido, abortando assim o fluxo normal de controlo no ponto de chamada [SWS_SM_81250].

Simultaneidade e condições marginais

• Segurança de threads: A função está explicitamente especificada como segura para threads (thread-safe) e pode, portanto, ser chamada sem problemas a partir de threads concorrentes [SWS_SM_81250].
• Segurança contra exceções: O comportamento está documentado como not exception safe [SWS_SM_81250]; Interpretação: Isto dever-se-á ao facto de o lançamento da exceção abandonar o fluxo normal de controlo e o método falhar por definição ou propagar uma exceção. Pergunta Q-5afbb1be303b657b (aberta)
• Restrição do compilador: De acordo com [SWS_CORE_10304], a função não participa na resolução de sobrecargas (overload resolution) se as exceções C++ estiverem desativadas na toolchain do compilador [SWS_SM_81250].