NVIDIA DeepStream SDK API Reference

9.2 Release
sdk::configuration::DocumentNode Class Referenceabstract

Detailed Description

Inheritance diagram for sdk::configuration::DocumentNode:

Public Member Functions

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

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 DoOneSubstitution (const std::string &text) const
 
bool BooleanFromString (const std::string &value) const
 
std::size_t IntegerFromString (const std::string &value) const
 
double DoubleFromString (const std::string &value) const
 
std::string DoSubstitution (const std::string &text) const
 
std::string DoOneSubstitution (const std::string &text) const
 
bool BooleanFromString (const std::string &value) const
 
std::size_t IntegerFromString (const std::string &value) const
 
double DoubleFromString (const std::string &value) const
 

Constructor & Destructor Documentation

◆ DocumentNode() [1/6]

sdk::configuration::DocumentNode::DocumentNode ( )
default

◆ DocumentNode() [2/6]

sdk::configuration::DocumentNode::DocumentNode ( DocumentNode &&  )
default

◆ DocumentNode() [3/6]

sdk::configuration::DocumentNode::DocumentNode ( const DocumentNode &  )
default

◆ ~DocumentNode() [1/2]

virtual sdk::configuration::DocumentNode::~DocumentNode ( )
virtualdefault

◆ DocumentNode() [4/6]

sdk::configuration::DocumentNode::DocumentNode ( )
default

◆ DocumentNode() [5/6]

sdk::configuration::DocumentNode::DocumentNode ( DocumentNode &&  )
default

◆ DocumentNode() [6/6]

sdk::configuration::DocumentNode::DocumentNode ( const DocumentNode &  )
default

◆ ~DocumentNode() [2/2]

virtual sdk::configuration::DocumentNode::~DocumentNode ( )
virtualdefault

Member Function Documentation

◆ AsBoolean() [1/2]

virtual bool sdk::configuration::DocumentNode::AsBoolean ( ) const
pure virtual

◆ AsBoolean() [2/2]

virtual bool sdk::configuration::DocumentNode::AsBoolean ( ) const
pure virtual

◆ AsDouble() [1/2]

virtual double sdk::configuration::DocumentNode::AsDouble ( ) const
pure virtual

◆ AsDouble() [2/2]

virtual double sdk::configuration::DocumentNode::AsDouble ( ) const
pure virtual

◆ AsInteger() [1/2]

virtual std::size_t sdk::configuration::DocumentNode::AsInteger ( ) const
pure virtual

◆ AsInteger() [2/2]

virtual std::size_t sdk::configuration::DocumentNode::AsInteger ( ) const
pure virtual

◆ AsString() [1/2]

virtual std::string sdk::configuration::DocumentNode::AsString ( ) const
pure virtual

◆ AsString() [2/2]

virtual std::string sdk::configuration::DocumentNode::AsString ( ) const
pure virtual

◆ begin() [1/2]

virtual DocumentNodeConstIterator sdk::configuration::DocumentNode::begin ( ) const
pure virtual

◆ begin() [2/2]

virtual DocumentNodeConstIterator sdk::configuration::DocumentNode::begin ( ) const
pure virtual

◆ begin_properties() [1/2]

virtual PropertiesNodeConstIterator sdk::configuration::DocumentNode::begin_properties ( ) const
pure virtual

◆ begin_properties() [2/2]

virtual PropertiesNodeConstIterator sdk::configuration::DocumentNode::begin_properties ( ) const
pure virtual

◆ BooleanFromString() [1/2]

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

◆ BooleanFromString() [2/2]

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

◆ DoOneSubstitution() [1/2]

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

◆ DoOneSubstitution() [2/2]

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

◆ DoSubstitution() [1/2]

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

◆ DoSubstitution() [2/2]

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

◆ DoubleFromString() [1/2]

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

◆ DoubleFromString() [2/2]

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

◆ end() [1/2]

virtual DocumentNodeConstIterator sdk::configuration::DocumentNode::end ( ) const
pure virtual

◆ end() [2/2]

virtual DocumentNodeConstIterator sdk::configuration::DocumentNode::end ( ) const
pure virtual

◆ end_properties() [1/2]

virtual PropertiesNodeConstIterator sdk::configuration::DocumentNode::end_properties ( ) const
pure virtual

◆ end_properties() [2/2]

virtual PropertiesNodeConstIterator sdk::configuration::DocumentNode::end_properties ( ) const
pure virtual

◆ GetBoolean() [1/2]

