vrforces5.0.3/classref/available_navigation_preferences_admin_8h_source.html

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

 ** Copyright (c) 2008 MAK Technologies, Inc.

 ** All rights reserved.

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


 #pragma once


 #include "vrftasks/adminContent.h"

 #include <list>


 class DT_DLL_vrftasks DtAvailableNavigationPreferencesAdmin : public DtAdminContent

 {

 public:


    DtAvailableNavigationPreferencesAdmin();


    DtAvailableNavigationPreferencesAdmin(const DtAvailableNavigationPreferencesAdmin & orig);


    const DtAvailableNavigationPreferencesAdmin & operator=(const

       DtAvailableNavigationPreferencesAdmin & orig);


    virtual ~DtAvailableNavigationPreferencesAdmin();


    static DtAdminContent* create();


    virtual bool init();


    virtual const DtAdminContentMessageType& type() const;


    virtual const std::list<DtString>& preferencesList() const;

    virtual std::list<DtString>& preferencesList();


    virtual void addPreference(const DtString& preferenceName);

    virtual void clearPreferencesList();


    virtual DtString currentPreference() const;

    virtual void setCurrentPreference(const DtString& preferenceName);


    virtual DtAdminContent * clone() const;


    virtual DtString stringRep() const;


    virtual int netRepSize() const;


    virtual bool setFromNet(const char* contentBuffer,

       unsigned contentSize);


    virtual bool setToNet();


 protected:

    std::list<DtString> myPreferenceList;

    DtString myCurrentPreference;

 };


DtAdminContent::setFromNet
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets the contents of this set request based on the network buffer. Base class does nothing and return...

DtAvailableNavigationPreferencesAdmin::myPreferenceList
std::list< DtString > myPreferenceList
The list of available preference names.
Definition: availableNavigationPreferencesAdmin.h:83

DtAdminContent::netRepSize
virtual int netRepSize() const

DtAdminContent::clone
virtual DtAdminContent * clone() const =0
Make a copy of this content. Returns a pointer to a newly created copy of this class. Derived classes must override this function to create and return an instance of the derived type.

DtVrfObjectMessageTypeTemplate
Definition: vrfObjectMessageTypeTemplate.h:24

DtAvailableNavigationPreferencesAdmin::myCurrentPreference
DtString myCurrentPreference
Definition: availableNavigationPreferencesAdmin.h:84

DtAdminContent::operator=
const DtAdminContent & operator=(const DtAdminContent &orig)
assignment operator; same as copy costructor.

adminContent.h

DtAvailableNavigationPreferencesAdmin
Admin content which contains the list of navigation preferences names that a particular entity has av...
Definition: availableNavigationPreferencesAdmin.h:21

DT_DLL_vrftasks
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26

DtAdminContent::init
virtual bool init()
Base class init does nothing, but this will be called by create, in case any other deriving class nee...

DtAdminContent
DtAdminContent.
Definition: adminContent.h:23

DtAdminContent::type
virtual const DtAdminContentMessageType & type() const =0

DtAdminContent::setToNet
virtual bool setToNet()
Sets netRep buffer to the contents of this set request. Base class does nothing and returns true...

DtAdminContent::stringRep
virtual DtString stringRep() const =0
Get a readable string representation of this content. Derived classes must implement this function...

DtString