NVIDIA DeepStream SDK API Reference

9.2 Release
sdk::configuration::RymlDocumentNode Class Reference

Detailed Description

Inheritance diagram for sdk::configuration::RymlDocumentNode:
Collaboration diagram for sdk::configuration::RymlDocumentNode:

Public Member Functions

 RymlDocumentNode (ryml::ConstNodeRef node, std::size_t depth)
 
 RymlDocumentNode (RymlDocumentNode &&)=delete
 
 RymlDocumentNode (const RymlDocumentNode &)=delete
 
RymlDocumentNode & operator= (RymlDocumentNode &&)=delete
 
RymlDocumentNode & operator= (const RymlDocumentNode &other)=delete
 
 ~RymlDocumentNode () override=default
 
std::string Key () const override
 
bool AsBoolean () const override
 
std::size_t AsInteger () const override
 
double AsDouble () const override
 
std::string AsString () const override
 
std::unique_ptr< DocumentNode > GetRequiredChildNode (const std::string &name) const override
 
std::unique_ptr< DocumentNode > GetChildNode (const std::string &name) const override
 
bool GetRequiredBoolean (const std::string &name) const override
 
bool GetBoolean (const std::string &name, bool default_value) const override
 
std::size_t GetRequiredInteger (const std::string &name) const override
 
std::size_t GetInteger (const std::string &name, std::size_t default_value) const override
 
double GetRequiredDouble (const std::string &name) const override
 
double GetDouble (const std::string &name, double default_value) const override
 
std::string GetRequiredString (const std::string &name) const override
 
std::string GetString (const std::string &name, const std::string &default_value) const override
 
DocumentNodeConstIterator begin () const override
 
DocumentNodeConstIterator end () const override
 
std::size_t num_children () const override
 
std::unique_ptr< DocumentNode > GetChild (std::size_t index) const override
 
PropertiesNodeConstIterator begin_properties () const override
 
PropertiesNodeConstIterator end_properties () const override
 
 RymlDocumentNode (ryml::ConstNodeRef node, std::size_t depth)
 
 RymlDocumentNode (RymlDocumentNode &&)=delete
 
 RymlDocumentNode (const RymlDocumentNode &)=delete
 
RymlDocumentNode & operator= (RymlDocumentNode &&)=delete
 
RymlDocumentNode & operator= (const RymlDocumentNode &other)=delete
 
 ~RymlDocumentNode () override=default
 
std::string Key () const override
 
bool AsBoolean () const override
 
std::size_t AsInteger () const override
 
double AsDouble () const override
 
std::string AsString () const override
 
std::unique_ptr< DocumentNode > GetRequiredChildNode (const std::string &name) const override
 
std::unique_ptr< DocumentNode > GetChildNode (const std::string &name) const override
 
bool GetRequiredBoolean (const std::string &name) const override
 
bool GetBoolean (const std::string &name, bool default_value) const override
 
std::size_t GetRequiredInteger (const std::string &name) const override
 
std::size_t GetInteger (const std::string &name, std::size_t default_value) const override
 
double GetRequiredDouble (const std::string &name) const override
 
double GetDouble (const std::string &name, double default_value) const override
 
std::string GetRequiredString (const std::string &name) const override
 
std::string GetString (const std::string &name, const std::string &default_value) const override
 
DocumentNodeConstIterator begin () const override
 
DocumentNodeConstIterator end () const override
 
std::size_t num_children () const override
 
std::unique_ptr< DocumentNode > GetChild (std::size_t index) const override
 
PropertiesNodeConstIterator begin_properties () const override
 
PropertiesNodeConstIterator end_properties () const override
 

Static Public Attributes

static constexpr std::size_t MAX_NODE_DEPTH = 100
 

Protected Member Functions

std::string DoSubstitution (const std::string &text) const
 
std::string DoSubstitution (const std::string &text) const
 
std::string DoOneSubstitution (const std::string &text) const
 
std::string DoOneSubstitution (const std::string &text) const
 
bool BooleanFromString (const std::string &value) const
 
bool BooleanFromString (const std::string &value) const
 
std::size_t IntegerFromString (const std::string &value) const
 
std::size_t IntegerFromString (const std::string &value) const
 
double DoubleFromString (const std::string &value) const
 
double DoubleFromString (const std::string &value) const
 

Constructor & Destructor Documentation

