BitFlow.NET
Source code documentation of the BitFlow .NET interface.
BFGTLUtilities.RegisterNode Class Reference
Inheritance diagram for BFGTLUtilities.RegisterNode:
BFGTLUtilities.ValueNode BFGTLUtilities.BaseNode

Public Member Functions

byte[] GetData ()
 Read the raw data currently stored at the register address. More...
 
void SetData (byte[] data)
 Set data upon the device registry, starting from Address. More...
 
- Public Member Functions inherited from BFGTLUtilities.BaseNode
bool GetIsValid ()
 This instance represents a valid node. More...
 
override bool Equals (Object other)
 Determine if two another Object is equivalent to this node. More...
 
override int GetHashCode ()
 Generate a hash code for this node. This is derived from the node name, which will be unique for every node of a given device. More...
 

Properties

Int64 Address [get]
 The byte address of the register data. More...
 
Int64 Length [get]
 The byte length of the register data. More...
 
- Properties inherited from BFGTLUtilities.ValueNode
String StringValue [get, set]
 A string representation of the ValueNode value. More...
 
- Properties inherited from BFGTLUtilities.BaseNode
bool IsValid [get]
 This instance represents a valid node. More...
 
String Name [get]
 Retrieve the node name. More...
 
String DisplayName [get]
 Retrieve the node display name. More...
 
String ToolTip [get]
 Retrieve the node tool-tip. More...
 
String Description [get]
 Retrieve the node description. More...
 
NodeType Type [get]
 Retrieve the node type. More...
 
Access Access [get]
 Retrieve the node accessibility. More...
 
bool IsReadable [get]
 Convenience method to evaluate node readability. More...
 
bool IsWritable [get]
 Convenience method to evaluate node writability. More...
 
bool IgnoreCache [get, set]
 When this flag is raised, cached node data is ignored, and the data is read anew. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BFGTLUtilities.BaseNode
static implicit operator bool (BaseNode node)
 
static bool operator! (BaseNode node)
 This instance does not represent a valid node. More...
 
- Protected Attributes inherited from BFGTLUtilities.BaseNode
Device m_device
 
ManagedBFGTLUtilitiesBaseNode m_node
 

Member Function Documentation

◆ GetData()

byte [] BFGTLUtilities.RegisterNode.GetData ( )

Read the raw data currently stored at the register address.

Returns
All data currently stored in the register.

◆ SetData()

void BFGTLUtilities.RegisterNode.SetData ( byte[]  data)

Set data upon the device registry, starting from Address.

Parameters
dataThe raw data to set upon the registry, no longer than Length.

Property Documentation

◆ Address

Int64 BFGTLUtilities.RegisterNode.Address
get

The byte address of the register data.

◆ Length

Int64 BFGTLUtilities.RegisterNode.Length
get

The byte length of the register data.


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