![]() |
![]() |
CParameter class used to simplify access to GenApi parameters. More...
#include <pylon/Parameter.h>
Public Member Functions | |
CParameter () | |
Creates an empty CParameter object. More... | |
CParameter (GenApi::INode *pNode) | |
Creates a CParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode(). More... | |
CParameter (GenApi::IValue *pValue) | |
Creates a CParameter object and attaches it to a node of a matching type. More... | |
CParameter (GenApi::INodeMap *pNodeMap, const char *pName) | |
Creates a CParameter object and attaches it to a node retrieved from the provided node map. More... | |
CParameter (GenApi::INodeMap &nodeMap, const char *pName) | |
Creates a CParameter object and attaches it to a node retrieved from the provided node map. More... | |
CParameter (const CParameter &rhs) | |
Copies a CParameter object. More... | |
virtual | ~CParameter () |
Destroys the CParameter 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::IValue *pValue) |
Assigns a node of the same type to the parameter object. More... | |
CParameter & | operator= (const CParameter &rhs) |
Assigns a CParameter 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::INode *pNode) const |
Returns true if the attached node pointer is equal. More... | |
virtual bool | Equals (const GenApi::IValue *pValue) const |
Returns true if the attached node pointer is equal. More... | |
virtual void | Release () |
Releases the attached node. 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 bool | IsValid () const |
Indicates whether a node is attached. 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... | |
CParameter class used to simplify access to GenApi parameters.
Pylon::CParameter::CParameter | ( | ) |
Creates an empty CParameter object.
|
explicit |
Creates a CParameter 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 CParameter object and attaches it to a node of a matching type.
[in] | pValue | The node to attach. |
pValue
has been destroyed. In this case, call Release() or attach a new node. Pylon::CParameter::CParameter | ( | GenApi::INodeMap * | pNodeMap, |
const char * | pName | ||
) |
Creates a CParameter 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::CParameter::CParameter | ( | GenApi::INodeMap & | nodeMap, |
const char * | pName | ||
) |
Creates a CParameter 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::CParameter::CParameter | ( | const CParameter & | rhs | ) |
Copies a CParameter object.
[in] | rhs | The object to copy. |
|
virtual |
Destroys the CParameter 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 in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
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 in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
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 in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
virtual |
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 in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
virtual |
Returns true if the attached node pointer is equal.
[in] | pValue | The node to compare to. |
|
virtual |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implements GenApi::IValue.
|
virtual |
Gets the parameter information.
[in] | info | The type information to return. |
Implements Pylon::IValueEx.
|
virtual |
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 |
Indicates whether the parameter is readable.
Implements Pylon::IValueEx.
|
virtual |
Indicates whether a node is attached.
Implements Pylon::IValueEx.
Reimplemented in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
virtual |
Indicates whether the parameter is writable.
Implements Pylon::IValueEx.
CParameter& Pylon::CParameter::operator= | ( | const CParameter & | rhs | ) |
Assigns a CParameter object.
[in] | rhs | The object to assign. |
|
virtual |
Releases the attached node.
Reimplemented in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
virtual |
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.
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.