Types¶

YANG types¶

class ydk::Bits¶

Concrete class representing a bits data type.

class ydk::Decimal64¶

Concrete class representing a decimal64 data type.

class ydk::Empty¶

Represents the empty type in YANG. The empty built-in type represents a leaf that does not have any value, it conveys information by its presence or absence.

class ydk::Enum¶

Super class of all classes that represents the enumeration type in YANG.

class ydk::Identity¶

Super class of all classes that represents the identity type in YANG. Instances of this type of classes are assigned as data to leafs of identityref type.

YANG leaf, leaf-list, and list¶

enum ydk::YType¶

Enum class to represent various types of leaf value

enum class YType {
    uint8,
    uint16,
    uint32,
    uint64,
    int8,
    int16,
    int32,
    int64,
    empty,
    identityref,
    str,
    boolean,
    enumeration,
    bits,
    decimal64
};

class ydk::YLeaf¶

Concrete class that represents a YANG leaf

YLeaf(YType type, std::string name)¶

Constructs an instance of the YLeaf.

Parameters:	type – YType, type of the leaf name – YANG name of the leaf

std::string name¶

Leaf YANG name

std::string value¶

String representation of the leaf value

int enum_value¶

Enum member value for enumeration type of a leaf

YType type¶

Leaf type from YType

YFilter filter¶

Optional attribute of the YLeaf class which can be set to perform various filtering

class ydk::YList¶

Concrete class that represents a YANG list. The class implements ordered dictionary, which can be accessed by item number or key value. The key value is calculated internally based on YLeaf key values for the entity.

YList(std::initializer_list<std::string> key_names)¶

Constructs an instance of the YList.

Parameters:	key_names – list of strings, which represent names of keys for the list entities, including empty list.

std::shared_ptr<Entity> operator[](const std::string &key) const¶

Gets YList entity, which has matching key value.

Parameters:	key – strings, which represent list entity key(s).
Returns:	std::shared_ptr<Entity> for the found entity, nullptr - otherwise.

std::shared_ptr<Entity> operator[](const std::size_t item) const¶

Gets YList element, which has sequence number item. The sequence is defined by the order in which the entity was added to the list.

Parameters:	key – std::size_t, which represents entity sequential number in the list (starts from 0).
Returns:	std::shared_ptr<Entity> for the found entity.
Raises:	YInvalidArgumentError exception if item value is out of bounds.

void append(std::shared_ptr<Entity> ep)¶

Adds entity to the list.

Parameters:	ep – std::shared_ptr<Entity>, which represents list entity.

void extend(std::initializer_list<std::shared_ptr<Entity>> ep_list)¶

Adds multiple entities to the list.

Parameters:	ep – std::initializer_list<std::shared_ptr<Entity>>, which represents list of entities to be appended to the YList.

std::vector<std::string> keys() const¶

Gets key values for all entities in the list.

Returns:	std::vector<std::string>.

std::vector<std::shared_ptr<Entity>> entities() const¶

Gets vector of all entities in the list in order, in which they were added.

Returns:	std::vector<std::shared_ptr<Entity>>.

std::size_t len() const¶

Returns size of the list.

std::shared_ptr<Entity> pop(const std::string &key)¶

Removes from YList an entity, which has matching key value.

Parameters:	key – strings, which represent list entity key(s).
Returns:	std::shared_ptr<Entity> for the removed entity, or nullptr matching key value is not found.

std::shared_ptr<Entity> pop(const std::size_t item)¶

Removes from YList an entity, which has sequence number item. The sequence number is defined by the order in which the entity was added to the list.

Parameters:	key – std::size_t, which represents entity sequential number in the list (starts from 0).
Returns:	std::shared_ptr<Entity> for the found entity.
Raises:	YInvalidArgumentError exception if item value is out of bounds.

class YLeafList¶

Concrete class that represents a YANG leaf-list, to which multiple instances of data can be appended to.

YFilter filter¶

Optional attribute of the YLeafList class which can be set to perform various filtering

YANG container and list¶

class ydk::Entity¶

Super class of all classes that represents containers in YANG. YANG lists are represented as YList instance

Entity *parent¶

Pointer to parent entity; the parent is set automatically during entity initialization except for presence container, which must be set manually after presence container is initialized

std::string yang_name¶

YANG name of container or list that this entity represents

std::string yang_parent_name¶

YANG name of container or list of parent entity

YFilter yfilter¶

Optional attribute of the Entity class, which can be set to perform various filtering

bool is_presence_container¶

Boolean flag set to true if this entity represents presence container

