BFGTLUtilities.EnumerationNode Class Reference

Inheritance diagram for BFGTLUtilities.EnumerationNode:

Public Member Functions
EnumEntryNode	GetEntry ()
	Return an instance of the current enumeration entry node. More...
EnumEntryNode[]	GetEntries ()
	Return a list of node instances for all of this enumeration's entries, in the original order. 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	EntryValue [get, set]
	The integer value of the currently selected enumeration entry. More...
String	EntryName [get, set]
	The name of the currently selected enumeration entry. More...
String	EntrySymbolic [get, set]
	The symbolic name of the currently selected enumeration entry. More...
Int64	EntryCount [get]
	The number of child node entries in this enumeration. More...
Int64[]	EntryValues [get]
	A list of the enumeration entry values, in the original order. More...
String[]	EntryNames [get]
	A list of the enumeration entry names, in the original order. More...
String[]	EntrySymbolics [get]
	A list of the enumeration entry symbolic names, in the original order. 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

GetEntries()

EnumEntryNode [] BFGTLUtilities.EnumerationNode.GetEntries

(

)

Return a list of node instances for all of this enumeration's entries, in the original order.

Returns

A list of instances of all of this enumeration's entries.

GetEntry()

EnumEntryNode BFGTLUtilities.EnumerationNode.GetEntry

(

)

Return an instance of the current enumeration entry node.

Returns

An instance of the current enumeration entry node.

Property Documentation

EntryCount

Int64 BFGTLUtilities.EnumerationNode.EntryCount

get

The number of child node entries in this enumeration.

EntryName

String BFGTLUtilities.EnumerationNode.EntryName

getset

The name of the currently selected enumeration entry.

EntryNames

String [] BFGTLUtilities.EnumerationNode.EntryNames

get

A list of the enumeration entry names, in the original order.

EntrySymbolic

String BFGTLUtilities.EnumerationNode.EntrySymbolic

getset

The symbolic name of the currently selected enumeration entry.

EntrySymbolics

String [] BFGTLUtilities.EnumerationNode.EntrySymbolics

get

A list of the enumeration entry symbolic names, in the original order.

EntryValue

Int64 BFGTLUtilities.EnumerationNode.EntryValue

getset

The integer value of the currently selected enumeration entry.

EntryValues

Int64 [] BFGTLUtilities.EnumerationNode.EntryValues

get

A list of the enumeration entry values, in the original order.

---

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

• Generic/Libraries/BFGTLUtilities/BFGTLUtilities.cs