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

Public Member Functions

bool isDestSet ()
 Check whether dest has been set. More...
 
boost::optional< const
std::string & > 
getDest ()
 Get the value of dest if it has been set. More...
 
const std::string & getDest (const std::string &defaultValue)
 Get the value of dest if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetDest (const std::string &newValue)
 Set dest to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetDest ()
 Unset dest in the currently-active mutator. More...
 
bool isDscpSet ()
 Check whether dscp has been set. More...
 
boost::optional< const uint8_t > getDscp ()
 Get the value of dscp if it has been set. More...
 
const uint8_t getDscp (const uint8_t defaultValue)
 Get the value of dscp if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetDscp (const uint8_t newValue)
 Set dscp to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetDscp ()
 Unset dscp in the currently-active mutator. More...
 
bool isFlowIdSet ()
 Check whether flowId has been set. More...
 
boost::optional< uint16_t > getFlowId ()
 Get the value of flowId if it has been set. More...
 
uint16_t getFlowId (uint16_t defaultValue)
 Get the value of flowId if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetFlowId (uint16_t newValue)
 Set flowId to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetFlowId ()
 Unset flowId in the currently-active mutator. More...
 
bool isModeSet ()
 Check whether mode has been set. More...
 
boost::optional< const uint8_t > getMode ()
 Get the value of mode if it has been set. More...
 
const uint8_t getMode (const uint8_t defaultValue)
 Get the value of mode if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetMode (const uint8_t newValue)
 Set mode to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetMode ()
 Unset mode in the currently-active mutator. More...
 
bool isMtuSet ()
 Check whether mtu has been set. More...
 
boost::optional< uint32_t > getMtu ()
 Get the value of mtu if it has been set. More...
 
uint32_t getMtu (uint32_t defaultValue)
 Get the value of mtu if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetMtu (uint32_t newValue)
 Set mtu to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetMtu ()
 Unset mtu in the currently-active mutator. More...
 
bool isSrcPrefixSet ()
 Check whether srcPrefix has been set. More...
 
boost::optional< const
std::string & > 
getSrcPrefix ()
 Get the value of srcPrefix if it has been set. More...
 
const std::string & getSrcPrefix (const std::string &defaultValue)
 Get the value of srcPrefix if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetSrcPrefix (const std::string &newValue)
 Set srcPrefix to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetSrcPrefix ()
 Unset srcPrefix in the currently-active mutator. More...
 
bool isTtlSet ()
 Check whether ttl has been set. More...
 
boost::optional< const uint8_t > getTtl ()
 Get the value of ttl if it has been set. More...
 
const uint8_t getTtl (const uint8_t defaultValue)
 Get the value of ttl if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetTtl (const uint8_t newValue)
 Set ttl to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetTtl ()
 Unset ttl in the currently-active mutator. More...
 
bool isVersionSet ()
 Check whether version has been set. More...
 
boost::optional< const uint8_t > getVersion ()
 Get the value of version if it has been set. More...
 
const uint8_t getVersion (const uint8_t defaultValue)
 Get the value of version if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetVersion (const uint8_t newValue)
 Set version to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetVersion ()
 Unset version in the currently-active mutator. More...
 
bool isVrfNameSet ()
 Check whether vrfName has been set. More...
 
boost::optional< const
std::string & > 
getVrfName ()
 Get the value of vrfName if it has been set. More...
 
const std::string & getVrfName (const std::string &defaultValue)
 Get the value of vrfName if set, otherwise the value of default passed in. More...
 
modelgbp::span::DstSummarysetVrfName (const std::string &newValue)
 Set vrfName to the specified value in the currently-active mutator. More...
 
modelgbp::span::DstSummaryunsetVrfName ()
 Unset vrfName in the currently-active mutator. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 DstSummary (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of DstSummary. More...
 

Static Public Member Functions

static boost::optional
< OF_SHARED_PTR
< modelgbp::span::DstSummary > > 
resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of DstSummary from the managed object store. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::span::DstSummary > > 
resolve (const opflex::modb::URI &uri)
 Retrieve an instance of DstSummary from the managed object store using the default framework instance. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::span::DstSummary > > 
resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName, const std::string &spanSrcGrpName, const std::string &spanDstMemberName)
 Retrieve an instance of DstSummary 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::DstSummary > > 
resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember (const std::string &platformConfigName, const std::string &spanSrcGrpName, const std::string &spanDstMemberName)
 Retrieve an instance of DstSummary from the default managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::span::DstSummary > > 
resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName, const std::string &spanDstGrpName, const std::string &spanDstMemberName)
 Retrieve an instance of DstSummary 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::DstSummary > > 
resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember (const std::string &platformConfigName, const std::string &spanDstGrpName, const std::string &spanDstMemberName)
 Retrieve an instance of DstSummary 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 DstSummary object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the DstSummary object with the specified URI using the currently-active mutator and the default framework instance. More...
 
static void removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName, const std::string &spanSrcGrpName, const std::string &spanDstMemberName)
 Remove the DstSummary object with the specified path elements from the managed object store. More...
 
static void removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember (const std::string &platformConfigName, const std::string &spanSrcGrpName, const std::string &spanDstMemberName)
 Remove the DstSummary object with the specified path elements from the managed object store using the default framework instance. More...
 
static void removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember (opflex::ofcore::OFFramework &framework, const std::string &platformConfigName, const std::string &spanDstGrpName, const std::string &spanDstMemberName)
 Remove the DstSummary object with the specified path elements from the managed object store. More...
 
static void removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember (const std::string &platformConfigName, const std::string &spanDstGrpName, const std::string &spanDstMemberName)
 Remove the DstSummary 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 = 79
 The unique class ID for DstSummary.
 

Constructor & Destructor Documentation

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

Construct an instance of DstSummary.

This should not typically be called from user code.

Member Function Documentation

boost::optional<const std::string&> modelgbp::span::DstSummary::getDest ( )
inline

Get the value of dest if it has been set.

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

References isDestSet().

Referenced by getDest().

const std::string& modelgbp::span::DstSummary::getDest ( const std::string &  defaultValue)
inline

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

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

References getDest().

boost::optional<const uint8_t> modelgbp::span::DstSummary::getDscp ( )
inline

Get the value of dscp if it has been set.

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

References isDscpSet().

Referenced by getDscp().

const uint8_t modelgbp::span::DstSummary::getDscp ( const uint8_t  defaultValue)
inline

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

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

References getDscp().

boost::optional<uint16_t> modelgbp::span::DstSummary::getFlowId ( )
inline

Get the value of flowId if it has been set.

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

References isFlowIdSet().

Referenced by getFlowId().

uint16_t modelgbp::span::DstSummary::getFlowId ( uint16_t  defaultValue)
inline

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

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

References getFlowId().

boost::optional<const uint8_t> modelgbp::span::DstSummary::getMode ( )
inline

Get the value of mode if it has been set.

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

References isModeSet().

Referenced by getMode().

const uint8_t modelgbp::span::DstSummary::getMode ( const uint8_t  defaultValue)
inline

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

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

References getMode().

boost::optional<uint32_t> modelgbp::span::DstSummary::getMtu ( )
inline

Get the value of mtu if it has been set.

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

References isMtuSet().

Referenced by getMtu().

uint32_t modelgbp::span::DstSummary::getMtu ( uint32_t  defaultValue)
inline

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

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

References getMtu().

boost::optional<const std::string&> modelgbp::span::DstSummary::getSrcPrefix ( )
inline

Get the value of srcPrefix if it has been set.

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

References isSrcPrefixSet().

Referenced by getSrcPrefix().

const std::string& modelgbp::span::DstSummary::getSrcPrefix ( const std::string &  defaultValue)
inline

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

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

References getSrcPrefix().

boost::optional<const uint8_t> modelgbp::span::DstSummary::getTtl ( )
inline

Get the value of ttl if it has been set.

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