bool is_top_level_class¶

Boolean flag set to true if this entity represents top-level container (does not have parent entity)

bool has_list_ancestor¶

Boolean flag set to true if this entity is member of a list

bool ignore_validation¶

Boolean flag for user to control validation of entity data (leaf and leaf-list data values); default setting is false, meaning the validation is on

std::vector<std::string> ylist_key_names¶

If this entity is member of a list, the vector specifies leaf names, which represents list keys

std::string ylist_key¶

If this entity is member of a list, the ylist_key is set to composite list key of this entity

YList *ylist¶

If this entity is member of a list, the ylist is set to a pointer of corresponding YList class

std::shared_ptr<Entity> clone() const¶

Returns copy of this entity

std::shared_ptr<Entity> clone_ptr() const¶

Returns new instance of the entity class

std::string get_segment_path() const¶

Returns relative path of this entity in terms of XPath

std::string get_absolute_path() const¶

Returns absolute path of this entity in terms of XPath

bool has_data() const¶

Returns true if any leaf in this entity or its child entity is assigned value; false otherwise

bool has_operation() const¶

Returns true if any leaf or container in this entity or its child entity has setting of yfilter; false otherwise

void set_value(const std::string &path, const std::string &value, const std::string &name_space = "", const std::string &name_space_prefix = "")¶

Sets leaf value

Parameters:	path – YANG name of the leaf value – std::string representation of the leaf value name_space – optional parameter for enumeration and identity types of leaf, which is name space of a module where the enum or identity is defined name_space_prefix – optional parameter for enumeration and identity types of leaf, which is name space prefix of a module where the enum or identity is defined

void set_filter(const std::string &path, YFilter filter)¶

Sets yfilter value in leaf

Parameters:	path – YANG name of the leaf filter – filtering, filter value

std::vector<std::pair<std::string, LeafData>> get_name_leaf_data() const¶

Gets set of leaves, which have data or operation

std::map<std::string, std::shared_ptr<Entity>> get_children() const¶

Gets map of child entities, where map key is a segment path of child entity

bool operator==(Entity &other) const¶

bool operator==(const Entity &other) const¶

Operator to compare two entities

Usage examples¶

1
2
3
4
5
6
7
8

// Instantiate a shared pointer object representing the BGP container from the openconfig-bgp YANG model
auto bgp = std::make_shared<ydk::openconfig_bgp::Bgp>();

// Instantiate a shared pointer object representing the afi-safi list member from the openconfig-bgp YANG model
auto afi_safi = make_shared<ydk::openconfig_bgp::Bgp::Global::AfiSafis::AfiSafi>();

// Append the afi-safi to the YList instance
bgp->global->afi_safis->afi_safi.append(afi_safi);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

// Assign values to leafs of various types
bgp->global->config->as = 65172; // uint32
bgp->global->config->router_id = "1.2.3.4"; // ip-address

afi_safi->afi_safi_name = L3VpnIpv4Unicast(); // identityref
afi_safi->config->enabled = false; //boolean

neighbor->config->peer_type = PeerType::INTERNAL // enum

Decimal64 deci{"1.2"};
node->decimal_value = deci; //decimal64

node->empty_value = Empty(); // empty

node->bits_value["first-position"] = true // bits
node->bits_value["second-position"] = false // bits

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

// Append values to leaf-lists of various types
config->as_list.append(65172); // uint32
config->router_id.append("1.2.3.4"); //ip-address
L3VpnIpv4Unicast id{}; //identityref
config->types_list.append(id); //identityref
config->enabled_list.append(false); //boolean
config->peer_types.append(PeerType::INTERNAL) // enum
Decimal64 deci{"1.2"};
node->decimal_values.append(deci); //decimal64

Bits bits_value; // bits
bits_value["first-position"] = true; // bits
bits_value["first-position"] = false; // bits
node->bits_values.append(bits_value); // bits

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

// Access by entity order
for (auto ent : bgp->global->afi_safis->afi_safi.entities()) {
    auto afi_safi = dynamic_cast<ydk::openconfig_bgp::Bgp::Global::AfiSafis::AfiSafi*> (ent.get());
    //Access afi_safi members
}

// Access by entity key value
for (auto key : bgp->global->afi_safis->afi_safi.keys()) {
    auto ent = bgp->global->afi_safis->afi_safi[key];
    auto afi_safi = dynamic_cast<ydk::openconfig_bgp::Bgp::Global::AfiSafis::AfiSafi*> (ent.get());
    //Access afi_safi members
}