Extends the GenApi::IString interface with convenience methods.
More...
#include <pylon/StringParameter.h>
Extends the GenApi::IString interface with convenience methods.
virtual void GenApi::IValue::FromString |
( |
const GenICam::gcstring & |
ValueStr, |
|
|
bool |
Verify = true |
|
) |
| |
|
pure virtualinherited |
Set content of the node as string.
- Parameters
-
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CParameter.
Gets the parameter information.
- Parameters
-
[in] | info | The type information to return. |
- Returns
- Returns the parameter information.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Throws an exception if no node is attached. Can throw exceptions if the retrieval of the information fails.
Implemented in Pylon::CParameter.
Gets the parameter information if the parameter is attached to a node.
See IsValid().
- Parameters
-
[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. |
- Returns
- Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.
- Parameters
-
[in] | defaultInfo | The default information returned if the parameter is not attached to a node. |
- 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.
Implemented in Pylon::CParameter.
virtual GenICam::gcstring GenApi::IString::GetValue |
( |
bool |
Verify = false , |
|
|
bool |
IgnoreCache = false |
|
) |
| |
|
pure virtualinherited |
Get node value.
- Parameters
-
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
- Returns
- The value read
Implemented in Pylon::CStringParameter.
virtual String_t Pylon::IStringEx::GetValueOrDefault |
( |
const String_t & |
defaultValue | ) |
|
|
pure virtual |
Gets the value of the parameter if the parameter is readable.
Otherwise returns the default value.
- Returns
- Returns the value of the parameter if the parameter is readable. Otherwise returns the default value.
- Parameters
-
[in] | defaultValue | The default value returned if the parameter is not readable. |
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if reading the value fails.
Implemented in Pylon::CStringParameter.
virtual bool Pylon::IValueEx::IsReadable |
( |
| ) |
const |
|
pure virtualinherited |
Indicates whether the parameter is readable.
- Error Safety:
- Does not throw C++ exceptions.
- Returns
- Returns true if the parameter is readable.
Implemented in Pylon::CParameter.
virtual bool Pylon::IValueEx::IsValid |
( |
| ) |
const |
|
pure virtualinherited |
virtual bool Pylon::IValueEx::IsWritable |
( |
| ) |
const |
|
pure virtualinherited |
Indicates whether the parameter is writable.
- Error Safety:
- Does not throw C++ exceptions.
- Returns
- Returns true if the parameter is writable.
Implemented in Pylon::CParameter.
virtual void GenApi::IString::SetValue |
( |
const GenICam::gcstring & |
Value, |
|
|
bool |
Verify = true |
|
) |
| |
|
pure virtualinherited |
Set node value.
- Parameters
-
Value | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CStringParameter.
virtual GenICam::gcstring GenApi::IValue::ToString |
( |
bool |
Verify = false , |
|
|
bool |
IgnoreCache = false |
|
) |
| |
|
pure virtualinherited |
Get content of the node as string.
- Parameters
-
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
- Returns
- The value read
Implemented in Pylon::CParameter.
virtual String_t Pylon::IValueEx::ToStringOrDefault |
( |
const String_t & |
defaultValue | ) |
|
|
pure virtualinherited |
Gets the parameter value as string if the parameter is readable.
Otherwise returns the default value.
- Returns
- Returns the parameter value if the parameter is readable. Otherwise returns the default value.
- Parameters
-
[in] | defaultValue | The default value returned if the parameter is not readable. |
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if reading the value fails.
Implemented in Pylon::CParameter.
virtual bool Pylon::IStringEx::TrySetValue |
( |
const String_t & |
value | ) |
|
|
pure virtual |
Sets the value of the parameter if the parameter is writable.
- Returns
- Returns false if the parameter is not writable.
- Parameters
-
[in] | value | The string value to set. |
- Precondition
-
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if the preconditions are not met or if writing the value fails.
Implemented in Pylon::CStringParameter.
The documentation for this struct was generated from the following file: