Standard objects

<< Click to Display Table of Contents >>

Navigation:  Macros > Macro structure and syntax >

Standard objects

In the macro language a number of standard variables is present. These can be consulted in a macro. With these variables the names of directories can be consulted and it can be tested if a calculation has been carried out correctly.

 

Standaard variable

Alterable

Type

Description

Options.Version

no

Text

Version number of Vision

Options.TypeFile

no

Text

Name of the basic type file

Options.NetworkDir

no

Text

Name of the directory with network files

Options.MacroDir

no

Text

Name of the directory with macro files

Options.TempDir

no

Text

Name of the directory with temporary files

Options.BackupDir

no

Text

Name of the directory with back up files

Options.ArchiveDir

no

Text

 

Options.Frequency

yes

Number

Set system frequency (50/60 Hz)

Options.UseConductorTemperature

yes

Boolean

Apply conductor temperature

Options.ConductorTemperature_PILC

yes

Number

Applicable conductor temperature for PILC

Options.ConductorTemperature_NonPILC

yes

Number

Applicable conductor temperature for non-PILC

Network.FileName

no

Text

Naam of the current network file

Network.FilePath

no

Text

Naam of the path of the current network file

Network.FileDir

no

Text

Naam of the directory of the current network file

Network.Result

no

NO’/’LF’/

'IEC'/'FA'/

'REL'/'SEL'/ 'RIP

Indicates whether the calculation has been correctly carried out or not

Network.SubResult

no

Text

 

Network.Year

yes

Number

Year for altering loads (as result of growth)

Network.Date

yes

Text

Date for active variant or scenario

Network.Client

no

Text

 

Network.Place

no

Text

 

Network.Country

no

Text

 

Network.Project

no

Text

 

Network.Description

no

Text

 

Network.Version

no

Text

 

Network.State

no

Text

 

Network.By

no

Text

 

Network.ActiveSheet (former ThisSheet)

yes

Text

Name of the current sheet

System.Date

no

Text

System date

System.Time

no

Text

System time

System.TimeStamp

no

Number

System time in seconds, starting from 0:00 h

Macro.Error

no

Number

The current error number

Macro.ErrorText

no

Text

The current error text

Macro.LoadflowErrorText

no

Text

The latest loadflow error text

Macro.LoadflowWarningText

no

Text

The latest loadflow warning text

 

Standard the object with the name 'Network' is available. This object contains the current network. From this object the attribute 'Result' can be consulted by means of: Network.Result. With this attribute it can be tested if the results for the whole network are available.

 

Almost all objects have the attribute 'Result'. This is a text, containing the value 'NO' if no calculation results are available. After successful completion of a calculation this attribute contains the values:

'LF': loadflow result available

'IEC': IEC 60909 result available

'FA': Fault Analysis result available

'REL': Reliability analysis result available

'SEL': Selectivity analysis result available

'RIP': Ripple control calculation result available

 

This is used to test if a calculation has been carried out successfully. E.g.:

if( Node('MyNode').Result, =, 'LF' )

 ...

end

 

The file locations can be consulted with options.typedir, options.macrodir, options.networkdir, options.tempdir and options.backupdir.

 

See also:

commands

objects

values

variables

 

Back to Structure and syntax.