virtual bool sdk::configuration::DocumentNode::GetBoolean ( const std::string &  name,
bool  default_value 
) const
pure virtual

◆ GetBoolean() [2/2]

virtual bool sdk::configuration::DocumentNode::GetBoolean ( const std::string &  name,
bool  default_value 
) const
pure virtual

◆ GetChild() [1/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetChild ( std::size_t  index) const
pure virtual

◆ GetChild() [2/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetChild ( std::size_t  index) const
pure virtual

◆ GetChildNode() [1/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetChildNode ( const std::string &  name) const
pure virtual

◆ GetChildNode() [2/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetChildNode ( const std::string &  name) const
pure virtual

◆ GetDouble() [1/2]

virtual double sdk::configuration::DocumentNode::GetDouble ( const std::string &  name,
double  default_value 
) const
pure virtual

◆ GetDouble() [2/2]

virtual double sdk::configuration::DocumentNode::GetDouble ( const std::string &  name,
double  default_value 
) const
pure virtual

◆ GetInteger() [1/2]

virtual std::size_t sdk::configuration::DocumentNode::GetInteger ( const std::string &  name,
std::size_t  default_value 
) const
pure virtual

◆ GetInteger() [2/2]

virtual std::size_t sdk::configuration::DocumentNode::GetInteger ( const std::string &  name,
std::size_t  default_value 
) const
pure virtual

◆ GetRequiredBoolean() [1/2]

virtual bool sdk::configuration::DocumentNode::GetRequiredBoolean ( const std::string &  name) const
pure virtual

◆ GetRequiredBoolean() [2/2]

virtual bool sdk::configuration::DocumentNode::GetRequiredBoolean ( const std::string &  name) const
pure virtual

◆ GetRequiredChildNode() [1/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetRequiredChildNode ( const std::string &  name) const
pure virtual

◆ GetRequiredChildNode() [2/2]

virtual std::unique_ptr<DocumentNode> sdk::configuration::DocumentNode::GetRequiredChildNode ( const std::string &  name) const
pure virtual

◆ GetRequiredDouble() [1/2]

virtual double sdk::configuration::DocumentNode::GetRequiredDouble ( const std::string &  name) const
pure virtual

◆ GetRequiredDouble() [2/2]

virtual double sdk::configuration::DocumentNode::GetRequiredDouble ( const std::string &  name) const
pure virtual

◆ GetRequiredInteger() [1/2]

virtual std::size_t sdk::configuration::DocumentNode::GetRequiredInteger ( const std::string &  name) const
pure virtual

◆ GetRequiredInteger() [2/2]

virtual std::size_t sdk::configuration::DocumentNode::GetRequiredInteger ( const std::string &  name) const
pure virtual

◆ GetRequiredString() [1/2]

virtual std::string sdk::configuration::DocumentNode::GetRequiredString ( const std::string &  name) const
pure virtual

◆ GetRequiredString() [2/2]

virtual std::string sdk::configuration::DocumentNode::GetRequiredString ( const std::string &  name) const
pure virtual

◆ GetString() [1/2]

virtual std::string sdk::configuration::DocumentNode::GetString ( const std::string &  name,
const std::string &  default_value 
) const
pure virtual

◆ GetString() [2/2]

virtual std::string sdk::configuration::DocumentNode::GetString ( const std::string &  name,
const std::string &  default_value 
) const
pure virtual

◆ IntegerFromString() [1/2]

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

◆ IntegerFromString() [2/2]

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

◆ Key() [1/2]

virtual std::string sdk::configuration::DocumentNode::Key ( ) const
pure virtual

◆ Key() [2/2]

virtual std::string sdk::configuration::DocumentNode::Key ( ) const
pure virtual

◆ num_children() [1/2]

virtual std::size_t sdk::configuration::DocumentNode::num_children ( ) const
pure virtual

◆ num_children() [2/2]

virtual std::size_t sdk::configuration::DocumentNode::num_children ( ) const
pure virtual

◆ operator=() [1/4]

DocumentNode& sdk::configuration::DocumentNode::operator= ( const DocumentNode &  other)
default

◆ operator=() [2/4]

DocumentNode& sdk::configuration::DocumentNode::operator= ( const DocumentNode &  other)
default

◆ operator=() [3/4]

DocumentNode& sdk::configuration::DocumentNode::operator= ( DocumentNode &&  )
default

◆ operator=() [4/4]

DocumentNode& sdk::configuration::DocumentNode::operator= ( DocumentNode &&  )
default

Field Documentation

◆ MAX_NODE_DEPTH

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

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