All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GenApi::IEnumeration Struct Referenceabstract

Interface for enumeration properties. More...

#include <GenApi/IEnumeration.h>

Inherits GenApi::IValue.

Inherited by GenApi::IEnumerationT< EnumT >, GenApi::IEnumerationT< AccessModeEnums >, GenApi::IEnumerationT< AcquisitionModeEnums >, GenApi::IEnumerationT< AcquisitionStatusSelectorEnums >, GenApi::IEnumerationT< AutoFunctionAOISelectorEnums >, GenApi::IEnumerationT< AutoFunctionProfileEnums >, GenApi::IEnumerationT< AutoFunctionROISelectorEnums >, GenApi::IEnumerationT< BalanceRatioSelectorEnums >, GenApi::IEnumerationT< BalanceWhiteAutoEnums >, GenApi::IEnumerationT< BinningHorizontalModeEnums >, GenApi::IEnumerationT< BinningModeHorizontalEnums >, GenApi::IEnumerationT< BinningModeVerticalEnums >, GenApi::IEnumerationT< BinningVerticalModeEnums >, GenApi::IEnumerationT< BlackLevelSelectorEnums >, GenApi::IEnumerationT< BslColorSpaceModeEnums >, GenApi::IEnumerationT< BslContrastModeEnums >, GenApi::IEnumerationT< BslImmediateTriggerModeEnums >, GenApi::IEnumerationT< BslUSBSpeedModeEnums >, GenApi::IEnumerationT< ChunkCounterSelectorEnums >, GenApi::IEnumerationT< ChunkGainSelectorEnums >, GenApi::IEnumerationT< ChunkPixelFormatEnums >, GenApi::IEnumerationT< ChunkSelectorEnums >, GenApi::IEnumerationT< ColorAdjustmentSelectorEnums >, GenApi::IEnumerationT< ColorOverexposureCompensationAOISelectorEnums >, GenApi::IEnumerationT< ColorSpaceEnums >, GenApi::IEnumerationT< ColorTransformationSelectorEnums >, GenApi::IEnumerationT< ColorTransformationValueSelectorEnums >, GenApi::IEnumerationT< CounterEventSourceEnums >, GenApi::IEnumerationT< CounterResetActivationEnums >, GenApi::IEnumerationT< CounterResetSourceEnums >, GenApi::IEnumerationT< CounterSelectorEnums >, GenApi::IEnumerationT< DefaultSetSelectorEnums >, GenApi::IEnumerationT< DefectPixelCorrectionModeEnums >, GenApi::IEnumerationT< DemosaicingModeEnums >, GenApi::IEnumerationT< DeviceIndicatorModeEnums >, GenApi::IEnumerationT< DeviceLinkThroughputLimitModeEnums >, GenApi::IEnumerationT< DeviceScanTypeEnums >, GenApi::IEnumerationT< DeviceTemperatureSelectorEnums >, GenApi::IEnumerationT< EventNotificationEnums >, GenApi::IEnumerationT< EventSelectorEnums >, GenApi::IEnumerationT< ExpertFeatureAccessSelectorEnums >, GenApi::IEnumerationT< ExposureAutoEnums >, GenApi::IEnumerationT< ExposureModeEnums >, GenApi::IEnumerationT< ExposureOverlapTimeModeEnums >, GenApi::IEnumerationT< FeatureSetEnums >, GenApi::IEnumerationT< FieldOutputModeEnums >, GenApi::IEnumerationT< FileOpenModeEnums >, GenApi::IEnumerationT< FileOperationSelectorEnums >, GenApi::IEnumerationT< FileOperationStatusEnums >, GenApi::IEnumerationT< FileSelectorEnums >, GenApi::IEnumerationT< FrequencyConverterInputSourceEnums >, GenApi::IEnumerationT< FrequencyConverterSignalAlignmentEnums >, GenApi::IEnumerationT< GainAutoEnums >, GenApi::IEnumerationT< GainSelectorEnums >, GenApi::IEnumerationT< GammaSelectorEnums >, GenApi::IEnumerationT< GevCCPEnums >, GenApi::IEnumerationT< GevGVSPExtendedIDModeEnums >, GenApi::IEnumerationT< GevIEEE1588StatusEnums >, GenApi::IEnumerationT< GevIEEE1588StatusLatchedEnums >, GenApi::IEnumerationT< GevInterfaceSelectorEnums >, GenApi::IEnumerationT< GevStreamChannelSelectorEnums >, GenApi::IEnumerationT< InconvertibleEdgeHandlingEnums >, GenApi::IEnumerationT< InterlacedIntegrationModeEnums >, GenApi::IEnumerationT< LastErrorEnums >, GenApi::IEnumerationT< LegacyBinningVerticalEnums >, GenApi::IEnumerationT< LightSourcePresetEnums >, GenApi::IEnumerationT< LightSourceSelectorEnums >, GenApi::IEnumerationT< LineFormatEnums >, GenApi::IEnumerationT< LineLogicEnums >, GenApi::IEnumerationT< LineModeEnums >, GenApi::IEnumerationT< LineSelectorEnums >, GenApi::IEnumerationT< LineSourceEnums >, GenApi::IEnumerationT< LUTSelectorEnums >, GenApi::IEnumerationT< MonoConversionMethodEnums >, GenApi::IEnumerationT< OutputBitAlignmentEnums >, GenApi::IEnumerationT< OutputOrientationEnums >, GenApi::IEnumerationT< OverlapModeEnums >, GenApi::IEnumerationT< ParameterSelectorEnums >, GenApi::IEnumerationT< PixelCodingEnums >, GenApi::IEnumerationT< PixelColorFilterEnums >, GenApi::IEnumerationT< PixelFormatEnums >, GenApi::IEnumerationT< PixelSizeEnums >, GenApi::IEnumerationT< RemoveParameterLimitSelectorEnums >, GenApi::IEnumerationT< SensorBitDepthEnums >, GenApi::IEnumerationT< SensorDigitizationTapsEnums >, GenApi::IEnumerationT< SensorReadoutModeEnums >, GenApi::IEnumerationT< SensorShutterModeEnums >, GenApi::IEnumerationT< SequenceAddressBitSelectorEnums >, GenApi::IEnumerationT< SequenceAddressBitSourceEnums >, GenApi::IEnumerationT< SequenceAdvanceModeEnums >, GenApi::IEnumerationT< SequenceConfigurationModeEnums >, GenApi::IEnumerationT< SequenceControlSelectorEnums >, GenApi::IEnumerationT< SequenceControlSourceEnums >, GenApi::IEnumerationT< SequencerConfigurationModeEnums >, GenApi::IEnumerationT< SequencerModeEnums >, GenApi::IEnumerationT< SequencerTriggerActivationEnums >, GenApi::IEnumerationT< SequencerTriggerSourceEnums >, GenApi::IEnumerationT< ShadingSelectorEnums >, GenApi::IEnumerationT< ShadingSetCreateEnums >, GenApi::IEnumerationT< ShadingSetDefaultSelectorEnums >, GenApi::IEnumerationT< ShadingSetSelectorEnums >, GenApi::IEnumerationT< ShadingStatusEnums >, GenApi::IEnumerationT< ShaftEncoderModuleCounterModeEnums >, GenApi::IEnumerationT< ShaftEncoderModuleLineSelectorEnums >, GenApi::IEnumerationT< ShaftEncoderModuleLineSourceEnums >, GenApi::IEnumerationT< ShaftEncoderModuleModeEnums >, GenApi::IEnumerationT< ShutterModeEnums >, GenApi::IEnumerationT< SoftwareSignalSelectorEnums >, GenApi::IEnumerationT< SpatialCorrectionStartingLineEnums >, GenApi::IEnumerationT< StatusEnums >, GenApi::IEnumerationT< SyncUserOutputSelectorEnums >, GenApi::IEnumerationT< TemperatureSelectorEnums >, GenApi::IEnumerationT< TemperatureStateEnums >, GenApi::IEnumerationT< TestImageSelectorEnums >, GenApi::IEnumerationT< TestPatternEnums >, GenApi::IEnumerationT< TimerSelectorEnums >, GenApi::IEnumerationT< TimerSequenceEntrySelectorEnums >, GenApi::IEnumerationT< TimerSequenceTimerSelectorEnums >, GenApi::IEnumerationT< TimerTriggerActivationEnums >, GenApi::IEnumerationT< TimerTriggerSourceEnums >, GenApi::IEnumerationT< TransmissionTypeEnums >, GenApi::IEnumerationT< TriggerActivationEnums >, GenApi::IEnumerationT< TriggerControlImplementationEnums >, GenApi::IEnumerationT< TriggerDelaySourceEnums >, GenApi::IEnumerationT< TriggerModeEnums >, GenApi::IEnumerationT< TriggerSelectorEnums >, GenApi::IEnumerationT< TriggerSourceEnums >, GenApi::IEnumerationT< TypeEnums >, GenApi::IEnumerationT< UserDefinedValueSelectorEnums >, GenApi::IEnumerationT< UserOutputSelectorEnums >, GenApi::IEnumerationT< UserSetDefaultEnums >, GenApi::IEnumerationT< UserSetDefaultSelectorEnums >, GenApi::IEnumerationT< UserSetSelectorEnums >, GenApi::IEnumerationT< VInpSignalReadoutActivationEnums >, and GenApi::IEnumerationT< VInpSignalSourceEnums >.

