Flip Documentation LibraryFlip Reference

Flip Reference

• Array
• Array::iterator
• array_iterator
• BackEndBinary
• BackEndIR::Type
• BackEndIR
• BackEndMl
• Blob
• Bool
• Class
• Collection
• Collection::iterator
• collection_iterator
• DataConsumerFile
• DataConsumerMemory
• DataModel
• DataProviderFile
• DataProviderMemory
• Document
• DocumentObserver
• DocumentObserverDynamic
• DocumentServer
• DocumentValidator
• Entity
• Enum
• EnumClass
• Float
• History
• Hub
• Int
• Map
• Map::iterator
• map_iterator
• Message
• MessageCached
• Mold
• MulticastServiceExplorer
• MulticastServiceProvider
• Object
• ObjectRef
• Optional
• Ref
• Signal
• String
• Transaction
• Variant
• Vector

DocumentValidator Class Reference

template <class T>   class DocumentValidator;

flip::DocumentValidator is the base of document validators.

Template Parameters

Member Functions Synopsys

Member Functions

validate

virtual void   validate (T & root) = 0;

To receive document change notification, one will inherit from this class and implement this function.

When a validation error is encountered, the function must throw to notify the flip system that validation failed. The macro flip_VALIDATION_FAILED is provided for convenience.

Example:

class MyValidator : public flip::DocumentValidator <MyRootClass>

{

public:

   virtual void   document_changed (MyRootClass & root) override;

};

void  MyValidator::document_changed (MyRootClass & root)

{

   if (root.changed ())

   {

      if (root.tempo < 20.0) flip_VALIDATION_FAILED ("incorrect tempo");

   }

}