DeviceID.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2008 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Fritz Dierks
//  $Header$
//
//  License: This file is published under the license of the EMVA GENICAM_NAMESPACE  Standard Group. 
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'. 
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.GENICAM_NAMESPACE.org) for a full copy.
// 
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM_NAMESPACE STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR  
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM_NAMESPACE STANDARD  GROUP 
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL, 
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO, 
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS; 
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY, 
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) 
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef CLPROTOCOL_DEVICEID_H
#define CLPROTOCOL_DEVICEID_H

#include <Base/GCBase.h>
#include <Base/GCUtilities.h>
#include <GenApi/PortImpl.h>
#include <CLProtocol/ClAllSerial.h>
#include <CLProtocol/CLProtocol.h>
#include <CLProtocol/ISerial.h>
#include <CLProtocol/CVersion.h>
#include <iostream>
#include <fstream>

namespace CLProtocol
{


    class CLPROTOCOL_DECL CDeviceID 
    {
    public:
        static const char* GetTokenSeparator();


        GENICAM_DEPRECATED( static const char* GetTokenSeperator() );

    public:
        CDeviceID();

        bool FromString(const GENICAM_NAMESPACE::gcstring &DeviceID);


        GENICAM_NAMESPACE::gcstring GetDriverDirectory(const bool ReplaceEnvironmentVariables = true) const;

        GENICAM_NAMESPACE::gcstring GetDriverFileName() const;

        GENICAM_NAMESPACE::gcstring GetDriverPath() const;

        GENICAM_NAMESPACE::gcstring GetCameraManufacturer() const;

        GENICAM_NAMESPACE::gcstring GetCameraFamily() const;

        GENICAM_NAMESPACE::gcstring GetCameraModel() const;

        GENICAM_NAMESPACE::gcstring GetCameraVersion() const;

        GENICAM_NAMESPACE::gcstring GetCameraSerialNumber() const;

        GENICAM_NAMESPACE::gcstring GetShortDeviceID() const;

        GENICAM_NAMESPACE::gcstring GetDeviceID(const bool ReplaceEnvironmentVariables = true) const;

    private:
        typedef enum
        {
            didDriverDirectory = 0,
            didDriverFileName = 1,
            didCameraManufacturer = 2,
            didCameraFamily = 3,
            didCameraModel = 4,
            didCameraVersion = 5,
            didCameraSerialNumber = 6
        } EDeviceIDIndex;

        GENICAM_NAMESPACE::gcstring_vector m_DeviceIDTokens;
    };
}
#endif // CLPROTOCOL_DEVICEID_H