ChimeraTK-ApplicationCore 04.06.00
Loading...
Searching...
No Matches
ChimeraTK::Model Namespace Reference

Namespaces

namespace  detail
 

Classes

struct  AdjacentInSearch
 
struct  AdjacentOutSearch
 
struct  AdjacentSearch
 
struct  AndSet
 
class  ApplicationModuleProxy
 
struct  BreadthFirstSearch
 
struct  CombinedSearchConfig
 
struct  ContinueSearchDisjunctTrees
 
struct  DepthFirstSearch
 
class  DeviceModuleProxy
 
class  DirectoryProxy
 
struct  EdgeFilter
 
struct  EdgeProperties
 Information to be stored with each edge. More...
 
class  Impl
 Implementation class for the model. More...
 
class  ModuleGroupProxy
 
class  NonOwningProxy
 Proxy class which does not keep the ownership of the model. More...
 
struct  OrSet
 
class  ProcessVariableProxy
 
struct  PropertyFilterTag
 
class  Proxy
 Base class for the proxies representing objects in the model. More...
 
struct  ReturnFirstHit
 
struct  ReturnFirstHitWithValue
 
class  RootProxy
 Proxy representing the root of the application model. More...
 
struct  SearchOption
 Do not use these class definitions, instead use the static instances below. More...
 
struct  SearchType
 Do not use these class definitions, instead use the static instances below. More...
 
struct  SearchTypeHolder
 
class  VariableGroupProxy
 
struct  VertexFilter
 
struct  VertexProperties
 Information to be stored with each vertex. More...
 
struct  VisitOrder
 

Typedefs

using Vertex = boost::adjacency_list< detail::OutEdgeListType, detail::VertexListType, boost::bidirectionalS >::vertex_descriptor
 
using Graph = boost::adjacency_list< detail::OutEdgeListType, detail::VertexListType, boost::bidirectionalS, VertexProperties, EdgeProperties >
 Graph type for the model.
 
using Edge = Graph::edge_descriptor
 
using EdgeFilteredView = boost::filtered_graph< Graph, std::function< bool(const Edge &)>, boost::keep_all >
 

Functions

