Woman, Life, Freedom


Adaptive AUTOSAR
ARA public interface header documentation
ara::exec::FunctionGroupState Class Referencefinal

Class that links a function group to a certain state. More...

#include <function_group_state.h>

Public Member Functions

 FunctionGroupState (const FunctionGroupState &other)=delete
 
 FunctionGroupState (FunctionGroupState &&other)
 
FunctionGroupStateoperator= (const FunctionGroupState &other)=delete
 
FunctionGroupStateoperator= (FunctionGroupState &&other)
 
const FunctionGroupGetFunctionGroup () const noexcept
 Get the function group bound to the instance. More...
 
const std::string & GetState () const noexcept
 Get the state bound to the instance. More...
 
void Serialize (std::vector< uint8_t > &serializedObject) const
 Serialized the object. More...
 
bool operator== (const FunctionGroupState &other) const noexcept
 
bool operator!= (const FunctionGroupState &other) const noexcept
 

Static Public Member Functions

static core::Result< FunctionGroupStateCreate (const FunctionGroup &functionGroup, std::string metaModelIdentifier)
 FunctionGroupState factory. More...
 

Detailed Description

Class that links a function group to a certain state.

Member Function Documentation

◆ Create()

core::Result< FunctionGroupState > ara::exec::FunctionGroupState::Create ( const FunctionGroup functionGroup,
std::string  metaModelIdentifier 
)
static

FunctionGroupState factory.

Parameters
metaModelIdentifierState manifest of a function group
Returns
Result containing a new instance if creation was successful, otherwise a Result containing the occurred error

◆ GetFunctionGroup()

const FunctionGroup & ara::exec::FunctionGroupState::GetFunctionGroup ( ) const
noexcept

Get the function group bound to the instance.

Returns
Constant reference to the corresponding function group

◆ GetState()

const std::string & ara::exec::FunctionGroupState::GetState ( ) const
noexcept

Get the state bound to the instance.

Returns
Constant reference to the state meta-model

◆ Serialize()

void ara::exec::FunctionGroupState::Serialize ( std::vector< uint8_t > &  serializedObject) const

Serialized the object.

Parameters
[out]serializedObjectSerialized object byte vector
Note
This is not an ARA specified method.