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

Interface for enumeration nodes managed by GenApi. More...

Inheritance diagram for Itala.GenApi.IEnumeration:
Itala.GenApi.IValue Itala.GenApi.IBase

Public Member Functions

List< string > GetSymbolics ()
 Get the symbolic in the enumeratinon Node. More...
 
List< IEnumEntryGetEnumEntries ()
 Get the enem entry in the enumeratinon Node. More...
 
IEnumEntry GetEntryByName (string name)
 Get the entry by name of the enumeration Node. More...
 
IEnumEntry GetEntryByIntValue (Int64 value)
 Get the enem entry in the enumeratinon Node. More...
 
- Public Member Functions inherited from Itala.GenApi.IValue
INode GetNode ()
 INode interface of the node. More...
 
void FromString (string value)
 Set content of the node as string. More...
 
string ToString ()
 Get content of the node as string. More...
 

Properties

Int64 IntValue [get, set]
 Value of the Node by integer. More...
 
IEnumEntry CurrentEntry [get]
 Current enem entry in the enumeratinon Node. More...
 
- Properties inherited from Itala.GenApi.IValue
bool IsValueCacheValid [get]
 Checks if the value comes from cache or is requested from another node. 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 for enumeration nodes managed by GenApi.

Member Function Documentation

◆ GetSymbolics()

List<string> Itala.GenApi.IEnumeration.GetSymbolics ( )

Get the symbolic in the enumeratinon Node.

Returns
List of string containing the symbolics value of the node

◆ GetEnumEntries()

List<IEnumEntry> Itala.GenApi.IEnumeration.GetEnumEntries ( )

Get the enem entry in the enumeratinon Node.

Returns
List of IEnumEntry retrived.

◆ GetEntryByName()

IEnumEntry Itala.GenApi.IEnumeration.GetEntryByName ( string  name)

Get the entry by name of the enumeration Node.

Parameters
nameName of the entry to retrive.
Returns
Rerefence to IEnumEntry retrived by name.

◆ GetEntryByIntValue()

IEnumEntry Itala.GenApi.IEnumeration.GetEntryByIntValue ( Int64  value)

Get the enem entry in the enumeratinon Node.

Parameters
value>Int value of the entry to retrive.
Returns
Rerefence to IEnumEntry retrived by value.

Property Documentation

◆ IntValue

Int64 Itala.GenApi.IEnumeration.IntValue
getset

Value of the Node by integer.

◆ CurrentEntry

IEnumEntry Itala.GenApi.IEnumeration.CurrentEntry
get

Current enem entry in the enumeratinon Node.


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