template<typename PROPERTY_OR_PROXY >
constexpr bool isRoot (const PROPERTY_OR_PROXY &)
 Predicates to identify the type of a proxy or a properties struct.
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isModuleGroup (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isApplicationModule (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isVariableGroup (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isDeviceModule (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isVariable (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool isDirectory (const PROPERTY_OR_PROXY &)
 
template<typename PROPERTY_OR_PROXY >
constexpr bool hasName (const PROPERTY_OR_PROXY &)
 
constexpr ReturnFirstHitWithValue< void > returnFirstHit ()
 Stop the search after the first hit and return.
 
template<typename FIRST , typename... MORE>
constexpr auto combinedSearchConfig (FIRST first, MORE... more)
 
template<typename FIRST , typename... ARGS>
constexpr auto getEdgeFilter (FIRST first, ARGS... args)
 
constexpr auto getEdgeFilter ()
 
template<typename FIRST , typename... ARGS>
constexpr auto getVertexFilter (FIRST first, ARGS... args)
 
constexpr auto getVertexFilter ()
 
template<typename FIRST , typename... ARGS>
constexpr auto getSearchType ()
 
constexpr auto getSearchType ()
 
template<typename SEARCH_OPTION_TO_FIND , typename FIRST , typename... ARGS>
constexpr bool hasSearchOption ()
 
template<typename SEARCH_OPTION_TO_FIND >
constexpr bool hasSearchOption ()
 
template<typename SEARCH_OPTION_TO_FIND , typename FIRST , typename... ARGS>
constexpr auto getSearchOption (FIRST first, ARGS... args)
 
template<typename SEARCH_OPTION_TO_FIND >
constexpr auto getSearchOption ()
 
template<typename FIRST , typename... ARGS>
constexpr void checkConfigValidity (FIRST, ARGS... args)
 
constexpr void checkConfigValidity ()
 

Typedef Documentation

◆ Edge

using ChimeraTK::Model::Edge = typedef Graph::edge_descriptor

Definition at line 700 of file Model.h.

◆ EdgeFilteredView

using ChimeraTK::Model::EdgeFilteredView = typedef boost::filtered_graph<Graph, std::function<bool(const Edge&)>, boost::keep_all>

Definition at line 702 of file Model.h.

◆ Graph

using ChimeraTK::Model::Graph = typedef boost::adjacency_list<detail::OutEdgeListType, detail::VertexListType, boost::bidirectionalS, VertexProperties, EdgeProperties>

Graph type for the model.

Definition at line 695 of file Model.h.

◆ Vertex

typedef Graph::vertex_descriptor ChimeraTK::Model::Vertex

Definition at line 64 of file Model.h.

Function Documentation

◆ checkConfigValidity() [1/2]

constexpr void ChimeraTK::Model::checkConfigValidity ( )
constexpr

Definition at line 1351 of file Model.h.

◆ checkConfigValidity() [2/2]

template<typename FIRST , typename... ARGS>
constexpr void ChimeraTK::Model::checkConfigValidity ( FIRST  ,
ARGS...  args 
)
constexpr

Definition at line 1340 of file Model.h.

◆ combinedSearchConfig()

template<typename FIRST , typename... MORE>
constexpr auto ChimeraTK::Model::combinedSearchConfig ( FIRST  first,
MORE...  more 
)
constexpr

Definition at line 1104 of file Model.h.

◆ getEdgeFilter() [1/2]

constexpr auto ChimeraTK::Model::getEdgeFilter ( )
constexpr

Definition at line 1250 of file Model.h.

◆ getEdgeFilter() [2/2]

template<typename FIRST , typename... ARGS>
constexpr auto ChimeraTK::Model::getEdgeFilter ( FIRST  first,
ARGS...  args 
)
constexpr

Definition at line 1238 of file Model.h.

◆ getSearchOption() [1/2]

template<typename SEARCH_OPTION_TO_FIND >
constexpr auto ChimeraTK::Model::getSearchOption ( )
constexpr

Definition at line 1333 of file Model.h.

◆ getSearchOption() [2/2]

template<typename SEARCH_OPTION_TO_FIND , typename FIRST , typename... ARGS>
constexpr auto ChimeraTK::Model::getSearchOption ( FIRST  first,
ARGS...  args 
)
constexpr

Definition at line 1320 of file Model.h.

◆ getSearchType() [1/2]

template<typename FIRST , typename... ARGS>
constexpr auto ChimeraTK::Model::getSearchType ( )
constexpr

Definition at line 1281 of file Model.h.

◆ getSearchType() [2/2]

constexpr auto ChimeraTK::Model::getSearchType ( )
constexpr

Definition at line 1293 of file Model.h.

◆ getVertexFilter() [1/2]

constexpr auto ChimeraTK::Model::getVertexFilter ( )
constexpr

Definition at line 1269 of file Model.h.

◆ getVertexFilter() [2/2]

template<typename FIRST , typename... ARGS>
constexpr auto ChimeraTK::Model::getVertexFilter ( FIRST  first,
ARGS...  args 
)
constexpr

Definition at line 1257 of file Model.h.

◆ hasName()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::hasName ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 677 of file Model.h.

◆ hasSearchOption() [1/2]

template<typename SEARCH_OPTION_TO_FIND , typename FIRST , typename... ARGS>
constexpr bool ChimeraTK::Model::hasSearchOption ( )
constexpr

Definition at line 1300 of file Model.h.

◆ hasSearchOption() [2/2]

template<typename SEARCH_OPTION_TO_FIND >
constexpr bool ChimeraTK::Model::hasSearchOption ( )
constexpr

Definition at line 1313 of file Model.h.

◆ isApplicationModule()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isApplicationModule ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 637 of file Model.h.

◆ isDeviceModule()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isDeviceModule ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 653 of file Model.h.

◆ isDirectory()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isDirectory ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 669 of file Model.h.

◆ isModuleGroup()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isModuleGroup ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 629 of file Model.h.

◆ isRoot()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isRoot ( const PROPERTY_OR_PROXY &  )
constexpr

Predicates to identify the type of a proxy or a properties struct.

All predicates can be used in constexpr if conditions to simplify type-specific access to members.

Definition at line 621 of file Model.h.

◆ isVariable()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isVariable ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 661 of file Model.h.

◆ isVariableGroup()

template<typename PROPERTY_OR_PROXY >
constexpr bool ChimeraTK::Model::isVariableGroup ( const PROPERTY_OR_PROXY &  )
constexpr

Definition at line 645 of file Model.h.

◆ returnFirstHit()

constexpr ReturnFirstHitWithValue< void > ChimeraTK::Model::returnFirstHit ( )
inlineconstexpr

Stop the search after the first hit and return.

If the visitor returns a value, it will be passed on to the caller of the visit() function. If no match is found, the provided notFoundValue will be returned.

Definition at line 790 of file Model.h.