Asset Management

NationalInstruments.SystemLink.Clients.AssetManagement

Contents

• AssetUtilizationStore
  • Dispose()
  • StartUtilization(startUtilizationConfiguration,utilizationCategory,userName,taskName)
  • StartUtilization(startUtilizationConfiguration,assetName,utilizationCategory,userName,taskName)
  • StartUtilization(startUtilizationConfiguration,assetNames,utilizationCategory,userName,taskName)
• AssetUtilizationStoreAdapter
  • #ctor()
  • AssetUtilizationStoreEndUtilization(utilizationUuid)
  • AssetUtilizationStoreStartUtilization(assetNames,utilizationCategory,userName,taskName)
  • AssetUtilizationStoreUpdateUtilization(utilizationUuid)
  • CleanStartUtilizationResult(utilizationResult)
  • Dispose(disposing)
  • Dispose()
  • Finalize()
  • InitializeAssetUtilizationStore()
  • ShutdownAssetUtilizationStore()
• AssetUtilizationStoreException
  • #ctor(errorCode)
  • #ctor(message)
  • #ctor(message,innerException)
  • #ctor(serializationInfo,streamingContext)
  • #ctor()
  • ErrorCode
  • GetObjectData()
• AssetUtilizationStoreFactory
  • #ctor(assetUtilizationStoreAdapter)
  • #ctor()
  • CreateAssetUtilizationStore()
  • Dispose()
  • Dispose()
• IAssetUtilizationStore
  • StartUtilization(startUtilizationConfiguration,utilizationCategory,userName,taskName)
  • StartUtilization(startUtilizationConfiguration,assetName,utilizationCategory,userName,taskName)
  • StartUtilization(startUtilizationConfiguration,assetNames,utilizationCategory,userName,taskName)
• IAssetUtilizationStoreAdapter
  • AssetUtilizationStoreEndUtilization(utilizationUuid)
  • AssetUtilizationStoreStartUtilization(assetNames,utilizationCategory,userName,taskName)
  • AssetUtilizationStoreUpdateUtilization(utilizationUuid)
  • CleanStartUtilizationResult(utilizationResult)
  • InitializeAssetUtilizationStore()
  • ShutdownAssetUtilizationStore()
• IAssetUtilizationStoreFactory
  • CreateAssetUtilizationStore()
• IStartedUtilization
  • AssetNames
  • TaskName
  • UserName
  • UtilizationCategory
  • Update()
• InteropStartUtilizationResult
  • ErrorCode
  • UtilizationUuid
• NativeMethods
  • GetAssetUtilizationClientDllFullPath()
• StartUtilizationConfiguration
  • AutogenerateHeartbeats
  • HeartbeatIntervalInMilliseconds
  • CreateDefault()
• StartedUtilization
  • AssetNames
  • TaskName
  • UserName
  • UtilizationCategory
  • Dispose()
  • Update()

AssetUtilizationStore type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Class containing methods to store asset utilization data locally.

Dispose() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

