Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
OfBaseContextHandle< T > Class Template Reference
Inheritance diagram for OfBaseContextHandle< T >:
OfBaseItemHandle< T > CoreBaseObject CoreBaseType

Public Types

typedef core_conditional< T,
const OfContext, OfContext >
::type 
ContextType
 
- Public Types inherited from OfBaseItemHandle< T >
typedef core_conditional< T,
const OfItem, OfItem >::type 
ItemType
 
typedef core_conditional< T,
const OfObject, OfObject >
::type 
ObjectType
 
typedef core_conditional< T,
const OfAttr, OfAttr >::type 
AttrType
 
typedef core_conditional< T,
const OfContext, OfContext >
::type 
ContextType
 

Public Member Functions

bool is_root () const
 
bool is_empty () const
 
bool is_embedded () const
 
unsigned int find_item_index (const OfItem *item) const
 
unsigned int get_context_count (const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
unsigned int get_all_contexts_count (const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void resolve_contexts (CoreSet< OfContext * > &contexts, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void resolve_all_contexts (CoreSet< OfContext * > &contexts, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
unsigned int get_object_count (const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
unsigned int get_all_objects_count (const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
CoreString get_attribute_path (const OfAttr &attr) const
 
unsigned int find_cam (const CoreString &cam_name) const
 
unsigned int find_cam (const OfAttr *custom_attr) const
 
bool is_cam_disabled (const unsigned int &index) const
 
bool is_cam_builtin (const unsigned int &index) const
 
unsigned int get_cam_count () const
 
CoreString get_cam_rule (const unsigned int &index) const
 
CoreString get_cam_exclusion_rule (const unsigned int &index) const
 
const OfAttrget_cam_attribute (const unsigned int &index) const
 
CamDesc get_cam_desc (const unsigned int &index) const
 
unsigned int get_instance_count (const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
OfItemget_last_event_item () const
 
OfObjectget_last_event_object () const
 
OfContextget_last_event_context () const
 
ParserEntryserialize (const OfSerialOptions &options=OfSerialOptions::get_default(), AppProgressBar *progress_bar=0) const
 
void protect (const bool &enable) const
 
unsigned int get_level () const
 
void export_project (const CoreString &filename) const
 
bool is_reference () const
 
bool is_override () const
 
bool is_scene_assembly () const
 
bool is_scene_assembly_read () const
 
const OfContextget_scene_assembly_source_context () const
 
bool is_build_package () const
 
void get_external_dependencies (CoreSet< OfItem * > &external_refs, CoreSet< OfItem * > &external_srcs) const
 
void get_external_dependencies (CoreHashTable< OfItem *, CoreSet< OfItem * > > &external_refs, CoreHashTable< OfItem *, CoreSet< OfItem * > > &external_srcs) const
 
void get_statistics (SysStatistic &stats) const
 
OfContextEngineget_engine () const
 
const CoreStringget_engine_serial_name () const
 
const CoreStringget_engine_identifier_name () const
 
int get_protected_object_count () const
 
const bool & is_import_point () const
 
bool options_exists () const
 
bool is_options (const OfObject &object) const
 
OfObjectget_options () const
 
bool is_child_of (const OfContext &context, const bool &follow_instances=false) const
 
bool is_child_of (const CoreSet< OfContext * > &parent_contexts) const
 
bool is_writable () const
 
OfContextEngineget_root_engine () const
 
void move_item_index (const unsigned int old_index, const unsigned int new_index)
 
void move_item_indices (const CoreBasicArray< OfItem * > &items, const OfItem *tgt_item, const bool add_after=true)
 
void clear ()
 
void remove_context (OfContext &context)
 
void remove_context (const CoreString &name)
 
void remove_context (const unsigned int &index)
 
void remove_all_contexts ()
 
void remove_all_contexts (const bool &remove_default, const bool &progress_bar_active=false)
 
void remove_object (const CoreString &object_name, const bool &remove_static=false)
 
void remove_object (OfObject &object, const bool &remove_static=false)
 
void remove_all_objects (const bool &progress_bar_active=false)
 
void rename_object (OfObject &object, const CoreString &new_name)
 
void rename_object (const CoreString &old_name, const CoreString &new_name)
 
OfContextadd_pending_context (const CoreString &ctx_path, const CoreString &engine_name)
 
OfObjectadd_pending_object (const CoreString &object_name, const CoreString &class_name)
 
OfItemadd_pending_item (const CoreString &object_name, const CoreString &item_type)
 
bool add_cam (const CamDesc &cam_desc)
 
void remove_cam (const unsigned int &index, const bool remove_attr=true)
 
void remove_cam (const OfAttr *custom_attr, const bool remove_attr=true)
 
void retarget_cam (const unsigned int &index, const CoreString &rule)
 
void retarget_cam (const OfAttr *custom_attr, const CoreString &rule)
 
void retarget_cam (const unsigned int &index, const CoreString &rule, const CoreString &exclusion_rule)
 
void retarget_cam (const OfAttr *custom_attr, const CoreString &rule, const CoreString &exclusion_rule)
 
void untarget_cam (const unsigned int &index)
 
void untarget_cam (const OfAttr *custom_attr)
 
void remove_all_cams (const bool remove_attr=true)
 
void disable_cam (const unsigned int &index, const bool &disabled)
 
void set_cam_builtin (const unsigned int &index, const bool &is_builtin)
 
OfObjectcreate_empty_CAM_set ()
 
bool create_CAM_set (OfObject &target_cam_set)
 
bool load_CAM_set (const OfObject &target_cam_set)
 
bool import_project (const CoreString &filename, const OfSerialOptions::Mode &serial_mode, const OfImportOptions::VariableMode &variable_mode, const OfImportOptions::AovMode &aov_mode, CoreVector< OfItem * > &items, OfImportOptions::LogMode log_mode=OfImportOptions::LOG_MODE_ERROR)
 
bool import_build (const CoreString &filename, const OfSerialOptions::Mode &serial_mode, const OfImportOptions::VariableMode &variable_mode, const OfImportOptions::AovMode &aov_mode, CoreVector< OfItem * > &items, OfImportOptions::LogMode log_mode=OfImportOptions::LOG_MODE_ERROR)
 
OfContextreference_file (const CoreString &filename, const OfImportOptions::VariableMode &import_variable_mode=OfImportOptions::VARIABLE_MODE_APPEND, const OfImportOptions::AovMode &import_aov_mode=OfImportOptions::AOV_MODE_IMPORT)
 
void set_engine (const CoreClassInfo &engine_info, ParserGroup *engine_settings=0)
 
void set_engine (const CoreString &engine_name, ParserGroup *engine_settings=0)
 
void set_import_point (const bool &flag)
 
bool deserialize (const ParserEntry &serial, const OfSerialOptions &options=OfSerialOptions::get_default(), AppProgressBar *progress_bar=0)
 
OfContextget_scene_assembly_source_context ()
 
void set_parent (OfContext &parent)
 
 OfBaseContextHandle (ContextType *context)
 
template<bool U>
 OfBaseContextHandle (const OfBaseItemHandle< U > &other)
 
 OfBaseContextHandle (const OfHandle &handle)
 
template<bool U>
OfBaseContextHandle< T > & operator= (const OfBaseItemHandle< U > &other)
 
 operator const OfContext * () const
 
 operator OfContext * () const
 
template<bool U>
bool operator== (const OfBaseItemHandle< U > &other) const
 
template<bool U>
bool operator!= (const OfBaseItemHandle< U > &other) const
 
bool operator== (ContextType *context) const
 
bool operator!= (ContextType *context) const
 
ContextTypeget_ptr () const
 
OfBaseContextHandle< T > get_parent () const
 
OfBaseContextHandle< T > get_source () const
 
CoreString get_item_path (OfConstItemHandle item) const
 
CoreString get_object_path (OfConstObjectHandle object) const
 
CoreString get_context_path (OfConstContextHandle context) const
 
void get_object_path (OfConstObjectHandle object, CoreVector< OfContext * > &path) const
 
OfItemHandle get_item (const CoreString &name) const
 return an item by specifying its path
 
OfItemHandle item_exists (const CoreString &name) const
 return an item by specifying its path
 
OfItemHandle get_item (const unsigned int index) const
 
OfObjectHandle get_object (const CoreString &object_name) const
 return an object by specifying its name
 
OfObjectHandle object_exists (const CoreString &object_name) const
 return an object by specifying its name
 
OfBaseContextHandle< T > get_context (const CoreString &name) const
 return the sub-context by name
 
OfConstContextHandle get_context (const unsigned &index, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
OfBaseContextHandle< T > context_exists (const CoreString &name) const
 return the sub-context by name
 
void get_contexts (CoreArray< OfContextHandle > &contexts, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void get_all_instances (CoreVector< OfContextHandle > &instances, const bool &recursive=false, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
OfContextHandle get_instance (const unsigned int &index, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void get_objects (const CoreString &class_name, CoreArray< OfObjectHandle > &objects, const int &mask, const bool &inclusive) const
 
void get_objects (const CoreString &class_name, CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_but_private_flags_mask) const
 
void get_objects (const CoreBasicArray< CoreString > &class_names, CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_but_private_flags_mask) const
 
void get_objects (CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void get_all_objects (const CoreString &class_name, CoreArray< OfObjectHandle > &objects, const int &mask, const bool &inclusive) const
 
void get_all_objects (const CoreBasicArray< CoreString > &class_names, CoreArray< OfObjectHandle > &objects, const int &mask, const bool &inclusive) const
 
void get_all_objects (const CoreString &class_name, CoreSet< OfObjectHandle > &objects, const int &mask, const bool &inclusive) const
 
void get_all_objects (const CoreBasicArray< CoreString > &class_names, CoreSet< OfObjectHandle > &objects, const int &mask, const bool &inclusive) const
 
void get_all_objects (const CoreString &class_name, CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_but_private_flags_mask, const bool &consider_embedded=false) const
 
void get_all_objects (const CoreBasicArray< CoreString > &class_names, CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_but_private_flags_mask, const bool &consider_embedded=false) const
 
void get_all_objects (const CoreString &class_name, CoreSet< OfObjectHandle > &objects, const CoreBitFieldHelper &flags, const bool &consider_embedded=false) const
 
void get_all_objects (const CoreBasicArray< CoreString > &class_names, CoreSet< OfObjectHandle > &objects, const CoreBitFieldHelper &flags, const bool &consider_embedded=false) const
 
void get_all_objects (CoreArray< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask, const bool &consider_embedded=false) const
 
void get_all_objects (CoreSet< OfObjectHandle > &objects, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask, const bool &consider_embedded=false) const
 
void get_items (CoreVector< OfItemHandle > &items, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void get_all_items (CoreVector< OfItemHandle > &items, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
void get_all_items (CoreSet< OfItemHandle > &items, const CoreBitFieldHelper &flags=OfItem::enabled_flags_mask) const
 
OfItemHandle find_item_neighbour (const OfItem *item, const bool previous_neighbour=true) const
 
OfAttrHandle find_attribute (const CoreString &path) const
 
OfAttrHandle find_attribute (const CoreString &path, unsigned int &value_index) const
 
OfAttrHandle find_attribute (const CoreString &path, bool &index_specified, unsigned int &value_index) const
 
OfAttrHandle find_attribute (const CoreString &path, unsigned int &value_index, bool &is_array) const
 
unsigned int find_attributes (CoreVector< OfAttrHandle > &attrs, const CoreString &name, const CoreString &class_name) const
 
OfOutputHandle find_output_plug (const CoreString &path, unsigned int &plug_index) const
 
OfContextHandle add_context (const CoreString &name, const CoreClassInfo *engine=0)
 
OfContextHandle add_context (const CoreString &name, const CoreString &engine_name)
 
OfContextHandle add_instance (OfContext &source, const CoreString &name="")
 
OfObjectHandle add_generic_object (const CoreString &object_name, const int &object_flags=OfObject::FLAG_NONE)
 
OfObjectHandle add_object (const CoreString &object_name, const CoreString &class_name, const int &flags=OfObject::FLAG_NONE, const OfItem::State &output_state=OfItem::STATE_LIVE)
 
OfObjectHandle add_object (const ParserEntry &entry, const OfSerialOptions &options=OfSerialOptions::get_default(), const int &flags=OfObject::FLAG_NONE)
 
OfObjectHandle add_embedded_object (OfObject &parent_object, ParserEntry &entry, const OfSerialOptions &options=OfSerialOptions::get_default())
 
OfContextadd_context (const ParserEntry &serial, const OfSerialOptions &options=OfSerialOptions::get_default())
 
OfObjectHandle add_instance (const OfObject &source, const CoreString &name="", const int &flags=OfObject::FLAG_NONE, const OfItem::State &output_state=OfItem::STATE_LIVE)
 
OfItemHandle add_instance (OfItem &source, const CoreString &name="")
 
OfItemHandle add_copy (const OfItem &source)
 
OfObjectHandle add_copy (const OfObject &source)
 
OfContextHandle add_copy (const OfContext &source)
 
OfItemHandle paste_item (const ParserEntry &serial, const OfSerialOptions &options=OfSerialOptions::get_default())
 
OfContextHandle paste_context (const ParserEntry &serial, const OfSerialOptions &options=OfSerialOptions::get_default())
 
OfObjectHandle paste_object (const ParserEntry &serial, const OfSerialOptions &options=OfSerialOptions::get_default())
 
- Public Member Functions inherited from OfBaseItemHandle< T >
bool is_cap_delete () const
 
bool is_cap_rename () const
 
bool is_cap_copy () const
 
bool is_cap_paste () const
 
bool is_cap_move () const
 
bool is_cap_instantiate () const
 
bool is_cap_localize () const
 
bool is_cap_localize_attributes () const
 
bool is_cap_display () const
 
bool is_referenceable () const
 
const unsigned int & get_dependency_count () const
 
CoreListId get_first_dependency () const
 
CoreListId get_next_dependency (const CoreListId &dep_id) const
 
const unsigned int get_dependency_attr_value_index (const CoreListId &dep_id) const
 
bool is_cyclic_reference (const OfAttr *attr) const
 
bool get_flag_is_active (const int &flag) const
 
bool is_private () const
 
bool is_static () const
 
bool is_remote () const
 
bool is_content_locked () const
 
bool is_user_locked () const
 
bool is_pending () const
 
bool is_scene_assembly_temp () const
 
bool is_overridden_in_scene_assembly () const
 
bool is_missing () const
 
bool is_zombie () const
 
bool is_overriden () const
 
bool is_external () const
 
bool is_source_disabled () const
 
bool is_parent_disabled () const
 
bool is_read_only () const
 
bool is_shadowed () const
 
bool is_added () const
 
bool is_removed () const
 
bool is_embedded () const
 
bool is_in_undo_process () const
 
bool is_kindof (const CoreString &type_name) const
 
bool is_kindof (const CoreClassInfo &class_info) const override
 
bool is_name_dirty () const
 
const CoreStringget_name () const
 
const GuiIconget_item_icon () const
 
const unsigned int & get_attribute_count () const
 
const unsigned int find_attribute_index (const CoreString &attr_name) const
 
const unsigned int find_attribute_index (const OfAttr &attr) const
 
OfObjectFactoryget_factory () const
 
OfChannelManagerget_channel_manager () const
 
OfAppget_application () const
 
CoreString get_as_string (const OfSerialOptions &options=OfSerialOptions::get_default()) const
 
bool has_position (const CoreString &pos_slot) const
 
bool get_position (const CoreString &pos_slot, GMathVec2i &pos) const
 
bool get_position (const CoreString &pos_slot, GMathVec3i &pos) const
 
bool get_nodal_property (const CoreString &pos_slot, int &value) const
 
const CoreStringget_last_changed_position () const
 
void serialize_positions (ParserGroup &group) const
 
int get_node_status () const
 
const long unsigned long & get_creation_date () const
 
const long unsigned long & get_modified_date () const
 
bool is_instance () const
 
bool is_source () const
 
const OfItemget_scene_assembly_source_item () const
 
const bool & is_object () const
 
const bool & is_context () const
 
const OfItem::State & get_state () const
 
CoreString get_comment () const
 
CoreString get_colortag () const
 
const int & get_internal_flags () const
 
bool is_traversal () const
 
const CoreStringget_type () const
 
bool is_shadowable () const
 
void clear_caps ()
 
void set_cap_delete (const bool &value)
 
void set_cap_rename (const bool &value)
 
void set_cap_copy (const bool &value)
 
void set_cap_paste (const bool &value)
 
void set_cap_move (const bool &value)
 
void set_cap_instantiate (const bool &value)
 
void set_cap_localize (const bool &value)
 
void set_cap_display (const bool &value)
 
void update_dep_index (const CoreListId &id, const unsigned int &new_index)
 
void remove_dep (const CoreListId &id)
 
CoreListId add_dep (OfAttr *attr, const int &type, const unsigned int &index)
 
void clear_flags ()
 
void set_in_undo_process (const bool &flag)
 
void set_read_only (const bool &value)
 
void set_private (const bool &value)
 
void set_static (const bool &value)
 
void set_remote (const bool &value)
 
void set_content_locked (const bool &value)
 
void set_user_locked (const bool &value)
 
void set_zombie (const bool &value)
 
void set_pending (const bool &value)
 
void set_external (const bool &value)
 
void set_shadowed (const bool &value)
 
void set_added (const bool &value)
 
void set_removed (const bool &value)
 
void set_disabled (const bool &value)
 
void set_parent_disabled (const bool &value)
 
void set_source_disabled (const bool &value)
 
void set_overriden (const bool &value)
 
void set_missing (const bool &value)
 
void set_scene_assembly_temp (const bool &value)
 
void set_overriden_in_scene_assembly (const bool &value)
 
OfItemget_scene_assembly_source_item ()
 
void set_name_dirty ()
 
void set_name (const CoreString &new_name)
 
unsigned int set_attribute_index (const OfAttr &attr, const unsigned int &new_index)
 
void remove_all_attributes ()
 
void remove_attribute (const CoreString &name)
 
void remove_attribute (OfAttr &attr)
 
void reset_attributes ()
 
void send_event (const CoreString &event)
 
void set_position (const CoreString &pos_slot, const GMathVec2i &pos)
 
void set_position (const CoreString &pos_slot, const GMathVec3i &pos)
 
void set_position (const CoreString &pos_slot, const int &x, const int &y, const int &property=-1)
 
void set_nodal_property (const CoreString &pos_slot, const int &value)
 
void deserialize_positions (const ParserGroup &group)
 
void set_state (const OfItem::State &new_state)
 
CoreString set_comment (const CoreString &comment)
 
CoreString set_colortag (const CoreString &tag)
 
bool test_flags (const CoreBitFieldHelper &flags)
 
 OfBaseItemHandle (ContextType *context, ItemType *item)
 
 OfBaseItemHandle (ContextType *context)
 
template<bool U>
 OfBaseItemHandle (const OfBaseItemHandle< U > &other)
 
 OfBaseItemHandle (const OfHandle &handle)
 
 OfBaseItemHandle (ItemType *item)
 
template<bool U>
bool operator== (const OfBaseItemHandle< U > &other) const
 
template<bool U>
bool operator!= (const OfBaseItemHandle< U > &other) const
 
template<bool U>
OfBaseItemHandle< T > & operator= (const OfBaseItemHandle< U > &other)
 
bool operator== (ItemType *item) const
 
bool operator!= (ItemType *item) const
 
OfBaseItemHandleoperator= (const OfHandle &handle)
 
 operator const OfItem * () const
 
 operator OfItem * () const
 
ItemTypeget_ptr () const
 
OfBaseContextHandle< T > get_context () const
 
ContextTypeget_context_ptr () const
 
bool is_valid () const
 
OfBaseObjectHandle< T > to_object () const
 
OfBaseContextHandle< T > to_context () const
 
bool is_virtual () const
 
bool is_real () const
 
bool is_implicit () const
 
bool is_explicit () const
 
OfBaseItemHandle< T > get_source () const
 
const CoreStringget_full_name () const
 
CoreString get_project_full_name () const
 
void rename (const CoreString &name)
 
bool get_can_copy () const
 
bool get_can_paste () const
 
bool get_can_move () const
 
bool get_can_instantiate () const
 
bool get_can_localize () const
 
bool get_can_rename () const
 
bool can_serialize (const int &serial_mode) const
 
bool get_can_delete () const
 
bool is_disabled () const
 
bool is_enabled () const
 
bool is_editable (const int &read_only_mask=RO_ALL_MASK) const
 
bool is_external_dependency (const OfContext &context) const
 
OfBaseAttrHandle< T > get_attribute (const CoreString &attr) const
 
OfBaseAttrHandle< T > get_attribute (const unsigned int &index) const
 
OfBaseAttrHandle< T > attribute_exists (const CoreString &attr) const
 
OfBaseAttrHandle< T > get_dependency_attr (const CoreListId &dep_id) const
 
OfBaseItemHandle< T > get_parent_item () const
 
bool is_build_visible () const
 
OfBaseItemHandle< false > get_traversal_item ()
 
OfAttrHandle add_attribute (const OfItem::AttrCreationParams &params)
 
OfAttrHandle add_attribute (const CoreString &attr, const OfAttr::Type &type, const OfAttr::Container &container=OfAttr::CONTAINER_SINGLE, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT, const CoreString &group_name="general")
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
virtual size_t get_memory_size () const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Static Public Attributes

static OfBaseContextHandle< T > s_empty_handle = OfBaseContextHandle<T>()
 
- Static Public Attributes inherited from OfBaseItemHandle< T >
static OfBaseItemHandle< T > s_empty_handle = OfBaseItemHandle<T>()
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 
- Static Protected Member Functions inherited from OfBaseItemHandle< T >
static void rename (OfBaseItemHandle< false > self, const CoreString &name)
 
static OfBaseItemHandle< false > get_traversal_item (OfBaseItemHandle< false > self)
 
static OfAttrHandle add_attribute (OfBaseItemHandle< false > self, const OfItem::AttrCreationParams &params)
 
static OfAttrHandle add_attribute (OfBaseItemHandle< false > self, const CoreString &attr, const OfAttr::Type &type, const OfAttr::Container &container=OfAttr::CONTAINER_SINGLE, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT, const CoreString &group_name="general")
 
- Protected Attributes inherited from OfBaseItemHandle< T >
ContextTypem_context
 context in which to consider the item
 
ItemTypem_data
 the original item
 

Detailed Description

template<bool T>
class OfBaseContextHandle< T >

Base class for const and non-const context handles. The context handle API allows to get the children of a context as item handles.

Member Function Documentation

template<bool T>
OfBaseContextHandle< T > OfBaseContextHandle< T >::context_exists ( const CoreString name) const

return the sub-context by name

Returns
0 if the sub-context is not found
template<bool T>
OfBaseContextHandle< T > OfBaseContextHandle< T >::get_context ( const CoreString name) const

return the sub-context by name

Returns
0 if the sub-context is not found
template<bool T>
OfItemHandle OfBaseContextHandle< T >::get_item ( const CoreString name) const

return an item by specifying its path

Parameters
namethe name of the item
Returns
0 and a warning if the object is not found
template<bool T>
OfObjectHandle OfBaseContextHandle< T >::get_object ( const CoreString object_name) const

return an object by specifying its name

Parameters
object_namethe name of the object
Returns
0 if the object is not found
template<bool T>
OfItemHandle OfBaseContextHandle< T >::item_exists ( const CoreString name) const

return an item by specifying its path

Parameters
namethe name of the item
Returns
0 if the object is not found
template<bool T>
OfObjectHandle OfBaseContextHandle< T >::object_exists ( const CoreString object_name) const

return an object by specifying its name

Parameters
object_namethe name of the object
Returns
0 if the object is not found
template<bool T>
void OfBaseContextHandle< T >::set_parent ( OfContext parent)
inline
Warning
This is the only method changing the current handle member variable m_context. It replaces it by the new one given as parameter. Thus, it is highly recommended to not use it as handles are always passed as copy parameter in all the API functions. This public method was added in order to be able to re-parent a context in Python, as contexts can be only manipulated through OfContextHandle in Python.