Inheritance diagram for modelgbp::span::DstSummary:

Public Member Functions
bool	isDestSet ()
	Check whether dest has been set.

boost::optional< const std::string & >	getDest ()
	Get the value of dest if it has been set.

const std::string &	getDest (const std::string &defaultValue)
	Get the value of dest if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setDest (const std::string &newValue)
	Set dest to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetDest ()
	Unset dest in the currently-active mutator.

bool	isDscpSet ()
	Check whether dscp has been set.

boost::optional< const uint8_t >	getDscp ()
	Get the value of dscp if it has been set.

const uint8_t	getDscp (const uint8_t defaultValue)
	Get the value of dscp if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setDscp (const uint8_t newValue)
	Set dscp to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetDscp ()
	Unset dscp in the currently-active mutator.

bool	isFlowIdSet ()
	Check whether flowId has been set.

boost::optional< uint16_t >	getFlowId ()
	Get the value of flowId if it has been set.

uint16_t	getFlowId (uint16_t defaultValue)
	Get the value of flowId if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setFlowId (uint16_t newValue)
	Set flowId to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetFlowId ()
	Unset flowId in the currently-active mutator.

bool	isModeSet ()
	Check whether mode has been set.

boost::optional< const uint8_t >	getMode ()
	Get the value of mode if it has been set.

const uint8_t	getMode (const uint8_t defaultValue)
	Get the value of mode if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setMode (const uint8_t newValue)
	Set mode to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetMode ()
	Unset mode in the currently-active mutator.

bool	isMtuSet ()
	Check whether mtu has been set.

boost::optional< uint32_t >	getMtu ()
	Get the value of mtu if it has been set.

uint32_t	getMtu (uint32_t defaultValue)
	Get the value of mtu if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setMtu (uint32_t newValue)
	Set mtu to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetMtu ()
	Unset mtu in the currently-active mutator.

bool	isSrcPrefixSet ()
	Check whether srcPrefix has been set.

boost::optional< const std::string & >	getSrcPrefix ()
	Get the value of srcPrefix if it has been set.

const std::string &	getSrcPrefix (const std::string &defaultValue)
	Get the value of srcPrefix if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setSrcPrefix (const std::string &newValue)
	Set srcPrefix to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetSrcPrefix ()
	Unset srcPrefix in the currently-active mutator.

bool	isTtlSet ()
	Check whether ttl has been set.

boost::optional< const uint8_t >	getTtl ()
	Get the value of ttl if it has been set.

const uint8_t	getTtl (const uint8_t defaultValue)
	Get the value of ttl if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setTtl (const uint8_t newValue)
	Set ttl to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetTtl ()
	Unset ttl in the currently-active mutator.

bool	isVersionSet ()
	Check whether version has been set.

boost::optional< const uint8_t >	getVersion ()
	Get the value of version if it has been set.

const uint8_t	getVersion (const uint8_t defaultValue)
	Get the value of version if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setVersion (const uint8_t newValue)
	Set version to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetVersion ()
	Unset version in the currently-active mutator.

bool	isVrfNameSet ()
	Check whether vrfName has been set.

boost::optional< const std::string & >	getVrfName ()
	Get the value of vrfName if it has been set.

const std::string &	getVrfName (const std::string &defaultValue)
	Get the value of vrfName if set, otherwise the value of default passed in.

modelgbp::span::DstSummary &	setVrfName (const std::string &newValue)
	Set vrfName to the specified value in the currently-active mutator.

modelgbp::span::DstSummary &	unsetVrfName ()
	Unset vrfName in the currently-active mutator.

void	remove ()
	Remove this instance using the currently-active mutator.

	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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 = 79
	The unique class ID for DstSummary.

Constructor & Destructor Documentation

◆ DstSummary()

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

◆ getDest() [1/2]

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(), and resolve().

Referenced by getDest().

◆ getDest() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of dest if set, otherwise the value of default passed in

References getDest(), and resolve().

◆ getDscp() [1/2]

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(), and resolve().

Referenced by getDscp().

◆ getDscp() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of dscp if set, otherwise the value of default passed in

References getDscp(), and resolve().

◆ getFlowId() [1/2]

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(), and resolve().

Referenced by getFlowId().

◆ getFlowId() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of flowId if set, otherwise the value of default passed in

References getFlowId(), and resolve().

◆ getMode() [1/2]

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(), and resolve().

Referenced by getMode().

◆ getMode() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of mode if set, otherwise the value of default passed in

References getMode(), and resolve().

◆ getMtu() [1/2]

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(), and resolve().

Referenced by getMtu().

◆ getMtu() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of mtu if set, otherwise the value of default passed in

References getMtu(), and resolve().

◆ getSrcPrefix() [1/2]

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(), and resolve().

Referenced by getSrcPrefix().

◆ getSrcPrefix() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of srcPrefix if set, otherwise the value of default passed in

