Types.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 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  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.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM 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 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 GENAPI_TYPES_H
#define GENAPI_TYPES_H

#include <Base/GCTypes.h>
#include <Base/GCStringVector.h>
#include <GenApi/GenApiDll.h>
#include <GenApi/Autovector.h>
#include <GenICamFwd.h>

namespace GENAPI_NAMESPACE
{

    typedef enum _ESign
    {
        Signed,         
        Unsigned,       
        _UndefinedSign  
    } ESign;

    typedef enum _EAccessMode
    {
        NI,        
        NA,        
        WO,        
        RO,        
        RW,        
        _UndefinedAccesMode,    
        _CycleDetectAccesMode   
    } EAccessMode;

    typedef enum _EVisibility
    {
        Beginner = 0,              
        Expert = 1,                
        Guru = 2,                  
        Invisible = 3,             
        _UndefinedVisibility  = 99 
    } EVisibility;

    typedef enum _ECachingMode
    {
        NoCache,              
        WriteThrough,         
        WriteAround,          
        _UndefinedCachingMode 
    } ECachingMode;

    typedef enum _ERepresentation
    {
        Linear,                     
        Logarithmic,                
        Boolean,                    
        PureNumber,                 
        HexNumber,                  
        IPV4Address,                
        MACAddress,                 
        _UndefinedRepresentation
    } ERepresentation;

// this define is required to deal with a spelling error corrected in v1.2
#ifndef NO_UNDEFINEDED_REPRESENTATION
#   define _UndefindedRepresentation _UndefinedRepresentation
#endif

    typedef enum _EEndianess
    {
        BigEndian,        
        LittleEndian,     
        _UndefinedEndian  
    } EEndianess;


    typedef enum _ENameSpace
    {
        Custom,             
        Standard,           
        _UndefinedNameSpace 
    } ENameSpace;


    typedef enum _EStandardNameSpace
    {
        None,            
        GEV,             
        IIDC,            
        CL,              
        USB,             
        _UndefinedStandardNameSpace  
    } EStandardNameSpace;


    typedef enum _EYesNo
    {
        Yes = 1,                
        No = 0,                 
        _UndefinedYesNo = 2     
    } EYesNo;

    typedef GENICAM_NAMESPACE::gcstring_vector StringList_t;


    typedef enum _ESlope
    {
        Increasing,      
        Decreasing,      
        Varying,         
        Automatic,       
        _UndefinedESlope 
    } ESlope;


    typedef enum _EXMLValidation
    {
        xvLoad                   = 0x00000001L,    
        xvCycles                 = 0x00000002L,    
        xvSFNC                   = 0x00000004L,    
        xvDefault                = 0x00000000L,    
        xvAll                    = 0xffffffffL,    
        _UndefinedEXMLValidation = 0x8000000L      
    } EXMLValidation;

    typedef enum _EDisplayNotation
    {
        fnAutomatic,                
        fnFixed,                    
        fnScientific,               
        _UndefinedEDisplayNotation  
    } EDisplayNotation;

    typedef enum _EInterfaceType
    {
        intfIValue,       
        intfIBase,        
        intfIInteger,     
        intfIBoolean,     
        intfICommand,     
        intfIFloat,       
        intfIString,      
        intfIRegister,    
        intfICategory,    
        intfIEnumeration, 
        intfIEnumEntry,   
        intfIPort         
    } EInterfaceType;


    typedef enum _ELinkType
    {
        ctParentNodes,          
        ctReadingChildren,      
        ctWritingChildren,      
        ctInvalidatingChildren, 
        ctDependingNodes,       
        ctTerminalNodes,         
        ctValueChangingChildren  
    } ELinkType;

    typedef enum _EIncMode
    {
        noIncrement,    // !> The feature has no increment
        fixedIncrement, // !> The feature has a fix increment
        listIncrement   // !> The feature has a list of valid value
    } EIncMode;

    typedef enum _EInputDirection
    {
        idFrom, 
        idTo,   
        idNone  
    } EInputDirection;

    typedef enum _EGenApiSchemaVersion
    {
        v1_0 = 1,        
        v1_1 = 2,        
        _Undefined = -1  
    } EGenApiSchemaVersion;

    typedef enum _ECallbackSuppressMode
    {
        csmOff = 0, 
        csmActive,  
        csmOnce     
    } ECallbackSuppressMode;

}

#endif // ifndef GENAPI_TYPES_H