Difference between Object and treenode in FlexScript Dot Syntax

Question

question

Arun Kr asked Dec 16, '16 Matt Long commented Apr 14, '17

Difference between Object and treenode in FlexScript Dot Syntax

Hi Support,

I am getting an error for the script given below. (The aim is to change the xlocation of the source object by 2)

Error Message:

exception: FlexScript exception: Label property location retrieved on /Source1. Label does not exist. at /0 c: /testlink_instance i: /testlink_associated

treenode src = model().find("Source1");
src.location.x += 2;

Instead of the script lines

treenode src = model().find("Source1");
Object srcAsObject = src; 
src.as(Object).location.x += 2;

Conceptually both are same right ? Or location can be used only with the object class?

Please correct me, if I had made a wrong question.

But the script given below is working.

treenode src = model().find("Source1");
Object srcAsObject = src; 
srcAsObject.location.x += 2;

Regards,

Arun KR

Software Version:

FlexSim 17.0.0

flexscript object treenode dot syntax

Answer 1 · 2016-12-16T13:21:30Z

Kaspar Chabot answered Dec 16, '16 Matt Long commented Apr 14, '17

Dear Arun KR,

I might be totally wrong about this, but for the moment this is how I think it works...

I think the reason this isn't working is the same as pointed out in the answers to this post.

Basically, you cannot use some of the dot syntax specific to certain classes on treenodes, if I'm not mistaken.

Probably you can use .location on the Object class, but e.g. not on the Table class, both of which can be referenced by a treenode

Since the .location syntax cannot be used for everything that can be referenced to as a treenode, src.location will be interpreted as being a label called 'location' attached to the treenode src.

Kind regards,

Kaspar

· 11

Matthew Gillespie ♦♦ commented · Dec 16, 2016 at 03:53 PM

Yes, the Object class is a subclass of treenode meaning it can do everything a treenode can do, but also expands on it by adding more properties and methods. If you look at the FlexScript Class Reference page in the User Manual you'll see that location property is on the Object class, but not the treenode class. Also on the treenode page you'll find this discussion about the relationship between treenode and Object:

The treenode class is the base class for all objects and nodes accessed in FlexSim's tree. While you can access more data and functionality specific to nodes with object data by using the Object class, treenode is the most basic interface. First, it gives access to data and functionality associated with the tree structure itself. Second, it gives access to basic data stored on the nodes themselves, such as node names and data values. Third, since so much modeling logic uses labels, the treenode class provides a mechanism for easy manipulation of labels on objects, tokens, and task sequences.

The treenode class can be automatically down-cast to a subclass such as Object.
treenode src = model().find("Source1");
Object srcAsObject = src; // auto-down-cast to object
You can also explicitly down-cast using the as() keyword
src.as(Object).location.x += 2;
When FlexScript performs a down-cast, if the node is not a valid instance of the target class type, an invalid cast exception will be thrown.
Object src = model().find("Tools");// throws invalid cast exception
model().find("Tools").as(Object).location.x += 2; // throws invalid cast exception
You can check if a node is a given subclass type with the is() keyword.
if (model().find("Source1").is(Object)) {
	...
}

5 ·

Matt Long Matthew Gillespie ♦♦ commented · Dec 16, 2016 at 06:29 PM

In case it isn't plainly understood from the above comment, you can combine the two lines:

treenode src = model().find("Source1");
Object srcAsObject = src;

into one line:

Object src = model().find("Source1");

2 ·

Arun Kr Matt Long commented · Dec 17, 2016 at 04:07 AM

Thanks Matt, this looks easy

0 ·

Arun Kr Matthew Gillespie ♦♦ commented · Dec 17, 2016 at 04:07 AM

Thanks for the detailed explanation.

0 ·

Arun Kr commented · Dec 16, 2016 at 03:12 PM

Thanks @Kaspar Chabot , looks like that is the answer.

0 ·

Joris Van Poucke commented · Apr 13, 2017 at 08:09 PM

@Matt Long:

As I understand there is no way to retrieve the x-location of for instance a source in one line, comparable to the previous -since 17.1 unusable- command xloc(model().find("Source1")) ?

0 ·

Matthew Gillespie ♦♦ Joris Van Poucke commented · Apr 13, 2017 at 08:40 PM

You can do that in one line:

model().find("Source1").as(Object).location.x

Usually though, you'll be doing that on a variable stored as an object. For example, in any of the Fixed Resource triggers current will be defined in the header as an object so getting it's x-location would look like this:

current.location.x

1 ·

Joris Van Poucke commented · Apr 13, 2017 at 08:47 PM

@Matthew Gillespie, but then I get a cast error. Or is this a bug in 17.1?

0 ·

Matthew Gillespie ♦♦ Joris Van Poucke commented · Apr 13, 2017 at 08:59 PM

No, I'm not aware of any bug like that. What code are you using and where is it? Can you attach your model?

0 ·

Joris Van Poucke Matthew Gillespie ♦♦ commented · Apr 13, 2017 at 10:03 PM

You are right. I made a seperate demo model to test just this, and everything's working as it should there. I'll figure out what I've done wrong in my real model.

Apologies and thank you!

0 ·

Matt Long Joris Van Poucke commented · Apr 14, 2017 at 04:13 PM

We didn't update any code headers in older models, so if you had an object created in a 2016 release and then try and use object methods like current.location.x, it won't work. You would need to manually update the code header to say:

Object current = ownerobject(c);

0 ·

question