Public Member Functions

virtual void GetSymbolics (StringList_t &Symbolics)=0
 Get list of symbolic Values.
 
virtual void GetEntries (NodeList_t &Entries)=0
 Get list of entry nodes.
 
virtual IEnumerationoperator= (const GenICam::gcstring &ValueStr)=0
 Set string node value.
 
virtual void SetIntValue (int64_t Value, bool Verify=true)=0
 Set integer node value. More...
 
virtual GenICam::gcstring operator* ()=0
 Get string node value.
 
virtual int64_t GetIntValue (bool Verify=false, bool IgnoreCache=false)=0
 Get integer node value. More...
 
virtual IEnumEntryGetEntryByName (const GenICam::gcstring &Symbolic)=0
 Get an entry node by name.
 
virtual IEnumEntryGetEntry (const int64_t IntValue)=0
 Get an entry node by its IntValue.
 
virtual IEnumEntryGetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
 Get the current entry.
 
virtual INodeGetNode ()
 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.
 

Detailed Description

Interface for enumeration properties.

Member Function Documentation

virtual void GenApi::IValue::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
pure virtualinherited

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual int64_t GenApi::IEnumeration::GetIntValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Get integer node value.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read
virtual void GenApi::IEnumeration::SetIntValue ( int64_t  Value,
bool  Verify = true 
)
pure virtual

Set integer node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual GenICam::gcstring GenApi::IValue::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get content of the node as string.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read

The documentation for this struct was generated from the following file:

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)