Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::Impl::RulesEntries Class Reference

Public Member Functions

 RulesEntries ()
 Constructor. More...
 
 ~RulesEntries ()
 Destructor. More...
 
 RulesEntries (const RulesEntries &rhs)
 Copy Constructor. More...
 
RulesEntriesoperator= (const RulesEntries &rhs)
 Assignment operator. More...
 
const SYNCOLOR::RulePtroperator[] (unsigned i) const
 Return the rule at a specified index. This is a direct access to the internal rule list. There is not error handling. param i The index. More...
 
void clear ()
 Clear the list. More...
 
unsigned int size () const
 Get the number of rules in the managed list. More...
 
SYNCOLOR::SynStatus getRule (unsigned int position, SYNCOLOR::RulePtr &rule) const
 Get a specific rule from the list by index param position position of the rule in the list param rule Returned rule pointer. More...
 
SYNCOLOR::SynStatus getRule (const char *name, SYNCOLOR::RulePtr &rule) const
 Get a specific rule from the list by name param name name of the rule to return param rule Returned rule pointer. More...
 
SYNCOLOR::SynStatus moveRule (const char *name, int offset)
 Move a rule in the list param name name of the rule to move param offset How to move the rule. More...
 
SYNCOLOR::SynStatus addRule (const SYNCOLOR::RulePtr &rule)
 Add a rule at the end of the list param rule The rule to add. More...
 
SYNCOLOR::SynStatus insertRule (unsigned int position, const SYNCOLOR::RulePtr &rule)
 Insert a rule in the list param position Where to add the rule param rule The rule to add. More...
 
SYNCOLOR::SynStatus removeRule (const char *name)
 Remove a rule from the list param name Name of the rule to remove. More...
 

Private Types

typedef std::vector
< SYNCOLOR::RulePtr
Entries
 

Private Attributes

Entries _entries
 

Detailed Description

Container class that manages a list of rules. This class does not serialize nor does it populate from disk. It is up to the user to do this.

Constructor & Destructor Documentation

SYNCOLOR::Impl::RulesEntries::RulesEntries ( )

Constructor.

SYNCOLOR::Impl::RulesEntries::~RulesEntries ( )

Destructor.

SYNCOLOR::Impl::RulesEntries::RulesEntries ( const RulesEntries rhs)

Copy Constructor.

Member Function Documentation

RulesEntries& SYNCOLOR::Impl::RulesEntries::operator= ( const RulesEntries rhs)

Assignment operator.

const SYNCOLOR::RulePtr& SYNCOLOR::Impl::RulesEntries::operator[] ( unsigned  i) const

Return the rule at a specified index. This is a direct access to the internal rule list. There is not error handling. param i The index.

Returns
The rule pointer
void SYNCOLOR::Impl::RulesEntries::clear ( )

Clear the list.

unsigned int SYNCOLOR::Impl::RulesEntries::size ( ) const

Get the number of rules in the managed list.

Returns
Number of rules
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::getRule ( unsigned int  position,
SYNCOLOR::RulePtr rule 
) const

Get a specific rule from the list by index param position position of the rule in the list param rule Returned rule pointer.

Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::getRule ( const char *  name,
SYNCOLOR::RulePtr rule 
) const

Get a specific rule from the list by name param name name of the rule to return param rule Returned rule pointer.

Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::moveRule ( const char *  name,
int  offset 
)

Move a rule in the list param name name of the rule to move param offset How to move the rule.

Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::addRule ( const SYNCOLOR::RulePtr rule)

Add a rule at the end of the list param rule The rule to add.

Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::insertRule ( unsigned int  position,
const SYNCOLOR::RulePtr rule 
)

Insert a rule in the list param position Where to add the rule param rule The rule to add.

Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
SYNCOLOR::SynStatus SYNCOLOR::Impl::RulesEntries::removeRule ( const char *  name)

Remove a rule from the list param name Name of the rule to remove.

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