References isTtlSet().

Referenced by getTtl().

const uint8_t modelgbp::span::DstSummary::getTtl ( const uint8_t  defaultValue)
inline

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

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

References getTtl().

boost::optional<const uint8_t> modelgbp::span::DstSummary::getVersion ( )
inline

Get the value of version if it has been set.

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

References isVersionSet().

Referenced by getVersion().

const uint8_t modelgbp::span::DstSummary::getVersion ( const uint8_t  defaultValue)
inline

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

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

References getVersion().

boost::optional<const std::string&> modelgbp::span::DstSummary::getVrfName ( )
inline

Get the value of vrfName if it has been set.

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

References isVrfNameSet().

Referenced by getVrfName().

const std::string& modelgbp::span::DstSummary::getVrfName ( const std::string &  defaultValue)
inline

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

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

References getVrfName().

bool modelgbp::span::DstSummary::isDestSet ( )
inline

Check whether dest has been set.

Returns
true if dest has been set

Referenced by getDest().

bool modelgbp::span::DstSummary::isDscpSet ( )
inline

Check whether dscp has been set.

Returns
true if dscp has been set

Referenced by getDscp().

bool modelgbp::span::DstSummary::isFlowIdSet ( )
inline

Check whether flowId has been set.

Returns
true if flowId has been set

Referenced by getFlowId().

bool modelgbp::span::DstSummary::isModeSet ( )
inline

Check whether mode has been set.

Returns
true if mode has been set

Referenced by getMode().

bool modelgbp::span::DstSummary::isMtuSet ( )
inline

Check whether mtu has been set.

Returns
true if mtu has been set

Referenced by getMtu().

bool modelgbp::span::DstSummary::isSrcPrefixSet ( )
inline

Check whether srcPrefix has been set.

Returns
true if srcPrefix has been set

Referenced by getSrcPrefix().

bool modelgbp::span::DstSummary::isTtlSet ( )
inline

Check whether ttl has been set.

Returns
true if ttl has been set

Referenced by getTtl().

bool modelgbp::span::DstSummary::isVersionSet ( )
inline

Check whether version has been set.

Returns
true if version has been set

Referenced by getVersion().

bool modelgbp::span::DstSummary::isVrfNameSet ( )
inline

Check whether vrfName has been set.

Returns
true if vrfName has been set

Referenced by getVrfName().

static void modelgbp::span::DstSummary::registerListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Register a listener that will get called for changes related to this class.

This listener will be called for any modifications of this class or any transitive children of this class.

Parameters
frameworkthe framework instance
listenerthe listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered.

References CLASS_ID.

Referenced by registerListener().

static void modelgbp::span::DstSummary::registerListener ( opflex::modb::ObjectListener *  listener)
inlinestatic

Register a listener that will get called for changes related to this class with the default framework instance.

This listener will be called for any modifications of this class or any transitive children of this class.

Parameters
listenerthe listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered.

References registerListener().

void modelgbp::span::DstSummary::remove ( )
inline

Remove this instance using the currently-active mutator.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

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

Remove the DstSummary object with the specified URI using the currently-active mutator.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Parameters
frameworkthe framework instance to use
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

static void modelgbp::span::DstSummary::remove ( const opflex::modb::URI &  uri)
inlinestatic

Remove the DstSummary object with the specified URI using the currently-active mutator and the default framework instance.

If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.

