Inheritance diagram for BFGTLUtilities.BaseNode:

Public Member Functions
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...

Static Public Member Functions
static implicit	operator bool (BaseNode node)

static bool	operator! (BaseNode node)
	This instance does not represent a valid node. More...

Protected Attributes
Device	m_device

ManagedBFGTLUtilitiesBaseNode	m_node

Properties
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...

Member Function Documentation

◆ Equals()

override bool BFGTLUtilities.BaseNode.Equals ( Object other )

Determine if two another Object is equivalent to this node.

Parameters

other An Object that we're comparing to.

Returns: True if the node handles reference the same underlying node, false, otherwise.

◆ GetHashCode()

override int BFGTLUtilities.BaseNode.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.

Returns: A hash code for this node.

◆ GetIsValid()

bool BFGTLUtilities.BaseNode.GetIsValid ( )

This instance represents a valid node.

◆ operator bool()

static implicit BFGTLUtilities.BaseNode.operator bool ( BaseNode node )

static

◆ operator!()

static bool BFGTLUtilities.BaseNode.operator! ( BaseNode node )

static

This instance does not represent a valid node.

Member Data Documentation

◆ m_device

Device BFGTLUtilities.BaseNode.m_device

protected

◆ m_node

ManagedBFGTLUtilitiesBaseNode BFGTLUtilities.BaseNode.m_node

protected

Property Documentation

◆ Access

Access BFGTLUtilities.BaseNode.Access

get

Retrieve the node accessibility.

◆ Description

String BFGTLUtilities.BaseNode.Description

get

Retrieve the node description.

◆ DisplayName

String BFGTLUtilities.BaseNode.DisplayName

get

Retrieve the node display name.

◆ IgnoreCache

bool BFGTLUtilities.BaseNode.IgnoreCache

getset

When this flag is raised, cached node data is ignored, and the data is read anew.

◆ IsReadable

bool BFGTLUtilities.BaseNode.IsReadable

get

Convenience method to evaluate node readability.

◆ IsValid

bool BFGTLUtilities.BaseNode.IsValid

get

This instance represents a valid node.

◆ IsWritable

bool BFGTLUtilities.BaseNode.IsWritable

get

Convenience method to evaluate node writability.

◆ Name

String BFGTLUtilities.BaseNode.Name

get

Retrieve the node name.

◆ ToolTip

String BFGTLUtilities.BaseNode.ToolTip

get

Retrieve the node tool-tip.

◆ Type

NodeType BFGTLUtilities.BaseNode.Type

get

Retrieve the node type.

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

Generic/Libraries/BFGTLUtilities/BFGTLUtilities.cs

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties