Scope settings helpers

Helpers to read and interpret what to do based on scope settings. More...

Enumerations
enum	ATTRIBUTE_CREATION_SETTINGS { CREATION_SETTING_E_ONLY = 0 , CREATION_SETTING_RE_VALUE_TYPES = 1 , CREATION_SETTING_DRE_VALUE_TYPES = 2 }
	Available values for the create_attributes setting. More...

Functions
bool	is_clear_desired_value_enabled (const ast::scope_settings_t &scope_settings)
	Looks up in the Scope settings if clear_desired is enabled. More...
bool	is_chain_reaction_enabled (const ast::scope_settings_t &scope_settings)
	Looks up in the Scope settings if chain_reaction is enabled. More...
bool	should_create_attributes (char updated_value_type, const ast::scope_settings_t &scope_settings, result_type_t evaluation_result)
	Looks up in the Scope settings if create_attributes is enabled. More...
attribute_store_type_t	get_common_parent_type_scope_configuration (attribute_store_type_t engine_configured_type, const ast::scope_settings_t &scope_settings)
	Looks up in the Scope settings if common_parent_type is configured. More...

Detailed Description

Helpers to read and interpret what to do based on scope settings.

This component provides helpers functions helping to decide what to do based on scope settings.

Enumeration Type Documentation

ATTRIBUTE_CREATION_SETTINGS

enum ATTRIBUTE_CREATION_SETTINGS

Available values for the create_attributes setting.

Enumerator
CREATION_SETTING_E_ONLY
CREATION_SETTING_RE_VALUE_TYPES
CREATION_SETTING_DRE_VALUE_TYPES

Function Documentation

get_common_parent_type_scope_configuration()

attribute_store_type_t get_common_parent_type_scope_configuration	(	attribute_store_type_t	engine_configured_type,
		const ast::scope_settings_t &	scope_settings
	)

Looks up in the Scope settings if common_parent_type is configured.

Parameters

engine_configured_type	Configured Common Parent Type for the Attribute Mapper engine
scope_settings	The settings passed to the scope

Returns

attribute_store_type_t to use

is_chain_reaction_enabled()

bool is_chain_reaction_enabled

(

const ast::scope_settings_t &

scope_settings

)

Looks up in the Scope settings if chain_reaction is enabled.

Parameters

scope_settings

the settings passed to the scope

Returns

true if setting not configured or configured to a non-zero value

false if setting is configured and set to 0.

is_clear_desired_value_enabled()

bool is_clear_desired_value_enabled

(

const ast::scope_settings_t &

scope_settings

)

Looks up in the Scope settings if clear_desired is enabled.

Parameters

scope_settings

the settings passed to the scope

Returns

true if setting not configured or configured to a non-zero value

false if setting is configured and set to 0.

should_create_attributes()

bool should_create_attributes	(	char	updated_value_type,
		const ast::scope_settings_t &	scope_settings,
		result_type_t	evaluation_result
	)

Looks up in the Scope settings if create_attributes is enabled.

Parameters

updated_value_type	Updated value type ('r', 'd' or 'e')
scope_settings	The settings passed to the scope
evaluation_result	Evaluation result of the assignment

Returns

true if setting not configured or configured to a non-zero value

false if setting is configured and set to 0.