vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::InstrumentationNode Class Reference

InstrumentationNode enables instrumentation of a subgraph. More...

#include <InstrumentationNode.h>

Inheritance diagram for vsg::InstrumentationNode:
Collaboration diagram for vsg::InstrumentationNode:

Public Member Functions

 InstrumentationNode (const InstrumentationNode &rhs, const CopyOp &copyop={})
 InstrumentationNode (ref_ptr< Node > in_child)
void setColor (uint_color color)
uint_color getColor () const
void setName (const std::string &name)
const std::string & getName () const
void setLevel (uint32_t level)
uint32_t getLevel () const
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
int compare (const Object &rhs) const override
 compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,
void traverse (Visitor &visitor) override
void traverse (ConstVisitor &visitor) const override
void traverse (RecordTraversal &visitor) const override
void read (Input &input) override
void write (Output &output) const override
Public Member Functions inherited from vsg::Inherit< Node, InstrumentationNode >
 Inherit (Args &&... args)
std::size_t sizeofObject () const noexcept override
const char * className () const noexcept override
const std::type_info & type_info () const noexcept override
bool is_compatible (const std::type_info &type) const noexcept override
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::Node
 Node (const Node &rhs, const CopyOp &copyop={})
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
Public Member Functions inherited from vsg::Inherit< Object, Node >
 Inherit (Args &&... args)
std::size_t sizeofObject () const noexcept override
const char * className () const noexcept override
const std::type_info & type_info () const noexcept override
bool is_compatible (const std::type_info &type) const noexcept override
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual void accept (ConstVisitor &visitor) const
virtual void accept (RecordTraversal &visitor) const
void ref () const noexcept
void unref () const noexcept
void unref_nodelete () const noexcept
unsigned int referenceCount () const noexcept
template<typename T>
void setValue (const std::string &key, const T &value)
void setValue (const std::string &key, const char *value)
 specialization of setValue to handle passing C strings
template<typename T>
bool getValue (const std::string &key, T &value) const
 get specified value type, return false if value associated with key is not assigned or is not the correct type
void setObject (const std::string &key, ref_ptr< Object > object)
 assign an Object associated with key
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const ObjectgetObject (const std::string &key) const
 get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
T * getObject (const std::string &key)
 get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const T * getObject (const std::string &key) const
 get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< ObjectgetRefObject (const std::string &key)
 get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< const ObjectgetRefObject (const std::string &key) const
 get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
ref_ptr< T > getRefObject (const std::string &key)
 get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const ref_ptr< const T > getRefObject (const std::string &key) const
 get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
void removeObject (const std::string &key)
 remove meta object or value associated with key
AuxiliarygetOrCreateAuxiliary ()
AuxiliarygetAuxiliary ()
const AuxiliarygetAuxiliary () const

Public Attributes

ref_ptr< vsg::Nodechild

Protected Attributes

uint32_t _level = 1
uint_color _color
std::string _name
SourceLocation _sl_Visitor
SourceLocation _sl_ConstVisitor
SourceLocation _sl_RecordTraversal

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Node, InstrumentationNode >
static ref_ptr< InstrumentationNodecreate (Args &&... args)
static ref_ptr< InstrumentationNodecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Node
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_NODES_OBJECTS
static void operator delete (void *ptr)
Static Public Member Functions inherited from vsg::Inherit< Object, Node >
static ref_ptr< Nodecreate (Args &&... args)
static ref_ptr< Nodecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
static ref_ptr< Objectcreate_if (bool flag)
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
static void operator delete (void *ptr)
Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Detailed Description

InstrumentationNode enables instrumentation of a subgraph.

Member Function Documentation

◆ clone()

ref_ptr< Object > vsg::InstrumentationNode::clone ( const CopyOp & copyop = {}) const
inlineoverridevirtual

clone this object using CopyOp's duplicates map to decide whether to clone or to return the original object. The default clone(CopyOp&) implementation simply returns ref_ptr<> to this object rather attempt to clone.

Reimplemented from vsg::Object.

◆ compare()

int vsg::InstrumentationNode::compare ( const Object & rhs) const
overridevirtual

compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,

Reimplemented from vsg::Inherit< Node, InstrumentationNode >.

◆ read()

void vsg::InstrumentationNode::read ( Input & input)
overridevirtual

Reimplemented from vsg::Object.

◆ traverse() [1/3]

void vsg::InstrumentationNode::traverse ( ConstVisitor & visitor) const
overridevirtual

Reimplemented from vsg::Object.

◆ traverse() [2/3]

void vsg::InstrumentationNode::traverse ( RecordTraversal & visitor) const
overridevirtual

Reimplemented from vsg::Object.

◆ traverse() [3/3]

void vsg::InstrumentationNode::traverse ( Visitor & visitor)
overridevirtual

Reimplemented from vsg::Object.

◆ write()

void vsg::InstrumentationNode::write ( Output & output) const
overridevirtual

Reimplemented from vsg::Object.


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