k3d::data Namespace Reference

Namespaces

namespace  constraint

Classes

class  container
 Host class for storing data using serialization, property, name, constraint, undo, storage, and signal policies. More...
class  no_serialization
 Serialization policy for data containers that do not need to be serialized. More...
class  with_serialization
 Serialization policy for data containers that can be serialized as XML. More...
class  path_serialization
 Serialization policy for filesystem path data that handles external filesystem resources. More...
class  node_serialization
 Serialization policy for data containers that store a document node and can be serialized as XML. More...
class  node_collection_serialization
 Serialization policy for data containers that can be serialized as XML. More...
class  no_property
 Property policy for data containers that do not expose their values using the K-3D property mechanism. More...
class  read_only_property
 Property policy that exposes a data container as a read-only K-3D property. More...
class  writable_property
 Property policy that exposes a data container as a writable K-3D property. More...
class  string_property
 Property policy that exposes a data container as a writable string property. More...
class  path_property
 Property policy that exposes a data container as a writable K-3D path property. More...
class  script_property
 Property policy that exposes a data container as a writable K-3D script property. More...
class  enumeration_property
 Property policy that exposes a data container as a K-3D enumeration property. More...
class  list_property
 Property policy that exposes a data container as a K-3D list property. More...
class  node_property
 Property policy that exposes a data container as a K-3D node property. More...
class  measurement_property
 Property policy that exposes a data container as a K-3D measurement property. More...
class  no_name
 Name policy for unnamed data containers. More...
class  immutable_name
 Name policy for data containers whose name cannot be changed. More...
class  no_constraint
 Constraint policy for data containers whose values are unconstrained. More...
class  iconstraint
 Abstract interface for a chain-of-responsibility constraint node. More...
class  with_constraint
 Policy for data nodes whose values are constrained by a chain of one-to-many iconstraint nodes. More...
class  no_undo
 Undo policy for data containers that do not store state changes for undo/redo. More...
class  with_undo
 Undo policy for data containers that stores state changes for undo/redo. More...
class  local_storage
 Storage policy for data containers that store their state by value. More...
class  node_storage
 Storage policy for data containers that store a pointer to a document node that could be deleted by the user at any time - note that value_t should be the interface type used to access the node. More...
class  pointer_storage
 Read-only storage policy that stores a value by pointer, created on-demand. More...
class  no_signal
 Signal policy for data containers that do not notify observers when their value changes. More...
class  change_signal
 Signal policy for data containers that notify observers when their value changes, including through undo/redo. More...
class  explicit_change_signal
 Signal policy for data containers that notify observers when their value changes. Observers can choose whether to be notified every time the value changes (including undo/redo), or only when the value is changed explicitly by a caller. More...
class  initializer_t
 Allows an arbitrary set of initializers to be consolidated into a single node. More...
class  composition_t
 Helper class used to consolidate two initializers into a single node. More...
class  value_initializer_t
 Helper class used to set a data container's initial value. More...
class  name_t
 Helper class used to set a data container's name. More...
class  label_t
 Helper class used to initialize a data container's label. More...
class  description_t
 Helper class used to initialize a data container's description. More...
class  constraint_t
 Helper class used to initialize a data container's constraints. More...
class  path_mode_t
 Helper class used to initialize the mode for path property nodes. More...
class  path_type_t
 Helper class used to initialize the type for path property nodes. More...
class  enumeration_t
 Helper class used to initialize enumeration property types. More...
class  values_t
 Helper class used to initialize list properties. More...
class  step_increment_t
 Helper class used to initialize measurement properties. More...
class  units_t
 Helper class used to initialize measurement properties. More...
class  owner_initializer_t
 Helper class used to initialize data containers. More...
class  external_owner_initializer_t
 Helper class used to initialize data containers. More...
class  slot_initializer_t
 Helper class used to initialize slots. More...
class  pointer_demand_storage
 Read-only storage policy that stores a value by pointer, created on-demand. More...
class  value_demand_storage
 Storage policy that computes a value on-demand. More...
class  array_serialization
 Serialization policy for data containers that can be serialized as XML. More...

Functions

ipropertyproperty_lookup (iproperty *const Source)
 Encapsulates the lookup process for connected properties.
xml::elementsave_external_resource (xml::element &Element, const ipersistent::save_context &Context, const std::string &Name, const ipath_property::reference_t Reference, const filesystem::path &Value)
void load_external_resource (xml::element &Element, const ipersistent::load_context &Context, ipath_property::reference_t &Reference, filesystem::path &Value)
template<typename lhs_t , typename rhs_t >
const initializer_t
< composition_t< lhs_t, rhs_t > > 
operator+ (const initializer_t< lhs_t > &LHS, const initializer_t< rhs_t > &RHS)
 Consolidates two initializers into a single node, which can be consolidated in-turn.
