doc/sdk/_pv_gen_parameter_array_8h_source.html

// *****************************************************************************

//

//     Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.

//

// *****************************************************************************


#ifndef __PVGENPARAMETERARRAY_H__

#define __PVGENPARAMETERARRAY_H__


#include <PvGenICamLib.h>

#include <PvGenString.h>

#include <PvGenInteger.h>

#include <PvGenEnum.h>

#include <PvGenFloat.h>

#include <PvGenCommand.h>

#include <PvGenBoolean.h>

#include <PvGenRegister.h>

#include <PvGenCategory.h>


namespace PvGenICamLib

{

    class GenParameterArray;

    class GenParameterArrayManager;

}


namespace PvDeviceLib

{

    class Device;

}


class PvGenFile;

class PvConfigurationWriter;

class PvConfigurationReader;


class PvGenParameterArray

{

public:


    PV_GENICAM_API PvGenParameterArray();


    PV_GENICAM_API virtual ~PvGenParameterArray();


    PV_GENICAM_API uint32_t GetCount() const;


    PV_GENICAM_API PvGenParameter *Get( uint32_t aIndex );


    PV_GENICAM_API PvGenParameter *Get( const PvString &aName );


    PV_GENICAM_API PvGenParameter *operator[]( uint32_t aIndex );


    PV_GENICAM_API PvGenParameter *operator[]( const PvString &aName );


    PV_GENICAM_API uint32_t GetCategoryCount() const;


    PV_GENICAM_API PvGenCategory *GetCategory( uint32_t aIndex );


    PV_GENICAM_API PvGenCategory *GetCategory( const PvString &aName );


    PV_GENICAM_API PvResult InvalidateCache();


    PV_GENICAM_API PV_GENAPI_NS::INodeMap *GetNodeMap();


    PV_GENICAM_API PvGenInteger *GetInteger( const PvString &aName );


    PV_GENICAM_API PvGenFloat *GetFloat( const PvString &aName );


    PV_GENICAM_API PvGenEnum *GetEnum( const PvString &aName );


    PV_GENICAM_API PvGenBoolean *GetBoolean( const PvString &aName );


    PV_GENICAM_API PvGenCommand *GetCommand( const PvString &aName );


    PV_GENICAM_API PvGenString *GetString( const PvString &aName );


    PV_GENICAM_API PvGenRegister *GetRegister( const PvString &aName );


    PV_GENICAM_API PvResult GetIntegerValue( const PvString &aName, int64_t &aValue );


    PV_GENICAM_API PvResult SetIntegerValue( const PvString &aName, int64_t aValue );


    PV_GENICAM_API PvResult GetFloatValue( const PvString &aName, double &aValue );


    PV_GENICAM_API PvResult SetFloatValue( const PvString &aName, double aValue );


    PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, PvString &aValue );


    PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, int64_t &aValue );


    PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, const PvString &aValue );


    PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, int64_t aValue );


    PV_GENICAM_API PvResult GetBooleanValue( const PvString &aName, bool &aValue );


    PV_GENICAM_API PvResult SetBooleanValue( const PvString &aName, bool aValue );


    PV_GENICAM_API PvResult GetStringValue( const PvString &aName, PvString &aValue );


    PV_GENICAM_API PvResult SetStringValue( const PvString &aName, const PvString &aValue );


    PV_GENICAM_API PvResult ExecuteCommand( const PvString &aName );


    PV_GENICAM_API PvResult GetIntegerRange( const PvString &aName, int64_t &aMin, int64_t &aMax );


    PV_GENICAM_API PvResult GetFloatRange( const PvString &aName, double &aMin, double &aMax );


    PV_GENICAM_API PvResult AttachDataChunks( uint8_t *aBuffer, uint32_t aBufferLength );


    PV_GENICAM_API PvResult DetachDataChunks();


    PV_GENICAM_API PvGenAccessMode GetAccessMode() const;


    PV_GENICAM_API PvResult Poll();


protected:


    PvGenICamLib::GenParameterArray *mThis;


private:


    friend class PvGenFile;

    friend class PvConfigurationWriter;

    friend class PvConfigurationReader;

    friend class PvGenICamLib::GenParameterArrayManager;

    friend class PvDeviceLib::Device;


     // Not implemented

    PvGenParameterArray( const PvGenParameterArray & );

    const PvGenParameterArray &operator=( const PvGenParameterArray & );


};


#endif