Difference between revisions of "Extensions.DataType.StructureCreate"

From emotive
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:OTX '''StructureCreate'''}}[[Category:DataTypes]]
+
{{DISPLAYTITLE:OTX '''StructureCreate'''}}[[Category:DataType]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | StructureCreate| Creates a new, initialised instance of the specified structure. | [[Term]] | [[Extensions.DataTypes|OTX DataTypes extension]] | [[Extensions.DataTypes#Terms|StructureCreate related terms]] | - | - }}
+
{{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;">
StructureTerm = DataType.StructureCreate(OtxLink);
+
/// 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.DataTypes.Structure|Structure]] | Returns a new, initialised instance of the specified structure. }}
+
{{TermReturnValue| [[Extensions.DataType.Structure|Structure]] | Returns a new, initialised instance of the specified structure. }}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| structureType | [[Extensions.DataTypes.StructureSignature|StructureSignature]] | - | - | [1..1] | Refers to a certain '''StructureSignature'''.}}
+
{{TableRowPropertie2| structureType | [[OtxLink]]| - | - | [1..1] | Refers to a certain '''StructureSignature'''.}}
  
 
|}
 
|}
Line 39: Line 42:
  
 
== See also ==
 
== See also ==
[[Extensions.DataTypes.EnumerationContainsName|EnumerationContainsName]] <br/>
+
[[Extensions.DataType.EnumerationContainsName|EnumerationContainsName]] <br/>
[[Extensions.DataTypes.EnumerationContainsValue|EnumerationContainsValue]] <br/>
+
[[Extensions.DataType.EnumerationContainsValue|EnumerationContainsValue]] <br/>
[[Extensions.DataTypes.EnumerationGetEntryList|EnumerationGetEntryList]] <br/>
+
[[Extensions.DataType.EnumerationGetEntryList|EnumerationGetEntryList]] <br/>
[[Extensions.DataTypes.GetEnumerationByName|GetEnumerationByName]] <br/>
+
[[Extensions.DataType.GetEnumerationByName|GetEnumerationByName]] <br/>
[[Extensions.DataTypes.GetEnumerationByValue|GetEnumerationByValue]] <br/>
+
[[Extensions.DataType.GetEnumerationByValue|GetEnumerationByValue]] <br/>
[[Extensions.DataTypes.StructureCopy|StructureCopy]]
+
[[Extensions.DataType.StructureCopy|StructureCopy]]

Latest revision as of 10:01, 23 October 2018

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.

Icons Note.png 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