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

Public Member Functions

bool isDirectionSet ()
 Check whether direction has been set. More...
 
boost::optional< const uint8_t > getDirection ()
 Get the value of direction if it has been set. More...
 
const uint8_t getDirection (const uint8_t defaultValue)
 Get the value of direction if set, otherwise the value of default passed in. More...
 
modelgbp::gbp::SecGroupRulesetDirection (const uint8_t newValue)
 Set direction to the specified value in the currently-active mutator. More...
 
modelgbp::gbp::SecGroupRuleunsetDirection ()
 Unset direction in the currently-active mutator. More...
 
bool isNameSet ()
 Check whether name has been set. More...
 
boost::optional< const std::string & > getName ()
 Get the value of name if it has been set. More...
 
const std::string & getName (const std::string &defaultValue)
 Get the value of name if set, otherwise the value of default passed in. More...
 
modelgbp::gbp::SecGroupRulesetName (const std::string &newValue)
 Set name to the specified value in the currently-active mutator. More...
 
modelgbp::gbp::SecGroupRuleunsetName ()
 Unset name in the currently-active mutator. More...
 
bool isOrderSet ()
 Check whether order has been set. More...
 
boost::optional< uint32_t > getOrder ()
 Get the value of order if it has been set. More...
 
uint32_t getOrder (uint32_t defaultValue)
 Get the value of order if set, otherwise the value of default passed in. More...
 
modelgbp::gbp::SecGroupRulesetOrder (uint32_t newValue)
 Set order to the specified value in the currently-active mutator. More...
 
