![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class Node represent one feature from the provided node list based on the underlying XML definition. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
String | GetInterface () |
This function delivers the interface type of the Node object. Depending on the interface type the needed access functions are available. The available interface types are defined in header file bgapi2_def.h. See definitions BGAPI2_NODEINTERFACE_xxx. More... | |
String | GetToolTip () |
This function delivers a short description text suitable for a ToolTip representation. More... | |
String | GetDescription () |
This function delivers a description text of the Node object. More... | |
String | GetName () |
This function delivers the name of the Node object. More... | |
String | GetDisplayName () |
This function delivers a name of the node object suitable for displaying. More... | |
String | GetVisibility () |
This function delivers a value representing the visibility of the Node object. More... | |
String | GetImposedAccessMode () |
This function is deprecated. Please use IsReadable or IsWriteable instead. More... | |
String | GetCurrentAccessMode () |
This function delivers a value that represents the current access to the Node object. More... | |
bo_bool | IsReadable () |
This function indicates if a Node object is readable. More... | |
bo_bool | IsWriteable () |
This function indicates if a Node object is writeable. More... | |
String | GetAlias () |
This function delivers the name of a Node object specified as the alias. An alias describes the same feature in a different manner. More... | |
String | GetRepresentation () |
This function delivers a value, which recommends the representation of the Node object on a GUI. Only available for the interface types 'IFloat' and 'IInteger'. More... | |
String | GetUnit () |
This function delivers the physical unit of the Node object. Only available for the interface types 'IFloat' and 'IInteger'. More... | |
bo_bool | HasUnit () |
This function delivers a flag that indicates whether the Node object has a physical unit. Only available for the interface types 'IFloat' and 'IInteger'. More... | |
bo_bool | GetImplemented () |
This function delivers a flag that indicates whether the Node object is implemented. More... | |
bo_bool | GetAvailable () |
This function delivers a flag that indicates whether the Node object is available. More... | |
bo_bool | GetLocked () |
This function is deprecated. Please use isReadable or isWriteable instead. More... | |
bo_int64 | GetEventID () |
This function delivers an ID of a asynchronous event to which the Node object is linked. More... | |
String | GetExtension () |
This function delivers user specific data from the XML definition of this Node object. More... | |
NodeMap * | GetEnumNodeList () |
This function delivers a NodeMap of available enumeration entries. More... | |
String | GetValue () |
This function delivers the value of the Node object in string format. More... | |
void | SetValue (String Value) |
This function writes a value in string format to the Node object. More... | |
bo_int64 | GetInt () |
This function delivers the current value of the Node object as Integer. More... | |
void | SetInt (bo_int64 value) |
This function writes a integer value to the Node object. More... | |
bo_int64 | GetIntMin () |
This function delivers the minimal allowed value of the Node object as Integer. More... | |
bo_int64 | GetIntMax () |
This function delivers the maximal allowed value of the Node object as Integer. More... | |
bo_int64 | GetIntInc () |
This function delivers the allowed step size for the value of the Node object as Integer. More... | |
bo_double | GetDouble () |
This function delivers the current value of the Node object as floating-point number. More... | |
void | SetDouble (bo_double value) |
This function writes a floating-point value to the Node object. More... | |
bo_double | GetDoubleMin () |
This function delivers the minimal allowed value of the Node object as floating-point number. More... | |
bo_double | GetDoubleMax () |
This function delivers the maximal allowed value of the Node object as floating-point number. More... | |
bo_bool | HasInc () |
This function delivers a flag that indicates whether the Node object has an increment. Only available for the interface types 'IFloat' and 'IInteger'. More... | |
bo_double | GetDoubleInc () |
This function delivers the allowed step size for the value of the Node object as Float. More... | |
bo_uint64 | GetDoublePrecision () |
This function delivers the precision for the corresponding double. More... | |
bo_int64 | GetMaxStringLength () |
This function delivers the length of the string. More... | |
String | GetString () |
This function is deprecated. Please use GetValue instead. More... | |
void | SetString (String value) |
This function is deprecated. Please use SetValue instead. More... | |
void | Execute () |
This function executes the command of the Node object. More... | |
bo_bool | IsDone () |
This function delivers a flag that indicates whether the command of the Node object has been executed. More... | |
bo_bool | GetBool () |
This function delivers the current value of the Node object as boolean value. More... | |
void | SetBool (bo_bool value) |
This function writes a boolean value to the Node object. More... | |
NodeMap * | GetNodeTree () |
This function provides the subordinate features of the Node object as tree structure in form of a NodeMap pointer. For a detailed description of the tree structure representation refer to the class description of NodeMap. More... | |
NodeMap * | GetNodeList () |
This function provides the subordinate features of the Node object as unstructured list in form of a NodeMap pointer. For a detailed description of the unstructured list representation refer to the class description of NodeMap. More... | |
bo_bool | IsSelector () |
This function delivers a flag that indicates whether the Node object is a selector. More... | |
NodeMap * | GetSelectedNodeList () |
This function delivers a list of features that depend on this selector Node. More... | |
bo_uint64 | getLength () |
This function delivers the length in bytes of the memory pointed to by the Node object. More... | |
bo_uint64 | getAddress () |
This function delivers the address of the memory pointed to by the Node object. More... | |
void | get (void *pBuffer, bo_uint64 len) |
This function reads the memory pointed to by the Node object and writes it into the provided buffer. More... | |
void | set (void *pBuffer, bo_uint64 len) |
This function writes the memory pointed to by the Node object. More... | |
The class Node represent one feature from the provided node list based on the underlying XML definition.
Definition at line 1016 of file bgapi2_genicam.hpp.
BGAPI2::Node::Execute | ( | ) |
This function executes the command of the Node object.
Only valid for the interface type 'ICommand'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::get | ( | void * | pBuffer, |
bo_uint64 | len | ||
) |
This function reads the memory pointed to by the Node object and writes it into the provided buffer.
Only valid for the interface type 'IRegister'.
pBuffer | The destination buffer into which the read data is copied. |
len | The size of the destination buffer. The function Node::getLength delivers the necessary size. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode, e.g. "WO". |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::getAddress | ( | ) |
This function delivers the address of the memory pointed to by the Node object.
Only valid for the interface type 'IRegister'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetAlias | ( | ) |
This function delivers the name of a Node object specified as the alias. An alias describes the same feature in a different manner.
Exceptions::NotAvailableException | No alias specified. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetAvailable | ( | ) |
This function delivers a flag that indicates whether the Node object is available.
This status is equivalent to the access mode 'NA'. See functions Node::GetImposedAccessMode and Node::GetCurrentAccessMode.
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetBool | ( | ) |
This function delivers the current value of the Node object as boolean value.
Only valid for the interface type 'IBoolean'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode, e.g. "WO". |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetCurrentAccessMode | ( | ) |
This function delivers a value that represents the current access to the Node object.
This value is affected by the change of dependent Node objects. In such a case, the current access mode is different and limited (i.e. less accessible) for general access mode. See also function Node::GetImposedAccessMode(). The available access modes are defined in header file bgapi2_def.h. See definitions BGAPI2_NODEACCESS_xxx.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDescription | ( | ) |
This function delivers a description text of the Node object.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDisplayName | ( | ) |
This function delivers a name of the node object suitable for displaying.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDouble | ( | ) |
This function delivers the current value of the Node object as floating-point number.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration' and 'IBoolean'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode, e.g. "WO". |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDoubleInc | ( | ) |
This function delivers the allowed step size for the value of the Node object as Float.
Valid for the interface types 'IFloat' and 'IInteger'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::InvalidParameterException | The Node object has no (valid) increment value. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDoubleMax | ( | ) |
This function delivers the maximal allowed value of the Node object as floating-point number.
Valid for the interface types 'IFloat' and 'IInteger'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDoubleMin | ( | ) |
This function delivers the minimal allowed value of the Node object as floating-point number.
Valid for the interface types 'IFloat' and 'IInteger'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetDoublePrecision | ( | ) |
This function delivers the precision for the corresponding double.
Only valid for the interface type 'IFloat'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetEnumNodeList | ( | ) |
This function delivers a NodeMap of available enumeration entries.
Only valid for interface type 'IEnumeration'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetEventID | ( | ) |
This function delivers an ID of a asynchronous event to which the Node object is linked.
Exceptions::NotAvailableException | The EventID is not specified in the XML description of this Node object. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetExtension | ( | ) |
This function delivers user specific data from the XML definition of this Node object.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetImplemented | ( | ) |
This function delivers a flag that indicates whether the Node object is implemented.
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetImposedAccessMode | ( | ) |
This function is deprecated. Please use IsReadable or IsWriteable instead.
This function delivers a value that specifies the general access to the Node object. This value is not affected by other Node objects. See also the function Node::GetCurrentAccessMode(). The available access modes are defined in header file bgapi2_def.h. See definitions BGAPI2_NODEACCESS_xxx.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetInt | ( | ) |
This function delivers the current value of the Node object as Integer.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration' and 'IBoolean'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode, e.g. "WO". |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetInterface | ( | ) |
This function delivers the interface type of the Node object. Depending on the interface type the needed access functions are available. The available interface types are defined in header file bgapi2_def.h. See definitions BGAPI2_NODEINTERFACE_xxx.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetIntInc | ( | ) |
This function delivers the allowed step size for the value of the Node object as Integer.
Valid for the interface types 'IInteger' and 'IFloat'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetIntMax | ( | ) |
This function delivers the maximal allowed value of the Node object as Integer.
Valid for the interface types 'IInteger' and 'IFloat'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetIntMin | ( | ) |
This function delivers the minimal allowed value of the Node object as Integer.
Valid for the interface types 'IInteger' and 'IFloat'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::getLength | ( | ) |
This function delivers the length in bytes of the memory pointed to by the Node object.
Only valid for the interface type 'IRegister'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetLocked | ( | ) |
This function is deprecated. Please use isReadable or isWriteable instead.
This function delivers a flag that indicates whether the Node object is locked for writing. This status is equivalent to the access mode 'RO'. See functions Node::GetImposedAccessMode and Node::GetCurrentAccessMode.
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetMaxStringLength | ( | ) |
This function delivers the length of the string.
Only valid for the interface type 'IString'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetName | ( | ) |
This function delivers the name of the Node object.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetNodeList | ( | ) |
This function provides the subordinate features of the Node object as unstructured list in form of a NodeMap pointer. For a detailed description of the unstructured list representation refer to the class description of NodeMap.
Only valid for the interface type 'ICategory'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetNodeTree | ( | ) |
This function provides the subordinate features of the Node object as tree structure in form of a NodeMap pointer. For a detailed description of the tree structure representation refer to the class description of NodeMap.
Only valid for the interface type 'ICategory'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetRepresentation | ( | ) |
This function delivers a value, which recommends the representation of the Node object on a GUI. Only available for the interface types 'IFloat' and 'IInteger'.
The available display options are defined in the header file bgapi2_def.h. See the definitions BGAPI2_NODEREPRESENTATION_xxx.
Exceptions::NotAvailableException | This exception is thrown when the interface type is not 'IFloat' and not 'IInteger'. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetSelectedNodeList | ( | ) |
This function delivers a list of features that depend on this selector Node.
Valid for the interface types 'IInteger' and 'IEnumeration'.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetString | ( | ) |
This function is deprecated. Please use GetValue instead.
This function delivers the current value of the Node object as String. Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration', IString', 'IBoolean' and 'ICommand'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode, e.g. "WO". |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetToolTip | ( | ) |
This function delivers a short description text suitable for a ToolTip representation.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetUnit | ( | ) |
This function delivers the physical unit of the Node object. Only available for the interface types 'IFloat' and 'IInteger'.
Exceptions::NotAvailableException | This exception is thrown when the interface type is not 'IFloat' and not 'IInteger'. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetValue | ( | ) |
This function delivers the value of the Node object in string format.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration', IString', 'IBoolean' and 'ICommand'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::GetVisibility | ( | ) |
This function delivers a value representing the visibility of the Node object.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::HasInc | ( | ) |
This function delivers a flag that indicates whether the Node object has an increment. Only available for the interface types 'IFloat' and 'IInteger'.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::HasUnit | ( | ) |
This function delivers a flag that indicates whether the Node object has a physical unit. Only available for the interface types 'IFloat' and 'IInteger'.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::IsDone | ( | ) |
This function delivers a flag that indicates whether the command of the Node object has been executed.
Only valid for the interface type 'ICommand'.
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::IsReadable | ( | ) |
This function indicates if a Node object is readable.
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::IsSelector | ( | ) |
This function delivers a flag that indicates whether the Node object is a selector.
A selector is a posibility to define feature dependencies. The current value of a selector node has an impact on the value of another Node object. Valid for the interface types 'IInteger' and 'IEnumeration'.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::IsWriteable | ( | ) |
This function indicates if a Node object is writeable.
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::set | ( | void * | pBuffer, |
bo_uint64 | len | ||
) |
This function writes the memory pointed to by the Node object.
Only valid for the interface type 'IRegister'.
pBuffer | The buffer for the data to be written. |
len | The size of the buffer to the data to be written. The function Node::getLength delivers the necessary size. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::SetBool | ( | bo_bool | value | ) |
This function writes a boolean value to the Node object.
Only valid for the interface type 'IBoolean'.
value | The boolean value to be written. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::SetDouble | ( | bo_double | value | ) |
This function writes a floating-point value to the Node object.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration' and 'IBoolean'.
value | The floating-point value to be written. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::SetInt | ( | bo_int64 | value | ) |
This function writes a integer value to the Node object.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration' and 'IBoolean'.
value | The integer value to be written. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::SetString | ( | String | value | ) |
This function is deprecated. Please use SetValue instead.
This function writes a string value to the Node object. Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration', IString', 'IBoolean' and 'ICommand'.
value | The string value to be written. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. Possible reasons for this exception are the loss of connection to the device and the wrong access mode. |
Exceptions::NotImplementedException | This feature is not implemented. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Node::SetValue | ( | String | Value | ) |
This function writes a value in string format to the Node object.
Valid for the interface types 'IFloat', 'IInteger', 'IEnumeration', IString', 'IBoolean' and 'ICommand'.
Value | The value to be written in string format. |
Exceptions::NotAvailableException | The Node object has the wrong interface type. |
Exceptions::AccessDeniedException | Error when accessing this function. A possible reason for this exception is the loss of connection to the device. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Jan, 14 2020
Baumer Optronic GmbH,
Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86,
Email:support.cameras@baumer.com