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

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

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

Public Member Functions

List< double > GetValidValuesSet ()
 Get valid value of the float Node. More...
 
void ImposeMin (double min)
 Restrict minimum value of float Node. More...
 
void ImposeMax (double max)
 Restrict maximum value of float 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

double Value [get, set]
 Value of the float Node. More...
 
double Min [get]
 Minimum value of the float Node. More...
 
double Max [get]
 Maximum value of the float Node. More...
 
bool HasIncrement [get]
 Get if the float Node has a software-imposed increment. More...
 
IncMode IncMode [get]
 Increment mode of the float Node, if any. More...
 
double Increment [get]
 Increment of the float Node, if any. More...
 
Representation Representation [get]
 Recommended representation of a flaot Node. More...
 
string Unit [get]
 Physical unit name of a float Node. More...
 
DisplayNotation DisplayNotation [get]
 The way the float should be converted to a string. More...
 
Int64 DisplayPrecision [get]
 The precision to be used when converting the float to a string. 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 float nodes managed by GenApi.

Member Function Documentation

◆ GetValidValuesSet()

List<double> Itala.GenApi.IFloat.GetValidValuesSet ( )

Get valid value of the float Node.

Returns
List of valid value for the current node.

◆ ImposeMin()

void Itala.GenApi.IFloat.ImposeMin ( double  min)

Restrict minimum value of float Node.

Parameters
minValue to imopse as minimum.

◆ ImposeMax()

void Itala.GenApi.IFloat.ImposeMax ( double  max)

Restrict maximum value of float Node.

Parameters
maxValue to imopse as maximum.

Property Documentation

◆ Value

double Itala.GenApi.IFloat.Value
getset

Value of the float Node.

◆ Min

double Itala.GenApi.IFloat.Min
get

Minimum value of the float Node.

◆ Max

double Itala.GenApi.IFloat.Max
get

Maximum value of the float Node.

◆ HasIncrement

bool Itala.GenApi.IFloat.HasIncrement
get

Get if the float Node has a software-imposed increment.

◆ IncMode

IncMode Itala.GenApi.IFloat.IncMode
get

Increment mode of the float Node, if any.

◆ Increment

double Itala.GenApi.IFloat.Increment
get

Increment of the float Node, if any.

◆ Representation

Representation Itala.GenApi.IFloat.Representation
get

Recommended representation of a flaot Node.

◆ Unit

string Itala.GenApi.IFloat.Unit
get

Physical unit name of a float Node.

◆ DisplayNotation

DisplayNotation Itala.GenApi.IFloat.DisplayNotation
get

The way the float should be converted to a string.

◆ DisplayPrecision

Int64 Itala.GenApi.IFloat.DisplayPrecision
get

The precision to be used when converting the float to a string.


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