Seg3D  2.4
Seg3D is a free volume segmentation and processing tool developed by the NIH Center for Integrative Biomedical Computing at the University of Utah Scientific Computing and Imaging (SCI) Institute.
Public Types | Public Member Functions | Protected Attributes | List of all members
Seg3D::ProvenanceStep Class Reference
Inheritance diagram for Seg3D::ProvenanceStep:

Public Types

typedef boost::posix_time::ptime timestamp_type
 

Public Member Functions

const ProvenanceIDList & get_input_provenance_ids () const
 
void set_input_provenance_ids (const ProvenanceIDList &input_provenance_ids)
 
const ProvenanceIDList & get_output_provenance_ids () const
 
void set_output_provenance_ids (const ProvenanceIDList &output_provenance_ids)
 
const ProvenanceIDList & get_replaced_provenance_ids () const
 
void set_replaced_provenance_ids (const ProvenanceIDList &replaced_provenance_ids)
 
void set_inputfiles_id (const InputFilesID inputfiles_id)
 
InputFilesID get_inputfiles_id () const
 
void set_action_name (const std::string &action_name)
 
const std::string & get_action_name () const
 
void set_action_params (const std::string &action_params)
 
const std::string & get_action_params () const
 
void set_username (const std::string &username)
 
const std::string & get_username () const
 
void set_provenance_ids_of_interest (const ProvenanceIDList &poi)
 
const ProvenanceIDList & get_provenance_ids_of_interest () const
 
void set_timestamp (timestamp_type timestamp)
 
timestamp_type get_timestamp () const
 

Protected Attributes

ProvenanceIDList input_provenance_ids_
 List of provenance ids that this step depends on.
 
ProvenanceIDList output_provenance_ids_
 List of provenance ids that this action will generate.
 
ProvenanceIDList replaced_provenance_ids_
 List of provenance ids that this action will replace.
 
std::string action_name_
 Name of the action.
 
std::string action_params_
 Parameters of the action.
 
std::string user_
 User that generated action.
 
InputFilesID inputfiles_id_
 Input Files cache id.
 
ProvenanceIDList prov_ids_of_interest_
 
timestamp_type timestamp_
 Timestamp.
 

Member Function Documentation

const std::string & Seg3D::ProvenanceStep::get_action_name ( ) const

GET_ACTION_NAME: Get the action name.

const std::string & Seg3D::ProvenanceStep::get_action_params ( ) const

GET_ACTION_PARAMS: Get the action parameters string.

const ProvenanceIDList & Seg3D::ProvenanceStep::get_input_provenance_ids ( ) const

GET_INPUT_PROVENANCE_IDS Get the input provenance ids

InputFilesID Seg3D::ProvenanceStep::get_inputfiles_id ( ) const

GET_INPUTFILES_ID Get the input files cache id from this provenance step

const ProvenanceIDList & Seg3D::ProvenanceStep::get_output_provenance_ids ( ) const

GET_OUTPUT_PROVENANCE_IDS Get the input provenance ids

const ProvenanceIDList & Seg3D::ProvenanceStep::get_provenance_ids_of_interest ( ) const

GET_PROVENANCE_ID_OF_INTEREST: Get the provenance ID in which we are interested.

const ProvenanceIDList & Seg3D::ProvenanceStep::get_replaced_provenance_ids ( ) const

GET_REPLACED_PROVENANCE_IDS: Get the replaced provenance ids

ProvenanceStep::timestamp_type Seg3D::ProvenanceStep::get_timestamp ( ) const

GET_TIMESTAMP: Get the timestamp of the step.

const std::string & Seg3D::ProvenanceStep::get_username ( ) const

GET_USERNAME: get the user's name

void Seg3D::ProvenanceStep::set_action_name ( const std::string &  action_name)

SET_ACTION_NAME: Set the action name.

void Seg3D::ProvenanceStep::set_action_params ( const std::string &  action_params)

SET_ACTION_PARAMS: Set the action parameters string.

void Seg3D::ProvenanceStep::set_input_provenance_ids ( const ProvenanceIDList &  input_provenance_ids)

SET_INPUT_PROVENANCE_IDS Set the input provenance ids

void Seg3D::ProvenanceStep::set_inputfiles_id ( const InputFilesID  inputfiles_id)

SET_INPUTFILES_ID Set the input files cache id in the provenance step

void Seg3D::ProvenanceStep::set_output_provenance_ids ( const ProvenanceIDList &  output_provenance_ids)

SET_OUTPUT_PROVENANCE_IDS Set the input provenance ids

void Seg3D::ProvenanceStep::set_provenance_ids_of_interest ( const ProvenanceIDList &  poi)

SET_PROVENANCE_ID_OF_INTEREST: Set the provenance ID in which we are interested.

void Seg3D::ProvenanceStep::set_replaced_provenance_ids ( const ProvenanceIDList &  replaced_provenance_ids)

SET_REPLACED_PROVENANCE_IDS: Set the replaced provenance ids

void Seg3D::ProvenanceStep::set_timestamp ( timestamp_type  timestamp)

SET_TIMESTAMP: Set the timestamp of the step. NOTE: This function is called when retrieving provenance records from database. Actions don't need to set the timestamp as it is automatically generated by the database.

void Seg3D::ProvenanceStep::set_username ( const std::string &  username)

SET_USERNAME: Set the user name for this step. NOTE: Actions that create provenance steps don't need to call this function to set the user name. It is set automatically in the constructor. It is used when retrieving provenance from database.

Member Data Documentation

ProvenanceIDList Seg3D::ProvenanceStep::prov_ids_of_interest_
protected

Provenance IDs of interest NOTE: This is for getting back a provenance trail, when we are only interested in provenance IDs of a certain layer.

The documentation for this class was generated from the following files:
Generated on Wed Jun 29 2016 22:45:08 for Seg3D by   doxygen 1.8.10