FAST  3.2.0
Framework for Heterogeneous Medical Image Computing and Visualization
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
fast::DataObject Class Referenceabstract

#include <DataObject.hpp>

+ Inheritance diagram for fast::DataObject:
+ Collaboration diagram for fast::DataObject:

Public Types

typedef std::shared_ptr< DataObjectpointer
 
- Public Types inherited from fast::Object
typedef std::shared_ptr< Objectpointer
 

Public Member Functions

 DataObject ()
 
void setMetadata (std::string name, std::string value)
 
void setMetadata (std::unordered_map< std::string, std::string > metadata)
 
std::string getMetadata (std::string name) const
 
std::unordered_map< std::string, std::string > getMetadata () const
 
void deleteMetadata (std::string name)
 
uint64_t getTimestamp () const
 
void updateModifiedTimestamp ()
 
virtual ~DataObject ()
 
virtual std::string getNameOfClass () const =0
 
uint64_t getCreationTimestamp () const
 
void setCreationTimestamp (uint64_t timestamp)
 
void setLastFrame (std::string streamer)
 
bool isLastFrame ()
 
bool isLastFrame (std::string streamer)
 
std::unordered_set< std::string > getLastFrame ()
 
void setFrameData (std::string name, std::string value)
 
std::string getFrameData (std::string name)
 
std::unordered_map< std::string, std::string > getFrameData ()
 
void accessFinished ()
 
- Public Member Functions inherited from fast::Object
 Object ()
 
virtual ~Object ()
 
ReportergetReporter ()
 

Static Public Member Functions

static std::string getStaticNameOfClass ()
 
- Static Public Member Functions inherited from fast::Object
static std::string getStaticNameOfClass ()
 

Protected Member Functions

virtual void free (ExecutionDevice::pointer device)=0
 
virtual void freeAll ()=0
 
void blockIfBeingWrittenTo ()
 
void blockIfBeingAccessed ()
 
- Protected Member Functions inherited from fast::Object
ReporterreportError ()
 
ReporterreportWarning ()
 
ReporterreportInfo ()
 
ReporterEnd reportEnd () const
 

Protected Attributes

std::mutex mDataIsBeingWrittenToMutex
 
std::condition_variable mDataIsBeingWrittenToCondition
 
bool mDataIsBeingWrittenTo
 
std::mutex mDataIsBeingAccessedMutex
 
std::condition_variable mDataIsBeingAccessedCondition
 
bool mDataIsBeingAccessed
 
- Protected Attributes inherited from fast::Object
std::weak_ptr< ObjectmPtr
 

Member Typedef Documentation

◆ pointer

typedef std::shared_ptr<DataObject> fast::DataObject::pointer

Constructor & Destructor Documentation

◆ DataObject()

fast::DataObject::DataObject ( )

◆ ~DataObject()

virtual fast::DataObject::~DataObject ( )
inlinevirtual

Member Function Documentation

◆ accessFinished()

void fast::DataObject::accessFinished ( )

◆ blockIfBeingAccessed()

void fast::DataObject::blockIfBeingAccessed ( )
protected

◆ blockIfBeingWrittenTo()

void fast::DataObject::blockIfBeingWrittenTo ( )
protected

◆ deleteMetadata()

void fast::DataObject::deleteMetadata ( std::string  name)

◆ free()

virtual void fast::DataObject::free ( ExecutionDevice::pointer  device)
protectedpure virtual

◆ freeAll()

virtual void fast::DataObject::freeAll ( )
protectedpure virtual

◆ getCreationTimestamp()

uint64_t fast::DataObject::getCreationTimestamp ( ) const

◆ getFrameData() [1/2]

std::unordered_map<std::string, std::string> fast::DataObject::getFrameData ( )

◆ getFrameData() [2/2]

std::string fast::DataObject::getFrameData ( std::string  name)

◆ getLastFrame()

std::unordered_set<std::string> fast::DataObject::getLastFrame ( )

◆ getMetadata() [1/2]

std::unordered_map<std::string, std::string> fast::DataObject::getMetadata ( ) const

◆ getMetadata() [2/2]

std::string fast::DataObject::getMetadata ( std::string  name) const

◆ getNameOfClass()

virtual std::string fast::DataObject::getNameOfClass ( ) const
pure virtual

◆ getStaticNameOfClass()

static std::string fast::DataObject::getStaticNameOfClass ( )
inlinestatic

◆ getTimestamp()

uint64_t fast::DataObject::getTimestamp ( ) const

◆ isLastFrame() [1/2]

bool fast::DataObject::isLastFrame ( )

◆ isLastFrame() [2/2]

bool fast::DataObject::isLastFrame ( std::string  streamer)

◆ setCreationTimestamp()

void fast::DataObject::setCreationTimestamp ( uint64_t  timestamp)

◆ setFrameData()

void fast::DataObject::setFrameData ( std::string  name,
std::string  value 
)

◆ setLastFrame()

void fast::DataObject::setLastFrame ( std::string  streamer)

◆ setMetadata() [1/2]

void fast::DataObject::setMetadata ( std::string  name,
std::string  value 
)

◆ setMetadata() [2/2]

void fast::DataObject::setMetadata ( std::unordered_map< std::string, std::string >  metadata)

◆ updateModifiedTimestamp()

void fast::DataObject::updateModifiedTimestamp ( )

Member Data Documentation

◆ mDataIsBeingAccessed

bool fast::DataObject::mDataIsBeingAccessed
protected

◆ mDataIsBeingAccessedCondition

std::condition_variable fast::DataObject::mDataIsBeingAccessedCondition
protected

◆ mDataIsBeingAccessedMutex

std::mutex fast::DataObject::mDataIsBeingAccessedMutex
protected

◆ mDataIsBeingWrittenTo

bool fast::DataObject::mDataIsBeingWrittenTo
protected

◆ mDataIsBeingWrittenToCondition

std::condition_variable fast::DataObject::mDataIsBeingWrittenToCondition
protected

◆ mDataIsBeingWrittenToMutex

std::mutex fast::DataObject::mDataIsBeingWrittenToMutex
protected

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