Difference between revisions of "Extensions.DataType.StructureCreate"
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''StructureCreate'''}}Category:DataTypes == Classification == {{ClassificationActivity | StructureCreate| Creates a new, initialised instance of the sp...") |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE:OTX '''StructureCreate'''}}[[Category: | + | {{DISPLAYTITLE:OTX '''StructureCreate'''}}[[Category:DataType]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | StructureCreate| Creates a new, initialised instance of the specified structure. | [[Term]] | [[Extensions. | + | {{ClassificationActivity | StructureCreate| Creates a new, initialised instance of the specified structure. | [[Term]] | [[Extensions.DataType|OTX DataType extension]] | [[Extensions.DataType#Terms|StructureCreate related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| + | StructureSignature StructureVariable; | ||
| + | /// Flow | ||
| + | StructureVariable = DataType.StructureCreate(OtxLink); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 14: | ||
'''StructureCreate''' is a term that creates a new, initialised instance of the specified structure. | '''StructureCreate''' is a term that creates a new, initialised instance of the specified structure. | ||
| − | {{TermReturnValue| [[Extensions. | + | {{TermReturnValue| [[Extensions.DataType.Structure|Structure]] | Returns a new, initialised instance of the specified structure. }} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| structureType | [[OtxLink]]| - | - | [1..1] | Refers to a certain '''StructureSignature'''.}} |
|} | |} | ||
| Line 22: | Line 25: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | package DataType.StructureSignature | + | package DataType.StructureSignature StructureSignature1(Integer StructureElement1, Boolean StructureElement2 = false); |
/// Global Declarations | /// Global Declarations | ||
| Line 30: | Line 33: | ||
/// Local Declarations | /// Local Declarations | ||
| − | + | StructureSignature1 Structure; | |
/// Flow | /// Flow | ||
| − | Structure = DataType.StructureCreate( | + | Structure = DataType.StructureCreate(StructureSignature1); |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[Extensions. | + | [[Extensions.DataType.EnumerationContainsName|EnumerationContainsName]] <br/> |
| − | [[Extensions. | + | [[Extensions.DataType.EnumerationContainsValue|EnumerationContainsValue]] <br/> |
| − | [[Extensions. | + | [[Extensions.DataType.EnumerationGetEntryList|EnumerationGetEntryList]] <br/> |
| − | [[Extensions. | + | [[Extensions.DataType.GetEnumerationByName|GetEnumerationByName]] <br/> |
| − | [[Extensions. | + | [[Extensions.DataType.GetEnumerationByValue|GetEnumerationByValue]] <br/> |
| − | [[Extensions. | + | [[Extensions.DataType.StructureCopy|StructureCopy]] |
Latest revision as of 10:01, 23 October 2018
Contents
Classification
| Name | StructureCreate |
| Short Description | Creates a new, initialised instance of the specified structure. |
| Class | Term |
| Extension | OTX DataType extension |
| Group | StructureCreate related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
StructureSignature StructureVariable;
/// Flow
StructureVariable = DataType.StructureCreate(OtxLink);Description
StructureCreate is a term that creates a new, initialised instance of the specified structure.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Structure | Returns a new, initialised instance of the specified structure. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| structureType | OtxLink | - | - | [1..1] | Refers to a certain StructureSignature. |
OTL Examples
package DataType.StructureSignature StructureSignature1(Integer StructureElement1, Boolean StructureElement2 = false);
/// Global Declarations
public procedure main()
{
/// Local Declarations
StructureSignature1 Structure;
/// Flow
Structure = DataType.StructureCreate(StructureSignature1);
}See also
EnumerationContainsName
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy
