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

Public Member Functions

bool isEncapTypeSet ()
 Check whether encapType has been set. More...
 
boost::optional< const uint8_t > getEncapType ()
 Get the value of encapType if it has been set. More...
 
const uint8_t getEncapType (const uint8_t defaultValue)
 Get the value of encapType if set, otherwise the value of default passed in. More...
 
modelgbp::platform::ConfigsetEncapType (const uint8_t newValue)
 Set encapType to the specified value in the currently-active mutator. More...
 
modelgbp::platform::ConfigunsetEncapType ()
 Unset encapType in the currently-active mutator. More...
 
bool isModeSet ()
 Check whether mode has been set. More...
 
boost::optional< const uint8_t > getMode ()
 Get the value of mode if it has been set. More...
 
const uint8_t getMode (const uint8_t defaultValue)
 Get the value of mode if set, otherwise the value of default passed in. More...
 
modelgbp::platform::ConfigsetMode (const uint8_t newValue)
 Set mode to the specified value in the currently-active mutator. More...
 
modelgbp::platform::ConfigunsetMode ()
 Unset mode in the currently-active mutator. More...
 
bool isMulticastGroupIPSet ()
 Check whether multicastGroupIP has been set. More...
 
boost::optional< const
std::string & > 
getMulticastGroupIP ()
 Get the value of multicastGroupIP if it has been set. More...
 
const std::string & getMulticastGroupIP (const std::string &defaultValue)
 Get the value of multicastGroupIP if set, otherwise the value of default passed in. More...
 
modelgbp::platform::ConfigsetMulticastGroupIP (const std::string &newValue)
 Set multicastGroupIP to the specified value in the currently-active mutator. More...
 
modelgbp::platform::ConfigunsetMulticastGroupIP ()
 Unset multicastGroupIP 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::platform::ConfigsetName (const std::string &newValue)
 Set name to the specified value in the currently-active mutator. More...
 
modelgbp::platform::ConfigunsetName ()
 Unset name in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::gbpe::SNATIPPool > > 
