modelgbp Generated OpFlex Model  1.7.0
modelgbp::inv::IpMapping Class Reference
Inheritance diagram for modelgbp::inv::IpMapping:

Public Member Functions

bool isFloatingIpSet ()
 Check whether floatingIp has been set. More...
 
boost::optional< const std::string & > getFloatingIp ()
 Get the value of floatingIp if it has been set. More...
 
const std::string & getFloatingIp (const std::string &defaultValue)
 Get the value of floatingIp if set, otherwise the value of default passed in. More...
 
modelgbp::inv::IpMappingsetFloatingIp (const std::string &newValue)
 Set floatingIp to the specified value in the currently-active mutator. More...
 
modelgbp::inv::IpMappingunsetFloatingIp ()
 Unset floatingIp in the currently-active mutator. More...
 
bool isMappedIpSet ()
 Check whether mappedIp has been set. More...
 
boost::optional< const std::string & > getMappedIp ()
 Get the value of mappedIp if it has been set. More...
 
const std::string & getMappedIp (const std::string &defaultValue)
 Get the value of mappedIp if set, otherwise the value of default passed in. More...
 
modelgbp::inv::IpMappingsetMappedIp (const std::string &newValue)
 Set mappedIp to the specified value in the currently-active mutator. More...
 
modelgbp::inv::IpMappingunsetMappedIp ()
 Unset mappedIp 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::inv::IpMappingsetName (const std::string &newValue)
 Set name to the specified value in the currently-active mutator. More...
 
modelgbp::inv::IpMappingunsetName ()
 Unset name in the currently-active mutator. More...
 
bool isNextHopIfSet ()
 Check whether nextHopIf has been set. More...
 
boost::optional< const std::string & > getNextHopIf ()
 Get the value of nextHopIf if it has been set. More...
 
const std::string & getNextHopIf (const std::string &defaultValue)
 Get the value of nextHopIf if set, otherwise the value of default passed in. More...
 
modelgbp::inv::IpMappingsetNextHopIf (const std::string &newValue)
 Set nextHopIf to the specified value in the currently-active mutator. More...
 
modelgbp::inv::IpMappingunsetNextHopIf ()
 Unset nextHopIf in the currently-active mutator. More...
 
bool isNextHopMacSet ()
 Check whether nextHopMac has been set. More...
 
boost::optional< const opflex::modb::MAC & > getNextHopMac ()
 Get the value of nextHopMac if it has been set. More...
 
const opflex::modb::MAC & getNextHopMac (const opflex::modb::MAC &defaultValue)
 Get the value of nextHopMac if set, otherwise the value of default passed in. More...
 
modelgbp::inv::IpMappingsetNextHopMac (const opflex::modb::MAC &newValue)
 Set nextHopMac to the specified value in the currently-active mutator. More...
 
modelgbp::inv::IpMappingunsetNextHopMac ()
 Unset nextHopMac in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMappingToGroupRSrc > > resolveInvIpMappingToGroupRSrc ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR< modelgbp::inv::IpMappingToGroupRSrcaddInvIpMappingToGroupRSrc ()
 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...
 
 IpMapping (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of IpMapping. More...
 

Static Public Member Functions

static boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMapping > > resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of IpMapping from the managed object store. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMapping > > resolve (const opflex::modb::URI &uri)
 Retrieve an instance of IpMapping from the managed object store using the default framework instance. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMapping > > resolve (opflex::ofcore::OFFramework &framework, const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid, const std::string &invIpMappingName)
 Retrieve an instance of IpMapping 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::inv::IpMapping > > resolve (const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid, const std::string &invIpMappingName)
 Retrieve an instance of IpMapping 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 IpMapping object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the IpMapping 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 &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid, const std::string &invIpMappingName)
 Remove the IpMapping object with the specified path elements from the managed object store. More...
 
static void remove (const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid, const std::string &invIpMappingName)
 Remove the IpMapping 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 = 124
 The unique class ID for IpMapping.
 

Constructor & Destructor Documentation

◆ IpMapping()

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

Construct an instance of IpMapping.

This should not typically be called from user code.

Member Function Documentation

◆ addInvIpMappingToGroupRSrc()

OF_SHARED_PTR<modelgbp::inv::IpMappingToGroupRSrc> modelgbp::inv::IpMapping::addInvIpMappingToGroupRSrc ( )
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.

◆ getFloatingIp() [1/2]

boost::optional<const std::string&> modelgbp::inv::IpMapping::getFloatingIp ( )
inline

Get the value of floatingIp if it has been set.

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

References isFloatingIpSet().

Referenced by getFloatingIp().

◆ getFloatingIp() [2/2]

const std::string& modelgbp::inv::IpMapping::getFloatingIp ( const std::string &  defaultValue)
inline

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

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

References getFloatingIp().

◆ getMappedIp() [1/2]

boost::optional<const std::string&> modelgbp::inv::IpMapping::getMappedIp ( )
inline

Get the value of mappedIp if it has been set.

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

References isMappedIpSet().

Referenced by getMappedIp().

◆ getMappedIp() [2/2]

const std::string& modelgbp::inv::IpMapping::getMappedIp ( const std::string &  defaultValue)
inline

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

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

References getMappedIp().

◆ getName() [1/2]

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

◆ getNextHopIf() [1/2]