◆ RymlDocumentNode() [1/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( ryml::ConstNodeRef  node,
std::size_t  depth 
)
inline

◆ RymlDocumentNode() [2/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( RymlDocumentNode &&  )
delete

◆ RymlDocumentNode() [3/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( const RymlDocumentNode &  )
delete

◆ ~RymlDocumentNode() [1/2]

sdk::configuration::RymlDocumentNode::~RymlDocumentNode ( )
overridedefault

◆ RymlDocumentNode() [4/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( ryml::ConstNodeRef  node,
std::size_t  depth 
)
inline

◆ RymlDocumentNode() [5/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( RymlDocumentNode &&  )
delete

◆ RymlDocumentNode() [6/6]

sdk::configuration::RymlDocumentNode::RymlDocumentNode ( const RymlDocumentNode &  )
delete

◆ ~RymlDocumentNode() [2/2]

sdk::configuration::RymlDocumentNode::~RymlDocumentNode ( )
overridedefault

Member Function Documentation

◆ AsBoolean() [1/2]

bool sdk::configuration::RymlDocumentNode::AsBoolean ( ) const
overridevirtual

◆ AsBoolean() [2/2]

bool sdk::configuration::RymlDocumentNode::AsBoolean ( ) const
overridevirtual

◆ AsDouble() [1/2]

double sdk::configuration::RymlDocumentNode::AsDouble ( ) const
overridevirtual

◆ AsDouble() [2/2]

double sdk::configuration::RymlDocumentNode::AsDouble ( ) const
overridevirtual

◆ AsInteger() [1/2]

std::size_t sdk::configuration::RymlDocumentNode::AsInteger ( ) const
overridevirtual

◆ AsInteger() [2/2]

std::size_t sdk::configuration::RymlDocumentNode::AsInteger ( ) const
overridevirtual

◆ AsString() [1/2]

std::string sdk::configuration::RymlDocumentNode::AsString ( ) const
overridevirtual

◆ AsString() [2/2]

std::string sdk::configuration::RymlDocumentNode::AsString ( ) const
overridevirtual

◆ begin() [1/2]

DocumentNodeConstIterator sdk::configuration::RymlDocumentNode::begin ( ) const
overridevirtual

◆ begin() [2/2]

DocumentNodeConstIterator sdk::configuration::RymlDocumentNode::begin ( ) const
overridevirtual

◆ begin_properties() [1/2]

PropertiesNodeConstIterator sdk::configuration::RymlDocumentNode::begin_properties ( ) const
overridevirtual

◆ begin_properties() [2/2]

PropertiesNodeConstIterator sdk::configuration::RymlDocumentNode::begin_properties ( ) const
overridevirtual

◆ BooleanFromString() [1/2]

bool sdk::configuration::DocumentNode::BooleanFromString ( const std::string &  value) const
protectedinherited

◆ BooleanFromString() [2/2]

bool sdk::configuration::DocumentNode::BooleanFromString ( const std::string &  value) const
protectedinherited

◆ DoOneSubstitution() [1/2]

std::string sdk::configuration::DocumentNode::DoOneSubstitution ( const std::string &  text) const
protectedinherited

◆ DoOneSubstitution() [2/2]

std::string sdk::configuration::DocumentNode::DoOneSubstitution ( const std::string &  text) const
protectedinherited

◆ DoSubstitution() [1/2]

std::string sdk::configuration::DocumentNode::DoSubstitution ( const std::string &  text) const
protectedinherited

◆ DoSubstitution() [2/2]

std::string sdk::configuration::DocumentNode::DoSubstitution ( const std::string &  text) const
protectedinherited

◆ DoubleFromString() [1/2]

double sdk::configuration::DocumentNode::DoubleFromString ( const std::string &  value) const
protectedinherited

◆ DoubleFromString() [2/2]

double sdk::configuration::DocumentNode::DoubleFromString ( const std::string &  value) const
protectedinherited

◆ end() [1/2]

DocumentNodeConstIterator sdk::configuration::RymlDocumentNode::end ( ) const
overridevirtual

◆ end() [2/2]

DocumentNodeConstIterator sdk::configuration::RymlDocumentNode::end ( ) const
overridevirtual

◆ end_properties() [1/2]

PropertiesNodeConstIterator sdk::configuration::RymlDocumentNode::end_properties ( ) const
overridevirtual

◆ end_properties() [2/2]

PropertiesNodeConstIterator sdk::configuration::RymlDocumentNode::end_properties ( ) const
overridevirtual

◆ GetBoolean() [1/2]

bool sdk::configuration::RymlDocumentNode::GetBoolean ( const std::string &  name,
bool  default_value 
) const
overridevirtual

◆ GetBoolean() [2/2]

bool sdk::configuration::RymlDocumentNode::GetBoolean ( const std::string &  name,
bool  default_value 
) const
overridevirtual

◆ GetChild() [1/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetChild ( std::size_t  index) const
overridevirtual

◆ GetChild() [2/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetChild ( std::size_t  index) const
overridevirtual

◆ GetChildNode() [1/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetChildNode ( const std::string &  name) const
overridevirtual

◆ GetChildNode() [2/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetChildNode ( const std::string &  name) const
overridevirtual

◆ GetDouble() [1/2]

double sdk::configuration::RymlDocumentNode::GetDouble ( const std::string &  name,
double  default_value 
) const
overridevirtual

◆ GetDouble() [2/2]

double sdk::configuration::RymlDocumentNode::GetDouble ( const std::string &  name,
double  default_value 
) const
overridevirtual

◆ GetInteger() [1/2]

std::size_t sdk::configuration::RymlDocumentNode::GetInteger ( const std::string &  name,
std::size_t  default_value 
) const
overridevirtual

◆ GetInteger() [2/2]

std::size_t sdk::configuration::RymlDocumentNode::GetInteger ( const std::string &  name,
std::size_t  default_value 
) const
overridevirtual

◆ GetRequiredBoolean() [1/2]

bool sdk::configuration::RymlDocumentNode::GetRequiredBoolean ( const std::string &  name) const
overridevirtual

◆ GetRequiredBoolean() [2/2]

bool sdk::configuration::RymlDocumentNode::GetRequiredBoolean ( const std::string &  name) const
overridevirtual

◆ GetRequiredChildNode() [1/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetRequiredChildNode ( const std::string &  name) const
overridevirtual

◆ GetRequiredChildNode() [2/2]

std::unique_ptr<DocumentNode> sdk::configuration::RymlDocumentNode::GetRequiredChildNode ( const std::string &  name) const
overridevirtual

◆ GetRequiredDouble() [1/2]

double sdk::configuration::RymlDocumentNode::GetRequiredDouble ( const std::string &  name) const
overridevirtual

◆ GetRequiredDouble() [2/2]

double sdk::configuration::RymlDocumentNode::GetRequiredDouble ( const std::string &  name) const
overridevirtual

◆ GetRequiredInteger() [1/2]

std::size_t sdk::configuration::RymlDocumentNode::GetRequiredInteger ( const std::string &  name) const
overridevirtual

◆ GetRequiredInteger() [2/2]

std::size_t sdk::configuration::RymlDocumentNode::GetRequiredInteger ( const std::string &  name) const
overridevirtual

◆ GetRequiredString() [1/2]

std::string sdk::configuration::RymlDocumentNode::GetRequiredString ( const std::string &  name) const
overridevirtual

◆ GetRequiredString() [2/2]

std::string sdk::configuration::RymlDocumentNode::GetRequiredString ( const std::string &  name) const
overridevirtual

◆ GetString() [1/2]

std::string sdk::configuration::RymlDocumentNode::GetString ( const std::string &  name,
const std::string &  default_value 
) const
overridevirtual

◆ GetString() [2/2]

std::string sdk::configuration::RymlDocumentNode::GetString ( const std::string &  name,
const std::string &  default_value 
) const
overridevirtual

◆ IntegerFromString() [1/2]

std::size_t sdk::configuration::DocumentNode::IntegerFromString ( const std::string &  value) const
protectedinherited

◆ IntegerFromString() [2/2]

std::size_t sdk::configuration::DocumentNode::IntegerFromString ( const std::string &  value) const
protectedinherited

◆ Key() [1/2]

std::string sdk::configuration::RymlDocumentNode::Key ( ) const
overridevirtual

◆ Key() [2/2]

std::string sdk::configuration::RymlDocumentNode::Key ( ) const
overridevirtual

◆ num_children() [1/2]

std::size_t sdk::configuration::RymlDocumentNode::num_children ( ) const
overridevirtual

◆ num_children() [2/2]

std::size_t sdk::configuration::RymlDocumentNode::num_children ( ) const
overridevirtual

◆ operator=() [1/4]

RymlDocumentNode& sdk::configuration::RymlDocumentNode::operator= ( const RymlDocumentNode &  other)
delete

◆ operator=() [2/4]

RymlDocumentNode& sdk::configuration::RymlDocumentNode::operator= ( const RymlDocumentNode &  other)
delete

◆ operator=() [3/4]

RymlDocumentNode& sdk::configuration::RymlDocumentNode::operator= ( RymlDocumentNode &&  )
delete

◆ operator=() [4/4]

RymlDocumentNode& sdk::configuration::RymlDocumentNode::operator= ( RymlDocumentNode &&  )
delete

Field Documentation

◆ MAX_NODE_DEPTH

static constexpr std::size_t sdk::configuration::DocumentNode::MAX_NODE_DEPTH = 100
staticconstexprinherited

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