OpenVSPAPI  3.20.0
Functions
Advanced Link Functions

The following functions are available for the Advanced Link tool.

Click here to return to the main page. More...

Functions

void AddInput (const string &in parm_id, const string &in var_name)
 
void AddOutput (const string &in parm_id, const string &in var_name)
 
void SetVar (const string &in var_name, double val)
 
double GetVar (const string &in var_name)
 

Detailed Description

Function Documentation

◆ AddInput()

void AddInput ( const string &in  parm_id,
const string &in  var_name 
)

Add an Advanced Link input Parm

// Add Pod Geom
string pid = AddGeom( "POD" );
string tess_u_id = FindParm( "PodGeom", "Shape", "Tess_U" );
AddInput( tess_u_id, "ExampleVariable" );
Parameters
[in]parm_idParm ID
[in]var_nameAdvanced Link variable name

◆ AddOutput()

void AddOutput ( const string &in  parm_id,
const string &in  var_name 
)

Add an Advanced Link output Parm

// Add Pod Geom
string pid = AddGeom( "POD" );
string tess_u_id = FindParm( "PodGeom", "Shape", "Tess_U" );
AddOutput( tess_u_id, "ExampleVariable" );
Parameters
[in]parm_idParm ID
[in]var_nameAdvanced Link variable name

◆ GetVar()

double GetVar ( const string &in  var_name)

Get the value of the specified Advanced Link variable

// Add Pod Geom
string pid = AddGeom( "POD" );
string tess_u_id = FindParm( "PodGeom", "Shape", "Tess_U" );
AddInput( tess_u_id, "ExampleVariable" );
SetVar( "ExampleVariable", 20 );
Print( "ExampleVariable: ", false );
Print( GetVar( "ExampleVariable" ) );
Parameters
[in]var_nameAdvanced Link variable name
Returns
Value for the variable

◆ SetVar()

void SetVar ( const string &in  var_name,
double  val 
)

Set an Advanced Link variable to the specified value

// Add Pod Geom
string pid = AddGeom( "POD" );
string tess_u_id = FindParm( "PodGeom", "Shape", "Tess_U" );
AddInput( tess_u_id, "ExampleVariable" );
SetVar( "ExampleVariable", 20 );
Parameters
[in]var_nameAdvanced Link variable name
[in]valValue for the variable
FindParm
string FindParm(const string &in parm_container_id, const string &in parm_name, const string &in group_name)
AddGeom
string AddGeom(const string &in type, const string &in parent=string())
Print
void Print(const string &in data, bool new_line=true)