Institute for Software Integrated Systems Vanderbilt University Interpreters 2. (Translators)

Institute for Software Integrated SystemsVanderbilt University

Interpreters 2.(Translators)

April 19, 2023 2

Component stack

C++ BON1 C++ BON2

MGA component of GME (Gmodel)

IMgaModel*

Implementationlayer

ModelImpl

WrapperlayerCBuilderModel

pointer toLegend

C++ BON1 based component

(interpreter)


(interpreter)

C++ Raw COM component

(interpreter)

operates on

Model

IMgaModel*

interface

JAVA BON

JAVA BON based component

(interpreter)

JBuilderModel

IMgaModel*

.NET-COM interop

C# Raw .NET component

(interpreter)

part of GME

user-written

April 19, 2023 3

Interface definitions found at:

C++ BON1 C++ BON2


IMgaModel*

Impllayer class ModelImpl

gme\SDK\BON\BONImpl.h

Wrapperlayerclass

CBuilderModelin

gme\SDK\BON\Builder.h


(interpreter)


(interpreter)


(interpreter)

class Modelgme\SDK\BON\

BON.h

IMgaModel*

JAVA BON


(interpreter)

class JBuilderModel

ingme\SDK\Java\

gme.jar- or -

gme\SDK\Java\org\isis\gme\

bon

interface IMgaModelin

gme\Interfaces\Mga.idl

.NET-COM interop


(interpreter)

COM interface definition mapped to .NET interface is shown in Visual Studio’s Object Browser

April 19, 2023 4

Using JAVA for interpreters

Org package Isis package

Jaut package GME package

Mga package Meta package BON package

TestBONComponent class

BONComponent interface JBuilderModel class JBuilderAtom class etc.

JavaBon Interpretersuse these classes

JAVA-BON found in GME\SDK\JAVA\gme.jar

Dummy implementation

BON = builder object network

--a higher level interface--

April 19, 2023 5

How to Create a JAVA intepreter?

// contents of file TestBONComponent.javapackage org.isis.gme.bon;

import java.util.*;import org.isis.gme.mga.MgaObject;

public class TestBONComponent implements BONComponent {public void invokeEx(

JBuilder builder,JBuilderObject focus,Collection selected,int param)

{}

}

invokeEx() methodentry point when an

interpreter is called from GME

April 19, 2023 6

A plain JAVA intepreter

Fill in the blanks in TestBONComponent.java Compile your class

javac -classpath "C:\Program Files\GME\SDK\Java\gme.jar" TestBONComponent.java

Register it with SDK \ JAVA \ JavaCompRegister.exe Name: MyHelloWorldInterpreter

No spaces Description: This is Hello World from JAVA ProgID: Mga.Interpreter.MyHelloWorldInterpreter

Autocompleted based on Name, no spaces, uniqueness GUID: 12345678-9ABC-DEF0-1234-56789ABCDEF0

Changes upon all invokations of JavaCompRegister ClassPath: <<path to your compiled .class file>>

E.g. c:\myprojects\myjavainterpreters Class: <<full name of your class>>

mic.gme.interpreters.TestBONComponent Paradigms

* indicates all Menu/Tooltip

Select a few objects before running this interpreter Register systemwide

For all users/For this user?

Run it from GME

April 19, 2023 7

Classes and methods

JBuilder methods JBuilderFolder getRootFolder() String getProjectName() MgaProject getProject()

JBuilderFolder methods public String getName() public Vector getRootModels() public Vector getSubFolders() JBuilderModel createNewModel(String kindName)

JBuilderModel methods Vector getChildren() String getCurrentAspent() JBuilderModel createNewModel(String partName) JBuilderAtom createNewAtom(String partName) JBuilderConnection createNewConnection(…) JBuilderReference createNewReference(String partName)

JBuilderReference methods boolean putReferred(JBuilderObject nref) JBuilderObject getReferred() int getReferredType()

JBuilderConnection methods JBuilderModel getOwner() JBuilderObject getSource() JBuilderObject getDestination()

BON classes found in GME\SDK\JAVA\gme.jar

April 19, 2023 8

Classes and methods 2.

