Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::PolicyInterface Class Referenceabstract

An abstract interface for any policy. More...

Inheritance diagram for SYNCOLOR::PolicyInterface:
SYNCOLOR::Policy SYNCOLOR::Preferences

Public Member Functions

virtual ~PolicyInterface ()
 Destructor. More...
 
virtual const char * getPolicyName () const =0
 Get the name of the policy. More...
 
virtual const char * getWorkingColourSpace () const =0
 Get the working colour space. More...
 
virtual const char * getRenderingColourSpace () const =0
 Get the rendering colour space. More...
 
virtual URL::Ptr getInputRules () const =0
 Get the full path to the input rules file. More...
 
virtual URL::Ptr getViewingRules () const =0
 Get the full path to the viewing rules file. More...
 
virtual URL::Ptr getUserColourSpaces () const =0
 Get the full path to the user colour space collection. More...
 
virtual const char * getUserVariable (const char *var) const =0
 Get the value of an arbitrary variable. More...
 

Static Public Member Functions

static const char * policyFile ()
 Gets the standard name of the policy file in which variables are stored. More...
 

Detailed Description

An abstract interface for any policy.

Constructor & Destructor Documentation

virtual SYNCOLOR::PolicyInterface::~PolicyInterface ( )
inlinevirtual

Destructor.

Releases all resources by the PolicyInterface instance.

Member Function Documentation

virtual const char* SYNCOLOR::PolicyInterface::getPolicyName ( ) const
pure virtual

Get the name of the policy.

This name is always defined for a policy used as a template. It will be defined for a Preferences object derived from a Policy unless the Preferences object was later modified.

Returns
The original name of the policy.
virtual const char* SYNCOLOR::PolicyInterface::getWorkingColourSpace ( ) const
pure virtual

Get the working colour space.

Returns
The working colour space's unique (short) name.
virtual const char* SYNCOLOR::PolicyInterface::getRenderingColourSpace ( ) const
pure virtual

Get the rendering colour space.

Returns
The rendering colour space unique (short) name.
virtual URL::Ptr SYNCOLOR::PolicyInterface::getInputRules ( ) const
pure virtual

Get the full path to the input rules file.

Returns
The location of the input rules file.
virtual URL::Ptr SYNCOLOR::PolicyInterface::getViewingRules ( ) const
pure virtual

Get the full path to the viewing rules file.

Returns
The location of the viewing rules file.
virtual URL::Ptr SYNCOLOR::PolicyInterface::getUserColourSpaces ( ) const
pure virtual

Get the full path to the user colour space collection.

Returns
The location of the user colour space collection.
virtual const char* SYNCOLOR::PolicyInterface::getUserVariable ( const char *  var) const
pure virtual

Get the value of an arbitrary variable.

Parameters
varThe name of the variable
Returns
The value assigned to a user defined variable
static const char* SYNCOLOR::PolicyInterface::policyFile ( )
static

Gets the standard name of the policy file in which variables are stored.

Returns
The name of the policy file (a constant).