This website is being translated through machine translation by a third-party service. Basler does not warrant the accuracy, reliability or timeliness of any information translated by this system and will not accept liability for loss or damage incurred as a result. Content that has not yet been translated appears in English. Switch to English version
GetValueOrDefault(const String_t & defaultValue) Gets the value of the parameter if the parameter is readable.
virtual bool
TrySetValue(const String_t & value) Sets the value of the parameter if the parameter is writable and the value is contained in the set of settable enumeration values.
virtual void
SetValue(const char ** nullTerminatedList) Sets the value of the parameter to the first valid value in a list of values.
virtual bool
TrySetValue(const char ** nullTerminatedList) If the parameter is writable, sets the value of the parameter to the first valid value in a list of values.
virtual bool
CanSetValue(const String_t & value) Indicates whether the given value can be set.
virtual void
SetValue(const String_t & value) Sets the value of the parameter.
CParameter(GenApi::INodeMap * pNodeMap, const char * pName) Creates a CParameter object and attaches it to a node retrieved from the provided node map.
CParameter(GenApi::INodeMap & nodeMap, const char * pName) Creates a CParameter object and attaches it to a node retrieved from the provided node map.
Creates a CEnumParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode().
Parameters:
pNode The node to attach.
Postcondition:
If the passed node does not match the parameter type, the parameter will be empty, see IsValid().
If the passed node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.
Creates a CEnumParameter object and attaches it to a node of a matching type.
Parameters:
pEnumeration The node to attach.
Postcondition: The parameter object must not be used to access the node's functionality if the source of the attached pEnumeration has been destroyed. In this case, call Release() or attach a new node.
Creates a CEnumParameter object and attaches it to a node retrieved from the provided node map.
Parameters:
pNodeMap The node map. The source of the parameter.
pName The name of the parameter to attach.
Postcondition:
If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
If the node does not match the parameter type, the parameter will be empty, see IsValid().
If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Creates a CEnumParameter object and attaches it to a node retrieved from the provided node map.
Parameters:
nodeMap The node map. The source of the parameter.
pName The name of the parameter to attach.
Postcondition:
If name is NULL, the parameter will be empty, see IsValid().
If the node does not match the parameter type, the parameter will be empty, see IsValid().
If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Attaches a node retrieved from the provided node map.
Parameters:
pNodeMap The node map. The source of the parameter.
pName The name of the parameter to attach.
Return: Returns true if the node has been attached.
Postcondition:
If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
If the node does not match the parameter type, the parameter will be empty, see IsValid().
If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Attaches a node retrieved from the provided node map.
Parameters:
nodeMap The node map. The source of the parameter.
pName The name of the parameter to attach.
Return: Returns true if the node has been attached.
Postcondition:
If name is NULL the parameter will be empty, see IsValid().
If the node does not match the parameter type, the parameter will be empty, see IsValid().
If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Attaches a node, typically retrieved for a nodemap calling GetNode().
Parameters:
pNode The node to assign.
Return: Returns true if the node has been attached.
Postcondition:
If the node does not match the parameter type, the parameter will be empty, see IsValid().
If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.
The entry is returned as a CParameter. This method can be used to access information about the enumeration value represented by the entry using CParameter::GetInfo().
The entry is returned as a CParameter. This method can be used to access information about the enumeration value represented by the entry using CParameter::GetInfo().
Gets the parameter information if the parameter is attached to a node.
Parameters:
info The type information to return. Otherwise returns the default information. This method is useful if you want to display parameter information and handle the case that some parameters are not available for a device.
defaultInfo The default information returned if the parameter is not attached to a node.
Return: Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if the retrieval of the information fails.
Gets the parameter information if the parameter is attached to a node.
Parameters:
info The type information to return. Otherwise returns the default information. This method is useful if you want to display parameter information and handle the case that some parameters are not available for a device.
defaultInfo The default information returned if the parameter is not attached to a node.
Return: Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if the retrieval of the information fails.