modelgbp Generated OpFlex Model  1.7.0
modelgbp::span::LocalEpToEpRSrc Class Reference
Inheritance diagram for modelgbp::span::LocalEpToEpRSrc:

Public Member Functions

bool isRoleSet ()
 Check whether role has been set. More...
 
boost::optional< const uint8_t > getRole ()
 Get the value of role if it has been set. More...
 
const uint8_t getRole (const uint8_t defaultValue)
 Get the value of role if set, otherwise the value of default passed in. More...
 
modelgbp::span::LocalEpToEpRSrcsetRole (const uint8_t newValue)
 Set role to the specified value in the currently-active mutator. More...
 
modelgbp::span::LocalEpToEpRSrcunsetRole ()
 Unset role in the currently-active mutator. More...
 
bool isTargetSet ()
 Check whether target has been set. More...
 
boost::optional< opflex::modb::class_id_t > getTargetClass ()
 Get the value of targetClass if it has been set. More...
 
boost::optional< opflex::modb::URI > getTargetURI ()
 Get the value of targetURI if it has been set. More...
 
opflex::modb::class_id_t getTargetClass (opflex::modb::class_id_t defaultValue)
 Get the value of targetClass if set, otherwise the value of default passed in. More...
 
opflex::modb::URI getTargetURI (opflex::modb::URI defaultValue)
 Get the value of targetURI if set, otherwise the value of default passed in. More...
 
modelgbp::span::LocalEpToEpRSrcsetTargetL2Ep (const opflex::modb::URI &uri)
 Set the reference to point to an instance of L2Ep with the specified URI. More...
 
modelgbp::span::LocalEpToEpRSrcsetTargetL2Ep (const std::string &eprL2EpContext, const opflex::modb::MAC &eprL2EpMac)
 Set the reference to point to an instance of L2Ep in the currently-active mutator by constructing its URI from the path elements that lead to it. More...
 
modelgbp::span::LocalEpToEpRSrcsetTargetL3Ep (const opflex::modb::URI &uri)
 Set the reference to point to an instance of L3Ep with the specified URI. More...
 
modelgbp::span::LocalEpToEpRSrcsetTargetL3Ep (const std::string &eprL3EpContext, const std::string &eprL3EpIp)
 Set the reference to point to an instance of L3Ep in the currently-active mutator by constructing its URI from the path elements that lead to it. More...
 
modelgbp::span::LocalEpToEpRSrcunsetTarget ()
 Unset target in the currently-active mutator. More...
 
bool isTypeSet ()
 Check whether type has been set. More...
 
boost::optional< const uint8_t > getType ()
 Get the value of type if it has been set. More...
 
const uint8_t getType (const uint8_t defaultValue)
 Get the value of type if set, otherwise the value of default passed in. More...
 
modelgbp::span::LocalEpToEpRSrcsetType (const uint8_t newValue)
 Set type to the specified value in the currently-active mutator. More...
 
modelgbp::span::LocalEpToEpRSrcunsetType ()
 Unset type in the currently-active mutator. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 LocalEpToEpRSrc (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of LocalEpToEpRSrc. More...
 

Static Public Member Functions

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

Constructor & Destructor Documentation

◆ LocalEpToEpRSrc()

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

Construct an instance of LocalEpToEpRSrc.

This should not typically be called from user code.

Member Function Documentation

◆ getRole() [1/2]

boost::optional<const uint8_t> modelgbp::span::LocalEpToEpRSrc::getRole ( )
inline

Get the value of role if it has been set.

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

References isRoleSet().

Referenced by getRole().

◆ getRole() [2/2]

const uint8_t modelgbp::span::LocalEpToEpRSrc::getRole ( const uint8_t  defaultValue)
inline

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

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

References getRole().

◆ getTargetClass() [1/2]

boost::optional<opflex::modb::class_id_t> modelgbp::span::LocalEpToEpRSrc::getTargetClass ( )
inline

Get the value of targetClass if it has been set.

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

References isTargetSet().

Referenced by getTargetClass().

◆ getTargetClass() [2/2]

opflex::modb::class_id_t modelgbp::span::LocalEpToEpRSrc::getTargetClass ( opflex::modb::class_id_t  defaultValue)
inline

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

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

References getTargetClass().

◆ getTargetURI() [1/2]

boost::optional<opflex::modb::URI> modelgbp::span::LocalEpToEpRSrc::getTargetURI ( )
inline

Get the value of targetURI if it has been set.

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

References isTargetSet().

Referenced by getTargetURI().

◆ getTargetURI() [2/2]

opflex::modb::URI modelgbp::span::LocalEpToEpRSrc::getTargetURI ( opflex::modb::URI  defaultValue)
inline

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

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

References getTargetURI().

◆ getType() [1/2]

boost::optional<const uint8_t> modelgbp::span::LocalEpToEpRSrc::getType ( )
inline

Get the value of type if it has been set.

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

References isTypeSet().

Referenced by getType().

◆ getType() [2/2]

const uint8_t modelgbp::span::LocalEpToEpRSrc::getType ( const uint8_t  defaultValue)
inline

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

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

References getType().

◆ isRoleSet()

bool modelgbp::span::LocalEpToEpRSrc::isRoleSet ( )
inline

Check whether role has been set.

Returns
true if role has been set

Referenced by getRole().

◆ isTargetSet()

bool modelgbp::span::LocalEpToEpRSrc::isTargetSet ( )
inline

Check whether target has been set.

Returns
true if target has been set

Referenced by getTargetClass(), and getTargetURI().

◆ isTypeSet()

bool modelgbp::span::LocalEpToEpRSrc::isTypeSet ( )
inline

Check whether type has been set.

Returns
true if type has been set

Referenced by getType().

◆ registerListener() [1/2]

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

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

Remove the LocalEpToEpRSrc 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::span::LocalEpToEpRSrc::remove ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanLocalEpName 
)
inlinestatic

