modelgbp Generated OpFlex Model  1.7.0
modelgbp::stp::Config Class Reference
Inheritance diagram for modelgbp::stp::Config:

Public Member Functions

bool isBpduFilterSet ()
 Check whether bpduFilter has been set. More...
 
boost::optional< const uint8_t > getBpduFilter ()
 Get the value of bpduFilter if it has been set. More...
 
const uint8_t getBpduFilter (const uint8_t defaultValue)
 Get the value of bpduFilter if set, otherwise the value of default passed in. More...
 
modelgbp::stp::ConfigsetBpduFilter (const uint8_t newValue)
 Set bpduFilter to the specified value in the currently-active mutator. More...
 
modelgbp::stp::ConfigunsetBpduFilter ()
 Unset bpduFilter in the currently-active mutator. More...
 
bool isBpduGuardSet ()
 Check whether bpduGuard has been set. More...
 
boost::optional< const uint8_t > getBpduGuard ()
 Get the value of bpduGuard if it has been set. More...
 
const uint8_t getBpduGuard (const uint8_t defaultValue)
 Get the value of bpduGuard if set, otherwise the value of default passed in. More...
 
modelgbp::stp::ConfigsetBpduGuard (const uint8_t newValue)
 Set bpduGuard to the specified value in the currently-active mutator. More...
 
modelgbp::stp::ConfigunsetBpduGuard ()
 Unset bpduGuard in the currently-active mutator. More...
 
bool isNameSet ()
 Check whether name has been set. More...
 
boost::optional< const std::string & > getName ()
 Get the value of name if it has been set. More...
 
const std::string & getName (const std::string &defaultValue)
 Get the value of name if set, otherwise the value of default passed in. More...
 
modelgbp::stp::ConfigsetName (const std::string &newValue)
 Set name to the specified value in the currently-active mutator. More...
 
modelgbp::stp::ConfigunsetName ()
 Unset name in the currently-active mutator. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 Config (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of Config. More...
 

Static Public Member Functions

static boost::optional< OF_SHARED_PTR< modelgbp::stp::Config > > resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of Config from the managed object store. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::stp::Config > > resolve (const opflex::modb::URI &uri)
 Retrieve an instance of Config from the managed object store using the default framework instance. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::stp::Config > > resolve (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName)
 Retrieve an instance of Config from the managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::stp::Config > > resolve (const std::string &platformConfigName)
 Retrieve an instance of Config from the default managed object store by constructing its URI from the path elements that lead to it. More...
 
static void remove (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Remove the Config object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the Config object with the specified URI using the currently-active mutator and the default framework instance. More...
 
static void remove (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName)
 Remove the Config object with the specified path elements from the managed object store. More...
 
static void remove (const std::string &platformConfigName)
 Remove the Config object with the specified path elements from the managed object store using the default framework instance. More...
 
static void registerListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
 Register a listener that will get called for changes related to this class. More...
 
static void registerListener (opflex::modb::ObjectListener *listener)
 Register a listener that will get called for changes related to this class with the default framework instance. More...
 
static void unregisterListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
 Unregister a listener from updates to this class. More...
 
static void unregisterListener (opflex::modb::ObjectListener *listener)
 Unregister a listener from updates to this class from the default framework instance. More...
 

Static Public Attributes

static const opflex::modb::class_id_t CLASS_ID = 80
 The unique class ID for Config.
 

Constructor & Destructor Documentation

◆ Config()

modelgbp::stp::Config::Config ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri,
const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &  oi 
)
inline

Construct an instance of Config.

This should not typically be called from user code.

Member Function Documentation

◆ getBpduFilter() [1/2]

boost::optional<const uint8_t> modelgbp::stp::Config::getBpduFilter ( )
inline

Get the value of bpduFilter if it has been set.

Returns
the value of bpduFilter or boost::none if not set

References isBpduFilterSet().

Referenced by getBpduFilter().

◆ getBpduFilter() [2/2]

const uint8_t modelgbp::stp::Config::getBpduFilter ( const uint8_t  defaultValue)
inline

Get the value of bpduFilter if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of bpduFilter if set, otherwise the value of default passed in

References getBpduFilter().

◆ getBpduGuard() [1/2]

boost::optional<const uint8_t> modelgbp::stp::Config::getBpduGuard ( )
inline

Get the value of bpduGuard if it has been set.

Returns
the value of bpduGuard or boost::none if not set

References isBpduGuardSet().

Referenced by getBpduGuard().

◆ getBpduGuard() [2/2]

const uint8_t modelgbp::stp::Config::getBpduGuard ( const uint8_t  defaultValue)
inline

Get the value of bpduGuard if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of bpduGuard if set, otherwise the value of default passed in

References getBpduGuard().

◆ getName() [1/2]

boost::optional<const std::string&> modelgbp::stp::Config::getName ( )
inline

Get the value of name if it has been set.

Returns
the value of name or boost::none if not set

References isNameSet().

Referenced by getName().

◆ getName() [2/2]

const std::string& modelgbp::stp::Config::getName ( const std::string &  defaultValue)
inline

Get the value of name if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of name if set, otherwise the value of default passed in

References getName().

◆ isBpduFilterSet()

bool modelgbp::stp::Config::isBpduFilterSet ( )
inline

Check whether bpduFilter has been set.

Returns
true if bpduFilter has been set

Referenced by getBpduFilter().

◆ isBpduGuardSet()

bool modelgbp::stp::Config::isBpduGuardSet ( )
inline

Check whether bpduGuard has been set.

Returns
true if bpduGuard has been set

Referenced by getBpduGuard().

◆ isNameSet()

bool modelgbp::stp::Config::isNameSet ( )
inline

Check whether name has been set.

Returns
true if name has been set

Referenced by getName().

◆ registerListener() [1/2]

static void modelgbp::stp::Config::registerListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Register a listener that will get called for changes related to this class.

This listener will be called for any modifications of this class or any transitive children of this class.

Parameters
frameworkthe framework instance
listenerthe listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered.

References CLASS_ID.

Referenced by registerListener().

◆ registerListener() [2/2]

static void modelgbp::stp::Config::registerListener ( opflex::modb::ObjectListener *  listener)
inlinestatic

Register a listener that will get called for changes related to this class with the default framework instance.

This listener will be called for any modifications of this class or any transitive children of this class.

Parameters
listenerthe listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered.

References registerListener().

◆ remove() [1/5]

void modelgbp::stp::Config::remove ( )
inline

Remove this instance using the currently-active mutator.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [2/5]

static void modelgbp::stp::Config::remove ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

Remove the Config object with the specified URI using the currently-active mutator.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Parameters
frameworkthe framework instance to use
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [3/5]

static void modelgbp::stp::Config::remove ( const opflex::modb::URI &  uri)
inlinestatic

Remove the Config object with the specified URI using the currently-active mutator and the default framework instance.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Parameters
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active

◆ remove() [4/5]

static void modelgbp::stp::Config::remove ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName 
)
inlinestatic

