Skip to content

Bobgarner/template access repository info #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 1, 2022
Merged

Bobgarner/template access repository info #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
341b0db
This gives a template the ability to access information about the rep…
Jun 1, 2022
b2588c7
Bumped the compiler version.
Jun 1, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions docs/emc/EMC_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Returns the name of this configuration.

<hr/>

#### `MTDirectory outputByName(String name)`
#### `MTDirectory outputByName(String arg0)`

With the name of an output, this returns the directory object representing the output that a template can be configured to use.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the output as it is defined inside the `config {}` block of your model. |
|`String arg0` | The name of the output as it is defined inside the `config {}` block of your model. |

<hr/>

Expand Down Expand Up @@ -113,13 +113,13 @@ These methods relate to a module.

<hr/>

#### `MTModule moduleWithName(String name)`
#### `MTModule moduleWithName(String arg0)`

Returns a module by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the module to return. |
|`String arg0` | The name of the module to return. |

<hr/>

Expand All @@ -134,23 +134,23 @@ These methods relate to an entity.

<hr/>

#### `MTDomain domain(String name)`
#### `MTDomain domain(String arg0)`

Returns a domain from its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the domain to return. |
|`String arg0` | The name of the domain to return. |

<hr/>

#### `MTEntity entity(String name)`
#### `MTEntity entity(String arg0)`

Returns an entity from its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the entity to return. |
|`String arg0` | The name of the entity to return. |

<hr/>

Expand All @@ -160,23 +160,23 @@ Returns a the total number of entities in this space including implicit entities

<hr/>

#### `MTEntityTemplate entityTemplateWithName(String name)`
#### `MTEntityTemplate entityTemplateWithName(String arg0)`

Returns an entity template by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the entity to return. |
|`String arg0` | The name of the entity to return. |

<hr/>

#### `boolean hasDomain(String name)`
#### `boolean hasDomain(String arg0)`

Indicates if there is a domain by the specified name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the domain in question. |
|`String arg0` | The name of the domain in question. |


### Enum Category
Expand All @@ -191,13 +191,13 @@ Returns a the number of enums in this space.

<hr/>

#### `MTEnum enumWithName(String name)`
#### `MTEnum enumWithName(String arg0)`

Returns an enum by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the enum to return. |
|`String arg0` | The name of the enum to return. |

<hr/>

Expand All @@ -212,14 +212,14 @@ These methods relate to typedefs.

<hr/>

#### `MTInterfaceOperation operationByName(MTInterface mtInterface, String extendedOperationName)`
#### `MTInterfaceOperation operationByName(MTInterface arg0, String arg1)`

Given an interface object, this will return an operation by its name.

| Parameter | Description |
|-----|-----|
|`MTInterface mtInterface` | The interface object that contains the operation. |
|`String extendedOperationName` | The name of the operation to return. |
|`MTInterface arg0` | The interface object that contains the operation. |
|`String arg1` | The name of the operation to return. |

<hr/>

Expand All @@ -229,13 +229,13 @@ Returns the number of typedefs declared in this space.

<hr/>

#### `MTTypedef typedefWithName(String name)`
#### `MTTypedef typedefWithName(String arg0)`

Returns a typedef by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the typedef to return. |
|`String arg0` | The name of the typedef to return. |

<hr/>

Expand All @@ -250,13 +250,13 @@ These methods relate to language definitions.

<hr/>

#### `MTLanguage languageWithName(String name)`
#### `MTLanguage languageWithName(String arg0)`

Returns a language object by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the language to return. |
|`String arg0` | The name of the language to return. |


### Tagging Category
Expand All @@ -265,73 +265,73 @@ These methods relate to the tagging.

<hr/>

#### `List domainsTagged(String tag)`
#### `List domainsTagged(String arg0)`

Returns all domains that are tagged with a specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `List entitiesTagged(String tag)`
#### `List entitiesTagged(String arg0)`

Returns all entities found with the specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `MTEntity entityTagged(String tag)`
#### `MTEntity entityTagged(String arg0)`

Returns the first entity found with the specified tag. This should only be used when it is expected that only one is tagged with the tag by nature of the entity. Use `entitiesTagged()` if you are expecting multiple entities that are found.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `MTEnum enumTagged(String tag)`
#### `MTEnum enumTagged(String arg0)`

Returns all enums that are tagged with a specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `boolean hasDomainTagged(String tag)`
#### `boolean hasDomainTagged(String arg0)`

Indicates if there is at least one domain tagged with the specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `boolean hasEntityTagged(String tag)`
#### `boolean hasEntityTagged(String arg0)`

Indicates if there is at least one entity tagged with the specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |

<hr/>

#### `boolean hasEnumTagged(String tag)`
#### `boolean hasEnumTagged(String arg0)`

Indicates if there is at least one enum tagged with the specified tag.

| Parameter | Description |
|-----|-----|
|`String tag` | The tag with which to search. |
|`String arg0` | The tag with which to search. |


### Configuration Category
Expand All @@ -340,13 +340,13 @@ These methods relate to a part of application configuration.

<hr/>

#### `boolean hasMetadataValue(String name)`
#### `boolean hasMetadataValue(String arg0)`

Indicates whether this space has a metadata name/value for the specified name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the metadata value to return. |
|`String arg0` | The name of the metadata value to return. |

<hr/>

Expand All @@ -362,33 +362,33 @@ Returns the names of the enums that have been imported into this space.

<hr/>

#### `Object metadataValue(String name)`
#### `Object metadataValue(String arg0)`

Spaces can define a dictionary of name/value pairs that provide some meta data about the space and basically the application. This method allows you to get a value by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the meta data. |
|`String arg0` | The name of the meta data. |

<hr/>

#### `MTRepository repository(String name)`
#### `MTRepository repository(String arg0)`

Returns the repository object by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the repository. |
|`String arg0` | The name of the repository. |

<hr/>

#### `MTRepository repositoryByName(String name)`
#### `MTRepository repositoryByName(String arg0)`

Returns a repository object by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the repository to return. |
|`String arg0` | The name of the repository to return. |


### Interface Category
Expand All @@ -397,13 +397,13 @@ These methods relate to an interface.

<hr/>

#### `MTInterface interface(String name)`
#### `MTInterface interface(String arg0)`

Returns an interface by its name.

| Parameter | Description |
|-----|-----|
|`String name` | The name of the interface to return. |
|`String arg0` | The name of the interface to return. |

<hr/>

Expand Down
Loading