scram::mef::Role

Mixin class that manages private or public roles for elements as needed. More...

#include <element.h>

Inherited by scram::mef::Component, scram::mef::Id

Public Functions

	Name
	Role(RoleSpecifier role =RoleSpecifier::kPublic, std::string base_path ="")<br>Sets the role of an element upon creation.
RoleSpecifier	role() const
const std::string &	base_path() const

Protected Functions

	Name
	~Role() =default

Detailed Description

cpp

class scram::mef::Role;

Mixin class that manages private or public roles for elements as needed.

Public is the default assumption. It is expected to be set only once and never change.

Public Functions Documentation

function Role

cpp

explicit Role(
    RoleSpecifier role =RoleSpecifier::kPublic,
    std::string base_path =""
)

Sets the role of an element upon creation.

Parameters:

role A role specifier of the element.
base_path The series of containers to get this event.

Exceptions:

ValidityError The base path string is malformed.
ValidityError Private element at model/global scope.

The base reference path must be formatted according to the MEF documentation and additions.

function role

cpp

inline RoleSpecifier role() const

Return: The assigned role of the element.

function base_path

cpp

inline const std::string & base_path() const

Return: The base path containing ancestor container names.

Protected Functions Documentation

function ~Role

cpp

~Role() =default

Updated on 2025-11-11 at 16:51:08 +0000

scram::mef::Role ​

Public Functions ​

Protected Functions ​

Detailed Description ​

Public Functions Documentation ​

function Role ​

function role ​

function base_path ​

Protected Functions Documentation ​

function ~Role ​