Extends the GenApi::IEnumeration interface with convenience methods.
More...
#include <pylon/EnumParameter.h>
Inherits GenApi::IEnumeration, and Pylon::IValueEx.
Inherited by Pylon::IEnumParameterT< AccessModeEnums > [virtual]
, Pylon::IEnumParameterT< AcquisitionFrameRateEnumEnums > [virtual]
, Pylon::IEnumParameterT< AcquisitionModeEnums > [virtual]
, Pylon::IEnumParameterT< AcquisitionStatusSelectorEnums > [virtual]
, Pylon::IEnumParameterT< AreaTriggerModeEnums > [virtual]
, Pylon::IEnumParameterT< AutoFunctionAOISelectorEnums > [virtual]
, Pylon::IEnumParameterT< AutoFunctionProfileEnums > [virtual]
, Pylon::IEnumParameterT< AutoFunctionROISelectorEnums > [virtual]
, Pylon::IEnumParameterT< AutoTonalRangeAdjustmentSelectorEnums > [virtual]
, Pylon::IEnumParameterT< AutoTonalRangeModeSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BalanceRatioSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BalanceWhiteAutoEnums > [virtual]
, Pylon::IEnumParameterT< BandwidthReserveModeEnums > [virtual]
, Pylon::IEnumParameterT< BconClockFrequencyEnums > [virtual]
, Pylon::IEnumParameterT< BconPixelsPerClockCycleEnums > [virtual]
, Pylon::IEnumParameterT< BinningHorizontalModeEnums > [virtual]
, Pylon::IEnumParameterT< BinningModeHorizontalEnums > [virtual]
, Pylon::IEnumParameterT< BinningModeVerticalEnums > [virtual]
, Pylon::IEnumParameterT< BinningVerticalModeEnums > [virtual]
, Pylon::IEnumParameterT< BitAlignmentEnums > [virtual]
, Pylon::IEnumParameterT< BlackLevelSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialPortBaudRateEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialPortParityEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialPortSourceEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialPortStopBitsEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialReceiveQueueStatusEnums > [virtual]
, Pylon::IEnumParameterT< BLCSerialTransmitQueueStatusEnums > [virtual]
, Pylon::IEnumParameterT< BslAcquisitionStopModeEnums > [virtual]
, Pylon::IEnumParameterT< BslColorAdjustmentSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BslColorSpaceEnums > [virtual]
, Pylon::IEnumParameterT< BslColorSpaceModeEnums > [virtual]
, Pylon::IEnumParameterT< BslContrastModeEnums > [virtual]
, Pylon::IEnumParameterT< BslExposureTimeModeEnums > [virtual]
, Pylon::IEnumParameterT< BslImmediateTriggerModeEnums > [virtual]
, Pylon::IEnumParameterT< BslLightControlErrorStatusEnums > [virtual]
, Pylon::IEnumParameterT< BslLightControlModeEnums > [virtual]
, Pylon::IEnumParameterT< BslLightControlSourceEnums > [virtual]
, Pylon::IEnumParameterT< BslLightControlStatusEnums > [virtual]
, Pylon::IEnumParameterT< BslLightDeviceChangeIDEnums > [virtual]
, Pylon::IEnumParameterT< BslLightDeviceLastErrorEnums > [virtual]
, Pylon::IEnumParameterT< BslLightDeviceOperationModeEnums > [virtual]
, Pylon::IEnumParameterT< BslLightDeviceSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BslLightDeviceStrobeModeEnums > [virtual]
, Pylon::IEnumParameterT< BslLightSourcePresetEnums > [virtual]
, Pylon::IEnumParameterT< BslLightSourcePresetFeatureSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BslPeriodicSignalSelectorEnums > [virtual]
, Pylon::IEnumParameterT< BslPeriodicSignalSourceEnums > [virtual]
, Pylon::IEnumParameterT< BslPtpDelayMechanismEnums > [virtual]
, Pylon::IEnumParameterT< BslPtpNetworkModeEnums > [virtual]
, Pylon::IEnumParameterT< BslPtpProfileEnums > [virtual]
, Pylon::IEnumParameterT< BslSensorBitDepthEnums > [virtual]
, Pylon::IEnumParameterT< BslSensorBitDepthModeEnums > [virtual]
, Pylon::IEnumParameterT< BslTemperatureStatusEnums > [virtual]
, Pylon::IEnumParameterT< BslUSBSpeedModeEnums > [virtual]
, Pylon::IEnumParameterT< BslVignettingCorrectionModeEnums > [virtual]
, Pylon::IEnumParameterT< CameraOperationModeEnums > [virtual]
, Pylon::IEnumParameterT< ChunkCounterSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ChunkGainSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ChunkPixelFormatEnums > [virtual]
, Pylon::IEnumParameterT< ChunkSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ClConfigurationEnums > [virtual]
, Pylon::IEnumParameterT< ClPixelClockEnums > [virtual]
, Pylon::IEnumParameterT< ClSerialPortBaudRateEnums > [virtual]
, Pylon::IEnumParameterT< ClTapGeometryEnums > [virtual]
, Pylon::IEnumParameterT< ClTimeSlotsEnums > [virtual]
, Pylon::IEnumParameterT< ColorAdjustmentSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ColorOverexposureCompensationAOISelectorEnums > [virtual]
, Pylon::IEnumParameterT< ColorSpaceEnums > [virtual]
, Pylon::IEnumParameterT< ColorTransformationSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ColorTransformationValueSelectorEnums > [virtual]
, Pylon::IEnumParameterT< CompressionModeEnums > [virtual]
, Pylon::IEnumParameterT< CounterEventActivationEnums > [virtual]
, Pylon::IEnumParameterT< CounterEventSourceEnums > [virtual]
, Pylon::IEnumParameterT< CounterResetActivationEnums > [virtual]
, Pylon::IEnumParameterT< CounterResetSourceEnums > [virtual]
, Pylon::IEnumParameterT< CounterSelectorEnums > [virtual]
, Pylon::IEnumParameterT< CounterStatusEnums > [virtual]
, Pylon::IEnumParameterT< CounterTriggerActivationEnums > [virtual]
, Pylon::IEnumParameterT< CounterTriggerSourceEnums > [virtual]
, Pylon::IEnumParameterT< CxpConnectionTestModeEnums > [virtual]
, Pylon::IEnumParameterT< CxpErrorCounterSelectorEnums > [virtual]
, Pylon::IEnumParameterT< CxpErrorCounterStatusEnums > [virtual]
, Pylon::IEnumParameterT< CxpLinkConfigurationEnums > [virtual]
, Pylon::IEnumParameterT< CxpLinkConfigurationPreferredEnums > [virtual]
, Pylon::IEnumParameterT< CxpLinkConfigurationStatusEnums > [virtual]
, Pylon::IEnumParameterT< CxpPoCxpStatusEnums > [virtual]
, Pylon::IEnumParameterT< CxpPort0PowerStateEnums > [virtual]
, Pylon::IEnumParameterT< CxpSendReceiveSelectorEnums > [virtual]
, Pylon::IEnumParameterT< DefectPixelCorrectionModeEnums > [virtual]
, Pylon::IEnumParameterT< DemosaicingModeEnums > [virtual]
, Pylon::IEnumParameterT< DeviceAccessStatusEnums > [virtual]
, Pylon::IEnumParameterT< DeviceCharacterSetEnums > [virtual]
, Pylon::IEnumParameterT< DeviceClockSelectorEnums > [virtual]
, Pylon::IEnumParameterT< DeviceIndicatorModeEnums > [virtual]
, Pylon::IEnumParameterT< DeviceLinkThroughputLimitModeEnums > [virtual]
, Pylon::IEnumParameterT< DeviceRegistersEndiannessEnums > [virtual]
, Pylon::IEnumParameterT< DeviceScanTypeEnums > [virtual]
, Pylon::IEnumParameterT< DeviceTapGeometryEnums > [virtual]
, Pylon::IEnumParameterT< DeviceTemperatureSelectorEnums > [virtual]
, Pylon::IEnumParameterT< DeviceTLTypeEnums > [virtual]
, Pylon::IEnumParameterT< DeviceTypeEnums > [virtual]
, Pylon::IEnumParameterT< EventNotificationEnums > [virtual]
, Pylon::IEnumParameterT< EventSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ExpertFeatureAccessSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ExposureAutoEnums > [virtual]
, Pylon::IEnumParameterT< ExposureModeEnums > [virtual]
, Pylon::IEnumParameterT< ExposureOverlapTimeModeEnums > [virtual]
, Pylon::IEnumParameterT< ExposureTimeModeEnums > [virtual]
, Pylon::IEnumParameterT< FeatureSetEnums > [virtual]
, Pylon::IEnumParameterT< FieldOutputModeEnums > [virtual]
, Pylon::IEnumParameterT< FileOpenModeEnums > [virtual]
, Pylon::IEnumParameterT< FileOperationSelectorEnums > [virtual]
, Pylon::IEnumParameterT< FileOperationStatusEnums > [virtual]
, Pylon::IEnumParameterT< FileSelectorEnums > [virtual]
, Pylon::IEnumParameterT< FormatEnums > [virtual]
, Pylon::IEnumParameterT< FrequencyConverterInputSourceEnums > [virtual]
, Pylon::IEnumParameterT< FrequencyConverterSignalAlignmentEnums > [virtual]
, Pylon::IEnumParameterT< GainAutoEnums > [virtual]
, Pylon::IEnumParameterT< GainSelectorEnums > [virtual]
, Pylon::IEnumParameterT< GammaSelectorEnums > [virtual]
, Pylon::IEnumParameterT< GevCCPEnums > [virtual]
, Pylon::IEnumParameterT< GevGVSPExtendedIDModeEnums > [virtual]
, Pylon::IEnumParameterT< GevIEEE1588StatusEnums > [virtual]
, Pylon::IEnumParameterT< GevIEEE1588StatusLatchedEnums > [virtual]
, Pylon::IEnumParameterT< GevInterfaceSelectorEnums > [virtual]
, Pylon::IEnumParameterT< GevStreamChannelSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ImageCompressionModeEnums > [virtual]
, Pylon::IEnumParameterT< ImageCompressionRateOptionEnums > [virtual]
, Pylon::IEnumParameterT< ImageFileModeEnums > [virtual]
, Pylon::IEnumParameterT< InconvertibleEdgeHandlingEnums > [virtual]
, Pylon::IEnumParameterT< InterfaceAppletEnums > [virtual]
, Pylon::IEnumParameterT< InterfaceTypeEnums > [virtual]
, Pylon::IEnumParameterT< InterlacedIntegrationModeEnums > [virtual]
, Pylon::IEnumParameterT< LastErrorEnums > [virtual]
, Pylon::IEnumParameterT< LegacyBinningVerticalEnums > [virtual]
, Pylon::IEnumParameterT< LightSourcePresetEnums > [virtual]
, Pylon::IEnumParameterT< LightSourceSelectorEnums > [virtual]
, Pylon::IEnumParameterT< LineFormatEnums > [virtual]
, Pylon::IEnumParameterT< LineLogicEnums > [virtual]
, Pylon::IEnumParameterT< LineModeEnums > [virtual]
, Pylon::IEnumParameterT< LineSelectorEnums > [virtual]
, Pylon::IEnumParameterT< LineSourceEnums > [virtual]
, Pylon::IEnumParameterT< LUTSelectorEnums > [virtual]
, Pylon::IEnumParameterT< MonoConversionMethodEnums > [virtual]
, Pylon::IEnumParameterT< OutputBitAlignmentEnums > [virtual]
, Pylon::IEnumParameterT< OutputOrientationEnums > [virtual]
, Pylon::IEnumParameterT< OverlapModeEnums > [virtual]
, Pylon::IEnumParameterT< ParameterSelectorEnums > [virtual]
, Pylon::IEnumParameterT< PgiModeEnums > [virtual]
, Pylon::IEnumParameterT< PixelCodingEnums > [virtual]
, Pylon::IEnumParameterT< PixelColorFilterEnums > [virtual]
, Pylon::IEnumParameterT< PixelFormatEnums > [virtual]
, Pylon::IEnumParameterT< PixelPerClockCycleEnums > [virtual]
, Pylon::IEnumParameterT< PixelSizeEnums > [virtual]
, Pylon::IEnumParameterT< PtpClockAccuracyEnums > [virtual]
, Pylon::IEnumParameterT< PtpServoStatusEnums > [virtual]
, Pylon::IEnumParameterT< PtpStatusEnums > [virtual]
, Pylon::IEnumParameterT< RemoveParameterLimitSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ROIZoneModeEnums > [virtual]
, Pylon::IEnumParameterT< ROIZoneSelectorEnums > [virtual]
, Pylon::IEnumParameterT< SensorBitDepthEnums > [virtual]
, Pylon::IEnumParameterT< SensorDigitizationTapsEnums > [virtual]
, Pylon::IEnumParameterT< SensorReadoutModeEnums > [virtual]
, Pylon::IEnumParameterT< SensorShutterModeEnums > [virtual]
, Pylon::IEnumParameterT< SequenceAddressBitSelectorEnums > [virtual]
, Pylon::IEnumParameterT< SequenceAddressBitSourceEnums > [virtual]
, Pylon::IEnumParameterT< SequenceAdvanceModeEnums > [virtual]
, Pylon::IEnumParameterT< SequenceConfigurationModeEnums > [virtual]
, Pylon::IEnumParameterT< SequenceControlSelectorEnums > [virtual]
, Pylon::IEnumParameterT< SequenceControlSourceEnums > [virtual]
, Pylon::IEnumParameterT< SequencerConfigurationModeEnums > [virtual]
, Pylon::IEnumParameterT< SequencerModeEnums > [virtual]
, Pylon::IEnumParameterT< SequencerTriggerActivationEnums > [virtual]
, Pylon::IEnumParameterT< SequencerTriggerSourceEnums > [virtual]
, Pylon::IEnumParameterT< ShadingSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ShadingSetCreateEnums > [virtual]
, Pylon::IEnumParameterT< ShadingSetDefaultSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ShadingSetSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ShadingStatusEnums > [virtual]
, Pylon::IEnumParameterT< ShaftEncoderModuleCounterModeEnums > [virtual]
, Pylon::IEnumParameterT< ShaftEncoderModuleLineSelectorEnums > [virtual]
, Pylon::IEnumParameterT< ShaftEncoderModuleLineSourceEnums > [virtual]
, Pylon::IEnumParameterT< ShaftEncoderModuleModeEnums > [virtual]
, Pylon::IEnumParameterT< ShutterModeEnums > [virtual]
, Pylon::IEnumParameterT< SoftwareSignalSelectorEnums > [virtual]
, Pylon::IEnumParameterT< SoftwareTriggerIsBusyEnums > [virtual]
, Pylon::IEnumParameterT< StatusEnums > [virtual]
, Pylon::IEnumParameterT< StreamBufferHandlingModeEnums > [virtual]
, Pylon::IEnumParameterT< StreamTypeEnums > [virtual]
, Pylon::IEnumParameterT< SyncUserOutputSelectorEnums > [virtual]
, Pylon::IEnumParameterT< SystemmonitorByteAlignment8b10bLockedEnums > [virtual]
, Pylon::IEnumParameterT< SystemmonitorExternalPowerEnums > [virtual]
, Pylon::IEnumParameterT< SystemmonitorPowerOverCxpStateEnums > [virtual]
, Pylon::IEnumParameterT< TemperatureSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TemperatureStateEnums > [virtual]
, Pylon::IEnumParameterT< TestImageSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TestPatternEnums > [virtual]
, Pylon::IEnumParameterT< TimerSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TimerSequenceEntrySelectorEnums > [virtual]
, Pylon::IEnumParameterT< TimerSequenceTimerSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TimerStatusEnums > [virtual]
, Pylon::IEnumParameterT< TimerTriggerActivationEnums > [virtual]
, Pylon::IEnumParameterT< TimerTriggerSourceEnums > [virtual]
, Pylon::IEnumParameterT< TonalRangeAutoEnums > [virtual]
, Pylon::IEnumParameterT< TonalRangeEnableEnums > [virtual]
, Pylon::IEnumParameterT< TonalRangeSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TransmissionTypeEnums > [virtual]
, Pylon::IEnumParameterT< TriggerActivationEnums > [virtual]
, Pylon::IEnumParameterT< TriggerCameraOutSelectEnums > [virtual]
, Pylon::IEnumParameterT< TriggerControlImplementationEnums > [virtual]
, Pylon::IEnumParameterT< TriggerDelaySourceEnums > [virtual]
, Pylon::IEnumParameterT< TriggerInPolarityEnums > [virtual]
, Pylon::IEnumParameterT< TriggerInSourceEnums > [virtual]
, Pylon::IEnumParameterT< TriggerModeEnums > [virtual]
, Pylon::IEnumParameterT< TriggerOutSelectFrontGPO0Enums > [virtual]
, Pylon::IEnumParameterT< TriggerOutSelectFrontGPO1Enums > [virtual]
, Pylon::IEnumParameterT< TriggerQueueModeEnums > [virtual]
, Pylon::IEnumParameterT< TriggerSelectorEnums > [virtual]
, Pylon::IEnumParameterT< TriggerSourceEnums > [virtual]
, Pylon::IEnumParameterT< TriggerStateEnums > [virtual]
, Pylon::IEnumParameterT< TypeEnums > [virtual]
, Pylon::IEnumParameterT< UserDefinedValueSelectorEnums > [virtual]
, Pylon::IEnumParameterT< UserOutputSelectorEnums > [virtual]
, Pylon::IEnumParameterT< UserSetDefaultEnums > [virtual]
, Pylon::IEnumParameterT< UserSetDefaultSelectorEnums > [virtual]
, Pylon::IEnumParameterT< UserSetSelectorEnums > [virtual]
, Pylon::IEnumParameterT< VignettingCorrectionModeEnums > [virtual]
, Pylon::IEnumParameterT< VInpSignalReadoutActivationEnums > [virtual]
, Pylon::IEnumParameterT< VInpSignalSourceEnums > [virtual]
, Pylon::CEnumParameter [virtual]
, and Pylon::IEnumParameterT< EnumT > [virtual]
.
Extends the GenApi::IEnumeration interface with convenience methods.
virtual bool Pylon::IEnumerationEx::CanSetValue |
( |
const String_t & |
value | ) |
|
|
pure virtual |
Indicates whether the given value can be set.
- Returns
- Returns true if the value can be set, otherwise false.
- Parameters
-
[in] | value | The value to be checked. |
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Does not throw exceptions.
Implemented in Pylon::CEnumParameter.
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 a list of all values of the enumeration including the values that are currently not settable.
- Parameters
-
[out] | values | Returns a list of all values of the enumeration including the values that are currently not settable. |
- Precondition
- The parameter must be readable.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions.
Implemented in Pylon::CEnumParameter.
virtual CParameter Pylon::IEnumerationEx::GetCurrentEntryAsParameter |
( |
| ) |
|
|
pure virtual |
Gets the currently selected entry of an enumeration.
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().
- Precondition
- The parameter must be readable.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions.
Implemented in Pylon::CEnumParameter.
Gets an enumeration entry by its symbolic name.
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().
- Parameters
-
[in] | value | The symbolic name of the enumeration entry, e.g., "Testimage1". |
- Precondition
- The parameter must be readable.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions.
Implemented in Pylon::CEnumParameter.
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 int64_t GenApi::IEnumeration::GetIntValue |
( |
bool |
Verify = false , |
|
|
bool |
IgnoreCache = false |
|
) |
| |
|
pure virtualinherited |
Get integer 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::CEnumParameter.
Gets a list of all values of the enumeration that are currently settable.
- Parameters
-
[out] | values | Returns a list of all values of the enumeration that are currently settable. |
- Precondition
- The parameter must be readable.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions.
Implemented in Pylon::CEnumParameter.
virtual String_t Pylon::IEnumerationEx::GetValue |
( |
| ) |
|
|
pure virtual |
Gets the value of the parameter.
- Returns
- Returns the current parameter value.
- Precondition
- The parameter must be readable.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if the parameter is not readable or if reading the value fails.
Implemented in Pylon::CEnumParameter.
virtual String_t Pylon::IEnumerationEx::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 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::CEnumParameter.
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::IEnumeration::SetIntValue |
( |
int64_t |
Value, |
|
|
bool |
Verify = true |
|
) |
| |
|
pure virtualinherited |
Set integer node value.
- Parameters
-
Value | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CEnumParameter.
virtual void Pylon::IEnumerationEx::SetValue |
( |
const char ** |
nullTerminatedList | ) |
|
|
pure virtual |
Sets the value of the parameter to the first valid value in a list of values.
Example:
CEnumParameter pixelFormat(nodemap, "PixelFormat");
const char* list[] = { "BayerGR8", "BayerRG8", "BayerGB8", "BayerBG8", "Mono8", NULL };
pixelFormat.SetValue(list);
- Parameters
-
[in] | nullTerminatedList | The list of possible values to set. The list is terminated by a NULL value. |
- Precondition
-
The parameter must be writable.
-
At least one value within the list passed must be contained in the set of settable enumeration values.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if the parameter is not writable, no value
nullTerminatedList
is settable, or writing the value fails.
Implemented in Pylon::CEnumParameter.
virtual void Pylon::IEnumerationEx::SetValue |
( |
const String_t & |
value | ) |
|
|
pure virtual |
Sets the value of the parameter.
Calls FromString().
- Parameters
-
[in] | value | The value to set. |
- Precondition
- The value must be contained in the set of settable enumeration values.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if the parameter is not writable, no value is valid, or writing the value fails.
Implemented in Pylon::CEnumParameter.
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::IEnumerationEx::TrySetValue |
( |
const String_t & |
value | ) |
|
|
pure virtual |
Sets the value of the parameter if the parameter is writable and the value is contained in the set of settable enumeration values.
- Returns
- Returns false if the parameter is not writable or the value is not contained in the set of settable enumeration values.
- Parameters
-
[in] | value | The value to set. |
- Precondition
- The value must be contained in the set of settable enumeration values.
- 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::CEnumParameter.
virtual bool Pylon::IEnumerationEx::TrySetValue |
( |
const char ** |
nullTerminatedList | ) |
|
|
pure virtual |
If the parameter is writable, sets the value of the parameter to the first valid value in a list of values.
Example:
CEnumParameter pixelFormat(nodemap, "PixelFormat");
const char* list[] = { "BayerGR8", "BayerRG8", "BayerGB8", "BayerBG8", "Mono8", NULL };
pixelFormat.TrySetValue(list);
- Parameters
-
[in] | nullTerminatedList | The list of possible values to set. The list is terminated by a NULL value. |
- Returns
- Returns false if the parameter is not writable.
- Precondition
- At least one value within the passed list must be contained in the set of settable enumeration values.
- Thread Safety:
- The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
- Error Safety:
- Can throw exceptions if the parameter is not writable, no value
nullTerminatedList
is settable, or writing the value fails.
Implemented in Pylon::CEnumParameter.
The documentation for this struct was generated from the following file: