Public Member Functions | Private Member Functions | Private Attributes | List of all members
AVT::VmbAPI::Feature Class Reference

#include <Feature.h>

Public Member Functions

 Feature (const VmbFeatureInfo_t *pFeatureInfo, FeatureContainer *pFeatureContainer)
 
VmbErrorType GetAffectedFeatures (FeaturePtrVector &affectedFeatures)
 
VmbErrorType GetCategory (std::string &category) const
 
IMEXPORT VmbErrorType GetDataType (VmbFeatureDataType &dataType) const
 
VmbErrorType GetDescription (std::string &description) const
 
VmbErrorType GetDisplayName (std::string &displayName) const
 
VmbErrorType GetEntries (EnumEntryVector &entries)
 
IMEXPORT VmbErrorType GetEntry (EnumEntry &entry, const char *pEntryName) const
 
IMEXPORT VmbErrorType GetFlags (VmbFeatureFlagsType &flags) const
 
IMEXPORT VmbErrorType GetIncrement (VmbInt64_t &increment) const
 
IMEXPORT VmbErrorType GetIncrement (double &increment) const
 
VmbErrorType GetName (std::string &name) const
 
IMEXPORT VmbErrorType GetPollingTime (VmbUint32_t &pollingTime) const
 
IMEXPORT VmbErrorType GetRange (double &minimum, double &maximum) const
 
IMEXPORT VmbErrorType GetRange (VmbInt64_t &minimum, VmbInt64_t &maximum) const
 
VmbErrorType GetRepresentation (std::string &representation) const
 
VmbErrorType GetSelectedFeatures (FeaturePtrVector &selectedFeatures)
 
VmbErrorType GetSFNCNamespace (std::string &sFNCNamespace) const
 
VmbErrorType GetToolTip (std::string &toolTip) const
 
VmbErrorType GetUnit (std::string &unit) const
 
IMEXPORT VmbErrorType GetValue (VmbInt64_t &value) const
 
IMEXPORT VmbErrorType GetValue (double &value) const
 
VmbErrorType GetValue (std::string &value) const
 
IMEXPORT VmbErrorType GetValue (bool &value) const
 
VmbErrorType GetValue (UcharVector &value) const
 
VmbErrorType GetValue (UcharVector &value, VmbUint32_t &sizeFilled) const
 
VmbErrorType GetValues (Int64Vector &values)
 
VmbErrorType GetValues (StringVector &values)
 
IMEXPORT VmbErrorType GetVisibility (VmbFeatureVisibilityType &visibility) const
 
IMEXPORT VmbErrorType HasIncrement (VmbBool_t &incrementSupported) const
 
IMEXPORT VmbErrorType IsCommandDone (bool &isDone) const
 
IMEXPORT VmbErrorType IsReadable (bool &isReadable)
 
IMEXPORT VmbErrorType IsStreamable (bool &isStreamable) const
 
IMEXPORT VmbErrorType IsValueAvailable (const char *pValue, bool &available) const
 
IMEXPORT VmbErrorType IsValueAvailable (const VmbInt64_t value, bool &available) const
 
IMEXPORT VmbErrorType IsWritable (bool &isWritable)
 
IMEXPORT VmbErrorType RegisterObserver (const IFeatureObserverPtr &pObserver)
 
void ResetFeatureContainer ()
 
IMEXPORT VmbErrorType RunCommand ()
 
IMEXPORT VmbErrorType SetValue (const VmbInt32_t &value)
 
IMEXPORT VmbErrorType SetValue (const VmbInt64_t &value)
 
IMEXPORT VmbErrorType SetValue (const double &value)
 
IMEXPORT VmbErrorType SetValue (const char *pValue)
 
IMEXPORT VmbErrorType SetValue (bool value)
 
VmbErrorType SetValue (const UcharVector &value)
 
IMEXPORT VmbErrorType UnregisterObserver (const IFeatureObserverPtr &pObserver)
 
virtual ~Feature ()
 

Private Member Functions

 Feature ()
 
 Feature (const Feature &)
 
IMEXPORT VmbErrorType GetAffectedFeatures (FeaturePtr *pAffectedFeatures, VmbUint32_t &nSize)
 
