Public Member Functions | Public Attributes | Static Public Attributes | List of all members
dai::node::SystemLogger Class Reference

SystemLogger node. Send system information periodically. More...

#include <SystemLogger.hpp>

Inheritance diagram for dai::node::SystemLogger:
Inheritance graph
[legend]

Public Member Functions

float getRate ()
 
void setRate (float hz)
 
 SystemLogger (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
 
 SystemLogger (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
 
- Public Member Functions inherited from dai::NodeCRTP< Node, SystemLogger, SystemLoggerProperties >
std::unique_ptr< Nodeclone () const override
 
const char * getName () const override
 
- Public Member Functions inherited from dai::Node
virtual std::unique_ptr< Nodeclone () const =0
 Deep copy the node. More...
 
AssetManagergetAssetManager ()
 Get node AssetManager as a reference. More...
 
const AssetManagergetAssetManager () const
 Get node AssetManager as a const reference. More...
 
std::vector< Input * > getInputRefs ()
 Retrieves reference to node inputs. More...
 
std::vector< const Input * > getInputRefs () const
 Retrieves reference to node inputs. More...
 
std::vector< InputgetInputs ()
 Retrieves all nodes inputs. More...
 
virtual const char * getName () const =0
 Retrieves nodes name. More...
 
std::vector< Output * > getOutputRefs ()
 Retrieves reference to node outputs. More...
 
std::vector< const Output * > getOutputRefs () const
 Retrieves reference to node outputs. More...
 
std::vector< OutputgetOutputs ()
 Retrieves all nodes outputs. More...
 
Pipeline getParentPipeline ()
 
const Pipeline getParentPipeline () const
 
 Node (const std::shared_ptr< PipelineImpl > &p, Id nodeId, std::unique_ptr< Properties > props)
 Constructs Node. More...
 
virtual ~Node ()=default
 

Public Attributes

Output out {*this, "out", Output::Type::MSender, {{DatatypeEnum::SystemInformation, false}}}
 
- Public Attributes inherited from dai::NodeCRTP< Node, SystemLogger, SystemLoggerProperties >
Propertiesproperties
 Underlying properties. More...
 
- Public Attributes inherited from dai::Node
const Id id
 Id of node. More...
 
Propertiesproperties
 

Static Public Attributes

constexpr static const char * NAME = "SystemLogger"
 

Additional Inherited Members

- Public Types inherited from dai::NodeCRTP< Node, SystemLogger, SystemLoggerProperties >
using Properties = SystemLoggerProperties
 
- Public Types inherited from dai::Node
using Id = std::int64_t
 Node identificator. Unique for every node on a single Pipeline. More...
 
- Protected Member Functions inherited from dai::Node
virtual PropertiesgetProperties ()
 
virtual tl::optional< OpenVINO::VersiongetRequiredOpenVINOVersion ()
 
void setInputMapRefs (InputMap *inMapRef)
 
void setInputMapRefs (std::initializer_list< InputMap * > l)
 
void setInputRefs (Input *inRef)
 
void setInputRefs (std::initializer_list< Input * > l)
 
void setOutputMapRefs (OutputMap *outMapRef)
 
void setOutputMapRefs (std::initializer_list< OutputMap * > l)
 
void setOutputRefs (Output *outRef)
 
void setOutputRefs (std::initializer_list< Output * > l)
 
- Protected Attributes inherited from dai::Node
AssetManager assetManager
 
std::unordered_map< std::string, InputMap * > inputMapRefs
 
std::unordered_map< std::string, Input * > inputRefs
 
std::unordered_map< std::string, OutputMap * > outputMapRefs
 
std::unordered_map< std::string, Output * > outputRefs
 
std::weak_ptr< PipelineImplparent
 
copyable_unique_ptr< PropertiespropertiesHolder
 

Detailed Description

SystemLogger node. Send system information periodically.

Definition at line 14 of file SystemLogger.hpp.

Constructor & Destructor Documentation

◆ SystemLogger() [1/2]

dai::node::SystemLogger::SystemLogger ( const std::shared_ptr< PipelineImpl > &  par,
int64_t  nodeId 
)

Definition at line 6 of file SystemLogger.cpp.

◆ SystemLogger() [2/2]

dai::node::SystemLogger::SystemLogger ( const std::shared_ptr< PipelineImpl > &  par,
int64_t  nodeId,
std::unique_ptr< Properties props 
)

Definition at line 8 of file SystemLogger.cpp.

Member Function Documentation

◆ getRate()

float dai::node::SystemLogger::getRate ( )

Gets logging rate, at which messages will be sent out

Definition at line 19 of file SystemLogger.cpp.

◆ setRate()

void dai::node::SystemLogger::setRate ( float  hz)

Specify logging rate, at which messages will be sent out

Parameters
hzSending rate in hertz (messages per second)

Definition at line 15 of file SystemLogger.cpp.

Member Data Documentation

◆ NAME

constexpr static const char* dai::node::SystemLogger::NAME = "SystemLogger"
staticconstexpr

Definition at line 16 of file SystemLogger.hpp.

◆ out

Output dai::node::SystemLogger::out {*this, "out", Output::Type::MSender, {{DatatypeEnum::SystemInformation, false}}}

Outputs SystemInformation message that carries various system information like memory and CPU usage, temperatures, ...

Definition at line 25 of file SystemLogger.hpp.


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


depthai
Author(s): Martin Peterlin
autogenerated on Sat Mar 22 2025 02:58:20