Classes | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
AVT::VmbAPI::BaseFeature Class Reference

#include <BaseFeature.h>

Inheritance diagram for AVT::VmbAPI::BaseFeature:
Inheritance graph
[legend]

Classes

struct  FeatureInfo
 
struct  Impl
 

Public Member Functions

 BaseFeature (const VmbFeatureInfo_t *pFeatureInfo, FeatureContainer *pFeatureContainer)
 
IMEXPORT VmbErrorType GetDataType (VmbFeatureDataType &dataType) const
 
virtual IMEXPORT VmbErrorType GetEntry (EnumEntry &entry, const char *pStrEntryName) const
 
IMEXPORT VmbErrorType GetFlags (VmbFeatureFlagsType &flags) const
 
virtual IMEXPORT VmbErrorType GetIncrement (VmbInt64_t &increment) const
 
virtual IMEXPORT VmbErrorType GetIncrement (double &increment) const
 
IMEXPORT VmbErrorType GetPollingTime (VmbUint32_t &pollingTime) const
 
virtual IMEXPORT VmbErrorType GetRange (VmbInt64_t &minimum, VmbInt64_t &maximum) const
 
virtual IMEXPORT VmbErrorType GetRange (double &minimum, double &maximum) const
 
virtual IMEXPORT VmbErrorType GetValue (VmbInt64_t &value) const
 
virtual IMEXPORT VmbErrorType GetValue (double &value) const
 
virtual IMEXPORT VmbErrorType GetValue (bool &value) const
 
IMEXPORT VmbErrorType GetVisibility (VmbFeatureVisibilityType &visibility) const
 
virtual IMEXPORT VmbErrorType HasIncrement (VmbBool_t &incrementSupported) const
 
virtual IMEXPORT VmbErrorType IsCommandDone (bool &isDone) const
 
IMEXPORT VmbErrorType IsReadable (bool &isReadable)
 
IMEXPORT VmbErrorType IsStreamable (bool &isStreamable) const
 
virtual IMEXPORT VmbErrorType IsValueAvailable (const char *pValue, bool &available) const
 
virtual IMEXPORT VmbErrorType IsValueAvailable (const VmbInt64_t value, bool &available) const
 
IMEXPORT VmbErrorType IsWritable (bool &isWritable)
 
IMEXPORT VmbErrorType RegisterObserver (const IFeatureObserverPtr &observer)
 
void ResetFeatureContainer ()
 
virtual IMEXPORT VmbErrorType RunCommand ()
 
virtual IMEXPORT VmbErrorType SetValue (const VmbInt32_t &value)
 
virtual IMEXPORT VmbErrorType SetValue (const VmbInt64_t &value)
 
virtual IMEXPORT VmbErrorType SetValue (const double &value)
 
virtual IMEXPORT VmbErrorType SetValue (const char *pValue)
 
virtual IMEXPORT VmbErrorType SetValue (bool value)
 
IMEXPORT VmbErrorType UnregisterObserver (const IFeatureObserverPtr &observer)
 
virtual ~BaseFeature ()
 
- Public Member Functions inherited from AVT::VmbAPI::BasicLockable
IMEXPORT BasicLockable ()
 
IMEXPORT BasicLockable (MutexPtr pMutex)
 
MutexPtr GetMutex () const
 
void Lock ()
 
void Unlock ()
 
virtual IMEXPORT ~BasicLockable ()
 

Protected Attributes

FeatureInfo m_featureInfo
 
FeatureContainerm_pFeatureContainer
 

Private Member Functions

 BaseFeature ()
 
 BaseFeature (const BaseFeature &)
 
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
 
virtual IMEXPORT VmbErrorType GetEntries (EnumEntry *pEntries, VmbUint32_t &size)
 
virtual 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
 
virtual IMEXPORT VmbErrorType GetValue (char *const pValue, VmbUint32_t &length) const
 
virtual IMEXPORT VmbErrorType GetValue (VmbUchar_t *pValue, VmbUint32_t &size, VmbUint32_t &sizeFilled) const
 
virtual IMEXPORT VmbErrorType GetValues (const char **pValues, VmbUint32_t &size)
 
virtual IMEXPORT VmbErrorType GetValues (VmbInt64_t *pValues, VmbUint32_t &Size)
 
virtual IMEXPORT VmbErrorType SetValue (const VmbUchar_t *pValue, VmbUint32_t size)
 

Private Attributes

Implm_pImpl
 

Friends

class Feature
 

Detailed Description

Definition at line 39 of file BaseFeature.h.

Constructor & Destructor Documentation

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

Definition at line 55 of file BaseFeature.cpp.

AVT::VmbAPI::BaseFeature::~BaseFeature ( )
virtual

Definition at line 103 of file BaseFeature.cpp.

AVT::VmbAPI::BaseFeature::BaseFeature ( )
private

Definition at line 93 of file BaseFeature.cpp.

AVT::VmbAPI::BaseFeature::BaseFeature ( const BaseFeature )
private

Definition at line 98 of file BaseFeature.cpp.

Member Function Documentation

VmbErrorType AVT::VmbAPI::BaseFeature::GetAffectedFeatures ( FeaturePtr pAffectedFeatures,
VmbUint32_t nSize 
)
private

Definition at line 669 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetCategory ( char *const  pCategory,
VmbUint32_t length 
) const
private

Definition at line 517 of file BaseFeature.cpp.

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

Definition at line 503 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetDescription ( char *const  pDescription,
VmbUint32_t length 
) const
private