IMEXPORT VmbErrorType GetCategory (char *const pCategory, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetDescription (char *const pDescription, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetDisplayName (char *const pDisplayName, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetEntries (EnumEntry *pEnumEntries, VmbUint32_t &size)
 
IMEXPORT VmbErrorType GetName (char *const pName, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetRepresentation (char *const pRepresentation, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetSelectedFeatures (FeaturePtr *pSelectedFeatures, VmbUint32_t &nSize)
 
IMEXPORT VmbErrorType GetSFNCNamespace (char *const pSFNCNamespace, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetToolTip (char *const pToolTip, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetUnit (char *const pUnit, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetValue (char *const pValue, VmbUint32_t &length) const
 
IMEXPORT VmbErrorType GetValue (VmbUchar_t *pValue, VmbUint32_t &size, VmbUint32_t &sizeFilled) const
 
IMEXPORT VmbErrorType GetValues (const char **pValues, VmbUint32_t &size)
 
IMEXPORT VmbErrorType GetValues (VmbInt64_t *pValues, VmbUint32_t &Size)
 
Featureoperator= (const Feature &)
 
IMEXPORT VmbErrorType SetValue (const VmbUchar_t *pValue, VmbUint32_t size)
 

Private Attributes

BaseFeaturem_pImpl
 

Detailed Description

Definition at line 51 of file Feature.h.

Constructor & Destructor Documentation

AVT::VmbAPI::Feature::Feature ( const VmbFeatureInfo_t pFeatureInfo,
FeatureContainer pFeatureContainer 
)

Definition at line 43 of file Feature.cpp.

AVT::VmbAPI::Feature::~Feature ( )
virtual

Definition at line 80 of file Feature.cpp.

AVT::VmbAPI::Feature::Feature ( )
private

Definition at line 70 of file Feature.cpp.

AVT::VmbAPI::Feature::Feature ( const Feature )
private

Definition at line 75 of file Feature.cpp.

Member Function Documentation

VmbErrorType AVT::VmbAPI::Feature::GetAffectedFeatures ( FeaturePtrVector affectedFeatures)
VmbErrorType AVT::VmbAPI::Feature::GetAffectedFeatures ( FeaturePtr pAffectedFeatures,
VmbUint32_t nSize 
)
private

Definition at line 303 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetCategory ( std::string &  category) const
VmbErrorType AVT::VmbAPI::Feature::GetCategory ( char *const  pCategory,
VmbUint32_t length 
) const
private

Definition at line 263 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetDataType ( VmbFeatureDataType dataType) const

Definition at line 253 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetDescription ( std::string &  description) const
VmbErrorType AVT::VmbAPI::Feature::GetDescription ( char *const  pDescription,
VmbUint32_t length 
) const
private

Definition at line 293 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetDisplayName ( std::string &  displayName) const
VmbErrorType AVT::VmbAPI::Feature::GetDisplayName ( char *const  pDisplayName,
VmbUint32_t length 
) const
private

Definition at line 248 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetEntries ( EnumEntryVector entries)
VmbErrorType AVT::VmbAPI::Feature::GetEntries ( EnumEntry pEnumEntries,
VmbUint32_t size 
)
private

Definition at line 184 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetEntry ( EnumEntry entry,
const char *  pEntryName 
) const

Definition at line 178 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetFlags ( VmbFeatureFlagsType flags) const

Definition at line 258 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetIncrement ( VmbInt64_t increment) const

Definition at line 129 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetIncrement ( double &  increment) const

Definition at line 135 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetName ( std::string &  name) const
VmbErrorType AVT::VmbAPI::Feature::GetName ( char *const  pName,
VmbUint32_t length 
) const
private

Definition at line 243 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetPollingTime ( VmbUint32_t pollingTime) const

Definition at line 268 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetRange ( double &  minimum,
double &  maximum 
) const

Definition at line 153 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetRange ( VmbInt64_t minimum,
VmbInt64_t maximum 
) const

Definition at line 119 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetRepresentation ( std::string &  representation) const
VmbErrorType AVT::VmbAPI::Feature::GetRepresentation ( char *const  pRepresentation,
VmbUint32_t length 
) const
private

Definition at line 278 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetSelectedFeatures ( FeaturePtrVector selectedFeatures)
VmbErrorType AVT::VmbAPI::Feature::GetSelectedFeatures ( FeaturePtr pSelectedFeatures,
VmbUint32_t nSize 
)
private

Definition at line 308 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetSFNCNamespace ( std::string &  sFNCNamespace) const
VmbErrorType AVT::VmbAPI::Feature::GetSFNCNamespace ( char *const  pSFNCNamespace,
VmbUint32_t length 
) const
private

Definition at line 298 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetToolTip ( std::string &  toolTip) const
VmbErrorType AVT::VmbAPI::Feature::GetToolTip ( char *const  pToolTip,
VmbUint32_t length 
) const
private

Definition at line 288 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetUnit ( std::string &  unit) const
VmbErrorType AVT::VmbAPI::Feature::GetUnit ( char *const  pUnit,
VmbUint32_t length 
) const
private

Definition at line 273 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValue ( VmbInt64_t value) const

Definition at line 101 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValue ( double &  value) const

Definition at line 141 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValue ( std::string &  value) const
VmbErrorType AVT::VmbAPI::Feature::GetValue ( bool &  value) const

Definition at line 208 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValue ( UcharVector value) const
VmbErrorType AVT::VmbAPI::Feature::GetValue ( UcharVector value,
VmbUint32_t sizeFilled 
) const
VmbErrorType AVT::VmbAPI::Feature::GetValue ( char *const  pValue,
VmbUint32_t length 
) const
private

Definition at line 202 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValue ( VmbUchar_t pValue,
VmbUint32_t size,
VmbUint32_t sizeFilled 
) const
private

Definition at line 232 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValues ( Int64Vector values)
VmbErrorType AVT::VmbAPI::Feature::GetValues ( StringVector values)
VmbErrorType AVT::VmbAPI::Feature::GetValues ( const char **  pValues,
VmbUint32_t size 
)
private

Definition at line 166 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetValues ( VmbInt64_t pValues,
VmbUint32_t Size 
)
private

Definition at line 172 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::GetVisibility ( VmbFeatureVisibilityType visibility) const

Definition at line 283 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::HasIncrement ( VmbBool_t incrementSupported) const

Definition at line 124 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsCommandDone ( bool &  isDone) const

Definition at line 226 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsReadable ( bool &  isReadable)

Definition at line 313 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsStreamable ( bool &  isStreamable) const

Definition at line 323 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsValueAvailable ( const char *  pValue,
bool &  available 
) const

Definition at line 190 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsValueAvailable ( const VmbInt64_t  value,
bool &  available 
) const

Definition at line 196 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::IsWritable ( bool &  isWritable)

Definition at line 318 of file Feature.cpp.

Feature& AVT::VmbAPI::Feature::operator= ( const Feature )
private
VmbErrorType AVT::VmbAPI::Feature::RegisterObserver ( const IFeatureObserverPtr &  pObserver)

Definition at line 90 of file Feature.cpp.

void AVT::VmbAPI::Feature::ResetFeatureContainer ( )

Definition at line 85 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::RunCommand ( )

Definition at line 220 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( const VmbInt32_t value)

Definition at line 113 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( const VmbInt64_t value)

Definition at line 107 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( const double &  value)

Definition at line 147 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( const char *  pValue)

Definition at line 160 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( bool  value)

Definition at line 214 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::SetValue ( const UcharVector value)
VmbErrorType AVT::VmbAPI::Feature::SetValue ( const VmbUchar_t pValue,
VmbUint32_t  size 
)
private

Definition at line 238 of file Feature.cpp.

VmbErrorType AVT::VmbAPI::Feature::UnregisterObserver ( const IFeatureObserverPtr &  pObserver)

Definition at line 95 of file Feature.cpp.

Member Data Documentation

BaseFeature* AVT::VmbAPI::Feature::m_pImpl
private

Definition at line 577 of file Feature.h.


The documentation for this class was generated from the following files:


avt_vimba_camera
Author(s): Miquel Massot , Allied Vision Technologies
autogenerated on Wed Jun 5 2019 22:22:41