modelgbp::gbp::SecGroupRuleunsetOrder ()
 Unset order in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::RuleToClassifierRSrc > > resolveGbpRuleToClassifierRSrc (const std::string &gbpRuleToClassifierRSrcTargetName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR< modelgbp::gbp::RuleToClassifierRSrcaddGbpRuleToClassifierRSrc (const std::string &gbpRuleToClassifierRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveGbpRuleToClassifierRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::RuleToClassifierRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::RuleToClassifierRSrc. More...
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::RuleToActionRSrc > > resolveGbpRuleToActionRSrc (const std::string &gbpRuleToActionRSrcTargetName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR< modelgbp::gbp::RuleToActionRSrcaddGbpRuleToActionRSrc (const std::string &gbpRuleToActionRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveGbpRuleToActionRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::RuleToActionRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::RuleToActionRSrc. More...
 
boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc > > resolveGbpSecGroupRuleToRemoteAddressRSrc (const std::string &gbpSecGroupRuleToRemoteAddressRSrcTargetName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR< modelgbp::gbp::SecGroupRuleToRemoteAddressRSrcaddGbpSecGroupRuleToRemoteAddressRSrc (const std::string &gbpSecGroupRuleToRemoteAddressRSrcTargetName)
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
void resolveGbpSecGroupRuleToRemoteAddressRSrc (std::vector< OF_SHARED_PTR< modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 SecGroupRule (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of SecGroupRule. More...
 

Static Public Member Functions

static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of SecGroupRule from the managed object store. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolve (const opflex::modb::URI &uri)
 Retrieve an instance of SecGroupRule from the managed object store using the default framework instance. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpContractName, const std::string &gbpSubjectName, const std::string &gbpSecGroupRuleName)
 Retrieve an instance of SecGroupRule from the managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject (const std::string &policySpaceName, const std::string &gbpContractName, const std::string &gbpSubjectName, const std::string &gbpSecGroupRuleName)
 Retrieve an instance of SecGroupRule from the default managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpSecGroupName, const std::string &gbpSecGroupSubjectName, const std::string &gbpSecGroupRuleName)
 Retrieve an instance of SecGroupRule from the managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional< OF_SHARED_PTR< modelgbp::gbp::SecGroupRule > > resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject (const std::string &policySpaceName, const std::string &gbpSecGroupName, const std::string &gbpSecGroupSubjectName, const std::string &gbpSecGroupRuleName)
 Retrieve an instance of SecGroupRule from the default managed object store by constructing its URI from the path elements that lead to it. More...
 
static void remove (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Remove the SecGroupRule object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the SecGroupRule object with the specified URI using the currently-active mutator and the default framework instance. More...
 
static void removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpContractName, const std::string &gbpSubjectName, const std::string &gbpSecGroupRuleName)
 Remove the SecGroupRule object with the specified path elements from the managed object store. More...
 
static void removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject (const std::string &policySpaceName, const std::string &gbpContractName, const std::string &gbpSubjectName, const std::string &gbpSecGroupRuleName)
 Remove the SecGroupRule object with the specified path elements from the managed object store using the default framework instance. More...
 
static void removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpSecGroupName, const std::string &gbpSecGroupSubjectName, const std::string &gbpSecGroupRuleName)
 Remove the SecGroupRule object with the specified path elements from the managed object store. More...
 
static void removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject (const std::string &policySpaceName, const std::string &gbpSecGroupName, const std::string &gbpSecGroupSubjectName, const std::string &gbpSecGroupRuleName)
 Remove the SecGroupRule object with the specified path elements from the managed object store using the default framework instance. More...
 
static void registerListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
 Register a listener that will get called for changes related to this class. More...
 
static void registerListener (opflex::modb::ObjectListener *listener)
 Register a listener that will get called for changes related to this class with the default framework instance. More...
 
static void unregisterListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
 Unregister a listener from updates to this class. More...
 
static void unregisterListener (opflex::modb::ObjectListener *listener)
 Unregister a listener from updates to this class from the default framework instance. More...
 

Static Public Attributes

static const opflex::modb::class_id_t CLASS_ID = 205
 The unique class ID for SecGroupRule.
 

Constructor & Destructor Documentation

◆ SecGroupRule()

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

Construct an instance of SecGroupRule.

This should not typically be called from user code.

Member Function Documentation

◆ addGbpRuleToActionRSrc()

OF_SHARED_PTR<modelgbp::gbp::RuleToActionRSrc> modelgbp::gbp::SecGroupRule::addGbpRuleToActionRSrc ( const std::string &  gbpRuleToActionRSrcTargetName)
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
gbpRuleToActionRSrcTargetClassthe value of gbpRuleToActionRSrcTargetClass, a naming property for RuleToActionRSrc
gbpRuleToActionRSrcTargetNamethe value of gbpRuleToActionRSrcTargetName, a naming property for RuleToActionRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpRuleToClassifierRSrc()

OF_SHARED_PTR<modelgbp::gbp::RuleToClassifierRSrc> modelgbp::gbp::SecGroupRule::addGbpRuleToClassifierRSrc ( const std::string &  gbpRuleToClassifierRSrcTargetName)
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
gbpRuleToClassifierRSrcTargetClassthe value of gbpRuleToClassifierRSrcTargetClass, a naming property for RuleToClassifierRSrc
gbpRuleToClassifierRSrcTargetNamethe value of gbpRuleToClassifierRSrcTargetName, a naming property for RuleToClassifierRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addGbpSecGroupRuleToRemoteAddressRSrc()

OF_SHARED_PTR<modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc> modelgbp::gbp::SecGroupRule::addGbpSecGroupRuleToRemoteAddressRSrc ( const std::string &  gbpSecGroupRuleToRemoteAddressRSrcTargetName)
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
gbpSecGroupRuleToRemoteAddressRSrcTargetClassthe value of gbpSecGroupRuleToRemoteAddressRSrcTargetClass, a naming property for SecGroupRuleToRemoteAddressRSrc
gbpSecGroupRuleToRemoteAddressRSrcTargetNamethe value of gbpSecGroupRuleToRemoteAddressRSrcTargetName, a naming property for SecGroupRuleToRemoteAddressRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ getDirection() [1/2]

boost::optional<const uint8_t> modelgbp::gbp::SecGroupRule::getDirection ( )
inline

Get the value of direction if it has been set.

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

References isDirectionSet().

Referenced by getDirection().

◆ getDirection() [2/2]

const uint8_t modelgbp::gbp::SecGroupRule::getDirection ( const uint8_t  defaultValue)
inline

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

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

References getDirection().

◆ getName() [1/2]

boost::optional<const std::string&> modelgbp::gbp::SecGroupRule::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::SecGroupRule::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().

◆ getOrder() [1/2]

boost::optional<uint32_t> modelgbp::gbp::SecGroupRule::getOrder ( )
inline

Get the value of order if it has been set.

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

References isOrderSet().

Referenced by getOrder().

◆ getOrder() [2/2]

uint32_t modelgbp::gbp::SecGroupRule::getOrder ( uint32_t  defaultValue)
inline

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

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

References getOrder().

◆ isDirectionSet()

bool modelgbp::gbp::SecGroupRule::isDirectionSet ( )
inline

Check whether direction has been set.

Returns
true if direction has been set

Referenced by getDirection().

◆ isNameSet()

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

Check whether name has been set.

Returns
true if name has been set

Referenced by getName().

◆ isOrderSet()

bool modelgbp::gbp::SecGroupRule::isOrderSet ( )
inline

Check whether order has been set.

Returns
true if order has been set

Referenced by getOrder().

◆ registerListener() [1/2]

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

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

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

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

References CLASS_ID.

Referenced by registerListener().

◆ registerListener() [2/2]

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

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

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

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

References registerListener().

◆ remove() [1/3]

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

Remove this instance using the currently-active mutator.

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

Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [2/3]

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

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

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

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

References CLASS_ID.

◆ remove() [3/3]

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

Remove the SecGroupRule 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

◆ removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject() [1/2]

static void modelgbp::gbp::SecGroupRule::removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject ( opflex::ofcore::OFFramework &  framework,
const std::string &  policySpaceName,
const std::string &  gbpContractName,
const std::string &  gbpSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Remove the SecGroupRule 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]/GbpContract/[gbpContractName]/GbpSubject/[gbpSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpContractNamethe value of gbpContractName, a naming property for Contract
gbpSubjectNamethe value of gbpSubjectName, a naming property for Subject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

Referenced by removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject().

◆ removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject() [2/2]

static void modelgbp::gbp::SecGroupRule::removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject ( const std::string &  policySpaceName,
const std::string &  gbpContractName,
const std::string &  gbpSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Remove the SecGroupRule 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]/GbpContract/[gbpContractName]/GbpSubject/[gbpSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpContractNamethe value of gbpContractName, a naming property for Contract
gbpSubjectNamethe value of gbpSubjectName, a naming property for Subject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Exceptions
std::logic_errorif no mutator is active

References removeUnderPolicyUniversePolicySpaceGbpContractGbpSubject().

◆ removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject() [1/2]

static void modelgbp::gbp::SecGroupRule::removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject ( opflex::ofcore::OFFramework &  framework,
const std::string &  policySpaceName,
const std::string &  gbpSecGroupName,
const std::string &  gbpSecGroupSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Remove the SecGroupRule 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]/GbpSecGroup/[gbpSecGroupName]/GbpSecGroupSubject/[gbpSecGroupSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpSecGroupNamethe value of gbpSecGroupName, a naming property for SecGroup
gbpSecGroupSubjectNamethe value of gbpSecGroupSubjectName, a naming property for SecGroupSubject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

Referenced by removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject().

◆ removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject() [2/2]

static void modelgbp::gbp::SecGroupRule::removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject ( const std::string &  policySpaceName,
const std::string &  gbpSecGroupName,
const std::string &  gbpSecGroupSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Remove the SecGroupRule 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]/GbpSecGroup/[gbpSecGroupName]/GbpSecGroupSubject/[gbpSecGroupSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpSecGroupNamethe value of gbpSecGroupName, a naming property for SecGroup
gbpSecGroupSubjectNamethe value of gbpSecGroupSubjectName, a naming property for SecGroupSubject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Exceptions
std::logic_errorif no mutator is active

References removeUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject().

◆ resolve() [1/2]

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

Retrieve an instance of SecGroupRule from the managed object store.

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

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

References CLASS_ID.

Referenced by modelgbp::gbp::SecGroupSubject::resolveGbpSecGroupRule(), resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject(), and resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject().

◆ resolve() [2/2]

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

Retrieve an instance of SecGroupRule 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.

◆ resolveGbpRuleToActionRSrc() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::gbp::RuleToActionRSrc> > modelgbp::gbp::SecGroupRule::resolveGbpRuleToActionRSrc ( const std::string &  gbpRuleToActionRSrcTargetName)
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
gbpRuleToActionRSrcTargetClassthe value of gbpRuleToActionRSrcTargetClass, a naming property for RuleToActionRSrc
gbpRuleToActionRSrcTargetNamethe value of gbpRuleToActionRSrcTargetName, a naming property for RuleToActionRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

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

◆ resolveGbpRuleToActionRSrc() [2/2]

void modelgbp::gbp::SecGroupRule::resolveGbpRuleToActionRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::RuleToActionRSrc > > &  out)
inline

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

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.

◆ resolveGbpRuleToClassifierRSrc() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::gbp::RuleToClassifierRSrc> > modelgbp::gbp::SecGroupRule::resolveGbpRuleToClassifierRSrc ( const std::string &  gbpRuleToClassifierRSrcTargetName)
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
gbpRuleToClassifierRSrcTargetClassthe value of gbpRuleToClassifierRSrcTargetClass, a naming property for RuleToClassifierRSrc
gbpRuleToClassifierRSrcTargetNamethe value of gbpRuleToClassifierRSrcTargetName, a naming property for RuleToClassifierRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

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

◆ resolveGbpRuleToClassifierRSrc() [2/2]

void modelgbp::gbp::SecGroupRule::resolveGbpRuleToClassifierRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::RuleToClassifierRSrc > > &  out)
inline

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

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.

◆ resolveGbpSecGroupRuleToRemoteAddressRSrc() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc> > modelgbp::gbp::SecGroupRule::resolveGbpSecGroupRuleToRemoteAddressRSrc ( const std::string &  gbpSecGroupRuleToRemoteAddressRSrcTargetName)
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
gbpSecGroupRuleToRemoteAddressRSrcTargetClassthe value of gbpSecGroupRuleToRemoteAddressRSrcTargetClass, a naming property for SecGroupRuleToRemoteAddressRSrc
gbpSecGroupRuleToRemoteAddressRSrcTargetNamethe value of gbpSecGroupRuleToRemoteAddressRSrcTargetName, a naming property for SecGroupRuleToRemoteAddressRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

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

◆ resolveGbpSecGroupRuleToRemoteAddressRSrc() [2/2]

void modelgbp::gbp::SecGroupRule::resolveGbpSecGroupRuleToRemoteAddressRSrc ( std::vector< OF_SHARED_PTR< modelgbp::gbp::SecGroupRuleToRemoteAddressRSrc > > &  out)
inline

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

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.

◆ resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject() [1/2]

static boost::optional<OF_SHARED_PTR<modelgbp::gbp::SecGroupRule> > modelgbp::gbp::SecGroupRule::resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject ( opflex::ofcore::OFFramework &  framework,
const std::string &  policySpaceName,
const std::string &  gbpContractName,
const std::string &  gbpSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Retrieve an instance of SecGroupRule 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]/GbpContract/[gbpContractName]/GbpSubject/[gbpSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpContractNamethe value of gbpContractName, a naming property for Contract
gbpSubjectNamethe value of gbpSubjectName, a naming property for Subject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

Referenced by resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject().

◆ resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject() [2/2]

static boost::optional<OF_SHARED_PTR<modelgbp::gbp::SecGroupRule> > modelgbp::gbp::SecGroupRule::resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject ( const std::string &  policySpaceName,
const std::string &  gbpContractName,
const std::string &  gbpSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Retrieve an instance of SecGroupRule 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]/GbpContract/[gbpContractName]/GbpSubject/[gbpSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpContractNamethe value of gbpContractName, a naming property for Contract
gbpSubjectNamethe value of gbpSubjectName, a naming property for Subject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolveUnderPolicyUniversePolicySpaceGbpContractGbpSubject().

◆ resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject() [1/2]

static boost::optional<OF_SHARED_PTR<modelgbp::gbp::SecGroupRule> > modelgbp::gbp::SecGroupRule::resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject ( opflex::ofcore::OFFramework &  framework,
const std::string &  policySpaceName,
const std::string &  gbpSecGroupName,
const std::string &  gbpSecGroupSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Retrieve an instance of SecGroupRule 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]/GbpSecGroup/[gbpSecGroupName]/GbpSecGroupSubject/[gbpSecGroupSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
frameworkthe framework instance to use
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpSecGroupNamethe value of gbpSecGroupName, a naming property for SecGroup
gbpSecGroupSubjectNamethe value of gbpSecGroupSubjectName, a naming property for SecGroupSubject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

Referenced by resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject().

◆ resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject() [2/2]

static boost::optional<OF_SHARED_PTR<modelgbp::gbp::SecGroupRule> > modelgbp::gbp::SecGroupRule::resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject ( const std::string &  policySpaceName,
const std::string &  gbpSecGroupName,
const std::string &  gbpSecGroupSubjectName,
const std::string &  gbpSecGroupRuleName 
)
inlinestatic

Retrieve an instance of SecGroupRule 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]/GbpSecGroup/[gbpSecGroupName]/GbpSecGroupSubject/[gbpSecGroupSubjectName]/GbpSecGroupRule/[gbpSecGroupRuleName]

Parameters
policySpaceNamethe value of policySpaceName, a naming property for Space
gbpSecGroupNamethe value of gbpSecGroupName, a naming property for SecGroup
gbpSecGroupSubjectNamethe value of gbpSecGroupSubjectName, a naming property for SecGroupSubject
gbpSecGroupRuleNamethe value of gbpSecGroupRuleName, a naming property for SecGroupRule
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolveUnderPolicyUniversePolicySpaceGbpSecGroupGbpSecGroupSubject().

◆ setDirection()

modelgbp::gbp::SecGroupRule& modelgbp::gbp::SecGroupRule::setDirection ( const uint8_t  newValue)
inline

Set direction 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::SecGroupRule& modelgbp::gbp::SecGroupRule::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

◆ setOrder()

modelgbp::gbp::SecGroupRule& modelgbp::gbp::SecGroupRule::setOrder ( uint32_t  newValue)
inline

Set order 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::SecGroupRule::unregisterListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Unregister a listener from updates to this class.

Parameters
frameworkthe framework instance
listenerThe listener to unregister.

References CLASS_ID.

Referenced by unregisterListener().

◆ unregisterListener() [2/2]

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

◆ unsetDirection()

modelgbp::gbp::SecGroupRule& modelgbp::gbp::SecGroupRule::unsetDirection ( )
inline

Unset direction 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::SecGroupRule& modelgbp::gbp::SecGroupRule::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

◆ unsetOrder()

modelgbp::gbp::SecGroupRule& modelgbp::gbp::SecGroupRule::unsetOrder ( )
inline

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