UN_Include.h File Reference

#include "UN_API.h"
#include <UT/UT_Array.h>
#include <UT/UT_ArrayMap.h>
#include <UT/UT_Options.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>
#include <SYS/SYS_Types.h>
#include <SYS/SYS_Hash.h>

Include dependency graph for UN_Include.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UN_DataNumber
class	UN_DataSize
class	UN_DataIndex
class	UN_DataIndexSpan
class	UN_DataID
class	UN_DataIDRemapT< ID >
	Adaptor of the UN_DataIDRemap to specific data types. More...
class	UN_DataIDRemap
class	UN_DataIDRemapT< ID >
	Adaptor of the UN_DataIDRemap to specific data types. More...
class	UN_DataMergeInfo
class	UN_IDRemapInfo
	Package of remappings for various data ID types (nodes, ports, subnets). More...
class	UN_GraphMergeInfo
	Information about the result of a merge from another graph. More...
struct	UT::DefaultClearer< T >
struct	UT::DefaultClearer< UN_DataID >
struct	UT::DefaultClearer< UN_DataIndex >

Namespaces
	UT

Macros
#define	UN_DATA_INDEX(Class)
#define	UN_DATA_ID(Class)
#define	UN_NUMBER_FORMATTER(IdOrIndexType)
	For debug printouts, etc: More...
#define	UN_ID_CLEARER(ID)   template <> struct DefaultClearer<ID> : public DefaultClearer<UN_DataID> {};
#define	UN_INDEX_CLEARER(ID)   template<> struct DefaultClearer<ID>: public DefaultClearer<UN_DataIndex>{};

Typedefs
using	UN_DataIDList = UT_Array< UN_DataID >
	A list of data IDs. More...
using	UN_Options = UT_Options
using	UN_OptionsPtr = UT_UniquePtr< UN_Options >

Enumerations
enum	UN_PortKind { UN_PortKind::Invalid, UN_PortKind::Input, UN_PortKind::Output }
	Differentiates between input and output ports. More...

Macro Definition Documentation

#define UN_DATA_ID

(

Class

)

Value:

class Class : public UN_DataID \
{ \
public: \
    constexpr explicit  Class( UN_DataID data_id = UN_DataID() ) \
                            : UN_DataID( data_id ) {} \
}; \
   \
using Class##List = UT_Array< Class >; \
using Class##Remap  = UN_DataIDRemapT< Class >; \

Data ID is unique throughout the lifespan of a graph, but only for within the same data class (eg, nodes). Ie, a node may have same data id as a wire. So it's a good idea to keep these type spaces separate. Defines types for various data ID numbers.

Definition at line 286 of file UN_Include.h.

#define UN_DATA_INDEX

(

Class

)

Value:

class Class : public UN_DataIndex \
{ \
public: \
    explicit    Class( UN_DataIndex data_index = UN_DataIndex() ) \
                    : UN_DataIndex( data_index ) {} \
}; \
   \
using Class##List = UT_Array< Class >; \

An index into a data container, referring to a data object. Indices may be reused for new data objects, if old ones were deleted.

Definition at line 229 of file UN_Include.h.

#define UN_ID_CLEARER

(

ID

)

template <> struct DefaultClearer<ID> : public DefaultClearer<UN_DataID> {};

Definition at line 614 of file UN_Include.h.

#define UN_INDEX_CLEARER

(

ID

)

template<> struct DefaultClearer<ID>: public DefaultClearer<UN_DataIndex>{};

Definition at line 633 of file UN_Include.h.

#define UN_NUMBER_FORMATTER

(

IdOrIndexType

)

Value:

inline size_t format(char *buffer, size_t buffer_size, const IdOrIndexType &v) \
{                                                                          \
    UT::Format::Writer w(buffer, buffer_size);                             \
    UT::Format::Formatter f;                                               \
    return f.format(w, #IdOrIndexType "({})", {v.exintValue()});           \
} \
inline size_t format(char *buffer, size_t buffer_size,                      \
        const UT_Array<IdOrIndexType> &v) \
{                                                                           \
    UT::Format::Writer w(buffer, buffer_size);                              \
    UT::Format::Formatter f;                                                \
    size_t bytesWritten = w("UT_Array<" #IdOrIndexType ">([",              \
                     sizeof("UT_Array<" #IdOrIndexType ">([")-1);           \
    bool first = true;                                                      \
    for (auto &&item : v)                                                   \
    {                                                                       \
        bytesWritten += f.format(w, first ? "{}" : ", {}",                  \
                {item.exintValue()});                                       \
	first = false;                                                      \
    }                                                                       \
    bytesWritten += w("])", 2);                                              \
    return bytesWritten;                                                    \
}

For debug printouts, etc:

Definition at line 554 of file UN_Include.h.

Typedef Documentation

using UN_DataIDList = UT_Array< UN_DataID >

A list of data IDs.

Definition at line 276 of file UN_Include.h.

using UN_Options = UT_Options

Graph serialization to UT_Options. Using UT_UniquePtr<UT_Options> to return values, to indicate the ownership. Using UT_UniquePtr<UT_OPtions> rather than UT_OptionsHolder because it is more flexible: it's easier to further edit options (editing UT_OptionsHolder is cumbersome), and it's easy to create UT_OptionsHolder from the UT_UniquePtr, if need be.

Definition at line 672 of file UN_Include.h.

using UN_OptionsPtr = UT_UniquePtr<UN_Options>

Definition at line 673 of file UN_Include.h.

Enumeration Type Documentation

enum UN_PortKind

strong

Differentiates between input and output ports.

Enumerator
Invalid
Input
Output

Definition at line 646 of file UN_Include.h.