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

Interface common to all nodes. More...

Inheritance diagram for Itala.GenApi.INode:
Itala.GenApi.IBase

Public Member Functions

void Invalidate ()
 Indicates that the node's value may have changed. Fires the handler on this and all dependent nodes. More...
 
List< INodeGetChildrens (LinkType linkType)
 Get all nodes this node directly depends on. More...
 
List< INodeGetParents ()
 Gets all nodes this node is directly depending on More...
 
List< string > PropertyNames ()
 List of the names all properties set during initialization. More...
 
string GetPropertyValue (string propertyName)
 Retrieves a property value. If a property has multiple values they come with Tabs as delimiters. More...
 
string GetPropertyAttributes (string propertyName)
 Retrieves a property attribute. If a property has multiple attributes they come with Tabs as delimiters. More...
 
void ImposeAccessMode (AccessMode accessMode)
 Imposes an access mode to the natural access mode of the node. More...
 
void ImposeVisibility (Visibility visibility)
 Imposes a visibility to the natural visibility of the node. More...
 
INode GetAlias ()
 Retrieves the a node which describes the same feature in a different way More...
 
INode GetCastAlias ()
 Retrieves the a node which describes the same feature so that it can be casted More...
 
TryGetAs< T > ()
 Retrive the value interface of type T of the current node. More...
 

Properties

string Name [get]
 Node name. More...
 
NameSpace NameSpace [get]
 Name space of the node. More...
 
Visibility Visibility [get]
 Recommended visibility of the node. More...
 
bool IsCachable [get]
 Is the node value cachable. More...
 
bool IsAccessModeCacheable [get]
 True if the AccessMode can be cached. More...
 
CachingMode CachingMode [get]
 Caching Mode of the node. More...
 
Int64 PollingTime [get]
 Recommended polling time (for not cachable nodes). More...
 
string ToolTip [get]
 Short description of the node. More...
 
string Description [get]
 Long description of the node. More...
 
string DisplayName [get]
 Name string for display. More...
 
string DeviceName [get]
 Name of the device. More...
 
GenApi.NodeChangedEventHandler NodeChanged
 Subscribes and Unsubscribe a NodeChangedEventHandler instance to the current node. The implementation must be provided by the client code. More...
 
INodeMap NodeMap [get]
 Retrieves the central node map. More...
 
string EventId [get]
 EventId of the node More...
 
bool IsStreamable [get]
 True if the node is streamable. More...
 
string DocuURL [get]
 URL pointing to the documentation of that feature. More...
 
bool IsDeprecated [get]
 True if the node should not be used any more. More...
 
InterfaceType InterfaceType [get]
 Type of the main interface of a node. More...
 
bool IsFeature [get]
 True if the node can be reached via category nodes from a category node named "Root". More...
 
- Properties inherited from Itala.GenApi.IBase
AccessMode AccessMode [get]
 Get the access mode of the node. More...
 
bool IsReadable [get]
 Checks if a node is readable, More...
 
bool IsWritable [get]
 Checks if a node is writable. More...
 
bool IsImplemented [get]
 Checks if a node is implemented. More...
 
bool IsAvailable [get]
 Checks if a node is available. More...
 

Detailed Description

Interface common to all nodes.

Member Function Documentation

◆ Invalidate()

void Itala.GenApi.INode.Invalidate ( )

Indicates that the node's value may have changed. Fires the handler on this and all dependent nodes.

◆ GetChildrens()

List<INode> Itala.GenApi.INode.GetChildrens ( LinkType  linkType)

Get all nodes this node directly depends on.

Parameters
linkTypeThe link type
Returns
List of reference to node children of the current node.

◆ GetParents()

List<INode> Itala.GenApi.INode.GetParents ( )

Gets all nodes this node is directly depending on

Returns
List of reference to node parents of the current node.

◆ PropertyNames()

List<string> Itala.GenApi.INode.PropertyNames ( )

List of the names all properties set during initialization.

Returns
Returns a list of the names all properties

◆ GetPropertyValue()

string Itala.GenApi.INode.GetPropertyValue ( string  propertyName)

Retrieves a property value. If a property has multiple values they come with Tabs as delimiters.

Parameters
propertyNameName of the property to retrive value
Returns
Retrieves a property value.

◆ GetPropertyAttributes()

string Itala.GenApi.INode.GetPropertyAttributes ( string  propertyName)

Retrieves a property attribute. If a property has multiple attributes they come with Tabs as delimiters.

Parameters
propertyNameName of the property to retrive attribute
Returns
Retrieves a property attributes.

◆ ImposeAccessMode()

void Itala.GenApi.INode.ImposeAccessMode ( AccessMode  accessMode)

Imposes an access mode to the natural access mode of the node.

Parameters
accessModeAccess Mode to impose.

◆ ImposeVisibility()

void Itala.GenApi.INode.ImposeVisibility ( Visibility  visibility)

Imposes a visibility to the natural visibility of the node.

Parameters
visibilityVisibility to impose.

◆ GetAlias()

INode Itala.GenApi.INode.GetAlias ( )

Retrieves the a node which describes the same feature in a different way

Returns
Reference to node.

◆ GetCastAlias()

INode Itala.GenApi.INode.GetCastAlias ( )

Retrieves the a node which describes the same feature so that it can be casted

Returns
Reference to node.

◆ TryGetAs< T >()

T Itala.GenApi.INode.TryGetAs< T > ( )

Retrive the value interface of type T of the current node.

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

Property Documentation

◆ Name

string Itala.GenApi.INode.Name
get

Node name.

◆ NameSpace

NameSpace Itala.GenApi.INode.NameSpace
get

Name space of the node.

◆ Visibility

Visibility Itala.GenApi.INode.Visibility
get

Recommended visibility of the node.

◆ IsCachable

bool Itala.GenApi.INode.IsCachable
get

Is the node value cachable.

◆ IsAccessModeCacheable

bool Itala.GenApi.INode.IsAccessModeCacheable
get

True if the AccessMode can be cached.

◆ CachingMode

CachingMode Itala.GenApi.INode.CachingMode
get

Caching Mode of the node.

◆ PollingTime

Int64 Itala.GenApi.INode.PollingTime
get

Recommended polling time (for not cachable nodes).

◆ ToolTip

string Itala.GenApi.INode.ToolTip
get

Short description of the node.

◆ Description

string Itala.GenApi.INode.Description
get

Long description of the node.

◆ DisplayName

string Itala.GenApi.INode.DisplayName
get

Name string for display.

◆ DeviceName

string Itala.GenApi.INode.DeviceName
get

Name of the device.

◆ NodeChanged

GenApi.NodeChangedEventHandler Itala.GenApi.INode.NodeChanged
addremove

Subscribes and Unsubscribe a NodeChangedEventHandler instance to the current node. The implementation must be provided by the client code.

◆ NodeMap

INodeMap Itala.GenApi.INode.NodeMap
get

Retrieves the central node map.

◆ EventId

string Itala.GenApi.INode.EventId
get

EventId of the node

◆ IsStreamable

bool Itala.GenApi.INode.IsStreamable
get

True if the node is streamable.

◆ DocuURL

string Itala.GenApi.INode.DocuURL
get

URL pointing to the documentation of that feature.

◆ IsDeprecated

bool Itala.GenApi.INode.IsDeprecated
get

True if the node should not be used any more.

◆ InterfaceType

InterfaceType Itala.GenApi.INode.InterfaceType
get

Type of the main interface of a node.

◆ IsFeature

bool Itala.GenApi.INode.IsFeature
get

True if the node can be reached via category nodes from a category node named "Root".


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