resolveGbpeSNATIPPool (const std::string &gbpeSNATIPPoolName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::gbpe::SNATIPPool
addGbpeSNATIPPool (const std::string &gbpeSNATIPPoolName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveGbpeSNATIPPool (std::vector< OF_SHARED_PTR< modelgbp::gbpe::SNATIPPool > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbpe::SNATIPPool. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::cdp::Config > > 
resolveCdpConfig ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::cdp::Config
addCdpConfig ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::dfw::Config > > 
resolveDfwConfig ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::dfw::Config
addDfwConfig ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::domain::ConfigFromConfigRTgt > > 
resolveDomainConfigFromConfigRTgt (const std::string &domainConfigFromConfigRTgtSource)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::domain::ConfigFromConfigRTgt
addDomainConfigFromConfigRTgt (const std::string &domainConfigFromConfigRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveDomainConfigFromConfigRTgt (std::vector< OF_SHARED_PTR< modelgbp::domain::ConfigFromConfigRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::domain::ConfigFromConfigRTgt. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::l2::Config > > 
resolveL2Config ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::l2::Config
addL2Config ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::lacp::Config > > 
resolveLacpConfig ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::lacp::Config
addLacpConfig ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::lldp::Config > > 
resolveLldpConfig ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::lldp::Config
addLldpConfig ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::span::SrcGrp > > 
resolveSpanSrcGrp (const std::string &spanSrcGrpName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::span::SrcGrp
addSpanSrcGrp (const std::string &spanSrcGrpName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveSpanSrcGrp (std::vector< OF_SHARED_PTR< modelgbp::span::SrcGrp > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::span::SrcGrp. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::span::DstGrp > > 
resolveSpanDstGrp (const std::string &spanDstGrpName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::span::DstGrp
addSpanDstGrp (const std::string &spanDstGrpName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveSpanDstGrp (std::vector< OF_SHARED_PTR< modelgbp::span::DstGrp > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::span::DstGrp. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::span::LocalEp > > 
resolveSpanLocalEp (const std::string &spanLocalEpName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::span::LocalEp
addSpanLocalEp (const std::string &spanLocalEpName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveSpanLocalEp (std::vector< OF_SHARED_PTR< modelgbp::span::LocalEp > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::span::LocalEp. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::stp::Config > > 
resolveStpConfig ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::stp::Config
addStpConfig ()
 Create a new child object with the specified naming properties and make it a child of this object 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::platform::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::platform::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::platform::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::platform::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 = 51
 The unique class ID for Config.
 

Constructor & Destructor Documentation

modelgbp::platform::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

OF_SHARED_PTR<modelgbp::cdp::Config> modelgbp::platform::Config::addCdpConfig ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::dfw::Config> modelgbp::platform::Config::addDfwConfig ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::domain::ConfigFromConfigRTgt> modelgbp::platform::Config::addDomainConfigFromConfigRTgt ( const std::string &  domainConfigFromConfigRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
domainConfigFromConfigRTgtSourcethe value of domainConfigFromConfigRTgtSource, a naming property for ConfigFromConfigRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::gbpe::SNATIPPool> modelgbp::platform::Config::addGbpeSNATIPPool ( const std::string &  gbpeSNATIPPoolName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpeSNATIPPoolNamethe value of gbpeSNATIPPoolName, a naming property for SNATIPPool
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::l2::Config> modelgbp::platform::Config::addL2Config ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::lacp::Config> modelgbp::platform::Config::addLacpConfig ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::lldp::Config> modelgbp::platform::Config::addLldpConfig ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::span::DstGrp> modelgbp::platform::Config::addSpanDstGrp ( const std::string &  spanDstGrpName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::span::LocalEp> modelgbp::platform::Config::addSpanLocalEp ( const std::string &  spanLocalEpName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
spanLocalEpNamethe value of spanLocalEpName, a naming property for LocalEp
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::span::SrcGrp> modelgbp::platform::Config::addSpanSrcGrp ( const std::string &  spanSrcGrpName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::stp::Config> modelgbp::platform::Config::addStpConfig ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

boost::optional<const uint8_t> modelgbp::platform::Config::getEncapType ( )
inline

Get the value of encapType if it has been set.

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

References isEncapTypeSet().

Referenced by getEncapType().

const uint8_t modelgbp::platform::Config::getEncapType ( const uint8_t  defaultValue)
inline

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

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

References getEncapType().

boost::optional<const uint8_t> modelgbp::platform::Config::getMode ( )
inline

Get the value of mode if it has been set.

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

References isModeSet().

Referenced by getMode().

const uint8_t modelgbp::platform::Config::getMode ( const uint8_t  defaultValue)
inline

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

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

References getMode().

boost::optional<const std::string&> modelgbp::platform::Config::getMulticastGroupIP ( )
inline

Get the value of multicastGroupIP if it has been set.

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

References isMulticastGroupIPSet().

Referenced by getMulticastGroupIP().

const std::string& modelgbp::platform::Config::getMulticastGroupIP ( const std::string &  defaultValue)
inline

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

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

References getMulticastGroupIP().

boost::optional<const std::string&> modelgbp::platform::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().

const std::string& modelgbp::platform::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().

bool modelgbp::platform::Config::isEncapTypeSet ( )
inline

Check whether encapType has been set.

Returns
true if encapType has been set

Referenced by getEncapType().

bool modelgbp::platform::Config::isModeSet ( )
inline

Check whether mode has been set.

Returns
true if mode has been set

Referenced by getMode().

bool modelgbp::platform::Config::isMulticastGroupIPSet ( )
inline

Check whether multicastGroupIP has been set.

Returns
true if multicastGroupIP has been set

Referenced by getMulticastGroupIP().

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

Check whether name has been set.

Returns
true if name has been set

Referenced by getName().

static void modelgbp::platform::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().

static void modelgbp::platform::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().

void modelgbp::platform::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.

static void modelgbp::platform::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.

static void modelgbp::platform::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
static void modelgbp::platform::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]

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.

static void modelgbp::platform::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]

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
Exceptions
std::logic_errorif no mutator is active
static boost::optional<OF_SHARED_PTR<modelgbp::platform::Config> > modelgbp::platform::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::policy::Universe::resolvePlatformConfig().

static boost::optional<OF_SHARED_PTR<modelgbp::platform::Config> > modelgbp::platform::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.

static boost::optional<OF_SHARED_PTR<modelgbp::platform::Config> > modelgbp::platform::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]

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().

static boost::optional<OF_SHARED_PTR<modelgbp::platform::Config> > modelgbp::platform::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]

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().

boost::optional<OF_SHARED_PTR<modelgbp::cdp::Config> > modelgbp::platform::Config::resolveCdpConfig ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::cdp::Config::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::dfw::Config> > modelgbp::platform::Config::resolveDfwConfig ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::dfw::Config::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::domain::ConfigFromConfigRTgt> > modelgbp::platform::Config::resolveDomainConfigFromConfigRTgt ( const std::string &  domainConfigFromConfigRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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
domainConfigFromConfigRTgtSourcethe value of domainConfigFromConfigRTgtSource, a naming property for ConfigFromConfigRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::domain::ConfigFromConfigRTgt::resolve().

void modelgbp::platform::Config::resolveDomainConfigFromConfigRTgt ( std::vector< OF_SHARED_PTR< modelgbp::domain::ConfigFromConfigRTgt > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::domain::ConfigFromConfigRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

boost::optional<OF_SHARED_PTR<modelgbp::gbpe::SNATIPPool> > modelgbp::platform::Config::resolveGbpeSNATIPPool ( const std::string &  gbpeSNATIPPoolName)
inline

Retrieve the child object with the specified naming properties.

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
gbpeSNATIPPoolNamethe value of gbpeSNATIPPoolName, a naming property for SNATIPPool
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbpe::SNATIPPool::resolve().

void modelgbp::platform::Config::resolveGbpeSNATIPPool ( std::vector< OF_SHARED_PTR< modelgbp::gbpe::SNATIPPool > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbpe::SNATIPPool.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

boost::optional<OF_SHARED_PTR<modelgbp::l2::Config> > modelgbp::platform::Config::resolveL2Config ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::l2::Config::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::lacp::Config> > modelgbp::platform::Config::resolveLacpConfig ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::lacp::Config::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::lldp::Config> > modelgbp::platform::Config::resolveLldpConfig ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::lldp::Config::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::span::DstGrp> > modelgbp::platform::Config::resolveSpanDstGrp ( const std::string &  spanDstGrpName)
inline

Retrieve the child object with the specified naming properties.

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
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::span::DstGrp::resolve().

void modelgbp::platform::Config::resolveSpanDstGrp ( std::vector< OF_SHARED_PTR< modelgbp::span::DstGrp > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::span::DstGrp.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

boost::optional<OF_SHARED_PTR<modelgbp::span::LocalEp> > modelgbp::platform::Config::resolveSpanLocalEp ( const std::string &  spanLocalEpName)
inline

Retrieve the child object with the specified naming properties.

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
spanLocalEpNamethe value of spanLocalEpName, a naming property for LocalEp
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::span::LocalEp::resolve().

void modelgbp::platform::Config::resolveSpanLocalEp ( std::vector< OF_SHARED_PTR< modelgbp::span::LocalEp > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::span::LocalEp.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

boost::optional<OF_SHARED_PTR<modelgbp::span::SrcGrp> > modelgbp::platform::Config::resolveSpanSrcGrp ( const std::string &  spanSrcGrpName)
inline

Retrieve the child object with the specified naming properties.

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
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::span::SrcGrp::resolve().

void modelgbp::platform::Config::resolveSpanSrcGrp ( std::vector< OF_SHARED_PTR< modelgbp::span::SrcGrp > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::span::SrcGrp.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

boost::optional<OF_SHARED_PTR<modelgbp::stp::Config> > modelgbp::platform::Config::resolveStpConfig ( )
inline

Retrieve the child object with the specified naming properties.

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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::stp::Config::resolve().

modelgbp::platform::Config& modelgbp::platform::Config::setEncapType ( const uint8_t  newValue)
inline

Set encapType 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
modelgbp::platform::Config& modelgbp::platform::Config::setMode ( const uint8_t  newValue)
inline

Set mode 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
modelgbp::platform::Config& modelgbp::platform::Config::setMulticastGroupIP ( const std::string &  newValue)
inline

Set multicastGroupIP 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
modelgbp::platform::Config& modelgbp::platform::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
static void modelgbp::platform::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().

static void modelgbp::platform::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().

modelgbp::platform::Config& modelgbp::platform::Config::unsetEncapType ( )
inline

Unset encapType 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
modelgbp::platform::Config& modelgbp::platform::Config::unsetMode ( )
inline

Unset mode 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
modelgbp::platform::Config& modelgbp::platform::Config::unsetMulticastGroupIP ( )
inline

Unset multicastGroupIP 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
modelgbp::platform::Config& modelgbp::platform::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: