modelgbp Generated OpFlex Model 1.7.0
modelgbp::gbp::EpGroup Class Reference
Inheritance diagram for modelgbp::gbp::EpGroup:

Public Member Functions

bool isIntraGroupPolicySet ()
 Check whether intraGroupPolicy has been set.
 
boost::optional< const uint8_t > getIntraGroupPolicy ()
 Get the value of intraGroupPolicy if it has been set.
 
const uint8_t getIntraGroupPolicy (const uint8_t defaultValue)
 Get the value of intraGroupPolicy if set, otherwise the value of default passed in.
 
modelgbp::gbp::EpGroupsetIntraGroupPolicy (const uint8_t newValue)
 Set intraGroupPolicy to the specified value in the currently-active mutator.
 
modelgbp::gbp::EpGroupunsetIntraGroupPolicy ()
 Unset intraGroupPolicy in the currently-active mutator.
 
bool isNameSet ()
 Check whether name has been set.
 
boost::optional< const std::string & > getName ()
 Get the value of name if it has been set.
 
const std::string & getName (const std::string &defaultValue)
 Get the value of name if set, otherwise the value of default passed in.
 
modelgbp::gbp::EpGroupsetName (const std::string &newValue)
 Set name to the specified value in the currently-active mutator.
 
modelgbp::gbp::EpGroupunsetName ()
 Unset name in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt > > resolveGbpeEpgMappingFromDefaultGroupRTgt (const std::string &gbpeEpgMappingFromDefaultGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgtaddGbpeEpgMappingFromDefaultGroupRTgt (const std::string &gbpeEpgMappingFromDefaultGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpeEpgMappingFromDefaultGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt > > resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt (const std::string &gbpeIndirectEpgMappingFromDefaultGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgtaddGbpeIndirectEpgMappingFromDefaultGroupRTgt (const std::string &gbpeIndirectEpgMappingFromDefaultGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgt > > resolveGbpeMappingRuleFromGroupRTgt (const std::string &gbpeMappingRuleFromGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgtaddGbpeMappingRuleFromGroupRTgt (const std::string &gbpeMappingRuleFromGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpeMappingRuleFromGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbpe::MappingRuleFromGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbpe::InstContext > > resolveGbpeInstContext ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbpe::InstContextaddGbpeInstContext ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgt > > resolveSpanMemberFromRefRTgt (const std::string &spanMemberFromRefRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgtaddSpanMemberFromRefRTgt (const std::string &spanMemberFromRefRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveSpanMemberFromRefRTgt (std::vector< OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::span::MemberFromRefRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgt > > resolveEpdrEndPointFromGroupRTgt (const std::string &epdrEndPointFromGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgtaddEpdrEndPointFromGroupRTgt (const std::string &epdrEndPointFromGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveEpdrEndPointFromGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::epdr::EndPointFromGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgt > > resolveInvLocalInventoryEpFromGroupRTgt (const std::string &invLocalInventoryEpFromGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgtaddInvLocalInventoryEpFromGroupRTgt (const std::string &invLocalInventoryEpFromGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvLocalInventoryEpFromGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::LocalInventoryEpFromGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgt > > resolveInvIpMappingFromGroupRTgt (const std::string &invIpMappingFromGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgtaddInvIpMappingFromGroupRTgt (const std::string &invIpMappingFromGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveInvIpMappingFromGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::IpMappingFromGroupRTgt.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToNetworkRSrc > > resolveGbpEpGroupToNetworkRSrc ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::EpGroupToNetworkRSrcaddGbpEpGroupToNetworkRSrc ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrc > > resolveGbpEpGroupToProvContractRSrc (const std::string &gbpEpGroupToProvContractRSrcTargetName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrcaddGbpEpGroupToProvContractRSrc (const std::string &gbpEpGroupToProvContractRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpEpGroupToProvContractRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToProvContractRSrc.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrc > > resolveGbpEpGroupToConsContractRSrc (const std::string &gbpEpGroupToConsContractRSrcTargetName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrcaddGbpEpGroupToConsContractRSrc (const std::string &gbpEpGroupToConsContractRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpEpGroupToConsContractRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToConsContractRSrc.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrc > > resolveGbpEpGroupToIntraContractRSrc (const std::string &gbpEpGroupToIntraContractRSrcTargetName)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrcaddGbpEpGroupToIntraContractRSrc (const std::string &gbpEpGroupToIntraContractRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpEpGroupToIntraContractRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToIntraContractRSrc.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToSubnetsRSrc > > resolveGbpEpGroupToSubnetsRSrc ()
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::EpGroupToSubnetsRSrcaddGbpEpGroupToSubnetsRSrc ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt > > resolveGbpL3ExternalNetworkFromNatEPGroupRTgt (const std::string &gbpL3ExternalNetworkFromNatEPGroupRTgtSource)
 Retrieve the child object with the specified naming properties.
 
OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgtaddGbpL3ExternalNetworkFromNatEPGroupRTgt (const std::string &gbpL3ExternalNetworkFromNatEPGroupRTgtSource)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
 
void resolveGbpL3ExternalNetworkFromNatEPGroupRTgt (std::vector< OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt.
 
void remove ()
 Remove this instance using the currently-active mutator.
 
 EpGroup (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of EpGroup.
 

Static Public Member Functions

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

Constructor & Destructor Documentation

◆ EpGroup()

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

Construct an instance of EpGroup.

This should not typically be called from user code.

References CLASS_ID.

Member Function Documentation

◆ addEpdrEndPointFromGroupRTgt()

OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgt > modelgbp::gbp::EpGroup::addEpdrEndPointFromGroupRTgt ( const std::string & epdrEndPointFromGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
epdrEndPointFromGroupRTgtSourcethe value of epdrEndPointFromGroupRTgtSource, a naming property for EndPointFromGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpeEpgMappingFromDefaultGroupRTgt()

OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt > modelgbp::gbp::EpGroup::addGbpeEpgMappingFromDefaultGroupRTgt ( const std::string & gbpeEpgMappingFromDefaultGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpeEpgMappingFromDefaultGroupRTgtSourcethe value of gbpeEpgMappingFromDefaultGroupRTgtSource, a naming property for EpgMappingFromDefaultGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpeIndirectEpgMappingFromDefaultGroupRTgt()

OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt > modelgbp::gbp::EpGroup::addGbpeIndirectEpgMappingFromDefaultGroupRTgt ( const std::string & gbpeIndirectEpgMappingFromDefaultGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpeIndirectEpgMappingFromDefaultGroupRTgtSourcethe value of gbpeIndirectEpgMappingFromDefaultGroupRTgtSource, a naming property for IndirectEpgMappingFromDefaultGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpeInstContext()

OF_SHARED_PTR< modelgbp::gbpe::InstContext > modelgbp::gbp::EpGroup::addGbpeInstContext ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpeMappingRuleFromGroupRTgt()

OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgt > modelgbp::gbp::EpGroup::addGbpeMappingRuleFromGroupRTgt ( const std::string & gbpeMappingRuleFromGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpeMappingRuleFromGroupRTgtSourcethe value of gbpeMappingRuleFromGroupRTgtSource, a naming property for MappingRuleFromGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpEpGroupToConsContractRSrc()

OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrc > modelgbp::gbp::EpGroup::addGbpEpGroupToConsContractRSrc ( const std::string & gbpEpGroupToConsContractRSrcTargetName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpEpGroupToConsContractRSrcTargetClassthe value of gbpEpGroupToConsContractRSrcTargetClass, a naming property for EpGroupToConsContractRSrc
gbpEpGroupToConsContractRSrcTargetNamethe value of gbpEpGroupToConsContractRSrcTargetName, a naming property for EpGroupToConsContractRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpEpGroupToIntraContractRSrc()

OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrc > modelgbp::gbp::EpGroup::addGbpEpGroupToIntraContractRSrc ( const std::string & gbpEpGroupToIntraContractRSrcTargetName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpEpGroupToIntraContractRSrcTargetClassthe value of gbpEpGroupToIntraContractRSrcTargetClass, a naming property for EpGroupToIntraContractRSrc
gbpEpGroupToIntraContractRSrcTargetNamethe value of gbpEpGroupToIntraContractRSrcTargetName, a naming property for EpGroupToIntraContractRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpEpGroupToNetworkRSrc()

OF_SHARED_PTR< modelgbp::gbp::EpGroupToNetworkRSrc > modelgbp::gbp::EpGroup::addGbpEpGroupToNetworkRSrc ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpEpGroupToProvContractRSrc()

OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrc > modelgbp::gbp::EpGroup::addGbpEpGroupToProvContractRSrc ( const std::string & gbpEpGroupToProvContractRSrcTargetName)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpEpGroupToProvContractRSrcTargetClassthe value of gbpEpGroupToProvContractRSrcTargetClass, a naming property for EpGroupToProvContractRSrc
gbpEpGroupToProvContractRSrcTargetNamethe value of gbpEpGroupToProvContractRSrcTargetName, a naming property for EpGroupToProvContractRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpEpGroupToSubnetsRSrc()

OF_SHARED_PTR< modelgbp::gbp::EpGroupToSubnetsRSrc > modelgbp::gbp::EpGroup::addGbpEpGroupToSubnetsRSrc ( )
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpL3ExternalNetworkFromNatEPGroupRTgt()

OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt > modelgbp::gbp::EpGroup::addGbpL3ExternalNetworkFromNatEPGroupRTgt ( const std::string & gbpL3ExternalNetworkFromNatEPGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
gbpL3ExternalNetworkFromNatEPGroupRTgtSourcethe value of gbpL3ExternalNetworkFromNatEPGroupRTgtSource, a naming property for L3ExternalNetworkFromNatEPGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvIpMappingFromGroupRTgt()

OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgt > modelgbp::gbp::EpGroup::addInvIpMappingFromGroupRTgt ( const std::string & invIpMappingFromGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
invIpMappingFromGroupRTgtSourcethe value of invIpMappingFromGroupRTgtSource, a naming property for IpMappingFromGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvLocalInventoryEpFromGroupRTgt()

OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgt > modelgbp::gbp::EpGroup::addInvLocalInventoryEpFromGroupRTgt ( const std::string & invLocalInventoryEpFromGroupRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
invLocalInventoryEpFromGroupRTgtSourcethe value of invLocalInventoryEpFromGroupRTgtSource, a naming property for LocalInventoryEpFromGroupRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addSpanMemberFromRefRTgt()

OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgt > modelgbp::gbp::EpGroup::addSpanMemberFromRefRTgt ( const std::string & spanMemberFromRefRTgtSource)
inline

Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.

Parameters
spanMemberFromRefRTgtSourcethe value of spanMemberFromRefRTgtSource, a naming property for MemberFromRefRTgt
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ getIntraGroupPolicy() [1/2]

boost::optional< const uint8_t > modelgbp::gbp::EpGroup::getIntraGroupPolicy ( )
inline

Get the value of intraGroupPolicy if it has been set.

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

References isIntraGroupPolicySet().

Referenced by getIntraGroupPolicy().

◆ getIntraGroupPolicy() [2/2]

const uint8_t modelgbp::gbp::EpGroup::getIntraGroupPolicy ( const uint8_t defaultValue)
inline

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

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

References getIntraGroupPolicy().

◆ getName() [1/2]

boost::optional< const std::string & > modelgbp::gbp::EpGroup::getName ( )
inline

Get the value of name if it has been set.

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

References isNameSet().

Referenced by getName().

◆ getName() [2/2]

const std::string & modelgbp::gbp::EpGroup::getName ( const std::string & defaultValue)
inline

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

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

References getName().

◆ isIntraGroupPolicySet()

bool modelgbp::gbp::EpGroup::isIntraGroupPolicySet ( )
inline

Check whether intraGroupPolicy has been set.

Returns
true if intraGroupPolicy has been set

Referenced by getIntraGroupPolicy().

◆ isNameSet()

bool modelgbp::gbp::EpGroup::isNameSet ( )
inline

Check whether name has been set.

Returns
true if name has been set

Referenced by getName().

◆ registerListener() [1/2]

static void modelgbp::gbp::EpGroup::registerListener ( opflex::modb::ObjectListener * listener)
inlinestatic

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

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

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

References registerListener().

◆ registerListener() [2/2]

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

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

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

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

References CLASS_ID.

Referenced by registerListener().

◆ remove() [1/5]

void modelgbp::gbp::EpGroup::remove ( )
inline

Remove this instance using the currently-active mutator.

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

Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

Referenced by remove(), and remove().

◆ remove() [2/5]

static void modelgbp::gbp::EpGroup::remove ( const opflex::modb::URI & uri)
inlinestatic

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

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

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

References remove().

◆ remove() [3/5]

static void modelgbp::gbp::EpGroup::remove ( const std::string & policySpaceName,
const std::string & gbpEpGroupName )
inlinestatic

Remove the EpGroup 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/PolicySpace/[policySpaceName]/GbpEpGroup/[gbpEpGroupName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpEpGroupNamethe value of gbpEpGroupName, a naming property for EpGroup
Exceptions
std::logic_errorif no mutator is active

References remove().

◆ remove() [4/5]

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

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

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

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

References CLASS_ID.

◆ remove() [5/5]

static void modelgbp::gbp::EpGroup::remove ( opflex::ofcore::OFFramework & framework,
const std::string & policySpaceName,
const std::string & gbpEpGroupName )
inlinestatic

Remove the EpGroup 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/PolicySpace/[policySpaceName]/GbpEpGroup/[gbpEpGroupName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpEpGroupNamethe value of gbpEpGroupName, a naming property for EpGroup
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ resolve() [1/4]

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

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

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

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

References CLASS_ID.

◆ resolve() [2/4]

static boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroup > > modelgbp::gbp::EpGroup::resolve ( const std::string & policySpaceName,
const std::string & gbpEpGroupName )
inlinestatic

Retrieve an instance of EpGroup 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/PolicySpace/[policySpaceName]/GbpEpGroup/[gbpEpGroupName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpEpGroupNamethe value of gbpEpGroupName, a naming property for EpGroup
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolve() [3/4]

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

Retrieve an instance of EpGroup from the managed object store.

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

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

References CLASS_ID.

Referenced by resolve(), resolve(), and modelgbp::policy::Space::resolveGbpEpGroup().

◆ resolve() [4/4]

static boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroup > > modelgbp::gbp::EpGroup::resolve ( opflex::ofcore::OFFramework & framework,
const std::string & policySpaceName,
const std::string & gbpEpGroupName )
inlinestatic

Retrieve an instance of EpGroup 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/PolicySpace/[policySpaceName]/GbpEpGroup/[gbpEpGroupName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpEpGroupNamethe value of gbpEpGroupName, a naming property for EpGroup
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolveEpdrEndPointFromGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgt > > modelgbp::gbp::EpGroup::resolveEpdrEndPointFromGroupRTgt ( const std::string & epdrEndPointFromGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
epdrEndPointFromGroupRTgtSourcethe value of epdrEndPointFromGroupRTgtSource, a naming property for EndPointFromGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::epdr::EndPointFromGroupRTgt::resolve().

◆ resolveEpdrEndPointFromGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveEpdrEndPointFromGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::epdr::EndPointFromGroupRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::epdr::EndPointFromGroupRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpeEpgMappingFromDefaultGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt > > modelgbp::gbp::EpGroup::resolveGbpeEpgMappingFromDefaultGroupRTgt ( const std::string & gbpeEpgMappingFromDefaultGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpeEpgMappingFromDefaultGroupRTgtSourcethe value of gbpeEpgMappingFromDefaultGroupRTgtSource, a naming property for EpgMappingFromDefaultGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt::resolve().

◆ resolveGbpeEpgMappingFromDefaultGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpeEpgMappingFromDefaultGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbpe::EpgMappingFromDefaultGroupRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt > > modelgbp::gbp::EpGroup::resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt ( const std::string & gbpeIndirectEpgMappingFromDefaultGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpeIndirectEpgMappingFromDefaultGroupRTgtSourcethe value of gbpeIndirectEpgMappingFromDefaultGroupRTgtSource, a naming property for IndirectEpgMappingFromDefaultGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt::resolve().

◆ resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpeIndirectEpgMappingFromDefaultGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbpe::IndirectEpgMappingFromDefaultGroupRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpeInstContext()

boost::optional< OF_SHARED_PTR< modelgbp::gbpe::InstContext > > modelgbp::gbp::EpGroup::resolveGbpeInstContext ( )
inline

Retrieve the child object with the specified naming properties.

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

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

References modelgbp::gbpe::InstContext::resolve().

◆ resolveGbpeMappingRuleFromGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgt > > modelgbp::gbp::EpGroup::resolveGbpeMappingRuleFromGroupRTgt ( const std::string & gbpeMappingRuleFromGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpeMappingRuleFromGroupRTgtSourcethe value of gbpeMappingRuleFromGroupRTgtSource, a naming property for MappingRuleFromGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbpe::MappingRuleFromGroupRTgt::resolve().

◆ resolveGbpeMappingRuleFromGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpeMappingRuleFromGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::gbpe::MappingRuleFromGroupRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbpe::MappingRuleFromGroupRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpEpGroupToConsContractRSrc() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrc > > modelgbp::gbp::EpGroup::resolveGbpEpGroupToConsContractRSrc ( const std::string & gbpEpGroupToConsContractRSrcTargetName)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpEpGroupToConsContractRSrcTargetClassthe value of gbpEpGroupToConsContractRSrcTargetClass, a naming property for EpGroupToConsContractRSrc
gbpEpGroupToConsContractRSrcTargetNamethe value of gbpEpGroupToConsContractRSrcTargetName, a naming property for EpGroupToConsContractRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbp::EpGroupToConsContractRSrc::resolve().

◆ resolveGbpEpGroupToConsContractRSrc() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpEpGroupToConsContractRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToConsContractRSrc > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToConsContractRSrc.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpEpGroupToIntraContractRSrc() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrc > > modelgbp::gbp::EpGroup::resolveGbpEpGroupToIntraContractRSrc ( const std::string & gbpEpGroupToIntraContractRSrcTargetName)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpEpGroupToIntraContractRSrcTargetClassthe value of gbpEpGroupToIntraContractRSrcTargetClass, a naming property for EpGroupToIntraContractRSrc
gbpEpGroupToIntraContractRSrcTargetNamethe value of gbpEpGroupToIntraContractRSrcTargetName, a naming property for EpGroupToIntraContractRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbp::EpGroupToIntraContractRSrc::resolve().

◆ resolveGbpEpGroupToIntraContractRSrc() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpEpGroupToIntraContractRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToIntraContractRSrc > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToIntraContractRSrc.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpEpGroupToNetworkRSrc()

boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToNetworkRSrc > > modelgbp::gbp::EpGroup::resolveGbpEpGroupToNetworkRSrc ( )
inline

Retrieve the child object with the specified naming properties.

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

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

References modelgbp::gbp::EpGroupToNetworkRSrc::resolve().

◆ resolveGbpEpGroupToProvContractRSrc() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrc > > modelgbp::gbp::EpGroup::resolveGbpEpGroupToProvContractRSrc ( const std::string & gbpEpGroupToProvContractRSrcTargetName)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpEpGroupToProvContractRSrcTargetClassthe value of gbpEpGroupToProvContractRSrcTargetClass, a naming property for EpGroupToProvContractRSrc
gbpEpGroupToProvContractRSrcTargetNamethe value of gbpEpGroupToProvContractRSrcTargetName, a naming property for EpGroupToProvContractRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbp::EpGroupToProvContractRSrc::resolve().

◆ resolveGbpEpGroupToProvContractRSrc() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpEpGroupToProvContractRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::EpGroupToProvContractRSrc > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbp::EpGroupToProvContractRSrc.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveGbpEpGroupToSubnetsRSrc()

boost::optional< OF_SHARED_PTR< modelgbp::gbp::EpGroupToSubnetsRSrc > > modelgbp::gbp::EpGroup::resolveGbpEpGroupToSubnetsRSrc ( )
inline

Retrieve the child object with the specified naming properties.

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

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

References modelgbp::gbp::EpGroupToSubnetsRSrc::resolve().

◆ resolveGbpL3ExternalNetworkFromNatEPGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt > > modelgbp::gbp::EpGroup::resolveGbpL3ExternalNetworkFromNatEPGroupRTgt ( const std::string & gbpL3ExternalNetworkFromNatEPGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
gbpL3ExternalNetworkFromNatEPGroupRTgtSourcethe value of gbpL3ExternalNetworkFromNatEPGroupRTgtSource, a naming property for L3ExternalNetworkFromNatEPGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt::resolve().

◆ resolveGbpL3ExternalNetworkFromNatEPGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveGbpL3ExternalNetworkFromNatEPGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbp::L3ExternalNetworkFromNatEPGroupRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveInvIpMappingFromGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgt > > modelgbp::gbp::EpGroup::resolveInvIpMappingFromGroupRTgt ( const std::string & invIpMappingFromGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
invIpMappingFromGroupRTgtSourcethe value of invIpMappingFromGroupRTgtSource, a naming property for IpMappingFromGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

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

◆ resolveInvIpMappingFromGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveInvIpMappingFromGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::inv::IpMappingFromGroupRTgt > > & out)
inline

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

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveInvLocalInventoryEpFromGroupRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgt > > modelgbp::gbp::EpGroup::resolveInvLocalInventoryEpFromGroupRTgt ( const std::string & invLocalInventoryEpFromGroupRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
invLocalInventoryEpFromGroupRTgtSourcethe value of invLocalInventoryEpFromGroupRTgtSource, a naming property for LocalInventoryEpFromGroupRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

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

◆ resolveInvLocalInventoryEpFromGroupRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveInvLocalInventoryEpFromGroupRTgt ( std::vector< OF_SHARED_PTR< modelgbp::inv::LocalInventoryEpFromGroupRTgt > > & out)
inline

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

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveSpanMemberFromRefRTgt() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgt > > modelgbp::gbp::EpGroup::resolveSpanMemberFromRefRTgt ( const std::string & spanMemberFromRefRTgtSource)
inline

Retrieve the child object with the specified naming properties.

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

Parameters
spanMemberFromRefRTgtSourcethe value of spanMemberFromRefRTgtSource, a naming property for MemberFromRefRTgt
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::span::MemberFromRefRTgt::resolve().

◆ resolveSpanMemberFromRefRTgt() [2/2]

void modelgbp::gbp::EpGroup::resolveSpanMemberFromRefRTgt ( std::vector< OF_SHARED_PTR< modelgbp::span::MemberFromRefRTgt > > & out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::span::MemberFromRefRTgt.

Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.

The resulting managed objects will be added to the result vector provided.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ setIntraGroupPolicy()

modelgbp::gbp::EpGroup & modelgbp::gbp::EpGroup::setIntraGroupPolicy ( const uint8_t newValue)
inline

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

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setName()

modelgbp::gbp::EpGroup & modelgbp::gbp::EpGroup::setName ( const std::string & newValue)
inline

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

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ unregisterListener() [1/2]

static void modelgbp::gbp::EpGroup::unregisterListener ( opflex::modb::ObjectListener * listener)
inlinestatic

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

Parameters
listenerThe listener to unregister.

References unregisterListener().

◆ unregisterListener() [2/2]

static void modelgbp::gbp::EpGroup::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().

◆ unsetIntraGroupPolicy()

modelgbp::gbp::EpGroup & modelgbp::gbp::EpGroup::unsetIntraGroupPolicy ( )
inline

Unset intraGroupPolicy in the currently-active mutator.

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

◆ unsetName()

modelgbp::gbp::EpGroup & modelgbp::gbp::EpGroup::unsetName ( )
inline

Unset name in the currently-active mutator.

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

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