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

Public Member Functions

bool isAccessVlanSet ()
 Check whether accessVlan has been set.
 
boost::optional< uint16_t > getAccessVlan ()
 Get the value of accessVlan if it has been set.
 
uint16_t getAccessVlan (uint16_t defaultValue)
 Get the value of accessVlan if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetAccessVlan (uint16_t newValue)
 Set accessVlan to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetAccessVlan ()
 Unset accessVlan in the currently-active mutator.
 
bool isDiscoveryModeSet ()
 Check whether discoveryMode has been set.
 
boost::optional< const uint8_t > getDiscoveryMode ()
 Get the value of discoveryMode if it has been set.
 
const uint8_t getDiscoveryMode (const uint8_t defaultValue)
 Get the value of discoveryMode if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetDiscoveryMode (const uint8_t newValue)
 Set discoveryMode to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetDiscoveryMode ()
 Unset discoveryMode in the currently-active mutator.
 
bool isEgMappingAliasSet ()
 Check whether egMappingAlias has been set.
 
boost::optional< const std::string & > getEgMappingAlias ()
 Get the value of egMappingAlias if it has been set.
 
const std::string & getEgMappingAlias (const std::string &defaultValue)
 Get the value of egMappingAlias if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetEgMappingAlias (const std::string &newValue)
 Set egMappingAlias to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetEgMappingAlias ()
 Unset egMappingAlias in the currently-active mutator.
 
bool isIfaceSecuritySet ()
 Check whether ifaceSecurity has been set.
 
boost::optional< const uint8_t > getIfaceSecurity ()
 Get the value of ifaceSecurity if it has been set.
 
const uint8_t getIfaceSecurity (const uint8_t defaultValue)
 Get the value of ifaceSecurity if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetIfaceSecurity (const uint8_t newValue)
 Set ifaceSecurity to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetIfaceSecurity ()
 Unset ifaceSecurity in the currently-active mutator.
 
bool isMacSet ()
 Check whether mac has been set.
 
boost::optional< const opflex::modb::MAC & > getMac ()
 Get the value of mac if it has been set.
 
const opflex::modb::MAC & getMac (const opflex::modb::MAC &defaultValue)
 Get the value of mac if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetMac (const opflex::modb::MAC &newValue)
 Set mac to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetMac ()
 Unset mac in the currently-active mutator.
 
bool isUuidSet ()
 Check whether uuid has been set.
 
boost::optional< const std::string & > getUuid ()
 Get the value of uuid if it has been set.
 
const std::string & getUuid (const std::string &defaultValue)
 Get the value of uuid if set, otherwise the value of default passed in.
 
modelgbp::inv::LocalInventoryEpsetUuid (const std::string &newValue)
 Set uuid to the specified value in the currently-active mutator.
 
