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

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

Inheritance diagram for SYNCOLOR::FilePathRule:
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 used by the rule. More...
 
virtual SynStatus setFileNameExtension (const char *fileNameExtension)=0
 Set the file name extension. More...
 
virtual const char * getFilePathPattern () const =0
 Get the file pattern used by the rule. More...
 
virtual SynStatus setFilePathPattern (const char *filePathPattern)=0
 Set the pattern to find in the file path. 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 the file pattern and the input color space could be user managed.

Member Function Documentation

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

Returns the type of the rule.

Returns
the rule's type

Implements SYNCOLOR::Rule.

References SYNCOLOR::Rule::STANDARD_RULE.

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

Get the file name extension used by the rule.

Returns
the file name extension
virtual SynStatus SYNCOLOR::FilePathRule::setFileNameExtension ( const char *  fileNameExtension)
pure virtual

Set the file name extension.

Parameters
fileNameExtensionThe extension to be used by the rule
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
virtual const char* SYNCOLOR::FilePathRule::getFilePathPattern ( ) const
pure virtual

Get the file pattern used by the rule.

Returns
the pattern
virtual SynStatus SYNCOLOR::FilePathRule::setFilePathPattern ( const char *  filePathPattern)
pure virtual

Set the pattern to find in the file path.

Parameters
filePathPatternThe pattern to be used by the rule
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
Note
"g?mma" accepts gamma, gimma but refuses gmma, gaaaamma "g*mma" accepts gamma, gimma, gmma and gaaaamma "g[ab]mma" only accepts gamma and gbmma, and refuses gmma, gaaamma "g[!ab]mma" refuses gmma, gamma, gbmma and gaaamma, and accepts gcmma "g[a-c]mma" only accepts gamma, gbmma and gcmma "g[!a-c]mma" refuses gamma, gbmma, gcmma and gmma, but accepts gemma "g\\*mma" only accepts g*mma
virtual const char* SYNCOLOR::FilePathRule::getColorSpace ( ) const
pure virtual

Get the color space.

Returns
returns the color space to be used
virtual SynStatus SYNCOLOR::FilePathRule::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.