Category.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_CATEGORY_H
#define GENAPI_CATEGORY_H

#include "../ICategory.h"
#include "Node.h"
#include "BaseT.h"
#include "ValueT.h"
#include "NodeT.h"
#include "NodeMap.h"

namespace GENAPI_NAMESPACE
{

    //*************************************************************
    // CCategory class
    //*************************************************************

    class CCategoryImpl : public CNodeImpl, public ICategory
    {
    public:

        CCategoryImpl();

        //-------------------------------------------------------------
        // IValue implementation (partial only)
        //-------------------------------------------------------------

    protected:
        virtual INode* InternalGetNode();

        virtual GENICAM_NAMESPACE::gcstring InternalToString(bool /*Verify = false*/, bool /*IgnoreCache = false*/)
        {
            return InternalGetNode()->GetDisplayName();
        }

        #pragma BullseyeCoverage off
        virtual void InternalFromString(const GENICAM_NAMESPACE::gcstring& /*ValueStr*/, bool /*Verify*/ )
        {
            // Categories are read-only
            assert(false);
        }
        #pragma BullseyeCoverage on
        virtual void Override(EVisibility newVisibility);
    public:
        //-------------------------------------------------------------
        // ICategory implementation
        //-------------------------------------------------------------

        virtual void GetFeatures(FeatureList_t &Features) const;

        
        virtual void SetProperty( CProperty &Property );
        virtual bool GetProperty(CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const;
        
        virtual void FinalConstruct();

        virtual EAccessMode InternalGetAccessMode() const;

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfICategory;
        }

        void SetInvalid(ESetInvalidMode simMode);

        FeatureList_t m_Features;
    };

    class CCategory : public BaseT< ValueT< NodeT< CCategoryImpl > > >
    {
    };

}

#endif // ifndef GENAPI_CATEGORY_H