template<typename value_t >
const initializer_t
< value_initializer_t< value_t > > 
init_value (const value_t &Value)
const initializer_t< name_tinit_name (const char *const Name)
const initializer_t< label_tinit_label (const char *const Label)
const initializer_t
< description_t
init_description (const char *const Description)
template<typename data_t >
const initializer_t
< constraint_t< data_t > > 
init_constraint (iconstraint< data_t > *Constraint)
const initializer_t< path_mode_tinit_path_mode (const ipath_property::mode_t Mode)
const initializer_t< path_type_tinit_path_type (const std::string &Type)
const initializer_t
< enumeration_t
init_enumeration (const ienumeration_property::enumeration_values_t &Values)
template<typename data_t >
const initializer_t< values_t
< data_t > > 
init_values (const data_t &Values)
const initializer_t
< step_increment_t
init_step_increment (const double StepIncrement)
const initializer_t< units_tinit_units (const std::type_info &Units)
template<typename owner_t >
const initializer_t
< owner_initializer_t< owner_t > > 
init_owner (owner_t &Owner)
const initializer_t
< external_owner_initializer_t
init_owner (idocument &Document, iproperty_collection &PropertyCollection, ipersistent_collection &PersistentCollection, inode *const Object)
template<typename slot_t >
const initializer_t
< slot_initializer_t< slot_t > > 
init_slot (const slot_t &Slot)

Function Documentation

template<typename data_t >
const initializer_t<constraint_t<data_t> > k3d::data::init_constraint ( iconstraint< data_t > *  Constraint  )  [inline]
const initializer_t<description_t> k3d::data::init_description ( const char *const   Description  )  [inline]
const initializer_t<enumeration_t> k3d::data::init_enumeration ( const ienumeration_property::enumeration_values_t &  Values  )  [inline]
const initializer_t<label_t> k3d::data::init_label ( const char *const   Label  )  [inline]
const initializer_t<name_t> k3d::data::init_name ( const char *const   Name  )  [inline]
const initializer_t<external_owner_initializer_t> k3d::data::init_owner ( idocument &  Document,
iproperty_collection &  PropertyCollection,
ipersistent_collection &  PersistentCollection,
inode *const   Object 
) [inline]
template<typename owner_t >
const initializer_t<owner_initializer_t<owner_t> > k3d::data::init_owner ( owner_t &  Owner  )  [inline]
const initializer_t<path_mode_t> k3d::data::init_path_mode ( const ipath_property::mode_t  Mode  )  [inline]
const initializer_t<path_type_t> k3d::data::init_path_type ( const std::string &  Type  )  [inline]
template<typename slot_t >
const initializer_t<slot_initializer_t<slot_t> > k3d::data::init_slot ( const slot_t &  Slot  )  [inline]
const initializer_t<step_increment_t> k3d::data::init_step_increment ( const double  StepIncrement  )  [inline]
const initializer_t<units_t> k3d::data::init_units ( const std::type_info &  Units  )  [inline]
template<typename value_t >
const initializer_t<value_initializer_t<value_t> > k3d::data::init_value ( const value_t &  Value  )  [inline]
template<typename data_t >
const initializer_t<values_t<data_t> > k3d::data::init_values ( const data_t &  Values  )  [inline]
void k3d::data::load_external_resource ( xml::element &  Element,
const ipersistent::load_context &  Context,
ipath_property::reference_t &  Reference,
filesystem::path &  Value 
)

Todo:
Change this to use generic_path after version 0.8

Referenced by k3d::data::path_serialization< value_t, property_policy_t >::load().

template<typename lhs_t , typename rhs_t >
const initializer_t<composition_t<lhs_t, rhs_t> > k3d::data::operator+ ( const initializer_t< lhs_t > &  LHS,
const initializer_t< rhs_t > &  RHS 
) [inline]

Consolidates two initializers into a single node, which can be consolidated in-turn.

iproperty * k3d::data::property_lookup ( iproperty *const   Source  ) 
xml::element & k3d::data::save_external_resource ( xml::element &  Element,
const ipersistent::save_context &  Context,
const std::string &  Name,
const ipath_property::reference_t  Reference,
const filesystem::path &  Value 
)

Generated on Mon Mar 21 07:42:18 2011 for K-3D by doxygen 1.6.3