Remove the LocalEpToEpRSrc 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]/SpanLocalEp/[spanLocalEpName]/SpanLocalEpToEpRSrc

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

References CLASS_ID.

◆ remove() [5/5]

static void modelgbp::span::LocalEpToEpRSrc::remove ( const std::string &  platformConfigName,
const std::string &  spanLocalEpName 
)
inlinestatic

Remove the LocalEpToEpRSrc 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]/SpanLocalEp/[spanLocalEpName]/SpanLocalEpToEpRSrc

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

◆ resolve() [1/4]

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

Retrieve an instance of LocalEpToEpRSrc 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::span::LocalEp::resolveSpanLocalEpToEpRSrc().

◆ resolve() [2/4]

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

Retrieve an instance of LocalEpToEpRSrc 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::span::LocalEpToEpRSrc> > modelgbp::span::LocalEpToEpRSrc::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanLocalEpName 
)
inlinestatic

Retrieve an instance of LocalEpToEpRSrc 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]/SpanLocalEp/[spanLocalEpName]/SpanLocalEpToEpRSrc

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
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 resolve().

◆ resolve() [4/4]

static boost::optional<OF_SHARED_PTR<modelgbp::span::LocalEpToEpRSrc> > modelgbp::span::LocalEpToEpRSrc::resolve ( const std::string &  platformConfigName,
const std::string &  spanLocalEpName 
)
inlinestatic

Retrieve an instance of LocalEpToEpRSrc 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]/SpanLocalEp/[spanLocalEpName]/SpanLocalEpToEpRSrc

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
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 resolve().

◆ setRole()

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setRole ( const uint8_t  newValue)
inline

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

◆ setTargetL2Ep() [1/2]

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setTargetL2Ep ( const opflex::modb::URI &  uri)
inline

Set the reference to point to an instance of L2Ep with the specified URI.

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

◆ setTargetL2Ep() [2/2]

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setTargetL2Ep ( const std::string &  eprL2EpContext,
const opflex::modb::MAC &  eprL2EpMac 
)
inline

Set the reference to point to an instance of L2Ep in the currently-active mutator by constructing its URI from the path elements that lead to it.

The reference URI generated by this function will take the form: /EprL2Universe/EprL2Ep/[eprL2EpContext]/[eprL2EpMac]

Parameters
eprL2EpContextthe value of eprL2EpContext, a naming property for L2Ep
eprL2EpMacthe value of eprL2EpMac, a naming property for L2Ep
Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ setTargetL3Ep() [1/2]

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setTargetL3Ep ( const opflex::modb::URI &  uri)
inline

Set the reference to point to an instance of L3Ep with the specified URI.

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

◆ setTargetL3Ep() [2/2]

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setTargetL3Ep ( const std::string &  eprL3EpContext,
const std::string &  eprL3EpIp 
)
inline

Set the reference to point to an instance of L3Ep in the currently-active mutator by constructing its URI from the path elements that lead to it.

The reference URI generated by this function will take the form: /EprL3Universe/EprL3Ep/[eprL3EpContext]/[eprL3EpIp]

Parameters
eprL3EpContextthe value of eprL3EpContext, a naming property for L3Ep
eprL3EpIpthe value of eprL3EpIp, a naming property for L3Ep
Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ setType()

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::setType ( const uint8_t  newValue)
inline

Set type 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::span::LocalEpToEpRSrc::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::span::LocalEpToEpRSrc::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().

◆ unsetRole()

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::unsetRole ( )
inline

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

◆ unsetTarget()

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::unsetTarget ( )
inline

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

◆ unsetType()

modelgbp::span::LocalEpToEpRSrc& modelgbp::span::LocalEpToEpRSrc::unsetType ( )
inline

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