StartUtilization(startUtilizationConfiguration,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for all assets with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if utilizationCategory, userName
or taskName are null.

StartUtilization(startUtilizationConfiguration,assetName,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for the given asset with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
assetName	System.String	A string containing the name of the asset that is being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if assetName, utilizationCategory,
userName or taskName are null.

Remarks

The system controller is automatically included in the utilization task.

StartUtilization(startUtilizationConfiguration,assetNames,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for the specified assets with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
assetNames	System.Collections.Generic.IEnumerable{System.String}	A collection containing the name of the assets that are being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if assetNames, utilizationCategory,
userName or taskName are null.

Remarks

The system controller is automatically included in the utilization task.

AssetUtilizationStoreAdapter type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Concrete implementation of the IAssetUtilizationStoreAdapter that calls into the C++ dll of the asset utilization store API.

#ctor() constructor

Summary

Create a new instance of AssetUtilizationStoreAdapter.

Parameters

This constructor has no parameters.

AssetUtilizationStoreEndUtilization(utilizationUuid) method

Summary

End the asset utilization.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

Name	Type	Description
utilizationUuid	System.String	UUID of the asset utilization to end.

AssetUtilizationStoreStartUtilization(assetNames,utilizationCategory,userName,taskName) method

Summary

Start a new asset utilization.

Returns

Object containing the result of the start utilization operation.

Parameters

Name	Type	Description
assetNames	System.String	Names of the assets that are being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

AssetUtilizationStoreUpdateUtilization(utilizationUuid) method

Summary

Update the asset utilization.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

Name	Type	Description
utilizationUuid	System.String	UUID of the asset utilization to update.

CleanStartUtilizationResult(utilizationResult) method

Summary

Clean the start utilization operation result object.

Parameters

Name	Type	Description
utilizationResult	NationalInstruments.SystemLink.Clients.AssetManagement.InteropStartUtilizationResult	Object to clean.

Dispose(disposing) method

Summary

On dispose, clean up any resources used.

Parameters

Name	Type	Description
disposing	System.Boolean	Flag for disposing

Dispose() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Finalize() method

Summary

Generic destructor.

Parameters

This method has no parameters.

InitializeAssetUtilizationStore() method

Summary

Initialize the asset utilization store.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

This method has no parameters.

ShutdownAssetUtilizationStore() method

Summary

Shutdown the asset utilization store.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

This method has no parameters.

AssetUtilizationStoreException type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Provides the exception that is thrown when an error occurs in asset utilization store.

Remarks

Use this class to retrieve information regarding the error that ocurred.

#ctor(errorCode) constructor

Summary

Initializes a new exception with the given error code.

Parameters

Name	Type	Description
errorCode	System.Int32	Error code.

#ctor(message) constructor

Summary

Initializes a new exception with the given message.

Parameters

Name	Type	Description
message	System.String	Exception message.

#ctor(message,innerException) constructor

Summary

Initializes a new exception with the given message and an inner exception.

Parameters

Name	Type	Description
message	System.String	Exception message.
innerException	System.Exception	Inner exception.

#ctor(serializationInfo,streamingContext) constructor

Summary

Initializes a new exception with the given serialization info and streaming context.

Parameters

Name	Type	Description
serializationInfo	System.Runtime.Serialization.SerializationInfo	Serialization information.
streamingContext	System.Runtime.Serialization.StreamingContext	Streaming context.

#ctor() constructor

Summary

Initializes a new exception.

Parameters

This constructor has no parameters.

ErrorCode property

Summary

The AssetUtilization error code corresponding to the exception.

GetObjectData() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

AssetUtilizationStoreFactory type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Class used to create IAssetUtilizationStore instances.

#ctor(assetUtilizationStoreAdapter) constructor

Summary

Create a new asset utilization store factory, given an asset utilization store adapter.

Parameters

Name	Type	Description
assetUtilizationStoreAdapter	NationalInstruments.SystemLink.Clients.AssetManagement.IAssetUtilizationStoreAdapter	Adapter for the asset utilization store implementation.

#ctor() constructor

Summary

Create a new asset utilization store factory.

Parameters

This constructor has no parameters.

CreateAssetUtilizationStore() method

Summary

Create a new instance of IAssetUtilizationStore.

Returns

Newly created instance.

Parameters

This method has no parameters.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the store initialization fails.

Dispose() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Dispose() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

IAssetUtilizationStore type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Interface for storing asset utilization data.

StartUtilization(startUtilizationConfiguration,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for all assets with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if utilizationCategory, userName
or taskName are null.

StartUtilization(startUtilizationConfiguration,assetName,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for the given asset with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
assetName	System.String	A string containing the name of the asset that is being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if assetName, utilizationCategory,
userName or taskName are null.

Remarks

The system controller is automatically included in the utilization task.

StartUtilization(startUtilizationConfiguration,assetNames,utilizationCategory,userName,taskName) method

Summary

Starts a utilization task for the specified assets with the given information about the current running task.

Returns

An object containing the utilization that was started.

Parameters

Name	Type	Description
startUtilizationConfiguration	NationalInstruments.SystemLink.Clients.AssetManagement.StartUtilizationConfiguration	Configuration used to start a new utilization.
assetNames	System.Collections.Generic.IEnumerable{System.String}	A collection containing the name of the assets that are being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the start utilization operations fails.
System.ObjectDisposedException	when this object was already disposed.
System.ArgumentNullException	if assetNames, utilizationCategory,
userName or taskName are null.

Remarks

The system controller is automatically included in the utilization task.

IAssetUtilizationStoreAdapter type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Adapter over the asset utilization store dll implementation.

AssetUtilizationStoreEndUtilization(utilizationUuid) method

Summary

End the asset utilization.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

Name	Type	Description
utilizationUuid	System.String	UUID of the asset utilization to end.

AssetUtilizationStoreStartUtilization(assetNames,utilizationCategory,userName,taskName) method

Summary

Start a new asset utilization.

Returns

Object containing the result of the start utilization operation.

Parameters

Name	Type	Description
assetNames	System.String	Names of the assets that are being utilized.
utilizationCategory	System.String	A string containing the category of the started utilization.
userName	System.String	The user name of the user that started the utilization session.
taskName	System.String	The name of the task that is running for the utilization session.

AssetUtilizationStoreUpdateUtilization(utilizationUuid) method

Summary

Update the asset utilization.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

Name	Type	Description
utilizationUuid	System.String	UUID of the asset utilization to update.

CleanStartUtilizationResult(utilizationResult) method

Summary

Clean the start utilization operation result object.

Parameters

Name	Type	Description
utilizationResult	NationalInstruments.SystemLink.Clients.AssetManagement.InteropStartUtilizationResult	Object to clean.

InitializeAssetUtilizationStore() method

Summary

Initialize the asset utilization store.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

This method has no parameters.

ShutdownAssetUtilizationStore() method

Summary

Shutdown the asset utilization store.

Returns

If the function succeeds, the return value is 0. Otherwise the return value is an error code.

Parameters

This method has no parameters.

IAssetUtilizationStoreFactory type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Interface used to create IAssetUtilizationStore instances.

CreateAssetUtilizationStore() method

Summary

Create a new instance of IAssetUtilizationStore.

Returns

Newly created instance.

Parameters

This method has no parameters.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the store initialization fails.

IStartedUtilization type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Interface for handling ongoing asset utilization.

AssetNames property

Summary

Gets the names of the utilized assets.

TaskName property

Summary

Gets the name of the task for the utilization.

UserName property

Summary

Gets the name of the user that started the utilization.

UtilizationCategory property

Summary

Gets the category of the utilization.

Update() method

Summary

Updates the utilization task with a heartbeat which means that the utilization task is still in progress.

Parameters

This method has no parameters.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the update utilization operation fails.
System.ObjectDisposedException	when this object was already disposed.

InteropStartUtilizationResult type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Class containing the result of the store start utilization operation.

ErrorCode constants

Summary

Error code returned by the Start Utilization operation.

UtilizationUuid constants

Summary

Integer handle for Utilization Unique Identifier.

NativeMethods type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Wrapper over the asset utilization store dll written in C++.

GetAssetUtilizationClientDllFullPath() method

Summary

Obtain the full path of the Asset Management utilization store library based on the process bitness and Skyline install directory.

Returns

Parameters

This method has no parameters.

StartUtilizationConfiguration type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Configuration object used by IAssetUtilizationStore to create and start an utilization.

AutogenerateHeartbeats property

Summary

Flag for specifying whether to autogenerate heart beats

HeartbeatIntervalInMilliseconds property

Summary

Heartbeat interval, in milliseconds.

CreateDefault() method

Summary

Default configuration for a IStartedUtilization that has autogenerated heartbeats every 5 minutes.

Parameters

This method has no parameters.

StartedUtilization type

Namespace

NationalInstruments.SystemLink.Clients.AssetManagement

Summary

Class containing an ongoing asset utilization.

AssetNames property

Summary

Gets the names of the utilized assets.

TaskName property

Summary

Gets the task for the utilization.

UserName property

Summary

Gets the user that started the utilization.

UtilizationCategory property

Summary

Gets the category of the utilization.

Dispose() method

Summary

Ends the utilization task.

Parameters

This method has no parameters.

Update() method

Summary

Updates the utilization task with a heartbeat which means that the utilization task is still in progress.

Parameters

This method has no parameters.

Exceptions

Name	Description
NationalInstruments.SystemLink.Clients.AssetManagement.AssetUtilizationStoreException	when the update utilization operation fails.
System.ObjectDisposedException	when this object was already disposed.