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

This class represents a rule where only the input color space could be user managed. More...

Inheritance diagram for SYNCOLOR::DefaultFileRule:
SYNCOLOR::Rule

Public Member Functions

RuleType getType () const
 Returns the type of the rule. More...
 
virtual const char * getFileNameExtension () const =0
 Get the file name extension pattern used by the rule. More...
 
virtual const char * getFilePathPattern () const =0
 Get the file path pattern used by the rule. More...
 
virtual const char * getColorSpace () const =0
 Get the color space. More...
 
virtual SynStatus setColorSpace (const char *colorSpace)=0
 Set the color space to use. More...
 
- Public Member Functions inherited from SYNCOLOR::Rule
virtual ~Rule ()
 Default destructor. More...
 
virtual const char * getName () const =0
 Returns the name of the rule. More...
 

Additional Inherited Members

- Public Types inherited from SYNCOLOR::Rule
enum  RuleType { OPAQUE_RULE = 0, DEFAULT_RULE, STANDARD_RULE }
 All supported types of rule. More...
 
- Protected Member Functions inherited from SYNCOLOR::Rule
 Rule ()
 Default constructor. More...
 

Detailed Description

This class represents a rule where only the input color space could be user managed.

Member Function Documentation

RuleType SYNCOLOR::DefaultFileRule::getType ( ) const
inlinevirtual

Returns the type of the rule.

Returns
the rule's type

Implements SYNCOLOR::Rule.

References SYNCOLOR::Rule::DEFAULT_RULE.

virtual const char* SYNCOLOR::DefaultFileRule::getFileNameExtension ( ) const
pure virtual

Get the file name extension pattern used by the rule.

Returns
the file name extension
virtual const char* SYNCOLOR::DefaultFileRule::getFilePathPattern ( ) const
pure virtual

Get the file path pattern used by the rule.

Returns
the pattern
virtual const char* SYNCOLOR::DefaultFileRule::getColorSpace ( ) const
pure virtual

Get the color space.

Returns
returns the color space to be used
virtual SynStatus SYNCOLOR::DefaultFileRule::setColorSpace ( const char *  colorSpace)
pure virtual

Set the color space to use.

Parameters
colorSpaceThe color space
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.