References getSrcPrefix(), and resolve().

◆ getTtl() [1/2]

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(), and resolve().

Referenced by getTtl().

◆ getTtl() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of ttl if set, otherwise the value of default passed in

References getTtl(), and resolve().

◆ getVersion() [1/2]

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(), and resolve().

Referenced by getVersion().

◆ getVersion() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of version if set, otherwise the value of default passed in

References getVersion(), and resolve().

◆ getVrfName() [1/2]

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(), and resolve().

Referenced by getVrfName().

◆ getVrfName() [2/2]

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

defaultValue default value returned if the property is not set

Returns: the value of vrfName if set, otherwise the value of default passed in

References getVrfName(), and resolve().

◆ isDestSet()

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

inline

Check whether dest has been set.

Returns: true if dest has been set

References resolve().

Referenced by getDest().

◆ isDscpSet()

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

inline

Check whether dscp has been set.

Returns: true if dscp has been set

References resolve().

Referenced by getDscp().

◆ isFlowIdSet()

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

inline

Check whether flowId has been set.

Returns: true if flowId has been set

References resolve().

Referenced by getFlowId().

◆ isModeSet()

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

inline

Check whether mode has been set.

Returns: true if mode has been set

References resolve().

Referenced by getMode().

◆ isMtuSet()

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

inline

Check whether mtu has been set.

Returns: true if mtu has been set

References resolve().

Referenced by getMtu().

◆ isSrcPrefixSet()

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

inline

Check whether srcPrefix has been set.

Returns: true if srcPrefix has been set

References resolve().

Referenced by getSrcPrefix().

◆ isTtlSet()

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

inline

Check whether ttl has been set.

Returns: true if ttl has been set

References resolve().

Referenced by getTtl().

◆ isVersionSet()

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

inline

Check whether version has been set.

Returns: true if version has been set

References resolve().

Referenced by getVersion().

◆ isVrfNameSet()

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

inline

Check whether vrfName has been set.

Returns: true if vrfName has been set

References resolve().

Referenced by getVrfName().

◆ registerListener() [1/2]

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

listener the 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(), and resolve().

◆ registerListener() [2/2]

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

framework	the framework instance
listener	the 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, and resolve().

Referenced by registerListener().

◆ remove() [1/3]

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_error if no mutator is active

References CLASS_ID, and resolve().

Referenced by remove().

◆ remove() [2/3]

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

uri	the URI of the object to remove

Exceptions

std::logic_error if no mutator is active

References remove(), and resolve().

◆ remove() [3/3]

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

framework	the framework instance to use
uri	the URI of the object to remove

Exceptions

std::logic_error if no mutator is active

References CLASS_ID, and resolve().

◆ removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [1/2]

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

platformConfigName	the value of platformConfigName, a naming property for Config
spanDstGrpName	the value of spanDstGrpName, a naming property for DstGrp
spanDstMemberName	the value of spanDstMemberName, a naming property for DstMember

Exceptions

std::logic_error if no mutator is active

References removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), and resolve().

◆ removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [2/2]

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

framework	the framework instance to use
platformConfigName	the value of platformConfigName, a naming property for Config
spanDstGrpName	the value of spanDstGrpName, a naming property for DstGrp
spanDstMemberName	the value of spanDstMemberName, a naming property for DstMember

Exceptions

std::logic_error if no mutator is active

References CLASS_ID, and resolve().

Referenced by removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

◆ removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [1/2]

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

platformConfigName	the value of platformConfigName, a naming property for Config
spanSrcGrpName	the value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberName	the value of spanDstMemberName, a naming property for DstMember

Exceptions

std::logic_error if no mutator is active

References removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember(), and resolve().

◆ removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [2/2]

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

framework	the framework instance to use
platformConfigName	the value of platformConfigName, a naming property for Config
spanSrcGrpName	the value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberName	the value of spanDstMemberName, a naming property for DstMember

Exceptions

std::logic_error if no mutator is active

References CLASS_ID, and resolve().

Referenced by removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

◆ resolve() [1/2]

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

uri	the URI of the object to retrieve

Returns: a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID, and resolve().

◆ resolve() [2/2]

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

framework	the framework instance to use
uri	the URI of the object to retrieve

Returns: a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID, and resolve().

Referenced by getDest(), getDest(), getDscp(), getDscp(), getFlowId(), getFlowId(), getMode(), getMode(), getMtu(), getMtu(), getSrcPrefix(), getSrcPrefix(), getTtl(), getTtl(), getVersion(), getVersion(), getVrfName(), getVrfName(), isDestSet(), isDscpSet(), isFlowIdSet(), isModeSet(), isMtuSet(), isSrcPrefixSet(), isTtlSet(), isVersionSet(), isVrfNameSet(), registerListener(), registerListener(), remove(), remove(), remove(), removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember(), removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember(), resolve(), resolve(), modelgbp::span::DstMember::resolveSpanDstSummary(), resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember(), resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember(), resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember(), setDest(), setDscp(), setFlowId(), setMode(), setMtu(), setSrcPrefix(), setTtl(), setVersion(), setVrfName(), unregisterListener(), unregisterListener(), unsetDest(), unsetDscp(), unsetFlowId(), unsetMode(), unsetMtu(), unsetSrcPrefix(), unsetTtl(), unsetVersion(), and unsetVrfName().

