![]() |
![]() |
CCommandParameter class used to simplify access to GenApi parameters. More...
#include <pylon/CommandParameter.h>
Public Member Functions | |
CCommandParameter () | |
Creates an empty CCommandParameter object. More... | |
CCommandParameter (GenApi::INode *pNode) | |
Creates a CCommandParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode(). More... | |
CCommandParameter (GenApi::ICommand *pCommand) | |
Creates a CCommandParameter object and attaches it to a node of a matching type. More... | |
CCommandParameter (GenApi::INodeMap *pNodeMap, const char *pName) | |
Creates a CCommandParameter object and attaches it to a node retrieved from the provided node map. More... | |
CCommandParameter (GenApi::INodeMap &nodeMap, const char *pName) | |
Creates a CCommandParameter object and attaches it to a node retrieved from the provided node map. More... | |
CCommandParameter (const CCommandParameter &rhs) | |
Copies a CCommandParameter object. More... | |
virtual | ~CCommandParameter () |
Destroys the CCommandParameter object. More... | |
virtual bool | Attach (GenApi::INodeMap *pNodeMap, const char *pName) |
Attaches a node retrieved from the provided node map. More... | |
virtual bool | Attach (GenApi::INodeMap &nodeMap, const char *pName) |
Attaches a node retrieved from the provided node map. More... | |
virtual bool | Attach (GenApi::INode *pNode) |
Attaches a node, typically retrieved for a nodemap calling GetNode(). More... | |
virtual bool | Attach (GenApi::ICommand *pCommand) |
Assigns a node of the same type to the parameter object. More... | |
CCommandParameter & | operator= (const CCommandParameter &rhs) |
Assigns a CCommandParameter object. More... | |
virtual bool | Equals (const CCommandParameter &rhs) const |
Returns true if the same nodes are attached or both parameters are empty. More... | |
virtual bool | Equals (const GenApi::INode *pNode) const |
Returns true if the attached node pointer is equal. More... | |
virtual bool | Equals (const GenApi::ICommand *pCommand) const |
Returns true if the attached node pointer is equal. More... | |
virtual void | Release () |
Releases the attached node. More... | |
virtual bool | IsValid () const |
Indicates whether a node is attached. More... | |
virtual void | Execute (bool verify=true) |
Execute the command. More... | |
virtual void | operator() () |
Execute the command. | |
virtual bool | IsDone (bool verify=true) |
Query whether the command is executed. More... | |
virtual bool | TryExecute () |
Executes the command and returns immediately if the parameter is writable. More... | |
virtual INode * | GetNode () |
Get the INode interface of the node. | |
virtual GenICam::gcstring | ToString (bool Verify=false, bool IgnoreCache=false)=0 |
Get content of the node as string. More... | |
virtual void | FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0 |
Set content of the node as string. More... | |
virtual bool | IsValueCacheValid () const =0 |
Checks if the value comes from cache or is requested from another node. | |
virtual EAccessMode | GetAccessMode () const =0 |
Get the access mode of the node. | |
virtual bool | IsReadable () const =0 |
Indicates whether the parameter is readable. More... | |
virtual bool | IsWritable () const =0 |
Indicates whether the parameter is writable. More... | |
virtual String_t | GetInfo (EParameterInfo info)=0 |
Gets the parameter information. More... | |
virtual String_t | GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo)=0 |
Gets the parameter information if the parameter is attached to a node. More... | |
virtual String_t | ToStringOrDefault (const String_t &defaultValue)=0 |
Gets the parameter value as string if the parameter is readable. More... | |
virtual bool | Attach (GenApi::IValue *pValue) |
Assigns a node of the same type to the parameter object. More... | |
virtual bool | Equals (const CParameter &rhs) const |
Returns true if the same nodes are attached or both parameters are empty. More... | |
virtual bool | Equals (const GenApi::IValue *pValue) const |
Returns true if the attached node pointer is equal. More... | |
virtual GenApi::EAccessMode | GetAccessMode () const |
Get the access mode of the node. | |
virtual GenApi::INode * | GetNode () |
Get the INode interface of the node. | |
virtual GenICam::gcstring | ToString (bool verify=false, bool ignoreCache=false) |
Get content of the node as string. More... | |
virtual void | FromString (const GenICam::gcstring &valueStr, bool verify=true) |
Set content of the node as string. More... | |
virtual bool | IsValueCacheValid () const |
Checks if the value comes from cache or is requested from another node. | |
virtual bool | IsReadable () const |
Indicates whether the parameter is readable. More... | |
virtual bool | IsWritable () const |
Indicates whether the parameter is writable. More... | |
virtual String_t | GetInfo (EParameterInfo info) |
Gets the parameter information. More... | |
virtual String_t | GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo) |
Gets the parameter information if the parameter is attached to a node. More... | |
virtual String_t | ToStringOrDefault (const String_t &defaultValue) |
Gets the parameter value as string if the parameter is readable. More... | |
CCommandParameter class used to simplify access to GenApi parameters.
Pylon::CCommandParameter::CCommandParameter | ( | ) |
Creates an empty CCommandParameter object.
|
explicit |
Creates a CCommandParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode().
[in] | pNode | The node to attach. |
pNode
has been destroyed. In this case, call Release() or attach a new node.
|
explicit |
Creates a CCommandParameter object and attaches it to a node of a matching type.
[in] | pCommand | The node to attach. |
pCommand
has been destroyed. In this case, call Release() or attach a new node. Pylon::CCommandParameter::CCommandParameter | ( | GenApi::INodeMap * | pNodeMap, |
const char * | pName | ||
) |
Creates a CCommandParameter object and attaches it to a node retrieved from the provided node map.
[in] | pNodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
pNodeMap
or name
is NULL, the parameter will be empty, see IsValid(). Pylon::CCommandParameter::CCommandParameter | ( | GenApi::INodeMap & | nodeMap, |
const char * | pName | ||
) |
Creates a CCommandParameter object and attaches it to a node retrieved from the provided node map.
[in] | nodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
name
is NULL, the parameter will be empty, see IsValid(). Pylon::CCommandParameter::CCommandParameter | ( | const CCommandParameter & | rhs | ) |
Copies a CCommandParameter object.
[in] | rhs | The object to copy. |
|
virtual |
Destroys the CCommandParameter object.
Does not access the attached node.
|
virtual |
Attaches a node retrieved from the provided node map.
[in] | pNodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
pNodeMap
or name
is NULL, the parameter will be empty, see IsValid(). Reimplemented from Pylon::CParameter.
|
virtual |
Attaches a node retrieved from the provided node map.
[in] | nodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
name
is NULL the parameter will be empty, see IsValid(). Reimplemented from Pylon::CParameter.
|
virtual |
Attaches a node, typically retrieved for a nodemap calling GetNode().
[in] | pNode | The node to assign. |
pNode
has been destroyed. In this case, call Release() or attach a new node. Reimplemented from Pylon::CParameter.
|
virtual |
Assigns a node of the same type to the parameter object.
[in] | pCommand | The node to assign. |
|
virtualinherited |
Assigns a node of the same type to the parameter object.
[in] | pValue | The node to assign. |
|
virtual |
Returns true if the same nodes are attached or both parameters are empty.
[in] | rhs | The object to compare to. |
|
virtual |
Returns true if the attached node pointer is equal.
[in] | pNode | The node to compare to. |
Reimplemented from Pylon::CParameter.
|
virtual |
Returns true if the attached node pointer is equal.
[in] | pCommand | The node to compare to. |
|
virtualinherited |
Returns true if the same nodes are attached or both parameters are empty.
[in] | rhs | The object to compare to. |
|
virtualinherited |
Returns true if the attached node pointer is equal.
[in] | pValue | The node to compare to. |
|
virtual |
Execute the command.
Verify | Enables AccessMode and Range verification (default = true) |
Implements GenApi::ICommand.
|
pure virtualinherited |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CParameter.
|
virtualinherited |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implements GenApi::IValue.
|
pure virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implemented in Pylon::CParameter.
|
virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implements Pylon::IValueEx.
|
pure virtualinherited |
Gets the parameter information if the parameter is attached to a node.
See IsValid().
[in] | 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. |
[in] | defaultInfo | The default information returned if the parameter is not attached to a node. |
Implemented in Pylon::CParameter.
|
virtualinherited |
Gets the parameter information if the parameter is attached to a node.
See IsValid().
[in] | 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. |
[in] | defaultInfo | The default information returned if the parameter is not attached to a node. |
Implements Pylon::IValueEx.
|
virtual |
Query whether the command is executed.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
Implements GenApi::ICommand.
|
pure virtualinherited |
Indicates whether the parameter is readable.
Implemented in Pylon::CParameter.
|
virtualinherited |
Indicates whether the parameter is readable.
Implements Pylon::IValueEx.
|
virtual |
Indicates whether a node is attached.
Reimplemented from Pylon::CParameter.
|
pure virtualinherited |
Indicates whether the parameter is writable.
Implemented in Pylon::CParameter.
|
virtualinherited |
Indicates whether the parameter is writable.
Implements Pylon::IValueEx.
CCommandParameter& Pylon::CCommandParameter::operator= | ( | const CCommandParameter & | rhs | ) |
Assigns a CCommandParameter object.
[in] | rhs | The object to assign. |
|
virtual |
Releases the attached node.
Reimplemented from Pylon::CParameter.
|
pure virtualinherited |
Get content of the node as string.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implemented in Pylon::CParameter.
|
virtualinherited |
Get content of the node as string.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implements GenApi::IValue.
|
pure virtualinherited |
Gets the parameter value as string if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implemented in Pylon::CParameter.
|
virtualinherited |
Gets the parameter value as string if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implements Pylon::IValueEx.
|
virtual |
Executes the command and returns immediately if the parameter is writable.
Implements Pylon::ICommandEx.