JBuilderObject methods String getObjID() JBuilderModel getParent() boolean getAttribute(String name, double val[]) boolean getAttribute(String name, boolean val[]) boolean getAttribute(String name, int val[]) boolean getAttribute(String name, String val[]) boolean setAttribute(String name, boolean val) boolean setAttribute(String name, float val) boolean setAttribute(String name, int val) boolean setAttribute(String name, String val) Vector getInConnections(String name) Vector getOutConnections(String name) boolean getInConnectedObjects(String name, Vector list[]) boolean getOutConnectedObjects(String name, Vector

list[]) Vector getReferencedBy()

BON classes found in GME\SDK\JAVA\gme.jar

April 19, 2023 9

ReferencePorts

if(selection.getObjType()==MgaObject.OBJTYPE_REFERENCE) { msg = msg + "Reference " + selection.getName() + " selected. \n Refers to: "; JBuilderObject referred = ((JBuilderReference)selection).getReferred(); if(referred == null) msg = msg + "NULL\n"; else { msg = msg + referred.getName() + "\n"; if(selection.getClass().getName().equals("org.isis.gme.bon.JBuilderModelReference")) {

Vector ports = ((JBuilderModelReference)selection).getReferencePorts();

msg = msg + " " + ports.size() + " Reference Ports.\n"; for(int j=0; j<ports.size(); j++) { JBuilderReferencePort port =

(JBuilderReferencePort)ports.elementAt(j); msg = msg + " " + port.getName() + " connected to:"; msg = msg + getConnectedNames(port); msg = msg + getConnectedNames(port.getPortObject()); msg = msg + "\n"; } } } }

If selection object is a reference

If not a null reference

If a modelrefernce ( = refers to a model)

Ref2Ref1Model1 Model2

April 19, 2023 10

A JAVA intepreter in Eclipse

Eclipse Open workspace Create a package (optional) Create a class MyBONComponent Add reference to gme.jar

Save it Register it with SDK \ JAVA \ JavaCompRegister.exe Run it Modify it Save it

Involves auto-compilation Run it

Repeat these steps

April 19, 2023 11

How to Create a C++ intepreter?

Use GME\SDK\CreateNewComponent.exe to create BON BON2 RAW COM components

Requires MS VS .NET 2003 installed the official version of GME is built with this version

Creates solution and project file properly set up for MS VS .NET 2003 (VC++ 7.1)

Available for download CreateNewComponent80.exe, which creates solution and project files for MS VS .NET 2005 (VC++ 8.0)

Workflow: Create the component Build (Build menu/Build Solution) Self-Registration into GME is done after link step succeeded Try it from GME Enhance it with your code: look for the invokeEx() method

April 19, 2023 12

Welcome to the BON2 world

Uses Standard template library (STL)

Is A Higher level C++ interface to Models

April 19, 2023 13

Standard Template Library (STL)

Container types: vector, list, set, multiset, map, multimap, hashmap

Methods: push_back, insert, remove, …

set< string> Myset; // Lexicographical compare by default

Myset.insert( “zero”); Myset.insert( “one”); //{ “one”, “zero”}

set< string, numericalCompare> Myset; Myset.insert( “zero”); //{ “zero”, “one” } Myset.insert( “one”);

April 19, 2023 14

Sets sorted in a specific order

class NumericalCompare // will compare p1 and p2; returns ( p1 < p2 ){

public: bool operator( ) ( string p1, string p2) const ;};

set< string, NumericalCompare> Myset;

// implementation of comparator:bool NumericalCompare::operator( )( string p1, string p2) const {

int v1 = parseInt( p1);int v2 = parseInt( p2);return v1 < v2;

}

class ObjComp{

public: bool operator()( BON::Object p1, BON::Object p2) const;};

std::set<BON::Object, ObjComp> ObjSet;

