FotoSHOCK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
FotoSHOCKcore::RootLoadImage Class Reference
Inheritance diagram for FotoSHOCKcore::RootLoadImage:
FotoSHOCKcore::ImageOperation RootLoadImage

Public Member Functions

 RootLoadImage (const std::string fileName)
 
 RootLoadImage (PixelData format, const std::string fileName)
 
void prepare (const std::string fileName)
 
void prepare (PixelData format, const std::string fileName)
 
virtual void runOperation (const Inputs &sources, const Outputs &dest, vector< UpdateInfo > &ROI, const long int stamp)
 
virtual bool isPrepared ()
 Tell whether the operations is prepared to process image data. More...
 
virtual void serialize (XmlSerializer &serializer)
 Serialize the operation using the specified serializer. More...
 
virtual void deserialize (XmlSerializer &serializer)
 Deserialize the operation using the specified serializer. More...
 
- Public Member Functions inherited from FotoSHOCKcore::ImageOperation
 ImageOperation ()
 A constructor. More...
 
virtual ~ImageOperation ()
 A destructor.
 
GraphNodegetOwnerNode () const
 Get the node containing the operation. More...
 
virtual void initialize ()
 Set up the internal data which depends on the information from the GraphNode class. More...
 
virtual void runOperation (const Inputs &sources, const Outputs &dest, vector< UpdateInfo > &ROI, const long stamp)=0
 Apply the operation. More...
 
virtual bool updateROI (UpdateInfo &currentROI, UpdateInfo &parentROI)
 Update ROI in parent to fit the needs of a new ROI. More...
 
boost::shared_ptr< UpdateInforequestROI (boost::shared_ptr< UpdateInfo > currentROI)
 Get the required ROI of an input. More...
 

Additional Inherited Members

- Protected Member Functions inherited from FotoSHOCKcore::ImageOperation
void setOwnerNode (GraphNode *node)
 Sets the node, that contains the operation. More...
 

Member Function Documentation

void RootLoadImage::deserialize ( XmlSerializer serializer)
virtual

Deserialize the operation using the specified serializer.

Parameters
serializerreference to OperationSerializer that contains the operation's serialized data

Reimplemented from FotoSHOCKcore::ImageOperation.

bool RootLoadImage::isPrepared ( )
virtual

Tell whether the operations is prepared to process image data.

The isPrepared() function is used to check whether all preconditions needed by the ImageOperation to work. These preconditions includes eg. initial setup from a user interface. This does not include setup done by the initialize() function.

The default implementation always returns true, ie. the ImageOperation is prepared to process image data without needing any additional setup.

Returns
true if the operation is prepared to run, false if it still needs some setup.

Reimplemented from FotoSHOCKcore::ImageOperation.

void RootLoadImage::serialize ( XmlSerializer serializer)
virtual

Serialize the operation using the specified serializer.

Implement this function when the operation has custom settings that should be saved in the project. The operation must use the serializer that is passed as a parameter to seriaze its data, as it guarantees, that the data are stored at a proper place in the project file.

If the operation implements this function, it must implement its counterpart, the deserialize() function.

Parameters
serializerreference to OperationSerializer that is used for serializing data

Reimplemented from FotoSHOCKcore::ImageOperation.


The documentation for this class was generated from the following files: