def undeploy(self):
"""
Undeploys the Stimulus Profile Session.
Returns:
None:
"""
err = self._dot_net_instance.Undeploy(None)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
def set_channel_vector_values(self, channel, new_values):
"""
Sets the vector values of a channel on the target.
Args:
channel (str): The name of the channel. You must enter the full path to the channel as specified in the
system definition file.
new_values (List[float]): The vector values. This parameter expects a 1D array. If the channel expects
two-dimensional data, convert the 2D channel data into a 1D array before passing it to this method.
"""
err = self._dot_net_instance.SetChannelVectorValues(channel, new_values)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
def get_single_channel_value(self, name):
"""
Gets the value of a single channel on the target.
Args:
name (str): The name of the channel. You must enter the full path to the channel as specified in the system
definition file.
Returns:
float: The value of the specified channel.
"""
err, value = self._dot_net_instance.GetSingleChannelValue(name, 0)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
return value
def get_multiple_system_nodes_data(self, names):
"""
Gets information about multiple nodes in the system definition file.
Args:
names ([str]): The names of the nodes. You must enter the full path to each node as specified in the system
definition file.
Returns:
niveristand.clientapi._nodeinfo._NodeInfo: Information about the nodes.
"""
err, node_infos = self._dot_net_instance.GetMultipleSystemNodesData(names, None)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
return [_NodeInfo(node_info) for node_info in node_infos]
def deploy(self, auto_start):
"""
Deploys the Stimulus Profile Session.
Args:
auto_start (bool): If True, starts sequences immediately upon deploy. If False, waits for an external Run
command.
Returns:
str: The ID of the Stimulus profile session.
"""
ret_val, session_id, err = self._dot_net_instance.Deploy(
auto_start, None, None)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
return session_id
def get_channel_vector_values(self, channel):
"""
Gets the vector values of a channel on the target.
Args:
channel (): The name of the channel. You must enter the full path to the channel as specified in the system
definition file.
Returns:
int: The number of rows in the vector array.
int: The number of columns in the vector array.
[float]: The vector values.
"""
err, row_dim, col_dim, value = self._dot_net_instance.GetChannelVectorValues(channel)
err = _Error(err)
if err.is_error:
raise \
errors.VeristandError(_errormessages.csharp_call_failed % (err.error_code, err.resolved_error_message))
return row_dim, col_dim, value
