Synergy Color Management Component - SDK -  2018.0.80
synColorPolicies.h File Reference

Policy management. More...

Classes

class  SYNCOLOR::PolicyInterface
 An abstract interface for any policy. More...
 
class  SYNCOLOR::Preferences
 An editable policy. More...
 
class  SYNCOLOR::Policy
 A read-only policy intended as a Preferences template. More...
 
class  SYNCOLOR::PolicyCollection
 A collection of policies. More...
 
struct  SYNCOLOR::PolicyCollection::Visitor
 Callback interface for collection traversal. More...
 

Namespaces

 SYNCOLOR
 Autodesk SynColor SDK public namespace.
 

Detailed Description

Policy management.

Policy management is achieved via this set of classes, namely PolicyCollection, providing access to a list of policies via a visitor, Policy, the incarnation of, you guessed it, a policy and, finally, Preferences, an editable copy of a policy. Both PolicyCollection and Preferences provide factory class methods for instantiation. Preferences also provides a copy method.

Physically, a policy consists of a directory holding a config file and whatever files this policy may provide. In this initial implementation, a policy directory contains a 'policy.cfg' file and, optionally, an input rules file, a viewing rules file and a directory containing a user colour space collection.

Initially, a policy collection will likely be empty. Clients can create Preferences objects and save them as policies in a policy collection (see. Preferences::saveAsPolicy). These policies are persisted and can later be retrieved to initialize the preferences of a project (see Policy::saveAsPreferences).