◆ resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [1/2]

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

platformConfigName	the value of platformConfigName, a naming property for Config
spanDstGrpName	the value of spanDstGrpName, a naming property for DstGrp
spanDstMemberName	the 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(), and resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember().

◆ resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [2/2]

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

framework	the framework instance to use
platformConfigName	the value of platformConfigName, a naming property for Config
spanDstGrpName	the value of spanDstGrpName, a naming property for DstGrp
spanDstMemberName	the 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().

◆ resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [1/2]

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

platformConfigName	the value of platformConfigName, a naming property for Config
spanSrcGrpName	the value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberName	the 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(), and resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember().

◆ resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [2/2]

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

framework	the framework instance to use
platformConfigName	the value of platformConfigName, a naming property for Config
spanSrcGrpName	the value of spanSrcGrpName, a naming property for SrcGrp
spanDstMemberName	the 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().

◆ setDest()

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

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setDscp()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setDscp ( const uint8_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setFlowId()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setFlowId ( uint16_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setMode()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setMode ( const uint8_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setMtu()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setMtu ( uint32_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setSrcPrefix()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setSrcPrefix ( const std::string & newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setTtl()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setTtl ( const uint8_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setVersion()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setVersion ( const uint8_t newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ setVrfName()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::setVrfName ( const std::string & newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ unregisterListener() [1/2]

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

listener The listener to unregister.

References resolve(), and unregisterListener().

◆ unregisterListener() [2/2]

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

inlinestatic

Unregister a listener from updates to this class.

Parameters

framework	the framework instance
listener	The listener to unregister.

References CLASS_ID, and resolve().

Referenced by unregisterListener().

◆ unsetDest()

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

inline

Unset dest in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetDscp()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetDscp ( )

inline

Unset dscp in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetFlowId()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetFlowId ( )

inline

Unset flowId in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetMode()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetMode ( )

inline

Unset mode in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetMtu()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetMtu ( )

inline

Unset mtu in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetSrcPrefix()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetSrcPrefix ( )

inline

Unset srcPrefix in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetTtl()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetTtl ( )

inline

Unset ttl in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetVersion()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetVersion ( )

inline

Unset version in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

◆ unsetVrfName()

modelgbp::span::DstSummary & modelgbp::span::DstSummary::unsetVrfName ( )

inline

Unset vrfName in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

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

DstSummary.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ DstSummary()

Member Function Documentation

◆ getDest() [1/2]

◆ getDest() [2/2]

◆ getDscp() [1/2]

◆ getDscp() [2/2]

◆ getFlowId() [1/2]

◆ getFlowId() [2/2]

◆ getMode() [1/2]

◆ getMode() [2/2]

◆ getMtu() [1/2]

◆ getMtu() [2/2]

◆ getSrcPrefix() [1/2]

◆ getSrcPrefix() [2/2]

◆ getTtl() [1/2]

◆ getTtl() [2/2]

◆ getVersion() [1/2]

◆ getVersion() [2/2]

◆ getVrfName() [1/2]

◆ getVrfName() [2/2]

◆ isDestSet()

◆ isDscpSet()

◆ isFlowIdSet()

◆ isModeSet()

◆ isMtuSet()

◆ isSrcPrefixSet()

◆ isTtlSet()

◆ isVersionSet()

◆ isVrfNameSet()

◆ registerListener() [1/2]

◆ registerListener() [2/2]

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [1/2]

◆ removeUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [2/2]

◆ removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [1/2]

◆ removeUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [2/2]

◆ resolve() [1/2]

◆ resolve() [2/2]

◆ resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [1/2]

◆ resolveUnderPolicyUniversePlatformConfigSpanDstGrpSpanDstMember() [2/2]

◆ resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [1/2]

◆ resolveUnderPolicyUniversePlatformConfigSpanSrcGrpSpanDstMember() [2/2]

◆ setDest()

◆ setDscp()

◆ setFlowId()

◆ setMode()

◆ setMtu()

◆ setSrcPrefix()

◆ setTtl()

◆ setVersion()

◆ setVrfName()

◆ unregisterListener() [1/2]

◆ unregisterListener() [2/2]

◆ unsetDest()

◆ unsetDscp()

◆ unsetFlowId()

◆ unsetMode()

◆ unsetMtu()

◆ unsetSrcPrefix()

◆ unsetTtl()

◆ unsetVersion()

◆ unsetVrfName()