boost::optional<const std::string&> modelgbp::inv::IpMapping::getNextHopIf ( )
inline

Get the value of nextHopIf if it has been set.

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

References isNextHopIfSet().

Referenced by getNextHopIf().

◆ getNextHopIf() [2/2]

const std::string& modelgbp::inv::IpMapping::getNextHopIf ( const std::string &  defaultValue)
inline

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

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

References getNextHopIf().

◆ getNextHopMac() [1/2]

boost::optional<const opflex::modb::MAC&> modelgbp::inv::IpMapping::getNextHopMac ( )
inline

Get the value of nextHopMac if it has been set.

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

References isNextHopMacSet().

Referenced by getNextHopMac().

◆ getNextHopMac() [2/2]

const opflex::modb::MAC& modelgbp::inv::IpMapping::getNextHopMac ( const opflex::modb::MAC &  defaultValue)
inline

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

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

References getNextHopMac().

◆ isFloatingIpSet()

bool modelgbp::inv::IpMapping::isFloatingIpSet ( )
inline

Check whether floatingIp has been set.

Returns
true if floatingIp has been set

Referenced by getFloatingIp().

◆ isMappedIpSet()

bool modelgbp::inv::IpMapping::isMappedIpSet ( )
inline

Check whether mappedIp has been set.

Returns
true if mappedIp has been set

Referenced by getMappedIp().

◆ isNameSet()

bool modelgbp::inv::IpMapping::isNameSet ( )
inline

Check whether name has been set.

Returns
true if name has been set

Referenced by getName().

◆ isNextHopIfSet()

bool modelgbp::inv::IpMapping::isNextHopIfSet ( )
inline

Check whether nextHopIf has been set.

Returns
true if nextHopIf has been set

Referenced by getNextHopIf().

◆ isNextHopMacSet()

bool modelgbp::inv::IpMapping::isNextHopMacSet ( )
inline

Check whether nextHopMac has been set.

Returns
true if nextHopMac has been set

Referenced by getNextHopMac().

◆ registerListener() [1/2]

static void modelgbp::inv::IpMapping::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::inv::IpMapping::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::inv::IpMapping::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::inv::IpMapping::remove ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

Remove the IpMapping 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::inv::IpMapping::remove ( const opflex::modb::URI &  uri)
inlinestatic

Remove the IpMapping 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::inv::IpMapping::remove ( opflex::ofcore::OFFramework &  framework,
const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid,
const std::string &  invIpMappingName 
)
inlinestatic

Remove the IpMapping 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvIpMapping/[invIpMappingName]

Parameters
frameworkthe framework instance to use
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
invIpMappingNamethe value of invIpMappingName, a naming property for IpMapping
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [5/5]

static void modelgbp::inv::IpMapping::remove ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid,
const std::string &  invIpMappingName 
)
inlinestatic

Remove the IpMapping 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvIpMapping/[invIpMappingName]

Parameters
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
invIpMappingNamethe value of invIpMappingName, a naming property for IpMapping
Exceptions
std::logic_errorif no mutator is active

◆ resolve() [1/4]

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

Retrieve an instance of IpMapping 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::inv::LocalInventoryEp::resolveInvIpMapping().

◆ resolve() [2/4]

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

Retrieve an instance of IpMapping 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::inv::IpMapping> > modelgbp::inv::IpMapping::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid,
const std::string &  invIpMappingName 
)
inlinestatic

Retrieve an instance of IpMapping 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvIpMapping/[invIpMappingName]

Parameters
frameworkthe framework instance to use
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
invIpMappingNamethe value of invIpMappingName, a naming property for IpMapping
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::inv::IpMapping> > modelgbp::inv::IpMapping::resolve ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid,
const std::string &  invIpMappingName 
)
inlinestatic

Retrieve an instance of IpMapping 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvIpMapping/[invIpMappingName]

Parameters
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
invIpMappingNamethe value of invIpMappingName, a naming property for IpMapping
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolveInvIpMappingToGroupRSrc()

boost::optional<OF_SHARED_PTR<modelgbp::inv::IpMappingToGroupRSrc> > modelgbp::inv::IpMapping::resolveInvIpMappingToGroupRSrc ( )
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::inv::IpMappingToGroupRSrc::resolve().

◆ setFloatingIp()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::setFloatingIp ( const std::string &  newValue)
inline

Set floatingIp 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

◆ setMappedIp()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::setMappedIp ( const std::string &  newValue)
inline

Set mappedIp 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::inv::IpMapping& modelgbp::inv::IpMapping::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

◆ setNextHopIf()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::setNextHopIf ( const std::string &  newValue)
inline

Set nextHopIf 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

◆ setNextHopMac()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::setNextHopMac ( const opflex::modb::MAC &  newValue)
inline

Set nextHopMac 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::inv::IpMapping::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::inv::IpMapping::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().

◆ unsetFloatingIp()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::unsetFloatingIp ( )
inline

Unset floatingIp 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

◆ unsetMappedIp()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::unsetMappedIp ( )
inline

Unset mappedIp 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::inv::IpMapping& modelgbp::inv::IpMapping::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

◆ unsetNextHopIf()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::unsetNextHopIf ( )
inline

Unset nextHopIf 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

◆ unsetNextHopMac()

modelgbp::inv::IpMapping& modelgbp::inv::IpMapping::unsetNextHopMac ( )
inline

Unset nextHopMac 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: