scxml4cpp::ReplaceRules Class Reference

#include <ReplaceRules.h>

Public Types
enum	ElementType {   State = 0 , Event , Guard , Action ,   Activity }

Public Member Functions
	ReplaceRules ()
	ReplaceRules (const ReplaceRules &)=default
ReplaceRules &	operator= (const ReplaceRules &)=default
void	add (const ElementType elementType, const std::string &srcId, const std::string &dstId)
void	clear ()
std::string	apply (const ElementType elementType, const std::string &srcId)
const std::map< std::string, std::string > &	get () const

Friends
std::ostream &	operator<< (std::ostream &stream, const ReplaceRules &rules)

Detailed Description

This class can be used to store rules to replace SCXML element identifiers with others when the model is loaded or appended.

Member Enumeration Documentation

ElementType

enum scxml4cpp::ReplaceRules::ElementType

Enumerator
State
Event
Guard
Action
Activity

Constructor & Destructor Documentation

ReplaceRules() [1/2]

scxml4cpp::ReplaceRules::ReplaceRules

(

)

Constructor.

ReplaceRules() [2/2]

scxml4cpp::ReplaceRules::ReplaceRules ( const ReplaceRules & )

default

Member Function Documentation

add()

void scxml4cpp::ReplaceRules::add	(	const ElementType	elementType,
		const std::string &	srcId,
		const std::string &	dstId )

Add a rule to replace a given SCXML element identifier with another one. Note that if more than one rule with the same elementType and srcId is added, it will overwrite the existing one.

Parameters

elementType	Type of the SCXML element (e.g. STATE, EVENT, etc.).
srcId	Identifier to be replaced.
dstId	Identifier to be used as replacement.

apply()

std::string scxml4cpp::ReplaceRules::apply	(	const ElementType	elementType,
		const std::string &	srcId )

Apply a rule to a given SCXML element identifier.

Parameters

elementType	Type of SCXML element (e.g. STATE, EVENT, etc.).
srcId	Identifier to be replaced.

Returns

Replacement for the given identifier.

clear()

void scxml4cpp::ReplaceRules::clear

(

)

Remove all added rules.

get()

const std::map< std::string, std::string > & scxml4cpp::ReplaceRules::get

(

)

const

Returns

The replacement rules.

operator=()

ReplaceRules & scxml4cpp::ReplaceRules::operator= ( const ReplaceRules & )

default

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & stream, const ReplaceRules & rules )

friend

Allows to stream out the rules.

Parameters

rules

An instance of the ReplaceRules.

Returns

The output stream.

---

The documentation for this class was generated from the following files:

• scxml4cpp/parser/src/include/scxml4cpp/ReplaceRules.h
• scxml4cpp/parser/src/ReplaceRules.cpp