Remove the Config object with the specified path elements from the managed object store.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

The object URI generated by this function will take the form: /PolicyUniverse/PlatformConfig/[platformConfigName]/StpConfig

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [5/5]

static void modelgbp::stp::Config::remove ( const std::string &  platformConfigName)
inlinestatic

Remove the Config object with the specified path elements from the managed object store using the default framework instance.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

The object URI generated by this function will take the form: /PolicyUniverse/PlatformConfig/[platformConfigName]/StpConfig

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
Exceptions
std::logic_errorif no mutator is active

◆ resolve() [1/4]

static boost::optional<OF_SHARED_PTR<modelgbp::stp::Config> > modelgbp::stp::Config::resolve ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

Retrieve an instance of Config from the managed object store.

If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.

Parameters
frameworkthe framework instance to use
urithe URI of the object to retrieve
Returns
a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID.

Referenced by resolve(), and modelgbp::platform::Config::resolveStpConfig().

◆ resolve() [2/4]

static boost::optional<OF_SHARED_PTR<modelgbp::stp::Config> > modelgbp::stp::Config::resolve ( const opflex::modb::URI &  uri)
inlinestatic

Retrieve an instance of Config from the managed object store using the default framework instance.

If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.

Parameters
urithe URI of the object to retrieve
Returns
a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID.

◆ resolve() [3/4]

static boost::optional<OF_SHARED_PTR<modelgbp::stp::Config> > modelgbp::stp::Config::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName 
)
inlinestatic

Retrieve an instance of Config from the managed object store by constructing its URI from the path elements that lead to it.

If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.

The object URI generated by this function will take the form: /PolicyUniverse/PlatformConfig/[platformConfigName]/StpConfig

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolve() [4/4]

static boost::optional<OF_SHARED_PTR<modelgbp::stp::Config> > modelgbp::stp::Config::resolve ( const std::string &  platformConfigName)
inlinestatic

Retrieve an instance of Config from the default managed object store by constructing its URI from the path elements that lead to it.

If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.

The object URI generated by this function will take the form: /PolicyUniverse/PlatformConfig/[platformConfigName]/StpConfig

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ setBpduFilter()

modelgbp::stp::Config& modelgbp::stp::Config::setBpduFilter ( const uint8_t  newValue)
inline

Set bpduFilter to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setBpduGuard()

modelgbp::stp::Config& modelgbp::stp::Config::setBpduGuard ( const uint8_t  newValue)
inline

Set bpduGuard to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setName()

modelgbp::stp::Config& modelgbp::stp::Config::setName ( const std::string &  newValue)
inline

Set name to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ unregisterListener() [1/2]

static void modelgbp::stp::Config::unregisterListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Unregister a listener from updates to this class.

Parameters
frameworkthe framework instance
listenerThe listener to unregister.

References CLASS_ID.

Referenced by unregisterListener().

◆ unregisterListener() [2/2]

static void modelgbp::stp::Config::unregisterListener ( opflex::modb::ObjectListener *  listener)
inlinestatic

Unregister a listener from updates to this class from the default framework instance.

Parameters
listenerThe listener to unregister.

References unregisterListener().

◆ unsetBpduFilter()

modelgbp::stp::Config& modelgbp::stp::Config::unsetBpduFilter ( )
inline

Unset bpduFilter in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetBpduGuard()

modelgbp::stp::Config& modelgbp::stp::Config::unsetBpduGuard ( )
inline

Unset bpduGuard in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetName()

modelgbp::stp::Config& modelgbp::stp::Config::unsetName ( )
inline

Unset name in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

The documentation for this class was generated from the following file: