epc::Relationship Class Reference

#include <Relationship.h>

Public Member Functions
	Relationship (const bool &internalTarget=true)
	Relationship (const std::string &rsTarget, const std::string &rsType, const std::string &rsId, const bool &internalTarget=true)
	~Relationship ()=default
std::string	toString () const
bool	isInternalTarget () const
const std::string &	getTarget () const
const std::string &	getType () const
const std::string &	getId () const
void	setIsExternalTarget ()
void	setIsInternalTarget ()
void	setTarget (const std::string &rsTarget)
void	setType (const std::string &rsType)
void	setDestinationObjectType ()
void	setSourceObjectType ()
void	setDestinationMediaType ()
void	setSourceMediaType ()
void	setChunkedPartType ()
void	setExternalPartProxyToMlType ()
void	setMlToExternalPartProxyType ()
void	setExternalResourceType ()
void	setId (const std::string &rsId)

Detailed Description

This class intends to represent a relationship entry of a rel file of a package part.

Constructor & Destructor Documentation

Relationship() [1/2]

epc::Relationship::Relationship ( const bool & internalTarget = true )

explicit

Constructor

Parameters

internalTarget

(Optional) True to internal target.

Relationship() [2/2]

epc::Relationship::Relationship	(	const std::string &	rsTarget,
		const std::string &	rsType,
		const std::string &	rsId,
		const bool &	internalTarget = true )

Constructor

Parameters

rsTarget	The RS target.
rsType	Type of the RS.
rsId	Identifier for the RS.
internalTarget	(Optional) True to internal target.

~Relationship()

epc::Relationship::~Relationship ( )

default

Destructor

Member Function Documentation

getId()

const std::string & epc::Relationship::getId

(

)

const

Gets the identifier

Returns

The identifier.

getTarget()

const std::string & epc::Relationship::getTarget

(

)

const

Gets the target

Returns

The target.

getType()

const std::string & epc::Relationship::getType

(

)

const

Gets the type

Returns

The type.

isInternalTarget()

bool epc::Relationship::isInternalTarget

(

)

const

Query if this object is internal target

Returns

True if internal target, false if not.

setChunkedPartType()

void epc::Relationship::setChunkedPartType ( )

inline

Sets chunked part type

setDestinationMediaType()

void epc::Relationship::setDestinationMediaType ( )

inline

Sets destination media type

setDestinationObjectType()

void epc::Relationship::setDestinationObjectType ( )

inline

Set predefined types to the relationship

setExternalPartProxyToMlType()

void epc::Relationship::setExternalPartProxyToMlType ( )

inline

Sets external part proxy to miles type

setExternalResourceType()

void epc::Relationship::setExternalResourceType ( )

inline

Sets external resource type

setId()

void epc::Relationship::setId

(

const std::string &

rsId

)

Set an arbitrary id to the relationship

Parameters

rsId	Identifier for the RS.

setIsExternalTarget()

void epc::Relationship::setIsExternalTarget

(

)

Sets is external target

setIsInternalTarget()

void epc::Relationship::setIsInternalTarget

(

)

Sets is internal target

setMlToExternalPartProxyType()

void epc::Relationship::setMlToExternalPartProxyType ( )

inline

Sets miles to external part proxy type

setSourceMediaType()

void epc::Relationship::setSourceMediaType ( )

inline

Sets source media type

setSourceObjectType()

void epc::Relationship::setSourceObjectType ( )

inline

Sets source object type

setTarget()

void epc::Relationship::setTarget

(

const std::string &

rsTarget

)

Sets a target

Parameters

rsTarget

The RS target.

setType()

void epc::Relationship::setType

(

const std::string &

rsType

)

Set an arbitrary type to the relationship

Parameters

rsType

Type of the RS.

toString()

std::string epc::Relationship::toString

(

)

const

Serialize the core property into an XML element embeded into a string.

Returns

A std::string that represents this object.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/epc/Relationship.h