Parameters
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active
static void modelgbp::span::DstSummary::removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanDstGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Remove the DstSummary 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]/SpanDstGrp/[spanDstGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

Referenced by removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

static void modelgbp::span::DstSummary::removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember ( const std::string &  platformConfigName,
const std::string &  spanDstGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Remove the DstSummary 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]/SpanDstGrp/[spanDstGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Exceptions
std::logic_errorif no mutator is active

References removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

static void modelgbp::span::DstSummary::removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanSrcGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Remove the DstSummary 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]/SpanSrcGrp/[spanSrcGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

Referenced by removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

static void modelgbp::span::DstSummary::removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember ( const std::string &  platformConfigName,
const std::string &  spanSrcGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Remove the DstSummary 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]/SpanSrcGrp/[spanSrcGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Exceptions
std::logic_errorif no mutator is active

References removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

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

Retrieve an instance of DstSummary 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 modelgbp::span::DstMember::resolveSpanDstSummary(), resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), and resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

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

Retrieve an instance of DstSummary from the managed object store using the default framework instance.

If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.

Parameters
urithe URI of the object to retrieve
Returns
a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID.

static boost::optional<OF_SHARED_PTR<modelgbp::span::DstSummary> > modelgbp::span::DstSummary::resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanDstGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Retrieve an instance of DstSummary 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]/SpanDstGrp/[spanDstGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

Referenced by resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

static boost::optional<OF_SHARED_PTR<modelgbp::span::DstSummary> > modelgbp::span::DstSummary::resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember ( const std::string &  platformConfigName,
const std::string &  spanDstGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Retrieve an instance of DstSummary 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]/SpanDstGrp/[spanDstGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
spanDstGrpNamethe value of spanDstGrpName, a naming property for DstGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

static boost::optional<OF_SHARED_PTR<modelgbp::span::DstSummary> > modelgbp::span::DstSummary::resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember ( opflex::ofcore::OFFramework &  framework,
const std::string &  platformConfigName,
const std::string &  spanSrcGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Retrieve an instance of DstSummary 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]/SpanSrcGrp/[spanSrcGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
frameworkthe framework instance to use
platformConfigNamethe value of platformConfigName, a naming property for Config
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

Referenced by resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

static boost::optional<OF_SHARED_PTR<modelgbp::span::DstSummary> > modelgbp::span::DstSummary::resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember ( const std::string &  platformConfigName,
const std::string &  spanSrcGrpName,
const std::string &  spanDstMemberName 
)
inlinestatic

Retrieve an instance of DstSummary 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]/SpanSrcGrp/[spanSrcGrpName]/SpanDstMember/[spanDstMemberName]/SpanDstSummary

Parameters
platformConfigNamethe value of platformConfigName, a naming property for Config
spanSrcGrpNamethe value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberNamethe value of spanDstMemberName, a naming property for DstMember
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

modelgbp::span::DstSummary& modelgbp::span::DstSummary::setDest ( const std::string &  newValue)
inline

Set dest to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setDscp ( const uint8_t  newValue)
inline

Set dscp to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setFlowId ( uint16_t  newValue)
inline

Set flowId to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setMode ( const uint8_t  newValue)
inline

Set mode to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setMtu ( uint32_t  newValue)
inline

Set mtu to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setSrcPrefix ( const std::string &  newValue)
inline

Set srcPrefix to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setTtl ( const uint8_t  newValue)
inline

Set ttl to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setVersion ( const uint8_t  newValue)
inline

Set version to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::setVrfName ( const std::string &  newValue)
inline

Set vrfName to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See Also
opflex::modb::Mutator
static void modelgbp::span::DstSummary::unregisterListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Unregister a listener from updates to this class.

Parameters
frameworkthe framework instance
listenerThe listener to unregister.

References CLASS_ID.

Referenced by unregisterListener().

static void modelgbp::span::DstSummary::unregisterListener ( opflex::modb::ObjectListener *  listener)
inlinestatic

Unregister a listener from updates to this class from the default framework instance.

Parameters
listenerThe listener to unregister.

References unregisterListener().

modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetDest ( )
inline

Unset dest in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetDscp ( )
inline

Unset dscp in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetFlowId ( )
inline

Unset flowId in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetMode ( )
inline

Unset mode in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetMtu ( )
inline

Unset mtu in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetSrcPrefix ( )
inline

Unset srcPrefix in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetTtl ( )
inline

Unset ttl in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetVersion ( )
inline

Unset version in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See Also
opflex::modb::Mutator
modelgbp::span::DstSummary& modelgbp::span::DstSummary::unsetVrfName ( )
inline

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