Difference between revisions of "Extensions.DataType.StructureCopy"

From emotive
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:OTX '''StructureCopy'''}}[[Category:DataTypes]]
+
{{DISPLAYTITLE:OTX '''StructureCopy'''}}[[Category:DataType]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | StructureCopy | Creates a deep copy of a specified structure. | [[Term]] | [[Extensions.DataTypes|OTX DataTypes extension]] | [[StructureCopy related terms]] | - | - }}
+
{{ClassificationActivity | StructureCopy | Creates a deep copy of a specified structure. | [[Term]] | [[Extensions.DataType|OTX DataTypes extension]] | [[Extensions.DataType#Terms|StructureCopy related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DataTypes.StructureCopy(StructureTerm);
+
/// Local Declarations
 +
DatatypeSignature StructureVariable;
 +
/// Flow
 +
StructureVariable = DataType.StructureCopy(StructureTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 11: Line 14:
 
'''StructureCopy''' is a term that creates a deep copy of a specified structure.
 
'''StructureCopy''' is a term that creates a deep copy of a specified structure.
  
{{TermReturnValue| [[Extensions.DataTypes.Structure|Structure]] | Returns the copy of the specified structure. }}
+
{{TermReturnValue| [[Extensions.DataType.Structure|Structure]] | Returns the copy of the specified structure. }}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| OtherStructure | [[Extensions.DataTypes.Structure|Structure]] | [[Term]] | - | [1] | The structure to be copied.}}
+
{{TableRowPropertie2| OtherStructure | [[Extensions.DataType.Structure|Structure]] | [[Term]] | - | [1] | The structure to be copied.}}
  
 
|}
 
|}
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 DataTypes.DatatypeSignature DatatypeSignature1(Boolean DatatypeElement1 = true, Integer DatatypeElement2 = 12);
+
package DataType.DatatypeSignature DatatypeSignature1(Boolean DatatypeElement1 = true, Integer DatatypeElement2 = 12);
 +
 
 +
/// Global Declarations
 +
 
 
public procedure main()
 
public procedure main()
 
{
 
{
  DatatypeSignature1 structure1;
+
        /// Local Declarations
  DatatypeSignature1 structure2;
+
 
 +
        DatatypeSignature1 structure1;
 +
        DatatypeSignature1 structure2;
 +
 
 +
        /// Flow
  
  structure2 = DataTypes.CopyStructure(structure1);
+
        structure2 = DataType.CopyStructure(structure1);
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== 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]] <br/> -->
+
<!-- [[Extensions.DataType.StructureCopy|StructureCopy]] <br/> -->

Latest revision as of 09:59, 23 October 2018

Classification

Name StructureCopy
Short Description Creates a deep copy of a specified structure.
Class Term
Extension OTX DataTypes extension
Group StructureCopy related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
DatatypeSignature StructureVariable;
/// Flow
StructureVariable = DataType.StructureCopy(StructureTerm);

Description

StructureCopy is a term that creates a deep copy of a 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 the copy of the specified structure.

Properties

Name Data Type Class Default Cardinality Description
OtherStructure Structure Term - [1] The structure to be copied.

OTL Examples

package DataType.DatatypeSignature DatatypeSignature1(Boolean DatatypeElement1 = true, Integer DatatypeElement2 = 12);

/// Global Declarations

public procedure main()
{
        /// Local Declarations

        DatatypeSignature1 structure1;
        DatatypeSignature1 structure2;

        /// Flow

        structure2 = DataType.CopyStructure(structure1);
}

See also

EnumerationContainsName
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue