Driver SDK 4.2.0
Public Types | Public Member Functions | Public Attributes | List of all members
aur::ADA::TMediaSize Class Reference
Driver information

#include <DriverInfo.h>

Public Types

enum  EMediaType { eLogical , ePhysical }
 

Public Member Functions

float GetLength (EMediaType which=eLogical) const noexcept
 
float GetWidth (EMediaType which=eLogical) const noexcept
 
float GetImageableLength (EMediaType which=eLogical) const noexcept
 
float GetImageableWidth (EMediaType which=eLogical) const noexcept
 
float GetLeftMargin (EMediaType which=eLogical) const noexcept
 
float GetRightMargin (EMediaType which=eLogical) const noexcept
 
float GetTopMargin (EMediaType which=eLogical) const noexcept
 
float GetBottomMargin (EMediaType which=eLogical) const noexcept
 
void FromJson (const jsonxx::Object &, float defaultWidth=0, float defaultLength=0)
 
void ToJson (jsonxx::Object &) const
 
void Load (const ACPL::XML::Node *)
 
void Save (ACPL::XML::Node *) const
 
ACPL::XML::Node * Save () const
 
bool IsEmpty () const noexcept
 
void Reset () noexcept
 

Public Attributes

char name [32]
 Name of the media size. More...
 
bool transverse
 True when the media is fed rotated in the machine. The RIP must provide rotated data. More...
 
bool roll
 True when the media size is a roll, False when it is a sheet. More...
 
float width
 Physical width in AOI units. More...
 
float length
 Physical length/height in AOI units. More...
 
float left
 Left non-imageable margin. More...
 
float right
 Right non-imageable margin. More...
 
float top
 Top non-imageable margin. More...
 
float bottom
 Bottom non-imageable margin. More...
 

Detailed Description

Media size description

Describes the media size and orientation

Definition at line 215 of file DriverInfo.h.

Member Enumeration Documentation

◆ EMediaType

enum aur::ADA::TMediaSize::EMediaType
Enumerator
eLogical 
ePhysical 

Definition at line 218 of file DriverInfo.h.

Member Function Documentation

◆ FromJson()

void aur::ADA::TMediaSize::FromJson ( const jsonxx::Object &  ,
float  defaultWidth = 0,
float  defaultLength = 0 
)

◆ GetBottomMargin()

float aur::ADA::TMediaSize::GetBottomMargin ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 287 of file DriverInfo.h.

◆ GetImageableLength()

float aur::ADA::TMediaSize::GetImageableLength ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 262 of file DriverInfo.h.

◆ GetImageableWidth()

float aur::ADA::TMediaSize::GetImageableWidth ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 267 of file DriverInfo.h.

◆ GetLeftMargin()

float aur::ADA::TMediaSize::GetLeftMargin ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 272 of file DriverInfo.h.

◆ GetLength()

float aur::ADA::TMediaSize::GetLength ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 252 of file DriverInfo.h.

◆ GetRightMargin()

float aur::ADA::TMediaSize::GetRightMargin ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 277 of file DriverInfo.h.

◆ GetTopMargin()

float aur::ADA::TMediaSize::GetTopMargin ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 282 of file DriverInfo.h.

◆ GetWidth()

float aur::ADA::TMediaSize::GetWidth ( EMediaType  which = eLogical) const
inlinenoexcept

Definition at line 257 of file DriverInfo.h.

◆ IsEmpty()

bool aur::ADA::TMediaSize::IsEmpty ( ) const
inlinenoexcept

Definition at line 248 of file DriverInfo.h.

◆ Load()

void aur::ADA::TMediaSize::Load ( const ACPL::XML::Node *  )

◆ Reset()

void aur::ADA::TMediaSize::Reset ( )
inlinenoexcept

Definition at line 249 of file DriverInfo.h.

◆ Save() [1/2]

ACPL::XML::Node * aur::ADA::TMediaSize::Save ( ) const

◆ Save() [2/2]

void aur::ADA::TMediaSize::Save ( ACPL::XML::Node *  ) const

◆ ToJson()

void aur::ADA::TMediaSize::ToJson ( jsonxx::Object &  ) const

Member Data Documentation

◆ bottom

float aur::ADA::TMediaSize::bottom

Bottom non-imageable margin.

Definition at line 231 of file DriverInfo.h.

◆ left

float aur::ADA::TMediaSize::left

Left non-imageable margin.

Definition at line 228 of file DriverInfo.h.

◆ length

float aur::ADA::TMediaSize::length

Physical length/height in AOI units.

Definition at line 227 of file DriverInfo.h.

◆ name

char aur::ADA::TMediaSize::name[32]

Name of the media size.

Definition at line 223 of file DriverInfo.h.

◆ right

float aur::ADA::TMediaSize::right

Right non-imageable margin.

Definition at line 229 of file DriverInfo.h.

◆ roll

bool aur::ADA::TMediaSize::roll

True when the media size is a roll, False when it is a sheet.

Definition at line 225 of file DriverInfo.h.

◆ top

float aur::ADA::TMediaSize::top

Top non-imageable margin.

Definition at line 230 of file DriverInfo.h.

◆ transverse

bool aur::ADA::TMediaSize::transverse

True when the media is fed rotated in the machine. The RIP must provide rotated data.

Definition at line 224 of file DriverInfo.h.

◆ width

float aur::ADA::TMediaSize::width

Physical width in AOI units.

Definition at line 226 of file DriverInfo.h.

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