ItalaApiNET  1.3.3
Public Member Functions | Properties | List of all members
Itala.GenApi.INodeMap Interface Reference

Interface to access the node map. More...

Inherited by Itala.GenApi.NodeMap.

Public Member Functions

INode GetNode (string name)
 Retrieves the node from the central map by Name. More...
 
GetNode< T > (string name)
 Retrieves the node from the central map by Name. More...
 
List< INodeGetNodes ()
 Retrieves all nodes in the node map. More...
 
void InvalidateNodes ()
 Invalidates all nodes. More...
 
void Poll (Int64 elapsedTime)
 Fires nodes which have a polling time. More...
 
void SaveToFile (string fileName)
 Save the current state of the Nodemap to a local file. The extension of the file must be specified in the input string. The path of where to save the file must be included in the filename. More...
 
void LoadFromFile (string fileName)
 Load the state of the Nodemap from a local file. The extension of the file must be specified in the input string. The path of where it has been saved must be included in the filename. More...
 

Properties

string DeviceName [get]
 Get device name. The device name identifies a device instance, e.g. for debugging purposes. The default ist "Device". More...
 
Int64 NumNodes [get]
 Number of nodes in the map. More...
 

Detailed Description

Interface to access the node map.

Member Function Documentation

◆ GetNode()

INode Itala.GenApi.INodeMap.GetNode ( string  name)

Retrieves the node from the central map by Name.

Parameters
nameName of the node to retrive.
Returns
Reference to INode interface retrived.

◆ GetNode< T >()

T Itala.GenApi.INodeMap.GetNode< T > ( string  name)

Retrieves the node from the central map by Name.

Template Parameters
TIntreface to retrive of the node, must be child of IValue.
Parameters
nameName of the node to retrive.
Returns
Reference to T interface retrived.
Type Constraints
T :IValue 

◆ GetNodes()

List<INode> Itala.GenApi.INodeMap.GetNodes ( )

Retrieves all nodes in the node map.

Returns
List of the node in the nodemap.

◆ InvalidateNodes()

void Itala.GenApi.INodeMap.InvalidateNodes ( )

Invalidates all nodes.

◆ Poll()

void Itala.GenApi.INodeMap.Poll ( Int64  elapsedTime)

Fires nodes which have a polling time.

Parameters
elapsedTimePolling time.

◆ SaveToFile()

void Itala.GenApi.INodeMap.SaveToFile ( string  fileName)

Save the current state of the Nodemap to a local file. The extension of the file must be specified in the input string. The path of where to save the file must be included in the filename.

Parameters
fileNameString containing the location, filename and extension of the file.

◆ LoadFromFile()

void Itala.GenApi.INodeMap.LoadFromFile ( string  fileName)

Load the state of the Nodemap from a local file. The extension of the file must be specified in the input string. The path of where it has been saved must be included in the filename.

Parameters
fileNameString containing the location, filename and extension of the file.

Property Documentation

◆ DeviceName

string Itala.GenApi.INodeMap.DeviceName
get

Get device name. The device name identifies a device instance, e.g. for debugging purposes. The default ist "Device".

◆ NumNodes

Int64 Itala.GenApi.INodeMap.NumNodes
get

Number of nodes in the map.


The documentation for this interface was generated from the following file: