<< Click to Display Table of Contents >> Navigation:  Macros > Macro structure and syntax > Macro objects

In the macro language, all network components are referred to collectively as Objects. So, for example, nodes, cables and loads are all Objects. The following Objects are defined in Vision’s macro language:

 

 

In this document, objects appear in bold type.

 

Individual Objects are referred to by name. A name may be in the form of text or a text variable. The name of an object is case sensitive. The general notation is:

Object( ObjectName ).

 

So, for example, a particular node might be referred to as:

Node( 'MyNode' ).

 

Branches (links, cables, connections, inductors, transformers, special transformers) are also referred to by name. Since some users use names to refer to circuits (white/black), it is also possible to indicate from-nodes and to-nodes. This is done by giving the name of the branch followed by a colon, then the name of the from-node, then a dash and finally the name of the to-node. No spaces are allowed either side of the colon or dash.

 

If the branch name, from-node name or to-node name does not exist, or if the names of the from and to-nodes are reversed, the Object will not be found.

 

If the user does not know beforehand what order the from and to-node names are defined in, an equals sign (=) may be used instead of a dash. If an equals sign is used, it does not matter what order the from and to-node names are given in. No spaces may be used either side of an equals sign.

 

The general notation for branches is:

Object( ObjectName )

or

Object( ObjectName:FromNodeName-ToNodeName )

or

Object( ObjectName:FromNodeName=ToNodeName )

 

Examples:

Link( 'MyLink'  )

Cable( 'MyCable:MyFromNode-MyToNode' )

Line( 'MyOverheadLine:MyFromNode=MyToNode' )

 

Elements (sources, synchronous generators, synchronous motors, asynchronous generators, asynchronous motors, loads, transformer loads, capacitors, coils, zero-point transformers) are similarly referred to by name. If an element name is not unique, it can be identified by adding the name of the node to which it is connected. This is done by giving the name of the element, followed by a colon, then the name of the relevant node. Spaces are not allowed either side of the colon.

 

The general notation for Elements is:

Object( ObjectName )

or

Object( ObjectName:ConnectedNodeName )

 

Examples:

Load( 'MyLoad' )

or

SynMot( 'MyMotor:MyConnectedNode' )

 

See also:

•commands

•values

•variables

•attributes

•standard objects

 

Back to Structure and syntax.