GenApi_ParameterDescriptor

Description

This structure stores the description, meta data and current state of a GenApi parameter or command node.

struct GenApi_ParameterDescriptor
{
	atl::String DisplayName;
	atl::String Description;
	GenApi_InterfaceType::Type InterfaceType;
	bool IsImplemented;
	bool IsAvailable;
	bool IsReadable;
	bool IsWriteable;
};
  • DisplayName - parameter friendly name (human readable).
  • Description - parameter textual description provided by device manufacturer.
  • InterfaceType - primary data type interface of parameter, that can be used to access it, one of:
    • Integer
    • Float
    • String
    • Enumeration
    • Command
    • Boolean
    • Category
  • IsImplemented - flag indicating if this parameter is implemented in currently opened device/module.
  • IsAvailable - flag indicating if this parameter is implemented and available in current device state.
  • IsReadable - flag indicating if this parameter is available and readable in current device state.
  • IsWriteable - flag indicating if this parameter is available and writeable in current device state.

See also