bool ObjComp::operator( )( BON::Object p1, BON::Object p2) const{ if( !p1) return true; if( !p2) return false; return p1->getName() < p2->getName(); // string lexicographical compare}

Comparator methods must fulfill the followingIrreflexivity x < x must be false. Antisymmetry x < y implies !(y < x)Transitivity x < y and y < z implies x < z

Otherwise one may end up with infinite loops upon insertion, when the comapator is used.

April 19, 2023 15


Standard way of iterating over a sequence of objects:typedef vector<int> MyCont;typedef vector<int>::const_iterator

MyCont_C_Iter;

MyCont mycont;for( MyCont_C_Iter it = mycont.begin();

it != mycont.end(); // standard end-condition ++it){ int k = *it; //current object is obtained by *it}

April 19, 2023 16


Underlying container changed from vector to list, and still works:typedef list<int> MyCont;typedef list<int>::const_iterator MyCont_C_Iter;

MyCont mycont;for( MyCont_C_Iter it = mycont.begin();

it != mycont.end(); // standard end-condition++it){ int k = *it; //current object is obtained by *it}

April 19, 2023 17


Layers in BON2

IMgaAtom*IMgaModel*

BON2 implementation layer

AtomImplModelImpl

BON2 wrapper layerModel

pointer to

Legend

BON2 component (interpreter) operates on

Atom

April 19, 2023 18

BON2 wrapper classes

ReferencePort

Reference Model

ConnectionEnd

FCO

Atom SetConnection

Util::GenRefCounter

ObjectAttributeRegistryNode

Folder

inheritance

Legend:

April 19, 2023 19

BON2 implementation classes

ReferencePortImpl

ReferenceImpl ModelImpl

ConnectionEndImpl

FCOImpl

AtomImpl SetImplConnectionImpl

Util::GenRefCounted

ObjectImplAttributeImpl

EventListenerPool

RegistryNodeImpl

FolderImpl

inheritance

Legend:

April 19, 2023 20

Important methods on the wrapper layer

class FCO {public:

// to test if an object is not null simply: if( myFCO) { //…operator bool () const;

// to test if an object is not null simply: if( !myFCO) { //…bool operator ! () const;

// constructor to convert from a ConnectionEnd e.g:// ConnectionEnd a_connection_end = … // given a ConnectionEnd object returned by some method// FCO myFCO( a_connection_end); // convert it to an FCO// if( myFCO) { // … } // if succeededFCO( const ConnectionEnd& object );

// constructor to convert from an ObjectFCO( const Object& object );

};

class Folder {public:

FolderImpl* operator -> () const;static Folder create( const Folder& parent, const MON::Folder& meta = MON::Folder() );static Folder create( const Folder& parent, const std::string& strFolder );

};

April 19, 2023 21

Important methods on the wrapper layer 2.

class Atom {public:

// to create a new Atom in a Folder e.g.: Atom myAtom = Atom::create( folder_parent);static Atom create( const Folder& parent, const MON::Atom& meta = MON::Atom() );

// to create a new Atom in a Folder e.g.: Atom myAtom = Atom::create( folder_parent, “InputSignal”);static Atom create( const Folder& parent, const std::string& strAtom );

// to create a new Atom in a Model e.g.: Atom myAtom = Atom::create( model_parent);static Atom create( const Model& parent, const MON::Atom& meta = MON::Atom(), const std::string& strRole = "" );// to create a new Atom in a Model e.g.: Atom myAtom = Atom::create( model_parent, “InputParam”, “InputParameters”);static Atom create( const Model& parent, const std::string& strAtom, const std::string& strRole = "" );

AtomImpl* operator -> () const;

};

class Model {public:

// to create a new Model in a Folder e.g.: Model myModel = Model::create( folder_parent, “Compound”);static Model create( const Folder& parent, const std::string& strModel );// to create a new Model in a Model e.g.: Model myModel = Model::create( model_parent, “Compound”, “CompoundParts”);static Model create( const Model& parent, const std::string& strModel, const std::string& strRole = "" );

// all other method calls will be dispatched to ModelImpl though operator ->// e.g. it is NOT OK : set<FCO> myInpSignals = myModel.getChildFCOs( “InputSignals”); // compiler error, no such method// e.g. it is OK : set<FCO> myInpSignals = myModel->getChildFCOs( “InputSignals”);ModelImpl* operator -> () const;

// …};

April 19, 2023 22

Important methods on the impl layer

class FCOImpl : public ObjectImpl, public ConnectionEndImpl {public:

// who is my parentModel getParentModel();

// which set is FCO member of e.g.: set<Set> i_am_member_of = fco->getMemberOf();set<Set> getMemberOf( const MON::Set& meta = MON::Set(), const MON::Aspect& aspect = MON::Aspect() );

// which reference points to this FCO e.g.: set<Reference> i_am_referred_by = fco->getReferredBy();set<Reference> getReferredBy( const MON::Reference& meta = MON::Reference() );

// to find out an attribute’s value use e.g.: string val = fco->getAttribute(“Firing”)->getStringValue();Attribute getAttribute( const std::string& strName );

};

class AttributeImpl {public:

// to inquire an attribute value these can be used depending on its type //e.g.: long prim_priority = primitiveFCO->getAttribute(“Priority”)->getIntegerValue();long getIntegerValue( bool bTypeTolerant = true ) const;void setIntegerValue( long lValue, bool bTypeTolerant = true );

bool getBooleanValue( bool bTypeTolerant = true ) const;void setBooleanValue( bool bValue, bool bTypeTolerant = true );

double getRealValue( bool bTypeTolerant = true ) const; void setRealValue( double dValue, bool bTypeTolerant = true );

string getStringValue( bool bTypeTolerant = true ) const;void setStringValue( const std::string& strValue, bool bTypeTolerant = true );

};

April 19, 2023 23

Important methods on the impl layer 2.

class ReferenceImpl {public:

// e.g. FCO refd = a_ref->getReferred();FCO getReferred( const MON::FCO& meta = MON::FCO() );FCO getReferred( const std::string& strFCO );

// e.g. a_ref->setReferred( new_target);void setReferred( const FCO& fco );

};

class SetImpl {public:

// to inquire members// e.g.: set< FCO> members = a_set->getMembers();std::set<FCO> getMembers( const MON::FCO& meta = MON::FCO(), const MON::Aspect& aspect = MON::Aspect() );std::set<FCO> getMembers( const std::string& strFCO, const MON::Aspect& aspect = MON::Aspect() );

// add and remove membersvoid addMember( const BON::FCO& fco );void removeMember( const BON::FCO& fco );

};

April 19, 2023 24

Important methods on the impl layer 3.

class ConnectionImpl : virtual public FCOImpl {// e.g. ConnectionEnd src = a_conn->getSrc();ConnectionEnd getSrc( ... );ConnectionEnd getDst( ... );

std::multiset<ConnectionEnd> getConnEnds( ... );

};

class ConnectionEndImpl {// e.g. set<Connection> lines = an_end->getConnLinks();std::set<Connection> getConnLinks();// e.g. multiset<ConnectionEnd> peers = an_end->getConnEnds();std::multiset<ConnectionEnd> getConnEnds();

};

class ReferencePortImpl : public ConnectionEndImpl {FCO getFCO();

};

class FCOImpl : public ObjectImpl, public ConnectionEndImpl { … };

April 19, 2023 25

Ref2

Handling connectionEnds in a complex paradigm

void handle( ConnectionEnd& p_connectionend){

BON::FCO connend_fco( p_connectionend);if( connend_fco){

// connend_fco is valid: the connected object is an fco}else{

BON::ReferencePort connend_refport( p_connectionend);if( connend_refport){

// it's a referenceport: see ReferencePortImpl for detailsBON::FCO fco = connend_refport->getFCO();BON::ReferencePortContainer rpc = connend_refport-

>getContainer();BON::Reference ref = rpc->getReference();// the connected end is a port (fco) shown on a reference (ref)

}else ASSERT(0); // it can't happen

}}

Ref1Model1 Model2

April 19, 2023 26

BON2 interpreter entry point& debugging

void Component::invokeEx( Project& project, FCO& currentFCO, const std::set<FCO>& setSelectedFCOs, long lParam )

// project : the currently opened project// currentFCO and setSelectedFCOs: the currently selected objects if

any{

std::string msg;std::set<FCO>::const_iterator it0 = setSelectedFCOs.begin();std::set<FCO>::const_iterator itE = setSelectedFCOs.end();

for( ; it0 != itE; ++it0){

FCO i = *it0;msg += i->getName();msg += "\n";

}

if( msg.empty())msg = "No object selected";

// show in a message box the names of the selected objectsAfxMessageBox( msg.c_str());

// show message in console windowproject->consoleMsg( msg, MSG_INFO);}

April 19, 2023 27

ProjectImpl (found in BonImpl.h)

Folder getRootFolder();

std::set<Object> findByKind( const std::string& strKind );

std::set<Object> findByKind( const MON::Object& meta );

const MON::Project& getProjectMeta();

void consoleMsg(const std::string& msg, msgtype_enum type);

Sends message to the GME console window

Access to the MetaModel

The most important: RootFolder accessed

April 19, 2023 28

FolderImpl

Object findByPath( const std::string& strPath, const std::string& strDelimiter = "/", bool bReverseOrder = false );

std::set<Object> getChildObjects( const MON::Object& meta = MON::Object() );

std::set<Object> getChildObjects( const std::string& strObject );

std::set<Folder> getChildFolders(); std::set<FCO> getRootFCOs(); std::set<Atom> getChildAtoms(); std::set<Model> getChildModels();

Model myC= project->getRootFolder()->findByPath("/SFDemo/System")std::set<Model> submodels = myC->getChildModels();

April 19, 2023 29

ModelImpl std::set<FCO> getChildFCOs(

const MON::FCO& meta = MON::FCO(), const MON::Aspect& aspect = MON::Aspect());

std::set<FCO> getChildFCOs( const std::string& strFCO, const MON::Aspect& aspect = MON::Aspect());

std::set<FCO> getChildFCOsAs(const std::string& strRole, const MON::Aspect& aspect = MON::Aspect());

std::set<Atom> getChildAtoms( const MON::Aspect& aspect = MON::Aspect());

std::set<Model> getChildModels( const MON::Aspect& aspect = MON::Aspect() );

std::set<Set> getChildSets( const MON::Aspect& aspect = MON::Aspect());

std::set<Reference> getChildReferences( const MON::Aspect& aspect = MON::Aspect());

std::set<Connection> getChildConnections( const MON::Aspect& aspect = MON::Aspect());

Children getter methods

isigs = model->getChildFCOsAs(“InputSignals")

isigs = model->getChildFCOs(“InputSignal")

April 19, 2023 30

ConnectionEndImpl

std::set<Connection> getConnLinks( const MON::Connection& meta = MON::Connection(), const std::string& strRole = "", bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::set<Connection> getConnLinks( const std::string& strConnection, const std::string& strRole = "", bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::set<Connection> getInConnLinks( const MON::Connection& meta = MON::Connection(), bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::set<Connection> getInConnLinks( const std::string& strConnection, bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::set<Connection> getOutConnLinks( const MON::Connection& meta = MON::Connection(), bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::set<Connection> getOutConnLinks( const std::string& strConnection, bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

Links: the connection lines

April 19, 2023 31

ConnectionEndImpl cont’d

std::multiset<ConnectionEnd> getInConnEnds( const MON::Connection& meta = MON::Connection(), bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::multiset<ConnectionEnd> getInConnEnds( const std::string& strConnection, bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::multiset<ConnectionEnd> getOutConnEnds(const MON::Connection& meta = MON::Connection(), bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::multiset<ConnectionEnd> getOutConnEnds( const std::string& strConnection, bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::multiset<ConnectionEnd> getConnEnds( const MON::Connection& meta = MON::Connection(), const std::string& strRole = "", bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

std::multiset<ConnectionEnd> getConnEnds( const std::string& strConnection, const std::string& strRole = "", bool bIncludeRefs = true, const MON::Aspect& aspect = MON::Aspect() );

Ends: the connection endpoints

April 19, 2023 32

ObjectImpl

std::string getName() const; void setName( const std::string& strName );

std::string getPath( const std::string& strDelimiter = "/", bool bReverseOrder = false, bool bNeedRootFolder = false ) const;

const MON::Object& getObjectMeta() const;

std::string getInfoString();

Absolute path of object

Meta description class of object

Debugging info

April 19, 2023 33

Automatic domain-specific extension of BON2

BonExtender (BonX) interpreter

April 19, 2023 34

BonX interpreter

CodeGenerator Input: Metamodel Output: C++ code (class definition and

implementation)

Automatical generation of paradigm specific code

Life without BonX: a paradigm specific code had to be hand-written first error prone for typos ( i.e. ‘InputSignal’ or

‘Inputsignal’)

Relates to UDM (Universal Data Model)

April 19, 2023 35

Metamodel and extended BON2 correspondence

class ParameterBaseImpl : virtual public BON::AtomImpl{public:

typedef enum{

Integer_DataType_Type,Double_DataType_Type,Character_DataType_Type,Pointer_DataType_Type

} DataType_Type;

// attribute getters and setterslong getSize() ;void setSize( const long val);DataType_Type getDataType();void setDataType( DataType_Type val);

};

April 19, 2023 36


SF_BON::Processing

SF_BON::Primitive SF_BON::Compound

SF_BON::ProcessingImpl

SF_BON::PrimitiveImpl SF_BON::CompoundImpl

BonXinterpreter

BON::ModelImpl

BON::Model C++ classes

April 19, 2023 37

Component stack - revisited

C++ BON1 C++ BON2


IMgaModel*

Implementationlayer

ModelImpl

WrapperlayerCBuilderModel

pointer toLegend


(interpreter)


(interpreter)


(interpreter)

operates on

Model

IMgaModel*

interface

JAVA BON


(interpreter)

JBuilderModel

IMgaModel*

.NET-COM interop


(interpreter)

BON2 Extension

C++ BONX based component

(interpreter)

PageImpl

extendsPage

part of GME

user-written

April 19, 2023 38

Extended BON2// declare Processing class, derived from BON::ModelDECLARE_ABSTRACT_BONEXTENSION( BON::Model, ProcessingImpl,

Processing );

class ProcessingImpl : // implementation class ProcessingImpl virtual public BON::ModelImpl // also derived from ModelImpl

{public:

// kind and role gettersstd::set<InputSignal> getInputSignals();std::set<OutputSignal>getOutputSignals();std::set<Signal> gets();std::set<InputParam> getInputParameters();std::set<OutputParam> getOutputParameters();std::set<Param> getParameters();std::set<ParameterBase> geteters();std::set<ParameterConn> getPC(); // connection

};

April 19, 2023 39

Extended BON2// declares automatically class Compound as a subclass of ProcessingDECLARE_BONEXTENSION( Processing, CompoundImpl, Compound );

class CompoundImpl : // implementation class CompoundImpl public ProcessingImpl // also derived from ProcessingImpl

{public:

// Compound specific kind and role getters// getChildFCOs() still available since defined in BON::ModelImpl baseclass std::set<Compound> getCompoundParts();std::set<DataflowConn> getDFC();std::set<Processing> getParts();std::set<Primitive> getPrimitiveParts();

///BUP// add your own members here///EUP

};Declarations added here are preserved

upon several invokations

April 19, 2023 40


class ParameterBaseImpl : virtual public BON::AtomImpl{public:

// … (attribute getters)

// connectionEnd gettersstd::multiset<ParameterBase> getParameterConnDsts();std::multiset<ParameterBase> getParameterConnSrcs();

// connectionLink gettersstd::set<ParameterConn> getInParameterConnLinks();std::set<ParameterConn> getOutParameterConnLinks();std::set<ParameterConn> getParameterConnLinks();

};

Multiplicity of elements >= 1

April 19, 2023 41

Casting to the extended types

void Component::invokeEx( Project& project, FCO& currentFCO, const std::set<FCO>& setSelectedFCOs, long lParam )

{std::string msg;std::set<FCO>::const_iterator it0 = setSelectedFCOs.begin();std::set<FCO>::const_iterator itE = setSelectedFCOs.end();for( ; it0 != itE; ++it0){

// BON::FCO i = *it0; // longer form // SF_BON::Processing proc = i; // copy ctor invoked 2x

SF_BON::Processing prc( *it0); // shorter formif( prc) // valid? test{

SF_BON::Compound com( prc);if( com) msg += “Compound: “;else msg += “Primitive: “;msg += prc->getName();msg += "\n";

}}// . . .

}

April 19, 2023 42

Using Visitor with extended BON2

namespace BON {void Component::invokeEx( Project& project, BON::FCO& curFCO,

const std::set<FCO>& selFCOs, long par){

SF_BON::SFVisitor v;Folder rf = project->getRootFolder();rf->accept( &v);v.showResults();

}}

namespace SF_BON {bool SFVisitor::visitCompound( const Compound& object ) {

if ( !object)return false;

m_results.push_back( Result( object->getName()));return true;

}void SFVisitor::showResults() {

for( int i = 0; i < m_results.size(); ++i) { /* . . . */ }}

}

April 19, 2023 43


class ModelImpl {public:

virtual void accept( Visitor* pVisitor);// . . .

};

void ModelImpl::accept( Visitor* pVisitor){

FCOSet children = getChildFCOsI();// visit children firstfor( FCOSet::iterator it = children.begin();

it != children.end() ; it++ ){

(*it)->accept( pVisitor ); }// visit the node itselfpVisitor->visitModel( Model( this ) );

}

April 19, 2023 44


void MyModelImpl::accept( Visitor* pVisitor){

std::set<Kid> children = getKids();// visit the node itself firstpVisitor->visitModel( Model( this ) );

// then visit childrenfor(std::set<Kid>::iterator

it=children.begin();it != children.end() ; it++ )

{(*it)->accept( pVisitor );

}}

April 19, 2023 45

BON versions compared

BON2 Lightweight: on-demand

instantiation STL-based

Multiple inheritance allowed: good metamodel conformance

domain-specific extension generation from metamodels (BonX interpreter)

Includes MON: Meta Object Network

Add-ons supported

Steep learning curve

BON1 Relatively heavyweight

Relies on MFC No multiple inheritance

allowed

Easier to use

April 19, 2023 46

COM Interpreter Concepts

Project FCO Atom Model Set Reference Connection Folder Aspect

IMgaProject IMgaFCO IMgaAtom IMgaModel, IMgaPart IMgaSet IMgaReference IMgaSimpleConnecti

on IMgaFolder IMgaMetaAspectThese Interfaces (which

stem from the COM architecture) can be used

already

April 19, 2023 47

COM interpreter called from GME

// section of generated RawComponent.cpp file:// This is the main component method for interpereters and plugins. // May als be used in case of invokeable addonsSTDMETHODIMP RawComponent::InvokeEx( IMgaProject *project, IMgaFCO *currentobj,

IMgaFCOs *selectedobjs, long param) {

COMTRY {CComBSTR projname;CComBSTR focusname = "<nothing>";CComPtr<IMgaTerritory> terr;COMTHROW(project->CreateTerritory(NULL, &terr));COMTHROW(project->BeginTransaction(terr));try {

COMTHROW(project->get_Name(&projname));if(currentobj) COMTHROW(currentobj->get_Name(&focusname));long cnt = 0;if( selectedobjs) COMTHROW( selectedobjs->get_Count( &cnt));for( long i = 1; i <= cnt; ++i){

CComPtr<IMgaFCO> obj_i;COMTHROW( selectedobjs->get_Item( i, &obj_i);CComBSTR nm;COMTHROW( obj_i->get_Name( &nm));

}AfxMessageBox("RAW Com Component --- Plugin!!!! Sample (project: " +

CString(projname) + ", focus: " + CString(focusname));COMTHROW(project->CommitTransaction());

}catch(...) { project->AbortTransaction(); throw;

}} COMCATCH(;);

}

April 19, 2023 48

COM interpreter - transactions

interface IMgaProject {

[ helpstring("method CreateTerritory (call outside transaction)")] HRESULT CreateTerritory([in] IMgaEventSink *handler, [out] IMgaTerritory **terr, [in, defaultvalue(0)] IMgaEventSink *rwhandler);

HRESULT BeginTransaction([in] IMgaTerritory *terr, [in, defaultvalue(TRANSACTION_GENERAL)] transactiontype_enum mode);

[ helpstring("method CommitTransaction")] HRESULT CommitTransaction();

[ helpstring("method AbortTransaction")] HRESULT AbortTransaction();

};

April 19, 2023 49

COM Interpreter Concepts 2. IMgaModel interface

interface IMgaModel : IMgaFCO{

[ helpstring("method CreateChildObject")] HRESULT CreateChildObject([in] IMgaMetaRole *meta, [out] IMgaFCO **newobj);[ helpstring("method DeriveChildObject")] HRESULT DeriveChildObject([in] IMgaFCO *base, [in] IMgaMetaRole *role, [in] VARIANT_BOOL instance, [out] IMgaFCO **newobj);[propget, helpstring("property ChildDerivedFrom")] HRESULT ChildDerivedFrom([in] IMgaFCO *baseobj, [out, retval] IMgaFCO **pVal);[propget, helpstring("property AspectParts")] HRESULT AspectParts([in] IMgaMetaAspect * asp, [in] unsigned int filter, [out, retval] IMgaParts **pVal);[ helpstring("method CreateSimpleConn")] HRESULT CreateSimpleConn([in] IMgaMetaRole *meta, [in] IMgaFCO *src, [in] IMgaFCO *dst, [in] IMgaFCOs *srcrefs, [in] IMgaFCOs *dstrefs, [out] IMgaFCO **newobj);[ helpstring("method CreateReference")] HRESULT CreateReference([in] IMgaMetaRole *meta, [in] IMgaFCO *target, [out] IMgaFCO **newobj);[ helpstring("method AddInternalConnections")] HRESULT AddInternalConnections([in] IMgaFCOs *inobjs, [out] IMgaFCOs **outobjs);[id(0x551), helpstring("method MoveFCOs")] HRESULT MoveFCOs([in] IMgaFCOs * to_copy, [in] IMgaMetaRoles *destroles, [out] IMgaFCOs **objs);[id(0x552), helpstring("method CopyFCOs")] HRESULT CopyFCOs([in] IMgaFCOs * to_move, [in] IMgaMetaRoles *destroles, [out] IMgaFCOs **objs);

A bit difficult

April 19, 2023 50

COM Interpreter Concepts 3. IMgaModel interface

// Container methods and properties[id(0x553), propget, helpstring("property ChildFCOs")] HRESULT ChildFCOs([out, retval] IMgaFCOs **pVal);[id(0x554),propget, helpstring("property ChildFCO, return NULL if not found")] HRESULT ChildFCO([in] BSTR name, [out, retval] IMgaFCO **pVal);[id(0x555), helpstring("method GetDescendantFCOs: recursive search")] HRESULT GetDescendantFCOs([in] IMgaFilter *filter, [out] IMgaFCOs **returnset);[id(0x556), helpstring("method GetChildFCOsOfKind: non recursive search")] HRESULT GetChildrenOfKind([in] BSTR kindname, [out] IMgaFCOs **returnset);

[id(0x560), propget, helpstring("property ChildRelIDCounter")] HRESULT ChildRelIDCounter([out, retval] long *pVal);[id(0x560), propput, helpstring("property ChildRelIDCounter")] HRESULT ChildRelIDCounter([in] long pVal);

};

Weird string datatype. A CString or std::string class must be converted all the

time back and forth

April 19, 2023 51

How to create a C# interpreter?

create a new C# class library project in a Visual Studio solution Add references to the mga.dll, meta.dll, core.dll libraries Enable project setting: “Register for COM interop”

[Guid("EA60E5CC-D141-47d7-98ED-7B8C686BDF52")][ClassInterface(ClassInterfaceType.None)][ProgId("Mga.Interpreter.MyFirstCSharpInterpreter")]public class MyMgaComponent : IMgaComponentEx, IMgaComponent, IMgaVersionInfo{

public void InvokeEx( MgaProject project, MgaFCO currentobj, MgaFCOs selectedobjs, int param){

System.Text.StringBuilder sb = new System.Text.StringBuilder( "My kids are: ");System.Windows.Forms.MessageBox.Show( "Is it really running?");IMgaTerritory terr;project.CreateTerritory( null, out terr, null);transactiontype_enum mod = transactiontype_enum.TRANSACTION_GENERAL;project.BeginTransaction( terr, mod);

MgaFolder rf = project.RootFolder;MgaFCOs childColl = rf.ChildFCOs;foreach( MgaFCO child in childColl){

sb.AppendFormat( " {0}", child.Name);}project.CommitTransaction();

System.Windows.Forms.MessageBox.Show( sb.ToString());return;

}}

April 19, 2023 52

Q & A

Documents

Institute for Software Integrated Systems Vanderbilt University Interpreters 2. (Translators)