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

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

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

Public Member Functions

List< Int64 > GetValidValuesSet ()
 Get valid value of the integer Node. More...
 
void ImposeMin (Int64 min)
 Restrict minimum value of integer Node. More...
 
void ImposeMax (Int64 max)
 Restrict maximum value of integer 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 Value [get, set]
 Value of the integer Node. More...
 
Int64 Min [get]
 Minimum value of the integer Node. More...
 
Int64 Max [get]
 Maximum value of the integer Node. More...
 
IncMode IncMode [get]
 Increment mode of the integer Node, if any. More...
 
Int64 Increment [get]
 Increment of the integer Node, if any. More...
 
Representation Representation [get]
 Recommended representation of a integer Node. More...
 
string Unit [get]
 Physical unit name of a integer 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 integer nodes managed by GenApi.

Member Function Documentation

◆ GetValidValuesSet()

List<Int64> Itala.GenApi.IInteger.GetValidValuesSet ( )

Get valid value of the integer Node.

Returns
List of valid value for the current node.

◆ ImposeMin()

void Itala.GenApi.IInteger.ImposeMin ( Int64  min)

Restrict minimum value of integer Node.

Parameters
minValue to impose as minimum

◆ ImposeMax()

void Itala.GenApi.IInteger.ImposeMax ( Int64  max)

Restrict maximum value of integer Node.

Parameters
maxValue to impose as maximum

Property Documentation

◆ Value

Int64 Itala.GenApi.IInteger.Value
getset

Value of the integer Node.

◆ Min

Int64 Itala.GenApi.IInteger.Min
get

Minimum value of the integer Node.

◆ Max

Int64 Itala.GenApi.IInteger.Max
get

Maximum value of the integer Node.

◆ IncMode

IncMode Itala.GenApi.IInteger.IncMode
get

Increment mode of the integer Node, if any.

◆ Increment

Int64 Itala.GenApi.IInteger.Increment
get

Increment of the integer Node, if any.

◆ Representation

Representation Itala.GenApi.IInteger.Representation
get

Recommended representation of a integer Node.

◆ Unit

string Itala.GenApi.IInteger.Unit
get

Physical unit name of a integer Node.


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