modelgbp::inv::LocalInventoryEpunsetUuid ()
 Unset uuid in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToGroupRSrc > > resolveInvLocalInventoryEpToGroupRSrc ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToGroupRSrcaddInvLocalInventoryEpToGroupRSrc ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrc > > resolveInvLocalInventoryEpToSecGroupRSrc (const std::string &invLocalInventoryEpToSecGroupRSrcTargetName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrcaddInvLocalInventoryEpToSecGroupRSrc (const std::string &invLocalInventoryEpToSecGroupRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvLocalInventoryEpToSecGroupRSrc (std::vector< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::LocalInventoryEpToSecGroupRSrc.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::Ip > > resolveInvIp (const std::string &invIpIp, const std::string &invIpType)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::IpaddInvIp (const std::string &invIpIp, const std::string &invIpType)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvIp (std::vector< OF_SHARED_PTR< modelgbp::inv::Ip > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::Ip.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMapping > > resolveInvIpMapping (const std::string &invIpMappingName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::IpMappingaddInvIpMapping (const std::string &invIpMappingName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvIpMapping (std::vector< OF_SHARED_PTR< modelgbp::inv::IpMapping > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::IpMapping.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::Interface > > resolveInvInterface (const std::string &invInterfaceName, const std::string &invInterfaceType)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::InterfaceaddInvInterface (const std::string &invInterfaceName, const std::string &invInterfaceType)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvInterface (std::vector< OF_SHARED_PTR< modelgbp::inv::Interface > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::Interface.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::DHCPv4Config > > resolveInvDHCPv4Config ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::DHCPv4ConfigaddInvDHCPv4Config ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::DHCPv6Config > > resolveInvDHCPv6Config ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::DHCPv6ConfigaddInvDHCPv6Config ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::Attribute > > resolveInvAttribute (const std::string &invAttributeName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::AttributeaddInvAttribute (const std::string &invAttributeName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvAttribute (std::vector< OF_SHARED_PTR< modelgbp::inv::Attribute > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::Attribute.
 
void remove ()
 Remove this instance using the currently-active mutator.
 
 LocalInventoryEp (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of LocalInventoryEp.
 

Static Public Member Functions

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

Constructor & Destructor Documentation

◆ LocalInventoryEp()

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

Construct an instance of LocalInventoryEp.

This should not typically be called from user code.

References CLASS_ID.

Member Function Documentation

◆ addInvAttribute()

OF_SHARED_PTR< modelgbp::inv::Attribute > modelgbp::inv::LocalInventoryEp::addInvAttribute ( const std::string & invAttributeName)
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
invAttributeNamethe value of invAttributeName, a naming property for Attribute
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvDHCPv4Config()

OF_SHARED_PTR< modelgbp::inv::DHCPv4Config > modelgbp::inv::LocalInventoryEp::addInvDHCPv4Config ( )
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.

◆ addInvDHCPv6Config()

OF_SHARED_PTR< modelgbp::inv::DHCPv6Config > modelgbp::inv::LocalInventoryEp::addInvDHCPv6Config ( )
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.

◆ addInvInterface()

OF_SHARED_PTR< modelgbp::inv::Interface > modelgbp::inv::LocalInventoryEp::addInvInterface ( const std::string & invInterfaceName,
const std::string & invInterfaceType )
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
invInterfaceNamethe value of invInterfaceName, a naming property for Interface
invInterfaceTypethe value of invInterfaceType, a naming property for Interface
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvIp()

OF_SHARED_PTR< modelgbp::inv::Ip > modelgbp::inv::LocalInventoryEp::addInvIp ( const std::string & invIpIp,
const std::string & invIpType )
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
invIpIpthe value of invIpIp, a naming property for Ip
invIpTypethe value of invIpType, a naming property for Ip
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvIpMapping()

OF_SHARED_PTR< modelgbp::inv::IpMapping > modelgbp::inv::LocalInventoryEp::addInvIpMapping ( const std::string & invIpMappingName)
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
invIpMappingNamethe value of invIpMappingName, a naming property for IpMapping
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvLocalInventoryEpToGroupRSrc()

OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToGroupRSrc > modelgbp::inv::LocalInventoryEp::addInvLocalInventoryEpToGroupRSrc ( )
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.

◆ addInvLocalInventoryEpToSecGroupRSrc()

OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrc > modelgbp::inv::LocalInventoryEp::addInvLocalInventoryEpToSecGroupRSrc ( const std::string & invLocalInventoryEpToSecGroupRSrcTargetName)
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
invLocalInventoryEpToSecGroupRSrcTargetClassthe value of invLocalInventoryEpToSecGroupRSrcTargetClass, a naming property for LocalInventoryEpToSecGroupRSrc
invLocalInventoryEpToSecGroupRSrcTargetNamethe value of invLocalInventoryEpToSecGroupRSrcTargetName, a naming property for LocalInventoryEpToSecGroupRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ getAccessVlan() [1/2]

boost::optional< uint16_t > modelgbp::inv::LocalInventoryEp::getAccessVlan ( )
inline

Get the value of accessVlan if it has been set.

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

References isAccessVlanSet().

Referenced by getAccessVlan().

◆ getAccessVlan() [2/2]

uint16_t modelgbp::inv::LocalInventoryEp::getAccessVlan ( uint16_t defaultValue)
inline

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

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

References getAccessVlan().

◆ getDiscoveryMode() [1/2]

boost::optional< const uint8_t > modelgbp::inv::LocalInventoryEp::getDiscoveryMode ( )
inline

Get the value of discoveryMode if it has been set.

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

References isDiscoveryModeSet().

Referenced by getDiscoveryMode().

◆ getDiscoveryMode() [2/2]

const uint8_t modelgbp::inv::LocalInventoryEp::getDiscoveryMode ( const uint8_t defaultValue)
inline

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

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

References getDiscoveryMode().

◆ getEgMappingAlias() [1/2]

boost::optional< const std::string & > modelgbp::inv::LocalInventoryEp::getEgMappingAlias ( )
inline

Get the value of egMappingAlias if it has been set.

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

References isEgMappingAliasSet().

Referenced by getEgMappingAlias().

◆ getEgMappingAlias() [2/2]

const std::string & modelgbp::inv::LocalInventoryEp::getEgMappingAlias ( const std::string & defaultValue)
inline

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

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

References getEgMappingAlias().

◆ getIfaceSecurity() [1/2]

boost::optional< const uint8_t > modelgbp::inv::LocalInventoryEp::getIfaceSecurity ( )
inline

Get the value of ifaceSecurity if it has been set.

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

References isIfaceSecuritySet().

Referenced by getIfaceSecurity().

◆ getIfaceSecurity() [2/2]

const uint8_t modelgbp::inv::LocalInventoryEp::getIfaceSecurity ( const uint8_t defaultValue)
inline

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

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

References getIfaceSecurity().

◆ getMac() [1/2]

boost::optional< const opflex::modb::MAC & > modelgbp::inv::LocalInventoryEp::getMac ( )
inline

Get the value of mac if it has been set.

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

References isMacSet().

Referenced by getMac().

◆ getMac() [2/2]

const opflex::modb::MAC & modelgbp::inv::LocalInventoryEp::getMac ( const opflex::modb::MAC & defaultValue)
inline

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

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

References getMac().

◆ getUuid() [1/2]

boost::optional< const std::string & > modelgbp::inv::LocalInventoryEp::getUuid ( )
inline

Get the value of uuid if it has been set.

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

References isUuidSet().

Referenced by getUuid().

◆ getUuid() [2/2]

const std::string & modelgbp::inv::LocalInventoryEp::getUuid ( const std::string & defaultValue)
inline

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

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

References getUuid().

◆ isAccessVlanSet()

bool modelgbp::inv::LocalInventoryEp::isAccessVlanSet ( )
inline

Check whether accessVlan has been set.

Returns
true if accessVlan has been set

Referenced by getAccessVlan().

◆ isDiscoveryModeSet()

bool modelgbp::inv::LocalInventoryEp::isDiscoveryModeSet ( )
inline

Check whether discoveryMode has been set.

Returns
true if discoveryMode has been set

Referenced by getDiscoveryMode().

◆ isEgMappingAliasSet()

bool modelgbp::inv::LocalInventoryEp::isEgMappingAliasSet ( )
inline

Check whether egMappingAlias has been set.

Returns
true if egMappingAlias has been set

Referenced by getEgMappingAlias().

◆ isIfaceSecuritySet()

bool modelgbp::inv::LocalInventoryEp::isIfaceSecuritySet ( )
inline

Check whether ifaceSecurity has been set.

Returns
true if ifaceSecurity has been set

Referenced by getIfaceSecurity().

◆ isMacSet()

bool modelgbp::inv::LocalInventoryEp::isMacSet ( )
inline

Check whether mac has been set.

Returns
true if mac has been set

Referenced by getMac().

◆ isUuidSet()

bool modelgbp::inv::LocalInventoryEp::isUuidSet ( )
inline

Check whether uuid has been set.

Returns
true if uuid has been set

Referenced by getUuid().

◆ registerListener() [1/2]

static void modelgbp::inv::LocalInventoryEp::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::inv::LocalInventoryEp::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::inv::LocalInventoryEp::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::inv::LocalInventoryEp::remove ( const opflex::modb::URI & uri)
inlinestatic

Remove the LocalInventoryEp 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::inv::LocalInventoryEp::remove ( const std::string & invLocalEndpointInventoryName,
const std::string & invLocalInventoryEpUuid )
inlinestatic

Remove the LocalInventoryEp 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]

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

References remove().

◆ remove() [4/5]

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

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

Remove the LocalInventoryEp 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]

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

References CLASS_ID.

◆ resolve() [1/4]

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

Retrieve an instance of LocalInventoryEp 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::inv::LocalInventoryEp > > modelgbp::inv::LocalInventoryEp::resolve ( const std::string & invLocalEndpointInventoryName,
const std::string & invLocalInventoryEpUuid )
inlinestatic

Retrieve an instance of LocalInventoryEp 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]

Parameters
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
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::inv::LocalInventoryEp > > modelgbp::inv::LocalInventoryEp::resolve ( opflex::ofcore::OFFramework & framework,
const opflex::modb::URI & uri )
inlinestatic

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

◆ resolve() [4/4]

static boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEp > > modelgbp::inv::LocalInventoryEp::resolve ( opflex::ofcore::OFFramework & framework,
const std::string & invLocalEndpointInventoryName,
const std::string & invLocalInventoryEpUuid )
inlinestatic

Retrieve an instance of LocalInventoryEp 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]

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

References resolve().

◆ resolveInvAttribute() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::Attribute > > modelgbp::inv::LocalInventoryEp::resolveInvAttribute ( const std::string & invAttributeName)
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
invAttributeNamethe value of invAttributeName, a naming property for Attribute
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::Attribute::resolve().

◆ resolveInvAttribute() [2/2]

void modelgbp::inv::LocalInventoryEp::resolveInvAttribute ( std::vector< OF_SHARED_PTR< modelgbp::inv::Attribute > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::Attribute.

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.

◆ resolveInvDHCPv4Config()

boost::optional< OF_SHARED_PTR< modelgbp::inv::DHCPv4Config > > modelgbp::inv::LocalInventoryEp::resolveInvDHCPv4Config ( )
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::DHCPv4Config::resolve().

◆ resolveInvDHCPv6Config()

boost::optional< OF_SHARED_PTR< modelgbp::inv::DHCPv6Config > > modelgbp::inv::LocalInventoryEp::resolveInvDHCPv6Config ( )
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::DHCPv6Config::resolve().

◆ resolveInvInterface() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::Interface > > modelgbp::inv::LocalInventoryEp::resolveInvInterface ( const std::string & invInterfaceName,
const std::string & invInterfaceType )
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
invInterfaceNamethe value of invInterfaceName, a naming property for Interface
invInterfaceTypethe value of invInterfaceType, a naming property for Interface
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::Interface::resolve().

◆ resolveInvInterface() [2/2]

void modelgbp::inv::LocalInventoryEp::resolveInvInterface ( std::vector< OF_SHARED_PTR< modelgbp::inv::Interface > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::Interface.

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.

◆ resolveInvIp() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::Ip > > modelgbp::inv::LocalInventoryEp::resolveInvIp ( const std::string & invIpIp,
const std::string & invIpType )
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
invIpIpthe value of invIpIp, a naming property for Ip
invIpTypethe value of invIpType, a naming property for Ip
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::Ip::resolve().

◆ resolveInvIp() [2/2]

void modelgbp::inv::LocalInventoryEp::resolveInvIp ( std::vector< OF_SHARED_PTR< modelgbp::inv::Ip > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::Ip.

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.

◆ resolveInvIpMapping() [1/2]

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

◆ resolveInvIpMapping() [2/2]

void modelgbp::inv::LocalInventoryEp::resolveInvIpMapping ( std::vector< OF_SHARED_PTR< modelgbp::inv::IpMapping > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::IpMapping.

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.

◆ resolveInvLocalInventoryEpToGroupRSrc()

boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToGroupRSrc > > modelgbp::inv::LocalInventoryEp::resolveInvLocalInventoryEpToGroupRSrc ( )
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::LocalInventoryEpToGroupRSrc::resolve().

◆ resolveInvLocalInventoryEpToSecGroupRSrc() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrc > > modelgbp::inv::LocalInventoryEp::resolveInvLocalInventoryEpToSecGroupRSrc ( const std::string & invLocalInventoryEpToSecGroupRSrcTargetName)
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
invLocalInventoryEpToSecGroupRSrcTargetClassthe value of invLocalInventoryEpToSecGroupRSrcTargetClass, a naming property for LocalInventoryEpToSecGroupRSrc
invLocalInventoryEpToSecGroupRSrcTargetNamethe value of invLocalInventoryEpToSecGroupRSrcTargetName, a naming property for LocalInventoryEpToSecGroupRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::LocalInventoryEpToSecGroupRSrc::resolve().

◆ resolveInvLocalInventoryEpToSecGroupRSrc() [2/2]

void modelgbp::inv::LocalInventoryEp::resolveInvLocalInventoryEpToSecGroupRSrc ( std::vector< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpToSecGroupRSrc > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::LocalInventoryEpToSecGroupRSrc.

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.

◆ setAccessVlan()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setAccessVlan ( uint16_t newValue)
inline

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

◆ setDiscoveryMode()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setDiscoveryMode ( const uint8_t newValue)
inline

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

◆ setEgMappingAlias()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setEgMappingAlias ( const std::string & newValue)
inline

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

◆ setIfaceSecurity()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setIfaceSecurity ( const uint8_t newValue)
inline

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

◆ setMac()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setMac ( const opflex::modb::MAC & newValue)
inline

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

◆ setUuid()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::setUuid ( const std::string & newValue)
inline

Set uuid 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::LocalInventoryEp::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::inv::LocalInventoryEp::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().

◆ unsetAccessVlan()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetAccessVlan ( )
inline

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

◆ unsetDiscoveryMode()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetDiscoveryMode ( )
inline

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

◆ unsetEgMappingAlias()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetEgMappingAlias ( )
inline

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

◆ unsetIfaceSecurity()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetIfaceSecurity ( )
inline

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

◆ unsetMac()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetMac ( )
inline

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

◆ unsetUuid()

modelgbp::inv::LocalInventoryEp & modelgbp::inv::LocalInventoryEp::unsetUuid ( )
inline

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