Definition at line 623 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetDisplayName ( char *const  pDisplayName,
VmbUint32_t length 
) const
private

Definition at line 480 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetEntries ( EnumEntry pEntries,
VmbUint32_t size 
)
privatevirtual

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 385 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetEntry ( EnumEntry entry,
const char *  pStrEntryName 
) const
virtual

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 379 of file BaseFeature.cpp.

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

Definition at line 510 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetIncrement ( VmbInt64_t increment) const
virtual

Reimplemented in AVT::VmbAPI::IntFeature.

Definition at line 342 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetIncrement ( double &  increment) const
virtual

Reimplemented in AVT::VmbAPI::FloatFeature.

Definition at line 348 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetName ( char *const  pName,
VmbUint32_t length 
) const
privatevirtual

Definition at line 457 of file BaseFeature.cpp.

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

Definition at line 540 of file BaseFeature.cpp.

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

Reimplemented in AVT::VmbAPI::IntFeature.

Definition at line 332 of file BaseFeature.cpp.

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

Reimplemented in AVT::VmbAPI::FloatFeature.

Definition at line 366 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetRepresentation ( char *const  pRepresentation,
VmbUint32_t length 
) const
private

Definition at line 570 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetSelectedFeatures ( FeaturePtr pSelectedFeatures,
VmbUint32_t nSize 
)
private

Definition at line 757 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetSFNCNamespace ( char *const  pSFNCNamespace,
VmbUint32_t length 
) const
private

Definition at line 646 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetToolTip ( char *const  pToolTip,
VmbUint32_t length 
) const
private

Definition at line 600 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetUnit ( char *const  pUnit,
VmbUint32_t length 
) const
private

Definition at line 547 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValue ( VmbInt64_t value) const
virtual

Reimplemented in AVT::VmbAPI::EnumFeature, and AVT::VmbAPI::IntFeature.

Definition at line 314 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValue ( double &  value) const
virtual

Reimplemented in AVT::VmbAPI::FloatFeature.

Definition at line 354 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValue ( bool &  value) const
virtual

Reimplemented in AVT::VmbAPI::BoolFeature.

Definition at line 422 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValue ( char *const  pValue,
VmbUint32_t length 
) const
privatevirtual

Reimplemented in AVT::VmbAPI::EnumFeature, and AVT::VmbAPI::StringFeature.

Definition at line 416 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValue ( VmbUchar_t pValue,
VmbUint32_t size,
VmbUint32_t sizeFilled 
) const
privatevirtual

Reimplemented in AVT::VmbAPI::RawFeature.

Definition at line 446 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValues ( const char **  pValues,
VmbUint32_t size 
)
privatevirtual

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 391 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::GetValues ( VmbInt64_t pValues,
VmbUint32_t Size 
)
privatevirtual

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 397 of file BaseFeature.cpp.

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

Definition at line 593 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::HasIncrement ( VmbBool_t incrementSupported) const
virtual

Reimplemented in AVT::VmbAPI::FloatFeature, and AVT::VmbAPI::IntFeature.

Definition at line 337 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::IsCommandDone ( bool &  isDone) const
virtual

Reimplemented in AVT::VmbAPI::CommandFeature.

Definition at line 440 of file BaseFeature.cpp.

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

Definition at line 845 of file BaseFeature.cpp.

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

Definition at line 869 of file BaseFeature.cpp.

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

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 403 of file BaseFeature.cpp.

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

Reimplemented in AVT::VmbAPI::EnumFeature.

Definition at line 409 of file BaseFeature.cpp.

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

Definition at line 857 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::RegisterObserver ( const IFeatureObserverPtr &  observer)

Definition at line 213 of file BaseFeature.cpp.

void AVT::VmbAPI::BaseFeature::ResetFeatureContainer ( )

Definition at line 112 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::RunCommand ( )
virtual

Reimplemented in AVT::VmbAPI::CommandFeature.

Definition at line 434 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( const VmbInt32_t value)
virtual

Definition at line 326 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( const VmbInt64_t value)
virtual

Reimplemented in AVT::VmbAPI::EnumFeature, and AVT::VmbAPI::IntFeature.

Definition at line 320 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( const double &  value)
virtual

Reimplemented in AVT::VmbAPI::FloatFeature.

Definition at line 360 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( const char *  pValue)
virtual

Reimplemented in AVT::VmbAPI::EnumFeature, and AVT::VmbAPI::StringFeature.

Definition at line 373 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( bool  value)
virtual

Reimplemented in AVT::VmbAPI::BoolFeature.

Definition at line 428 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::SetValue ( const VmbUchar_t pValue,
VmbUint32_t  size 
)
privatevirtual

Reimplemented in AVT::VmbAPI::RawFeature.

Definition at line 452 of file BaseFeature.cpp.

VmbErrorType AVT::VmbAPI::BaseFeature::UnregisterObserver ( const IFeatureObserverPtr &  observer)

Definition at line 260 of file BaseFeature.cpp.

Friends And Related Function Documentation

friend class Feature
friend

Definition at line 41 of file BaseFeature.h.

Member Data Documentation

FeatureInfo AVT::VmbAPI::BaseFeature::m_featureInfo
protected

Definition at line 106 of file BaseFeature.h.

FeatureContainer* AVT::VmbAPI::BaseFeature::m_pFeatureContainer
protected

Definition at line 108 of file BaseFeature.h.

Impl* AVT::VmbAPI::BaseFeature::m_pImpl
private

Definition at line 117 of file BaseFeature.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:40