modelgbp Generated OpFlex Model 1.7.0
modelgbp::gbpe::FloodContext Class Reference
Inheritance diagram for modelgbp::gbpe::FloodContext:

Public Member Functions

bool isMulticastGroupIPSet ()
 Check whether multicastGroupIP has been set.
 
boost::optional< const std::string & > getMulticastGroupIP ()
 Get the value of multicastGroupIP if it has been set.
 
const std::string & getMulticastGroupIP (const std::string &defaultValue)
 Get the value of multicastGroupIP if set, otherwise the value of default passed in.
 
modelgbp::gbpe::FloodContextsetMulticastGroupIP (const std::string &newValue)
 Set multicastGroupIP to the specified value in the currently-active mutator.
 
modelgbp::gbpe::FloodContextunsetMulticastGroupIP ()
 Unset multicastGroupIP in the currently-active mutator.
 
void remove ()
 Remove this instance using the currently-active mutator.
 
 FloodContext (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of FloodContext.
 

Static Public Member Functions

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

Static Public Attributes

static const opflex::modb::class_id_t CLASS_ID = 41
 The unique class ID for FloodContext.
 

Constructor & Destructor Documentation

◆ FloodContext()

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

Construct an instance of FloodContext.

This should not typically be called from user code.

References CLASS_ID.

Member Function Documentation

◆ getMulticastGroupIP() [1/2]

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

◆ getMulticastGroupIP() [2/2]

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

◆ isMulticastGroupIPSet()

bool modelgbp::gbpe::FloodContext::isMulticastGroupIPSet ( )
inline

Check whether multicastGroupIP has been set.

Returns
true if multicastGroupIP has been set

Referenced by getMulticastGroupIP().

◆ registerListener() [1/2]

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

◆ registerListener() [2/2]

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

◆ remove() [1/5]

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

Referenced by remove(), and remove().

◆ remove() [2/5]

static void modelgbp::gbpe::FloodContext::remove ( const opflex::modb::URI & uri)
inlinestatic

Remove the FloodContext 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

References remove().

◆ remove() [3/5]

static void modelgbp::gbpe::FloodContext::remove ( const std::string & policySpaceName,
const std::string & gbpFloodDomainName )
inlinestatic

Remove the FloodContext 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/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpFloodDomainNamethe value of gbpFloodDomainName, a naming property for FloodDomain
Exceptions
std::logic_errorif no mutator is active

References remove().

◆ remove() [4/5]

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

Remove the FloodContext 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() [5/5]

static void modelgbp::gbpe::FloodContext::remove ( opflex::ofcore::OFFramework & framework,
const std::string & policySpaceName,
const std::string & gbpFloodDomainName )
inlinestatic

Remove the FloodContext 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/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpFloodDomainNamethe value of gbpFloodDomainName, a naming property for FloodDomain
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ resolve() [1/4]

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

Retrieve an instance of FloodContext 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() [2/4]

static boost::optional< OF_SHARED_PTR< modelgbp::gbpe::FloodContext > > modelgbp::gbpe::FloodContext::resolve ( const std::string & policySpaceName,
const std::string & gbpFloodDomainName )
inlinestatic

Retrieve an instance of FloodContext 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/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpFloodDomainNamethe value of gbpFloodDomainName, a naming property for FloodDomain
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolve() [3/4]

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

Retrieve an instance of FloodContext 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(), resolve(), and modelgbp::gbp::FloodDomain::resolveGbpeFloodContext().

◆ resolve() [4/4]

static boost::optional< OF_SHARED_PTR< modelgbp::gbpe::FloodContext > > modelgbp::gbpe::FloodContext::resolve ( opflex::ofcore::OFFramework & framework,
const std::string & policySpaceName,
const std::string & gbpFloodDomainName )
inlinestatic

Retrieve an instance of FloodContext 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/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpFloodDomainNamethe value of gbpFloodDomainName, a naming property for FloodDomain
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ setMulticastGroupIP()

modelgbp::gbpe::FloodContext & modelgbp::gbpe::FloodContext::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

◆ unregisterListener() [1/2]

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

◆ unregisterListener() [2/2]

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

◆ unsetMulticastGroupIP()

modelgbp::gbpe::FloodContext & modelgbp::gbpe::FloodContext::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

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