Jump to: navigation, search

Difference between revisions of "Activity:AssignToNamedRelation (Activity)"


(Example)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
The AssignedToNamedRelation activity assigns a child objec via the name of an existing [[Relation|relation]] to a given parent object.
 
The AssignedToNamedRelation activity assigns a child objec via the name of an existing [[Relation|relation]] to a given parent object.
 
+
=Description=
 
+
 
{{ActivityInfoBox
 
{{ActivityInfoBox
 
| title = Assign To Named Relation
 
| title = Assign To Named Relation
Line 8: Line 7:
 
| imagecaption = Activity AssignToNamedRelation
 
| imagecaption = Activity AssignToNamedRelation
 
| purpose = Relate child object to parent object
 
| purpose = Relate child object to parent object
| category = Object Primitives
+
| category = UBIK Object Primitives
 
| returns = True if successful
 
| returns = True if successful
 
| version = 2.1.15+
 
| version = 2.1.15+
 
}}
 
}}
  
 
+
===Arguments===
 
+
 
+
 
+
==Arguments==
+
  
 
{| class="wikitable sortable" | width = "50%"
 
{| class="wikitable sortable" | width = "50%"
Line 23: Line 18:
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- align="left"
| Parent || RelationalObject || In || The parent object
+
| Parent || [[RelationalObject]] || In || The parent object
 
|- align="left"
 
|- align="left"
| RelationName || String|| In || The name of the relation to be searched for at the parent object
+
| RelationName || {{String_MSDN}}|| In || The name of the relation to be searched for at the parent object
 
|- align="left"
 
|- align="left"
| Child || RelationalObject || In || The child to relate
+
| Child || [[RelationalObject]] || In || The child to relate
 
|- align="left"
 
|- align="left"
| RelationData|| RelationData || Out || The created relation data object, null if failed
+
| RelationData|| [[RelationData]] || Out || The created relation data object, null if failed
 
|- align="left"
 
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
+
| Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed
 
|}
 
|}
  
==Usage==
+
===Usage===
  
 
This activity is used to find a certain relation at the parent object via the name and then relate the child object to it.
 
This activity is used to find a certain relation at the parent object via the name and then relate the child object to it.
  
==Example==
+
=Example=
 
+
 
Load the MetaClass named ''PUMP'', also load the MetaProperty ''NOMINALPOWER'' from the property pool and then add it to the MetaClasses' properties:
 
Load the MetaClass named ''PUMP'', also load the MetaProperty ''NOMINALPOWER'' from the property pool and then add it to the MetaClasses' properties:
 
  
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
Line 57: Line 50:
 
.GetMetaProperty("NOMINALPOWER")</source>
 
.GetMetaProperty("NOMINALPOWER")</source>
 
|}
 
|}
 +
 +
<headertabs />
  
 
==See also==
 
==See also==
 
* [[Workflow Designer]]
 
* [[Workflow Designer]]
* [[RemoveFromNamedRelation (Activity)]]
+
* [[Activity:RemoveFromNamedRelation (Activity)]]
  
[[Category:Workflows]] [[Category:Activities]]
+
[[Category:Activities]]

Latest revision as of 13:54, 23 February 2015

The AssignedToNamedRelation activity assigns a child objec via the name of an existing Relation to a given parent object.

[edit]

Description

Assign To Named Relation
Name AssignToNamedRelation
Purpose Relate child object to parent object
Category UBIK Object Primitives
Returns True if successful
Version 2.1.15+

Arguments

Argument Type Direction Purpose
Parent RelationalObject In The parent object
RelationName String In The name of the relation to be searched for at the parent object
Child RelationalObject In The child to relate
RelationData RelationData Out The created relation data object, null if failed
Result Boolean Out True if successful, false if failed

Usage

This activity is used to find a certain relation at the parent object via the name and then relate the child object to it.

Example

Load the MetaClass named PUMP, also load the MetaProperty NOMINALPOWER from the property pool and then add it to the MetaClasses' properties:

Argument Value
Parent
UBIKObject.Environment _
.GetSystemMetaClass(SystemObjects.METACLASS) _
.AllInstances("PUMP")
RelationName
"SYSREL_METAPROPERTY"
Child
UBIKObject.Environment _
.GetSystemMetaClass(SystemObjects.POOL_METAPROPERTY) _
.GetMetaProperty("NOMINALPOWER")

See also