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

This class represents a generic rule. More...

Inheritance diagram for SYNCOLOR::Rule:
SYNCOLOR::DefaultFileRule SYNCOLOR::DefaultViewingRule SYNCOLOR::FilePathRule SYNCOLOR::OpaqueFileRule SYNCOLOR::ViewingRule

Public Types

enum  RuleType { OPAQUE_RULE = 0, DEFAULT_RULE, STANDARD_RULE }
 All supported types of rule. More...
 

Public Member Functions

virtual ~Rule ()
 Default destructor. More...
 
virtual RuleType getType () const =0
 Returns the type of the rule. More...
 
virtual const char * getName () const =0
 Returns the name of the rule. More...
 

Protected Member Functions

 Rule ()
 Default constructor. More...
 

Private Member Functions

 Rule (const Rule &)
 Forbidden method. More...
 
Ruleoperator= (const Rule &)
 Forbidden method. More...
 

Detailed Description

This class represents a generic rule.

Member Enumeration Documentation

All supported types of rule.

Enumerator
OPAQUE_RULE 

An opaque rule is a rule where the parameters are hidden.

DEFAULT_RULE 

The default rule is the fallback rule if all other rules fail.

STANDARD_RULE 

The standard rule is a fully customizable and manageable rule.

Constructor & Destructor Documentation

virtual SYNCOLOR::Rule::~Rule ( )
inlinevirtual

Default destructor.

SYNCOLOR::Rule::Rule ( )
inlineprotected

Default constructor.

SYNCOLOR::Rule::Rule ( const Rule )
private

Forbidden method.

Member Function Documentation

virtual RuleType SYNCOLOR::Rule::getType ( ) const
pure virtual

Returns the type of the rule.

Returns
the rule's type

Implemented in SYNCOLOR::FilePathRule, SYNCOLOR::DefaultFileRule, SYNCOLOR::OpaqueFileRule, SYNCOLOR::ViewingRule, and SYNCOLOR::DefaultViewingRule.

virtual const char* SYNCOLOR::Rule::getName ( ) const
pure virtual

Returns the name of the rule.

Returns
the rule's name which could never be null or empty
Rule& SYNCOLOR::Rule::operator= ( const Rule )
private

Forbidden method.

Returns
the instance itself