BFGTLUtilities Namespace Reference

Class library for Gen<i>Cam camera device access via BFGTL. More...

Namespaces
	PRIVATE_IMP

Classes
class	BaseNode
	Base class for BFGTLUtilities::Device node access and modification. More...
class	BooleanNode
	BFGTLUtilities::Device node class to access or modify boolean value nodes. More...
class	CategoryNode
	BFGTLUtilities::Device node class to read category nodes and their features. More...
class	CommandNode
	BFGTLUtilities::Device node class to execute command nodes. More...
class	Device
	Interface to access and modify features on a Gen<i>Cam device. More...
class	EnumEntryNode
	BFGTLUtilities::Device node class to examine enumeration-entry value nodes. More...
class	EnumerationNode
	BFGTLUtilities::Device node class to access or modify enumeration value nodes, and read their features. More...
class	FloatNode
	BFGTLUtilities::Device node class to access or modify floating-point value nodes. More...
class	IntegerNode
	BFGTLUtilities::Device node class to access or modify integer value nodes. More...
class	PortNode
	BFGTLUtilities::Device node class to examine port nodes. More...
class	RegisterNode
	BFGTLUtilities::Device node class to access or modify register value nodes. More...
class	StringNode
	BFGTLUtilities::Device node class to access or modify string value nodes. More...
class	ValueNode
	BFGTLUtilities::Device node class to access or modify nodes with any kind of value. More...

Typedefs
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::ValueNodeBase, NodeType::Value >	ValueNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::IntegerNodeBase, NodeType::Integer >	IntegerNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::BooleanNodeBase, NodeType::Boolean >	BooleanNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::CommandNodeBase, NodeType::Command >	CommandNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::FloatNodeBase, NodeType::Float >	FloatNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::StringNodeBase, NodeType::String >	StringNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::RegisterNodeBase, NodeType::Register >	RegisterNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::CategoryNodeBase, NodeType::Category >	CategoryNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::EnumerationNodeBase, NodeType::Enumeration >	EnumerationNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::EnumEntryNodeBase, NodeType::EnumEntry >	EnumEntryNode
typedef PRIVATE_IMP::NodeImpT< PRIVATE_IMP::PortNodeBase, NodeType::Port >	PortNode

Enumerations
enum	NodeType {   NodeType::Unknown = BFGTL_TYPE_UNKNOWN, NodeType::Value = BFGTL_NODE_TYPE_VALUE, NodeType::Base = BFGTL_NODE_TYPE_BASE, NodeType::Integer = BFGTL_NODE_TYPE_INTEGER,   NodeType::Boolean = BFGTL_NODE_TYPE_BOOLEAN, NodeType::Command = BFGTL_NODE_TYPE_COMMAND, NodeType::Float = BFGTL_NODE_TYPE_FLOAT, NodeType::String = BFGTL_NODE_TYPE_STRING,   NodeType::Register = BFGTL_NODE_TYPE_REGISTER, NodeType::Category = BFGTL_NODE_TYPE_CATEGORY, NodeType::Enumeration = BFGTL_NODE_TYPE_ENUMERATION, NodeType::EnumEntry = BFGTL_NODE_TYPE_ENUM_ENTRY,   NodeType::Port = BFGTL_NODE_TYPE_PORT }
enum	Access {   Access::Unknown = BFGTL_ACCESS_UNKNOWN, Access::NI = BFGTL_ACCESS_NI, Access::NA = BFGTL_ACCESS_NA, Access::RO = BFGTL_ACCESS_RO,   Access::WO = BFGTL_ACCESS_WO, Access::RW = BFGTL_ACCESS_RW }

Functions
BFBOOL BFCAPI	LibIsGood (void)

Detailed Description

Class library for Gen<i>Cam camera device access via BFGTL.

Typedef Documentation

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::BooleanNodeBase,NodeType::Boolean> BFGTLUtilities::BooleanNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::CategoryNodeBase,NodeType::Category> BFGTLUtilities::CategoryNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::CommandNodeBase,NodeType::Command> BFGTLUtilities::CommandNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::EnumEntryNodeBase,NodeType::EnumEntry> BFGTLUtilities::EnumEntryNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::EnumerationNodeBase,NodeType::Enumeration> BFGTLUtilities::EnumerationNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::FloatNodeBase,NodeType::Float> BFGTLUtilities::FloatNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::IntegerNodeBase,NodeType::Integer> BFGTLUtilities::IntegerNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::PortNodeBase,NodeType::Port> BFGTLUtilities::PortNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::RegisterNodeBase,NodeType::Register> BFGTLUtilities::RegisterNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::StringNodeBase,NodeType::String> BFGTLUtilities::StringNode

typedef PRIVATE_IMP::NodeImpT<PRIVATE_IMP::ValueNodeBase,NodeType::Value> BFGTLUtilities::ValueNode

Enumeration Type Documentation

enum BFGTLUtilities::Access

strong

Enumerator
Unknown
NI
NA
RO
WO
RW

    {
        Unknown = BFGTL_ACCESS_UNKNOWN,

        NI = BFGTL_ACCESS_NI,    // Not Implemented
        NA = BFGTL_ACCESS_NA,    // Not Accessible
        RO = BFGTL_ACCESS_RO,    // Read Only
        WO = BFGTL_ACCESS_WO,    // Write Only
        RW = BFGTL_ACCESS_RW,    // Read/Write
    };

enum BFGTLUtilities::NodeType

strong

Enumerator
Unknown
Value
Base
Integer
Boolean
Command
Float
String
Register
Category
Enumeration
EnumEntry
Port

    {
        Unknown = BFGTL_TYPE_UNKNOWN,
        
        Value = BFGTL_NODE_TYPE_VALUE,
        Base = BFGTL_NODE_TYPE_BASE,
        Integer = BFGTL_NODE_TYPE_INTEGER,
        Boolean = BFGTL_NODE_TYPE_BOOLEAN,
        Command = BFGTL_NODE_TYPE_COMMAND,
        Float = BFGTL_NODE_TYPE_FLOAT,
        String = BFGTL_NODE_TYPE_STRING,
        Register = BFGTL_NODE_TYPE_REGISTER,
        Category = BFGTL_NODE_TYPE_CATEGORY,
        Enumeration = BFGTL_NODE_TYPE_ENUMERATION,
        EnumEntry = BFGTL_NODE_TYPE_ENUM_ENTRY,
        Port = BFGTL_NODE_TYPE_PORT,
    };

Function Documentation

BFBOOL BFCAPI BFGTLUtilities::LibIsGood

(

void

)

Determine if the base library can be opened. This is necessary for BFGTLUtilities to be usable.

{
    const UINT prevErrorMode = SetErrorMode(SEM_FAILCRITICALERRORS);
    SetErrorMode(prevErrorMode | SEM_FAILCRITICALERRORS);

    const bool libIsGood = BFGTLUtilIsGood();

    SetErrorMode(prevErrorMode);

    return libIsGood;
}