HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CH_ChannelRef.h File Reference
#include "CH_API.h"
#include "CH_Types.h"
#include <UT/UT_Map.h>
#include <UT/UT_String.h>
#include <functional>
#include <iosfwd>
+ Include dependency graph for CH_ChannelRef.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  CH_ChannelRef
 

Typedefs

typedef UT_Map< CH_ChannelRef,
unsigned > 
CH_ChannelRefTable
 
typedef std::function< bool(const
CH_ChannelRef &, unsigned
flags)> 
CH_ChannelRefQueryCallback
 
typedef std::function< void(const
CH_ChannelRef &)> 
CH_ChannelRefCallback
 

Functions

size_t hash_value (const CH_ChannelRef &ref)
 
CH_API int CHdeleteRefsWithNodeId (CH_ChannelRefTable &ref_table, int node_id, CH_ChannelRefQueryCallback should_delete_callback=nullptr, CH_ChannelRefCallback pre_delete_callback=nullptr)
 
CH_API void CHaddFullChannelPath (const CH_ChannelRefTable &table, UT_StringArray &chan_paths, bool use_alias)
 
CH_API void CHaddExposedChannel (const CH_ChannelRefTable &table, CH_ChannelList &channels)
 
CH_API void CHaddExposedChanRef (const CH_ChannelRefTable &table, CH_ChannelRefList &chanrefs, unsigned mask)
 
CH_API int CHcompareChanRefs (const CH_ChannelRef *, const CH_ChannelRef *)
 
CH_API bool CHchannelsToChanRefs (const CH_ChannelList &channels, CH_ChannelRefList &refs)
 
CH_API bool CHchanRefsToChannels (const CH_ChannelRefList &refs, CH_ChannelList &channels)
 
CH_API void CHdisplayChanRefs (const CH_ChannelRefList &refs)
 
CH_API std::ostream & operator<< (std::ostream &os, const CH_ChannelRef &ref)
 

Typedef Documentation

typedef std::function<void(const CH_ChannelRef&)> CH_ChannelRefCallback

Definition at line 158 of file CH_ChannelRef.h.

typedef std::function<bool(const CH_ChannelRef&, unsigned flags)> CH_ChannelRefQueryCallback

Definition at line 156 of file CH_ChannelRef.h.

CH_ChannelRefTable maintains a set of CH_ChannelRef's along with some flags that are from CH_ScopeMasks (see CH_Types.h)

Definition at line 153 of file CH_ChannelRef.h.

Function Documentation

CH_API void CHaddExposedChannel ( const CH_ChannelRefTable table,
CH_ChannelList channels 
)
CH_API void CHaddExposedChanRef ( const CH_ChannelRefTable table,
CH_ChannelRefList chanrefs,
unsigned  mask 
)
CH_API void CHaddFullChannelPath ( const CH_ChannelRefTable table,
UT_StringArray chan_paths,
bool  use_alias 
)
CH_API bool CHchannelsToChanRefs ( const CH_ChannelList channels,
CH_ChannelRefList refs 
)
CH_API bool CHchanRefsToChannels ( const CH_ChannelRefList refs,
CH_ChannelList channels 
)
CH_API int CHcompareChanRefs ( const CH_ChannelRef ,
const CH_ChannelRef  
)
CH_API int CHdeleteRefsWithNodeId ( CH_ChannelRefTable ref_table,
int  node_id,
CH_ChannelRefQueryCallback  should_delete_callback = nullptr,
CH_ChannelRefCallback  pre_delete_callback = nullptr 
)

Deletes all the symbols from the table that have the given node_id, returns the number of items deleted

CH_API void CHdisplayChanRefs ( const CH_ChannelRefList refs)
size_t hash_value ( const CH_ChannelRef ref)
inline

Definition at line 146 of file CH_ChannelRef.h.

CH_API std::ostream& operator<< ( std::ostream &  os,
const CH_ChannelRef ref 
)